IDirectDraw::CreateClipper

HRESULT CreateClipper(DWORD dwFlags,

LPDIRECTDRAWCLIPPER FAR * lplpDDClipper,

IUnknown FAR * pUnkOuter);

Creates a DirectDrawClipper object.

·Returns DD_OK if successful, or one of the following error values otherwise:

DDERR_INVALIDOBJECT DDERR_INVALIDPARAMS
DDERR_OUTOFMEMORY DDERR_NOCOOPERATIVELEVELSET

dwFlags

This parameter is not currently used and must be set to 0.

lplpDDClipper

Address of a pointer to be filled in with the address of the new DirectDrawClipper object if the IDirectDraw::CreateClipper method is successful.

pUnkOuter

Allows for future compatibility with COM aggregation features. Presently, however, IDirectDraw::CreateClipper will return an error if this parameter is anything but NULL.

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

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