Platform SDK: DirectX

IDirectDrawSurface7::GetPixelFormat

The IDirectDrawSurface7::GetPixelFormat method retrieves the color and pixel format of the surface.

HRESULT GetPixelFormat(
  LPDDPIXELFORMAT lpDDPixelFormat  
);

Parameters

lpDDPixelFormat
Address of the DDPIXELFORMAT structure to be filled with a detailed description of the current pixel and color space format of the surface.

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:

DDERR_INVALIDOBJECT
DDERR_INVALIDPARAMS
DDERR_INVALIDSURFACETYPE

Requirements

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