IDirectDraw2::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_NOCOOPERATIVELEVELSET

DDERR_OUTOFMEMORY

dwFlags

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

lplpDDClipper

Address of a pointer that will be filled with the address of the new DirectDrawClipper object if this method returns successfully.

pUnkOuter

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

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

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