IDirectDrawClipper::SetClipList

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 IDirectDrawClipper::SetClipListmethod sets or deletes the clip list used by the IDirectDrawSurface5::Bltand IDirectDrawSurface5::UpdateOverlaymethods on surfaces to which the parent DirectDrawClipper object is attached.

HRESULT SetClipList(
LPRGNDATA
lpClipList
,
DWORD
dwFlags
);

Parameters

lpClipList

Either an address to a valid RGNDATAstructure or NULL. If there is an existing clip list associated with the DirectDrawClipper object and this value is NULL, the clip list will be deleted.

dwFlags

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

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_CLIPPERISUSINGHWND

DDERR_INVALIDCLIPLIST

DDERR_INVALIDOBJECT

DDERR_INVALIDPARAMS

DDERR_OUTOFMEMORY

Remarks

The clip list cannot be set if a window handle is already associated with the DirectDrawClipper object. Note that the BltFastmethod cannot clip.

The RGNDATAstructure used with this method has the following syntax:

typedef struct _RGNDATA { RGNDATAHEADER rdh; char
Buffer[1]; } RGNDATA;

The rdhmember of the RGNDATAstructure is an RGNDATAHEADERstructure that has the following syntax:

typedef struct _RGNDATAHEADER { DWORD dwSize;
DWORD iType; DWORD nCount; DWORD nRgnSize; RECT rcBound; }
RGNDATAHEADER;

For more information about these structures, see the documentation in the Platform Software Development Kit.

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