Share via


IDirectDraw::CreateClipper

Send Feedback

This 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 zero.
  • 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 functionality. Presently, this method will return CLASS_E_NOAGGREGATION 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:

DDERR_INVALIDOBJECT
DDERR_INVALIDPARAMS
DDERR_NOCOOPERATIVELEVELSET
DDERR_OUTOFMEMORY

Remarks

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

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

Requirements

Pocket PC: Windows Mobile 5.0 and later
Smartphone: Windows Mobile 5.0 and later
OS Versions: Windows CE 5.01 and later
Header: Ddraw.h.
Library: Ddraw.lib.

See Also

IDirectDrawSurface::GetClipper | IDirectDrawSurface::SetClipper

Send Feedback on this topic to the authors

Feedback FAQs

© 2006 Microsoft Corporation. All rights reserved.