IDirectDrawSurface4::GetPixelFormat

The IDirectDrawSurface4::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/2000: Requires Windows 2000.
  Windows 95/98: Requires Windows 95 or later. Available as a redistributable for Windows 95.
  Header: Declared in ddraw.h.
  Import Library: Use ddraw.lib.