Microsoft DirectX 9.0

IDirectDraw::CreateClipper

The CreateClipper method creates a DirectDrawClipper object. The DirectDrawClipper object can be attached to a DirectDrawSurface if desired, and used during Blt, BltBatch, and UpdateOverlay operations.

Syntax

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

Parameters

dwFlags

Not currently used. Zero is the only valid value.

lplpDDClipper

Points to a pointer which will be filled in with the address of the new DirectDrawClipper object if the CreateClipper method is successful.

pUnkOuter

This parameter is provided for future compability with COM aggregation features. Presently, however, CreateClipper returns an error if it is anything but NULL.

Return Values

Value Description
DDERR_INVALIDOBJECT The object is invalid.
DDERR_INVALIDPARAMS One or more of the input parameters is invalid.
DDERR_OUTOFMEMORY DirectDraw does not have enough memory to perform the operation.
DDERR_NOCOOPERATIVELEVELSET Create function called without SetCooperativeLevel being called.

See Also