IDirectDrawSurface::GetPixelFormat

  • Article

A version of this page is also available for

Windows Embedded CE 6.0 R3

4/8/2010

This method retrieves the color and pixel format of the surface.

Syntax

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 Value

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

For more information on these error codes see DirectDraw Return Values.

Requirements

Header ddraw.h
Library ddraw.lib
Windows Embedded CE Windows Embedded CE 6.0 and later
Windows Mobile Pocket PC for Windows Mobile Version 5.0 and later, Smartphone for Windows Mobile Version 5.0 and later