IDirectDrawClipper::SetClipList

A version of this page is also available for

4/8/2010

This method sets or deletes the clip list used by the IDirectDrawSurface::Blt and IDirectDrawSurface::UpdateOverlay methods on surfaces to which the parent DirectDrawClipper object is attached.

Syntax

HRESULT SetClipList(
  LPRGNDATA lpClipList, 
  DWORD dwFlags
);

lpClipList
Either an address to a valid RGNDATA structure 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.

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

For more information on these error codes see DirectDraw Return Values.

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

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 documentation in the Platform Software Development Kit.

Header	ddraw.h
Library	ddraw.lib
Windows Embedded CE	Windows Embedded CE 6.0 and later
Windows Mobile	Pocket PC for Windows Mobile Version 5.0 and later, Smartphone for Windows Mobile Version 5.0 and later