Source 2 Viewer

Appearance

Download Source 2 Viewer

Class SceneLight ​

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

Scene node representing a light source with type, color, and attenuation.

csharp
public class SceneLight : SceneNode

Inheritance ​

object ← SceneNode ← SceneLight

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 ​

SceneLight(Scene) ​

Scene node representing a light source with type, color, and attenuation.

csharp
public SceneLight(Scene scene)

Parameters ​

scene Scene

Properties ​

AttenuationLinear ​

Gets or sets the linear attenuation coefficient.

csharp
public float AttenuationLinear { get; set; }

Property Value ​

float

AttenuationQuadratic ​

Gets or sets the quadratic attenuation coefficient.

csharp
public float AttenuationQuadratic { get; set; }

Property Value ​

float

BarnFaces ​

Gets the precomputed face data array (1 face for barn lights, 1–6 for omni lights).

csharp
public SceneLight.BarnFaceData[] BarnFaces { get; }

Property Value ​

SceneLight.BarnFaceData[]

Brightness ​

Gets or sets the brightness (intensity) of the light.

csharp
public float Brightness { get; set; }

Property Value ​

float

BrightnessScale ​

Gets or sets the additional brightness scale multiplier.

csharp
public float BrightnessScale { get; set; }

Property Value ​

float

CastShadows ​

Gets or sets whether this light casts shadows.

csharp
public int CastShadows { get; set; }

Property Value ​

int

Color ​

Gets or sets the sRGB color of the light.

csharp
public Vector3 Color { get; set; }

Property Value ​

Vector3

CookieTexturePath ​

Gets or sets the material path of the cookie texture, or null if none.

csharp
public string? CookieTexturePath { get; set; }

Property Value ​

string?

DirectLight ​

Gets or sets the direct light contribution mode (0 = off, 1 = stationary, 2 = dynamic).

csharp
public int DirectLight { get; set; }

Property Value ​

int

Direction ​

Gets or sets the normalized direction the light faces.

csharp
public Vector3 Direction { get; set; }

Property Value ​

Vector3

Entity ​

Gets or sets the entity class that created this light.

csharp
public SceneLight.EntityType Entity { get; set; }

Property Value ​

SceneLight.EntityType

FallOff ​

Gets or sets the distance falloff skirt fraction.

csharp
public float FallOff { get; set; }

Property Value ​

float

IsDirty ​

Gets or sets whether this light's face data needs to be recomputed.

csharp
public bool IsDirty { get; set; }

Property Value ​

bool

LuminaireAnisotropy ​

Gets or sets the luminaire anisotropy for capsule-shaped area lights.

csharp
public float LuminaireAnisotropy { get; set; }

Property Value ​

float

LuminaireShape ​

Gets or sets the luminaire shape index (0 = sphere, 1 = capsule, 2 = rect).

csharp
public int LuminaireShape { get; set; }

Property Value ​

int

LuminaireSize ​

Gets or sets the luminaire (source) size used for area light calculations.

csharp
public float LuminaireSize { get; set; }

Property Value ​

float

MinRoughness ​

Gets or sets the minimum roughness clamped for specular highlight calculations.

csharp
public float MinRoughness { get; set; }

Property Value ​

float

Position ​

Gets or sets the world-space position of the light.

csharp
public Vector3 Position { get; set; }

Property Value ​

Vector3

PrecomputedBounds ​

Gets or sets the axis-aligned precomputed world bounds.

csharp
public AABB PrecomputedBounds { get; set; }

Property Value ​

AABB

PrecomputedFieldsValid ​

Gets or sets whether the precomputed OBB fields below are valid.

csharp
public bool PrecomputedFieldsValid { get; set; }

Property Value ​

bool

PrecomputedObbAngles ​

Gets or sets the Euler angles of the precomputed oriented bounding box.

csharp
public Vector3 PrecomputedObbAngles { get; set; }

Property Value ​

Vector3

PrecomputedObbExtent ​

Gets or sets the half-extents of the precomputed oriented bounding box.

csharp
public Vector3 PrecomputedObbExtent { get; set; }

Property Value ​

Vector3

PrecomputedObbOrigin ​

Gets or sets the center of the precomputed oriented bounding box.

csharp
public Vector3 PrecomputedObbOrigin { get; set; }

Property Value ​

Vector3

PrecomputedSubObbAngles ​

