This document is archived and information here might be outdated.  Recommended version.


IScene.GetDefaultBackgroundColor Method (ArcObjects .NET 10.4 SDK)
ArcObjects namespaces > 3DAnalyst > ESRI.ArcGIS.Analyst3D > Interfaces > IS > IScene Interface > IScene.GetDefaultBackgroundColor Method (ArcObjects .NET 10.4 SDK)
ArcObjects Library Reference (3DAnalyst)  

IScene.GetDefaultBackgroundColor Method

Returns the default background color.

[Visual Basic .NET]
Public Sub GetDefaultBackgroundColor ( _
    ByRef red As Single&, _
    ByRef green As Single&, _
    ByRef blue As Single& _
)

[C#]
public void GetDefaultBackgroundColor (
    ref Single& red,
    ref Single& green,
    ref Single& blue
);

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

[C++]

Parameters
red [out]
  red is a parameter of type float
green [out]
  green is a parameter of type float
blue [out]
  blue is a parameter of type float

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires 3D Analyst Extension.

Remarks

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

The DefaultBackgroundColor is that used by new scenes. It does not necessarilly indicate the background color of the current scene.

If you want to know the background color of the current scene use ISceneGraph.GetBackgroundColor.

See Also

IScene Interface