Atlassian uses cookies to improve your browsing experience, perform analytics and research, and conduct advertising. Accept all cookies to indicate that you agree to our use of cookies on your device. Atlassian cookies and tracking notice, (opens new window)
Enlighten API 4.03 Documentation
Results will update as you type.
  • Modules
  • Namespaces
    • namespace Enlighten
      • class Enlighten A8CpuTextureSampler
      • class Enlighten Alpha8Normalised
      • class Enlighten AsyncTaskThreadGroup
      • class Enlighten BakedProbeOutputInfo
      • class Enlighten BakeInputLight
      • class Enlighten BakeInputMeshInfo
      • class Enlighten BakeMaterialInfo
      • class Enlighten BaseAlbedoHandler
      • class Enlighten BaseCubeMap
      • class Enlighten BaseDynamicObject
      • class Enlighten BaseEnvironment
      • class Enlighten BaseProbeSet
      • class Enlighten BaseSystem
      • class Enlighten BaseSystemSolutionSpace
      • class Enlighten BaseWorker
      • class Enlighten BoundingBox2D
      • class Enlighten BoxSpotlight
        • class Enlighten BoxSpotlight CachedData
      • class Enlighten BoxVolume
      • class Enlighten CallableEnqueueFunctorCommand
      • class Enlighten ClusterAlbedoWorkspaceMaterialData
      • class Enlighten ClusterMaterialComponent
      • class Enlighten ClusterMaterials
      • class Enlighten ClusterProbeTransparencySampleData
      • class Enlighten ClusterRange
      • class Enlighten Command
      • class Enlighten ConstLightValueIterator
      • class Enlighten CopyAlbedoBufferInfo
      • class Enlighten CopyBounceBufferInfo
      • class Enlighten CopyEmissiveBufferInfo
      • class Enlighten CopyEmissiveEnvironmentInfo
      • class Enlighten CopyInputLightingBufferInfo
      • class Enlighten CopyProbeOutputInfo
      • class Enlighten CopyRawOutputInfo
      • class Enlighten CopyTransparencyBufferInfo
      • class Enlighten CopyVisibilityBufferInfo
      • class Enlighten CpuAlbedoHandler
      • class Enlighten CpuCubeMap
      • class Enlighten CpuDynamicObject
      • class Enlighten CpuEnvironment
      • class Enlighten CpuSystem
      • class Enlighten CpuSystemSolutionSpace
      • class Enlighten CpuTextureSamplerBase
      • class Enlighten CpuWorker
      • class Enlighten DefaultGeometryTransparencySampler
      • class Enlighten DefaultThreadGroup
      • class Enlighten DirectInputLightingParameters
      • class Enlighten DirectionalLight
      • class Enlighten Dx11TextureUpdater
      • class Enlighten DynamicMaterialWorkspace
      • class Enlighten DynamicObject
      • class Enlighten EnlightenProfile
      • class Enlighten EnlightenTask
      • class Enlighten EntireProbeSetTask
      • class Enlighten FitModel
      • class Enlighten FixedTimeLimiter
      • class Enlighten Fp16CpuTextureSampler
    Calendars
You‘re viewing this with anonymous access, so some content might be blocked.
/
class Enlighten BoxSpotlight

    This is the documentation for Enlighten.

    class Enlighten BoxSpotlight

    Sept 09, 2025

    class Enlighten::BoxSpotlight

        └>Enlighten::InputLightBase

    BoxSpotlight class used by extended input lighting.

    Classes

    Name Description
    Enlighten::BoxSpotlight::CachedData

    Cached data for box spotlight.

    Variables

    Name Description
    float m_ConeAngle

    Cone angle.

    float m_CutOff

    The radius outside which intensity is clamped to zero; specified in Enlighten units.

    Geo::v128 m_Direction

    Forward direction.

    const InputLightFalloffTable * m_FalloffTable

    Falloff table.

    float m_Far

    Far plane.

    bool m_HasChanged

    Whether the light has changed since it was last given to the extended direct lighting api.

    float m_InnerConeAngle

    Inner cone angle.

    Geo::v128 m_Intensity

    RGB intensity of the light (linear space).

    const eLightType m_LightType

    Type of input light corresponding to an eLightType enum value.

    float m_Near

    Near plane.

    Geo::u64 m_Padding

    Unused (this class is usually extended by one that starts with multiple v128s)

    Geo::v128 m_Position

    World space position of light.

    float m_Radius

    The radius inside which intensity is clamped to the given value; specified in Enlighten units.

    Geo::v128 m_RightDirection

    Right direction.

    float m_SecondConeAngle

    Second cone angle.

    float m_SecondInnerConeAngle

    Second inner cone angle.

    Geo::v128 m_UpDirection

    Up direction.

    Functions

    Name Description
    DistanceFilter(float)

    Return true if this light affects a system at the specified distance from the viewer.

    InputLightBase(eLightType, bool)

    Constructor.

    InputLightBase(eLightType)

    Constructor.


    GEO_CONTROLLED_INLINE bool Enlighten::InputLightBase::DistanceFilter

    public: GEO_CONTROLLED_INLINE bool DistanceFilter
    (
        float viewDistance
    ) const

    Return true if this light affects a system at the specified distance from the viewer.


    Enlighten::InputLightBase::InputLightBase

    protected: InputLightBase
    (
        eLightType lightType,
        bool hasChanged
    )

    Constructor.


    Enlighten::InputLightBase::InputLightBase

    protected: InputLightBase
    (
        eLightType lightType
    )

    Constructor.

    , multiple selections available,
    {"serverDuration": 12, "requestCorrelationId": "dd8b25d3a2024dffbc8475cb0e103f62"}