IScene.SetDefaultBackgroundColor Method

Sets the default background color.

[Visual Basic .NET]
Public Sub SetDefaultBackgroundColor ( _
    ByVal red As Single, _
    ByVal green As Single, _
    ByVal blue As Single _
)

[C#]
public void SetDefaultBackgroundColor (
    float red,
    float green,
    float blue
);

[C++]
HRESULT SetDefaultBackgroundColor(
  float red,
  float green,
  float blue
);

[C++]
Parameters
red [in]
  red is a parameter of type float
green [in]
  green is a parameter of type float
blue [in]
  blue is a parameter of type float

Product Availability

Remarks

The values for the red, green, and blue components should fall between 0 and 1 inclusive. A value of 1 represents 100% saturation of that component.

The DefaultBackgroundColor is that used by new scenes. Only when a new scene is created will the color set here be used.

If you want to set the background color of the existing scene use ISceneGraph.SetBackgroundColor.

See Also