IDirectDrawClipper::SetClipList

HRESULT SetClipList(LPRGNDATA lpClipList, DWORD dwFlags);

Sets or deletes the clip list used by the IDirectDrawSurface::Blt, IDirectDrawSurface::BltBatch, and IDirectDrawSurface::UpdateOverlay methods on surfaces to which the parent DirectDrawClipper is attached.

·Returns DD_OK if successful, or one of the following error values otherwise:

DDERR_INVALIDOBJECT DDERR_CLIPPERISUSINGHWND
DDERR_INVALIDPARAMS DDERR_INVALIDCLIPLIST
DDERR_OUTOFMEMORY  

lpClipList

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

dwFlags

This parameter is not used at this time and must be set to 0.

The clip list is a series of rectangles that describes the visible areas of the surface. The clip list cannot be set if an hWnd is already associated with the DirectDrawClipper object. Note that the IDirectDrawSurface::BltFast method cannot clip.