nw::gfx::SceneEnvironment Class

Syntax

class SceneEnvironment

Description

The class indicating the scene environment.

The RenderEnvironment class has been eliminated and replaced by SceneEnvironment.

Structures

nw::gfx::SceneEnvironment::Description Scene environment settings.

Member Functions

Scene Environment Settings-Related
ApplyFrom Applies a scene environment from the scene environment settings.
ClearSettings Clears the scene environment.
SetFog Sets a fog in the fog array.
GetFog Obtains a fog from the fog array.
SetCamera Sets a camera in the camera array.
GetCamera Obtains a camera from the camera array.
SetLightSet Sets a light set in the light set array.
GetLightSet Obtains a light set from the light set array.
Light-Related
SetFragmentLight Sets a fragment light.
GetFragmentLightCount Gets the number of fragment lights.
GetFragmentLight Gets the fragment light that has been set.
SetVertexLight Sets a vertex light.
GetVertexLight Gets the vertex light that has been set.
GetVertexLightCount Gets the number of vertex lights.
SetAmbientLight Sets an ambient light.
GetAmbientLight Gets the ambient light that has been set.
SetHemiSphereLight Sets a hemispherical light.
GetHemiSphereLight Gets a hemispherical light.
SetActiveLightSet Sets the active light set.
Fog-Related
SetActiveFog Activates the fog with the specified index.
GetActiveFog Obtains active fogs.
Camera-Related
NW_DEPRECATED_FUNCTION Activates the camera with the specified index. This function is scheduled to be removed in version 1.2.0. Be sure to call RenderContext::SetActiveCamera.
Flag-Related
IsFragmentLightsDirty Gets the flag that indicates whether to reconfigure fragment lights. This feature is provisional.
SetFragmentLightsDirty Sets the flag that indicates whether to reconfigure fragment lights. This feature is provisional.
IsAmbientLightDirty Gets the flag that indicates whether to reconfigure ambient light. This feature is provisional.
SetAmbientLightDirty Sets the flag that indicates whether to reconfigure ambient light. This feature is provisional.
IsVertexLightsDirty Gets the flag that indicates whether to reconfigure vertex lights. This feature is provisional.
SetVertexLightsDirty Sets the flag that indicates whether to reconfigure vertex lights. This feature is provisional.
IsHemiSphereLightDirty Gets the flag that indicates whether to reconfigure hemispherical lights. This feature is provisional.
SetHemiSphereLightDirty Sets the flag that indicates whether to reconfigure hemispherical lights. This feature is provisional.
IsFogDirty Gets the flag that indicates whether to reconfigure fog. This feature is provisional.
SetFogDirty Sets the flag that indicates whether to reconfigure fog. This feature is provisional.
SetAllFlagsDirty Sets the flag that indicates whether to reconfigure light and fog. This feature is provisional.
State-related
Reset Resets all states.
ResetFragmentLights Resets the fragment light state.
ResetVertexLights Resets the vertex light state.
ResetHemiSphereLight Resets the hemispherical light state.
ResetAmbientLight Resets the ambient light state.
NW_DEPRECATED_FUNCTION Resets the camera state. This function is scheduled to be removed in version 1.2.0.
ResetFog Resets the fog state.
ResetLightSet Resets the light set state.
Other
SceneEnvironment Constructor.

CONFIDENTIAL