Skip to content

Latest commit

 

History

History
91 lines (69 loc) · 3.38 KB

nf-ddraw-idirectdrawclipper-setcliplist.md

File metadata and controls

91 lines (69 loc) · 3.38 KB
UID title description helpviewer_keywords old-location tech.root ms.assetid ms.date ms.keywords req.header req.include-header req.target-type req.target-min-winverclnt req.target-min-winversvr req.kmdf-ver req.umdf-ver req.ddi-compliance req.unicode-ansi req.idl req.max-support req.namespace req.assembly req.type-library req.lib req.dll req.irql targetos req.typenames req.redist ms.custom f1_keywords dev_langs topic_type api_type api_location api_name
NF:ddraw.IDirectDrawClipper.SetClipList
IDirectDrawClipper::SetClipList (ddraw.h)
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.
IDirectDrawClipper interface [DirectDraw]
SetClipList method
IDirectDrawClipper.SetClipList
IDirectDrawClipper::SetClipList
SetClipList
SetClipList method [DirectDraw]
SetClipList method [DirectDraw]
IDirectDrawClipper interface
ddraw/IDirectDrawClipper::SetClipList
directdraw.idirectdrawclipper_setcliplist
directdraw\idirectdrawclipper_setcliplist.htm
directdraw
717f51e0-80cb-4762-b05d-30e30d065d0c
12/05/2018
IDirectDrawClipper interface [DirectDraw],SetClipList method, IDirectDrawClipper.SetClipList, IDirectDrawClipper::SetClipList, SetClipList, SetClipList method [DirectDraw], SetClipList method [DirectDraw],IDirectDrawClipper interface, ddraw/IDirectDrawClipper::SetClipList, directdraw.idirectdrawclipper_setcliplist
ddraw.h
Windows
Ddraw.lib
Ddraw.dll
Windows
19H1
IDirectDrawClipper::SetClipList
ddraw/IDirectDrawClipper::SetClipList
c++
APIRef
kbSyntax
COM
Ddraw.dll
IDirectDrawClipper.SetClipList

IDirectDrawClipper::SetClipList

-description

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.

-parameters

-param unnamedParam1 [in]

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.

-param unnamedParam2 [in]

Currently not used and must be set to 0.

-returns

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.

-see-also

IDirectDrawClipper