IDirectDraw4::CreateClipper

The IDirectDraw4::CreateClipper method creates a DirectDrawClipper object.

HRESULT CreateClipper(
  DWORD dwFlags,                           
  LPDIRECTDRAWCLIPPER FAR *lplpDDClipper,  
  IUnknown FAR *pUnkOuter                  
);
 

Parameters

dwFlags

This parameter is currently not used and must be set to 0.

lplpDDClipper

Address of a variable that will be set to a valid IDirectDrawClipper interface pointer if the call succeeds.

pUnkOuter

Allows for future compatibility with COM aggregation features. Presently, however, this method will return an error if this parameter is anything but NULL.

Return Values

If the method succeeds, the return value is DD_OK.

If the method fails, the return value may be one of the following error values:

Remarks

The DirectDrawClipper object can be attached to a DirectDrawSurface and used during IDirectDrawSurface4::Blt, IDirectDrawSurface4::BltBatch, and IDirectDrawSurface4::UpdateOverlay operations.

To create a DirectDrawClipper object that is not owned by a specific DirectDraw object, use the DirectDrawCreateClipper function.

QuickInfo

  Windows NT/2000: Requires Windows 2000.
  Windows 95/98: Requires Windows 95 or later. Available as a redistributable for Windows 95.
  Header: Declared in ddraw.h.
  Import Library: Use ddraw.lib.

See Also

IDirectDrawSurface4::GetClipper, IDirectDrawSurface4::SetClipper