IDirectDrawSurface3::GetPixelFormat

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

HRESULT GetPixelFormat(
  LPDDPIXELFORMAT lpDDPixelFormat  
);
 

Parameters

lpDDPixelFormat
Address of the DDPIXELFORMAT structure that will 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 the method fails, the return value may be one of the following error values:

DDERR_INVALIDOBJECT
DDERR_INVALIDPARAMS
DDERR_INVALIDSURFACETYPE

QuickInfo

  Windows NT: Use version 5.0 or later.
  Windows: Use Windows 95 or later. Available as a redistributable for Windows 95.
  Windows CE: Unsupported.
  Header: Declared in ddraw.h.
  Import Library: Use ddraw.lib.