IDirectDraw::CreateClipper (Compact 2013)

3/26/2014

This method creates a DirectDrawClipper object.

Syntax

HRESULT CreateClipper( 
  DWORD dwFlags, 
  LPDIRECTDRAWCLIPPER FAR* lplpDDClipper, 
  IUnknown FAR* pUnkOuter 
);

Parameters

  • dwFlags
    Currently not used and must be set to zero.
  • lplpDDClipper
    Address of a variable that will be set to a valid IDirectDrawClipper interface pointer if the call succeeds.
  • pUnkOuter
    This method returns CLASS_E_NOAGGREGATION if this parameter is anything but NULL.

Return Value

If the method succeeds, the return value is DD_OK.

If the method fails, the return value may be one of the following error values:

DDERR_INVALIDOBJECT

DDERR_INVALIDPARAMS

DDERR_NOCOOPERATIVELEVELSET

DDERR_OUTOFMEMORY

For more information on these error codes see DirectDraw Return Values.

Remarks

The DirectDrawClipper object can be attached to a DirectDrawSurface and used during IDirectDrawSurface::Blt and IDirectDrawSurface::UpdateOverlay operations.

To create a DirectDrawClipper object that is not owned by a specific DirectDraw object, use the DirectDrawCreateClipper function.

Requirements

Header

ddraw.h

Library

ddraw.lib

See Also

Reference

IDirectDraw
DirectDraw Reference
DirectDraw Interfaces
IDirectDrawSurface::GetClipper
IDirectDrawSurface::SetClipper

Other Resources

DirectDraw