IDirectDrawSurface7::GetSurfaceDesc method (ddraw.h)

Retrieves a description of this surface in its current condition.

Syntax

HRESULT GetSurfaceDesc(
  [in, out] LPDDSURFACEDESC2 unnamedParam1
);

Parameters

[in, out] unnamedParam1

A pointer to a DDSURFACEDESC2 structure that receives the current description of this surface. You need only initialize this structure's dwSize member to the size, in bytes, of the structure prior to the call; no other preparation is required.

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

Requirements

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

See also

IDirectDrawSurface7