DDPIXELFORMAT

A version of this page is also available for

Windows Embedded CE 6.0 R3

4/8/2010

This structure describes the pixel format of a DirectDrawSurface object for the IDirectDrawSurface::GetPixelFormat method.

Syntax

typedef struct _DDPIXELFORMAT {
  DWORD dwSize;
  DWORD dwFlags;
  DWORD dwFourCC;
  union
  {
    DWORD dwRGBBitCount;
    DWORD dwYUVBitCount;
    DWORD dwAlphaBitDepth;
  };
  union
  {
    DWORD dwRBitMask;
    DWORD dwYBitMask;
  };
  union
  {
    DWORD dwGBitMask;
    DWORD dwUBitMask;
  };
  union
  {
     DWORD dwBBitMask;
    DWORD dwVBitMask;
  };
  union
  {
    DWORD dwRGBAlphaBitMask;
  };
} DDPIXELFORMAT, FAR* LPDDPIXELFORMAT;

Members

• dwSize
  Specifies the size, in bytes, of the DDPIXELFORMAT structure.

  This member must be initialized before the structure is used.

• dwFlags
  Set of flags that specify optional control flags.

  This member is a bitwise OR of any of the flags shown in the following table.

  Flag	Description
  DDPF_ALPHA	The pixel format describes an alpha-only surface.
  DDPF_ALPHAPIXELS	The surface has alpha channel information in the pixel format.
  DDPF_ALPHAPREMULT	The color components in the pixel are premultiplied by the alpha value in the pixel. If this flag is set, the DDPF_ALPHAPIXELS flag must also be set. If this flag is not set but the DDPF_ALPHAPIXELS flag is set, the color components in the pixel format are not premultiplied by alpha. In this case, the color components must be multiplied by the alpha value at the time that an alpha-blending operation is performed.
  DDPF_FOURCC	The FourCC code is valid.
  DDPF_PALETTEINDEXED	Unsupported.
  DDPF_RGB	The RGB data in the pixel format structure is valid.

• dwFourCC
  Specifies the FourCC code.

• dwRGBBitCount
  Specifies the number of RGB bits per pixel (4, 8, 16, 24, or 32).

• dwYUVBitCount
  Specifies the number of YUV bits per pixel.

• dwAlphaBitDepth
  Specifies the Alpha channel bit depth.

• dwRBitMask
  Specifies the mask for red bits.

• dwYBitMask
  Specifies the mask for Y bits.

• dwGBitMask
  Specifies the mask for green bits.

• dwUBitMask
  Not supported.

• dwBBitMask
  Specifies the mask for blue bits.

• dwVBitMask
  Not supported

• dwRGBAlphaBitMask
  Specify the masks for alpha channel.

Requirements

See Also

Concepts

Creating an Off-Screen Surface