public:
     virtual bool __fastcall SetClipper( TDx_DrawClipper* pClipper );

• Description
• Parameters
• See Also

If you would like to submit additions or improvements to this page, click: admin@bcb-tools.com.

The TDx_DrawSurface::SetClipper method will attach or detach a clipper for the surface.

The initial call to this method will increment the clippers reference count but further calls associating it with the same surface will not further affect the reference count.

Passing NULL to the Clipper parameter detaches the clipper and decrements the clippers reference count. If the surface is released before the clipper is detached, the clippers reference count will automatically be decremented. It is the applications responsibility to release further references to the clipper if it is no longer needed.

If the method call fails, the OnError event will be triggered with one of the following values:
DDERR_INVALIDOBJECT
DDERR_INVALIDPARAMS
DDERR_INVALIDSURFACETYPE
DDERR_NOCLIPPERATTACHED

Clipper
The Clipper parameter references the clipper that is to be attached.
Set this parameter to NULL to detach the current clipper.

TDx_DrawSurface
TDx_DrawClipper