IDirectDraw4::CreateClipper

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 features. 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 IDirectDrawSurface5::Blt and IDirectDrawSurface5::UpdateOverlay operations.

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

Requirements

OS Versions: Windows CE 2.12 and later. Version 2.12 requires DXPAK 1.0 or later.
Header: Ddraw.h.
Link Library: Ddraw.lib.

See Also

IDirectDrawSurface5::GetClipper | IDirectDrawSurface5::SetClipper

 Last updated on Thursday, April 08, 2004

© 1992-2003 Microsoft Corporation. All rights reserved.