IDirectDrawClipper::SetClipList

A version of this page is also available for

Windows Embedded CE 6.0 R3

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
); 

Parameters

• 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.

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

Return Value

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:

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

Remarks

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.

Requirements

See Also

Reference

IDirectDrawClipper::GetClipList
IDirectDrawSurface::Blt
IDirectDrawSurface::UpdateOverlay