Edit

Share via

IDirectDrawClipper::SetClipList method (ddraw.h)

  • Article

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

Syntax

HRESULT SetClipList(
  [in] LPRGNDATA unnamedParam1,
  [in] DWORD     unnamedParam2
);

Parameters

[in] unnamedParam1

A pointer to a valid RGNDATA structure for the clip list to set or NULL. If there is an existing clip list that is associated with the DirectDrawClipper object and this value is NULL, the clip list is deleted.

[in] unnamedParam2

Currently not used and must be set to 0.

Return value

If the method succeeds, the return value is DD_OK.

If it fails, the method can return one of the following error values:

  • DDERR_CLIPPERISUSINGHWND
  • DDERR_INVALIDCLIPLIST
  • DDERR_INVALIDOBJECT
  • DDERR_INVALIDPARAMS
  • DDERR_OUTOFMEMORY

Remarks

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

The IDirectDrawSurface7::BltFast method cannot clip. If you call IDirectDrawSurface7::BltFast on a surface with an attached clipper, it returns DDERR_UNSUPPORTED.

Requirements

Requirement Value
Target Platform Windows
Header ddraw.h
Library Ddraw.lib
DLL Ddraw.dll

See also

IDirectDrawClipper