Platform SDK: DirectX |
The IDirectDrawClipper::GetClipList method retrieves a copy of the clip list associated with a DirectDrawClipper object. A subset of the clip list can be selected by passing a rectangle that clips the clip list.
HRESULT GetClipList( LPRECT lpRect, LPRGNDATA lpClipList, LPDWORD lpdwSize );
If the method succeeds, the return value is DD_OK.
If it fails, the method can return one of the following error values:
DDERR_GENERIC |
DDERR_INVALIDCLIPLIST |
DDERR_INVALIDOBJECT |
DDERR_INVALIDPARAMS |
DDERR_NOCLIPLIST |
DDERR_REGIONTOOSMALL |
The RGNDATA structure used with this method has the following syntax:
typedef struct _RGNDATA { RGNDATAHEADER rdh; char Buffer[1]; } RGNDATA;
The rdh member of the RGNDATA structure is an RGNDATAHEADER structure 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 Platform SDK.
Windows NT/2000: Requires Windows NT 4.0 SP3 or later.
Windows 95/98: Requires Windows 95 or later. Available as a redistributable for Windows 95.
Header: Declared in ddraw.h.
Import Library: Use ddraw.lib.