D3DCOLORVALUE structure

Represents a color value with alpha, which is used for transparency.

Syntax

typedef struct _D3DCOLORVALUE {
  float r;
  float g;
  float b;
  float a;
} D3DCOLORVALUE;

Members

r

Floating-point value that specifies the red component of a color. This value generally is in the range from 0.0 through 1.0. A value of 0.0 indicates the complete absence of the red component, while a value of 1.0 indicates that red is fully present.

g

Floating-point value that specifies the green component of a color. This value generally is in the range from 0.0 through 1.0. A value of 0.0 indicates the complete absence of the green component, while a value of 1.0 indicates that green is fully present.

b

Floating-point value that specifies the blue component of a color. This value generally is in the range from 0.0 through 1.0. A value of 0.0 indicates the complete absence of the blue component, while a value of 1.0 indicates that blue is fully present.

a

Floating-point value that specifies the alpha component of a color. This value generally is in the range from 0.0 through 1.0. A value of 0.0 indicates fully transparent, while a value of 1.0 indicates fully opaque.

Remarks

You can set the members of this structure to values outside the range of 0 through 1 to implement some unusual effects. Values greater than 1 produce strong lights that tend to wash out a scene. Negative values produce dark lights that actually remove light from a scene.

The DXGItype.h header type-defines DXGI_RGBA as an alias of D3DCOLORVALUE, as follows:

typedef D3DCOLORVALUE DXGI_RGBA;

You can use D3DCOLORVALUE or DXGI_RGBA with IDXGISwapChain1::SetBackgroundColor, IDXGISwapChain1::GetBackgroundColor, and DXGI_ALPHA_MODE.

Requirements

See also

DXGI Structures

DXGI_RGBA