IDirectDraw7::CreatePalette

The IDirectDraw7::CreatePalette method creates a DirectDrawPalette object for this DirectDraw object.

HRESULT CreatePalette(
  DWORD dwFlags,                           
  LPPALETTEENTRY lpDDColorArray,           
  LPDIRECTDRAWPALETTE FAR *lplpDDPalette,  
  IUnknown FAR *pUnkOuter                  
);

Parameters

dwFlags

One or more of the following flags:

DDPCAPS_1BIT

The index is 1 bit. There are two entries in the color table.

DDPCAPS_2BIT

The index is 2 bits. There are four entries in the color table.

DDPCAPS_4BIT

The index is 4 bits. There are 16 entries in the color table.

DDPCAPS_8BIT

The index is 8 bits. There are 256 entries in the color table.

DDPCAPS_8BITENTRIES

The index refers to an 8-bit color index. This flag is valid only when used with the DDPCAPS_1BIT, DDPCAPS_2BIT, or DDPCAPS_4BIT flag, and when the target surface is 8 bpp. Each color entry is 1 byte long and is an index to a destination surface's 8-bpp palette.

DDPCAPS_ALPHA

The peFlags member of the associated PALETTEENTRY structure is to be interpreted as a single 8-bit alpha value (in addition to the peRed, peGreen, and peBlue members). A palette created with this flag can only be attached to a texture: a surface created with the DDSCAPS_TEXTURE capability flag.

DDPCAPS_ALLOW256

This palette can have all 256 entries defined.

DDPCAPS_INITIALIZE

Obsolete. DirectDraw always initializes this palette with the colors in the color array passed at lpDDColorArray.

DDPCAPS_PRIMARYSURFACE

This palette is attached to the primary surface. Changing this palette's color table immediately affects the display unless DDPSETPAL_VSYNC is specified and supported.

DDPCAPS_PRIMARYSURFACELEFT

This palette is the one attached to the left-eye primary surface. Changing this palette's color table immediately affects the left-eye display unless DDPSETPAL_VSYNC is specified and supported.

DDPCAPS_VSYNC

This palette can have modifications to it synchronized with the monitor's refresh rate.

lpDDColorArray

Address of an array of 2, 4, 16, or 256 PALETTEENTRY structures to initialize this DirectDrawPalette object.

lplpDDPalette

Address of a variable to be set to a valid IDirectDrawPalette interface pointer if the call succeeds.

pUnkOuter

Allows for future compatibility with COM aggregation features. Presently, however, this method returns an error if this parameter is anything but NULL.

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:

Requirements

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