Skip to content

Game.Rendering.AreaLightShape

Assembly: Assembly-CSharp
Namespace: Game.Rendering

Type: public enum

Base: System.Enum (underlying type: System.Int32)

Summary:
Represents the geometric shape used by an area light in the rendering system. This enum selects how the area light is sampled and rendered. Rectangle denotes a planar rectangular area light; Tube denotes an elongated, cylindrical/tubular area light. The chosen shape can affect light emission distribution, shadowing, and shader sampling behavior.

Fields

  • Rectangle
    Value: 0. A rectangular (planar) area light. Typically used for windows, panels, or any flat light-emitting surface. Rendering and sampling code will treat the light as a 2D rectangle.

  • Tube
    Value: 1. A tubular (cylindrical) area light. Used for elongated lights such as fluorescent tubes or neon strips. Sampling and shadowing may use a different model to represent the curved/extended emission.

Properties

  • (none)
    This enum defines no properties.

Constructors

  • (none)
    Enums do not declare constructors in source code. Members are represented by named constants with underlying integer values (default starting at 0).

Methods

  • (inherited) System.Enum/ValueType/Object methods (e.g., ToString, HasFlag, GetValues) are available but no additional methods are defined on this enum.

Usage Example

// Choose an area light shape when creating or configuring a light component
AreaLightShape shape = AreaLightShape.Rectangle;

switch (shape)
{
    case AreaLightShape.Rectangle:
        // configure rectangle sampling, sizeX, sizeY, etc.
        break;
    case AreaLightShape.Tube:
        // configure tube radius, length, and sampling strategy
        break;
}