IDirectDraw7::CreateClipper method (ddraw.h)

Creates a DirectDrawClipper object.

Syntax

HRESULT CreateClipper(
  [in]  DWORD               unnamedParam1,
  [out] LPDIRECTDRAWCLIPPER *unnamedParam2,
  [in]  IUnknown            *unnamedParam3
);

Parameters

[in] unnamedParam1

Currently not used and must be set to 0.

[out] unnamedParam2

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

[in] unnamedParam3

Allows for future compatibility with COM aggregation features. Currently this method returns an error if this parameter is not NULL.

Return value

If the method succeeds, the return value is DD_OK.

If it fails, the method can return 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 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

Requirement Value
Target Platform Windows
Header ddraw.h
Library Ddraw.lib
DLL Ddraw.dll

See also

IDirectDraw7