IDirectDraw4::CreateClipper

Important:
This is retired content. This content is outdated and is no longer being maintained. It is provided as a courtesy for individuals who are still using these technologies. This content may contain URLs that were valid when originally published, but now link to sites or pages that no longer exist.

The IDirectDraw4::CreateClippermethod creates a DirectDrawClipper object.

HRESULT CreateClipper(
DWORD
dwFlags
,
LPDIRECTDRAWCLIPPER FAR

*
lplpDDClipper
,
IUnknown FAR

*
pUnkOuter
);

Parameters

dwFlags

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

lplpDDClipper

Address of a variable that will be set to a valid IDirectDrawClipperinterface pointer if the call succeeds.

pUnkOuter

Allows for future compatibility with COM aggregation features. Presently, this method will return CLASS_E_NOAGGREGATION if this parameter is anything but NULL.

Return Values

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

Remarks

The DirectDrawClipper object can be attached to a DirectDrawSurface and used during IDirectDrawSurface5::Bltand IDirectDrawSurface5::UpdateOverlayoperations.

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

Requirements

Runs on	Versions	Declared in	Link to
Windows CE OS	2.12 or later. Version 2.12 requires DXPAK 1.0 or later.	ddraw.h	ddraw.lib