IDirectDraw7::CreateClipper

The IDirectDraw7::CreateClipper method creates a DirectDrawClipper object.

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

Parameters

dwFlags

Currently not used and must be set to 0.

lplpDDClipper

Address of a variable to 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 returns an error if this parameter is anything but NULL.

Return Values

If the method succeeds, the return value is DD_OK.

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

Remarks

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

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

Requirements

  Windows NT/2000: Requires Windows 2000.
  Windows 95/98: Requires Windows 98.
  Header: Declared in ddraw.h.

See Also

IDirectDrawSurface7::GetClipper, IDirectDrawSurface7::SetClipper