Microsoft DirectX 9.0


The SetClipList method sets or deletes the clip list used by the Blt, BltBatch, and UpdateOverlay methods of surfaces to which the parent DirectDrawClipper is attached. The clip list is a series of rectangles that describe the areas of the surface that are visible. The clip list cannot be set if there is already a window handle associated with the DirectDrawClipper object. Note that the BltFast method cannot clip.


HRESULT SetClipList(
  LPRGNDATA lpClipList,
  DWORD dwFlags



This is either a pointer to a valid RGNDATA or NULL. If it is NULL, and there is an existing clip list associated with the DirectDrawClipper, it will be deleted.


Not used at this time.

Return Values

Value Description
DD_OK The method succeeded.
DDERR_INVALIDOBJECT DirectDraw received a pointer that was an invalid DirectDraw object.
DDERR_INVALIDPARAMS One or more of the parameters passed to the function are incorrect.
DDERR_INVALIDCLIPLIST DirectDraw does not support the provided clip list.
DDERR_OUTOFMEMORY DirectDraw does not have enough memory to perform the operation.
DDERR_CLIPPERISUSINGHWND An attempt was made to set a clip list for a clipper object that is already monitoring an hwnd.

See Also