Gets or sets the Euler angles of the precomputed sub-OBBs, one per frustum.

csharp
public Vector3[]? PrecomputedSubObbAngles { get; set; }

Property Value ​

Vector3[]?

PrecomputedSubObbExtents ​

Gets or sets the half-extents of the precomputed sub-OBBs, one per frustum.

csharp
public Vector3[]? PrecomputedSubObbExtents { get; set; }

Property Value ​

Vector3[]?

PrecomputedSubObbOrigins ​

Gets or sets the centers of the precomputed sub-OBBs, one per frustum.

csharp
public Vector3[]? PrecomputedSubObbOrigins { get; set; }

Property Value ​

Vector3[]?

PrecomputedSubfrusta ​

Gets or sets the number of precomputed sub-frusta for omni lights.

csharp
public int PrecomputedSubfrusta { get; set; }

Property Value ​

int

Range ​

Gets or sets the maximum range of the light in world units.

csharp
public float Range { get; set; }

Property Value ​

float

ShadowMapSize ​

Gets or sets the shadow map resolution in texels.

csharp
public int ShadowMapSize { get; set; }

Property Value ​

int

Shape ​

Gets or sets the shape blend factor for barn lights.

csharp
public float Shape { get; set; }

Property Value ​

float

Shear ​

Gets or sets the 2D shear offset for barn lights.

csharp
public Vector2 Shear { get; set; }

Property Value ​

Vector2

SizeParams ​

Gets or sets the half-width, half-height, and near-plane reciprocal for barn lights.

csharp
public Vector3 SizeParams { get; set; }

Property Value ​

Vector3

SkirtNear ​

Gets or sets the near skirt distance for perspective barn lights.

csharp
public float SkirtNear { get; set; }

Property Value ​

float

SoftX ​

Gets or sets the horizontal soft edge width for barn lights.

csharp
public float SoftX { get; set; }

Property Value ​

float

SoftY ​

Gets or sets the vertical soft edge width for barn lights.

csharp
public float SoftY { get; set; }

Property Value ​

float

SpotInnerAngle ​

Gets or sets the inner cone half-angle for spot lights in degrees.

csharp
public float SpotInnerAngle { get; set; }

Property Value ​

float

SpotOuterAngle ​

Gets or sets the outer cone half-angle for spot lights in degrees.

csharp
public float SpotOuterAngle { get; set; }

Property Value ​

float

StationaryLightIndex ​

Light index to a baked lightmap. Range: 0..255 for GameLightmapVersion 1 and 0..3 for GameLightmapVersion 2.

csharp
public int StationaryLightIndex { get; set; }

Property Value ​

int

Type ​

Gets or sets the shader light type used during rendering.

csharp
public SceneLight.LightType Type { get; set; }

Property Value ​

SceneLight.LightType

Methods ​

AnglesToDirection(Vector3) ​

Converts Euler pitch/yaw angles to a normalized forward direction vector.

csharp
public static Vector3 AnglesToDirection(Vector3 angles)

Parameters ​

angles Vector3

Returns ​

Vector3

ComputeBarnFaces(Dictionary<string, int>) ​

Recomputes the array from the current light properties.

csharp
public void ComputeBarnFaces(Dictionary<string, int> cookiePaths)

Parameters ​

cookiePaths Dictionary<string, int>

Map from cookie material path to cookie atlas index.

FromEntityProperties(Scene, EntityType, Entity) ​

Creates a populated from entity key-value properties.

csharp
public static SceneLight FromEntityProperties(Scene scene, SceneLight.EntityType type, EntityLump.Entity entity)

Parameters ​

scene Scene

type SceneLight.EntityType

entity EntityLump.Entity

Returns ​

SceneLight

GetShadowFaceDimensions() ​

Returns the shadow map pixel dimensions for this light, accounting for aspect ratio.

csharp
public (int W, int H) GetShadowFaceDimensions()

Returns ​

(int W, int H)

IsAccepted(string) ​

Returns whether the given entity classname is a recognized light type, and which it maps to.

csharp
public static (bool Accepted, SceneLight.EntityType Type) IsAccepted(string classname)

Parameters ​

classname string

Returns ​

(bool Accepted, SceneLight.EntityType Type)

This project is not affiliated with Valve Software. Source 2 is a trademark and/or registered trademark of Valve Corporation.

Released under the MIT License.