Class SceneLightProbe

Namespace: ValveResourceFormat.Renderer.SceneEnvironment
Assembly: Renderer.dll

Scene node for indirect lighting via light probe volumes.

public class SceneLightProbe : SceneNode

Inheritance

object ← SceneNode ← SceneLightProbe

Inherited Members

SceneNode.Transform, SceneNode.LayerName, SceneNode.LayerEnabled, SceneNode.BoundingBox, SceneNode.LocalBoundingBox, SceneNode.Name, SceneNode.Id, SceneNode.IsSelected, SceneNode.Flags, SceneNode.Scene, SceneNode.EnvMaps, SceneNode.ShaderEnvMapVisibility, SceneNode.LightingOrigin, SceneNode.OverlayRenderOrder, SceneNode.CubeMapPrecomputedHandshake, SceneNode.LightProbeVolumePrecomputedHandshake, SceneNode.LightProbeBinding, SceneNode.EntityData, SceneNode.Update(Scene.UpdateContext), SceneNode.Render(Scene.RenderContext), SceneNode.GetSupportedRenderModes(), SceneNode.SetRenderMode(string), SceneNode.Delete(), SceneNode.GetCameraDistance(Camera)

Constructors

SceneLightProbe(Scene, AABB)

Initializes a new instance of the class with the given local-space bounds.

public SceneLightProbe(Scene scene, AABB bounds)

Parameters

scene Scene

The scene this node belongs to.

bounds AABB

The local-space bounds of the light probe volume.

Properties

AtlasOffset

Gets or sets the probe atlas offset in texels (lighting version 8.2).

public Vector3 AtlasOffset { get; set; }

Property Value

Vector3

AtlasSize

Gets or sets the probe atlas size in texels (lighting version 8.2).

public Vector3 AtlasSize { get; set; }

Property Value

Vector3

DebugGridSpheres

Gets the aggregate scene node used to visualize the probe grid spheres, if created.

public SceneAggregate? DebugGridSpheres { get; }

Property Value

SceneAggregate?

DirectLightIndices

Gets or sets the direct light index texture (lighting version 8.1).

public RenderTexture? DirectLightIndices { get; set; }

Property Value

RenderTexture?

DirectLightScalars

Gets or sets the direct light scalar texture (lighting version 8.1).

public RenderTexture? DirectLightScalars { get; set; }

Property Value

RenderTexture?

DirectLightShadows

Gets or sets the direct light shadow texture (lighting version 8.2).

public RenderTexture? DirectLightShadows { get; set; }

Property Value

RenderTexture?

HandShake

Gets or sets the handshake value used to match this probe to scene nodes during precomputation.

public int HandShake { get; set; }

Property Value

int

IndoorOutdoorLevel

If multiple volumes contain an object, the highest priority volume takes precedence.

public int IndoorOutdoorLevel { get; init; }

Property Value

int

Irradiance

Gets or sets the irradiance probe texture (lighting version 6 and 8.x).

public RenderTexture? Irradiance { get; set; }

Property Value

RenderTexture?

ShaderIndex

Gets or sets the shader-side index assigned to this probe for UBO packing.

public int ShaderIndex { get; set; }

Property Value

int

VoxelSize

Gets or sets the world-space size of each voxel cell in the probe grid.

public float VoxelSize { get; set; }

Property Value

float

Methods

CalculateGpuProbeData(bool)

Computes the GPU data for this probe, including atlas offsets when applicable.

public LightProbeVolume CalculateGpuProbeData(bool isProbeAtlas)

Parameters

isProbeAtlas bool

Whether the probe uses a probe atlas texture (lighting version 8.2).

Returns

LightProbeVolume

CreateDebugGridSpheres()

Creates or re-enables the debug grid sphere visualization for this light probe volume.

public void CreateDebugGridSpheres()

RemoveDebugGridSpheres()

Hides the debug grid sphere visualization without destroying it.

public void RemoveDebugGridSpheres()