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.
  • class Enlighten SetVisibilityBitsInfo
  • class Enlighten SolveBounceTask
  • class Enlighten SortedLights
  • class Enlighten SphereVolume
  • class Enlighten Spotlight
  • class Enlighten SystemAlbedoData
  • class Enlighten SystemDependencies
  • class Enlighten SystemGrouping
  • class Enlighten TaskProcessor
  • class Enlighten TransparencyWorkspace
  • class Enlighten Triangle2D
  • class Enlighten TriggerVolumeTransparencyGeneric
  • class Enlighten UpdateEnvironmentInfo
  • class Enlighten UpdateLightCommandGeneric
  • class Enlighten UpdateLightInfo
  • class Enlighten UpdateLightOptions
  • class Enlighten UpdateManagerLight
  • class Enlighten UpdateManagerProperties
  • class Enlighten UpdateManagerWorkerProperties
  • class Enlighten Vertex2D
  • class Enlighten VisibilityBuffer
  • class Enlighten WorkerFunctionCommand
  • class Enlighten WorkerFunctionParameterCommand
  • class Enlighten WorkerFunctionTwoParametersCommand
  • class Enlighten WorkerFunctorCommand
  • class Enlighten WorkerObjectFunctionCommand
  • class Enlighten WorkerThreadData
  • class Enlighten WorkspaceAllocator
  • namespace Enlighten Errors
  • namespace Enlighten Helpers
  • namespace Enlighten Iff
  • namespace Enlighten InputLightingValidation
  • namespace Enlighten Itt
  • namespace Enlighten OutputTextureState
  • namespace Enlighten UE4
    • class Enlighten UE4 FourVec3s
    • class Enlighten UE4 RectLight
    • class Enlighten UE4 UE4InputLight
    • class Enlighten UE4 UnrealDirectionalLight
    • class Enlighten UE4 UnrealDirectionalLightFunction
      • struct Enlighten UE4 UnrealDirectionalLightFunction CachedData
    • struct Enlighten UE4 InverseSquareFalloffModel
    • struct Enlighten UE4 UnrealFalloffModel
  • namespace Enlighten Version
  • struct Enlighten AllFilter
  • struct Enlighten BakeInputTexture
  • struct Enlighten CachedLightSelector
  • struct Enlighten CachedLightWriter
  • struct Enlighten CanQuickShade
  • struct Enlighten CanQuickShade< LIGHT_TYPE_DIRECTIONAL_LIGHT >
  • struct Enlighten CountLightSizeVisitor
  • struct Enlighten CullCluster
  • struct Enlighten CullClusterGroup
  • struct Enlighten CullingIterator
  • struct Enlighten CullingIterator< LIGHT_TYPE_INVALID, Culler >
  • struct Enlighten CullSystem
  • struct Enlighten ExcludeQuickShadeFilter
  • struct Enlighten HashLightVisitor
  • struct Enlighten InstanceDescMinimal
  • struct Enlighten LightSelector
  • struct Enlighten LightTypeInfo
  • struct Enlighten NullSurroundingsSampler
  • struct Enlighten PipelineInstanceMaterial
  • struct Enlighten PipelineMaterial
  • struct Enlighten PipelineRadiosityProperties
  • struct Enlighten PipelineWorldAxes
  • struct Enlighten PixelBarycentricWeights
  • struct Enlighten PixelCoord
  • struct Enlighten PointProjectionVertex
  • struct Enlighten PppiAtlasFootprint
  • struct Enlighten PppiAtlasMaxima
  • struct Enlighten PppiAtlasUpdateData
  • struct Enlighten PppiAtlasUpdateRequirements
  • struct Enlighten PppiClipmapUpdateData
  • struct Enlighten PppiClipmapUpdateRequirements
  • struct Enlighten PppiConfiguration
  • struct Enlighten PppiIrradiance
  • struct Enlighten PppiIrradiance16
  • struct Enlighten PppiOutputTextureRequirements
  • struct Enlighten PppiProbeSetState
  • struct Enlighten PppiShaderParameters
    Calendars
You‘re viewing this with anonymous access, so some content might be blocked.
/
struct Enlighten UE4 UnrealDirectionalLightFunction CachedData

    This is the documentation for Enlighten.

    struct Enlighten UE4 UnrealDirectionalLightFunction CachedData

    Sept 09, 2025

    struct Enlighten::UE4::UnrealDirectionalLightFunction::CachedData

        └>Enlighten::InputLightBase

    Cached data for DirectionalLight.

    Variables

    Name Description
    Geo::v128 m_Colour

    RGB intensity of the light (linear space).

    Geo::v128 m_Direction

    World space position of light.

    bool m_HasChanged

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

    Geo::u32 m_HasVisibility

    Has visisibility data?

    const Geo::u8 * m_LightFunctionClipmap

    Clipmap for light function.

    Geo::u32 m_LightFunctionClipmapLevelCount

    Clipmap level count for light function.

    Geo::u32 m_LightFunctionClipmapResolution

    Clipmap resolution for light function.

    Geo::u32 m_LightFunctionClipmapScale

    Clipmap scale for light function.

    const eLightType m_LightType

    Type of input light corresponding to an eLightType enum value.

    float m_MaximumDistance

    Distance from the camera changing the light to another(Refer to Enlighten::DirectionalLight).

    Geo::u64 m_Padding

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

    Geo::v128 m_ViewPosition

    Clipmap view position for light function.

    VisibilityBuffer m_VisibilityBuffer

    Visibility buffer.

    Functions

    Name Description
    CachedData(const UnrealDirectionalLightFunction &, const void *)

    Constructor.

    DistanceFilter(float)

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

    DistanceFilter(float)

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

    Hash(Helpers::Hasher &, Geo::u32, Geo::u32)

    Hash the light data.

    InputLightBase(eLightType)

    Constructor.

    InputLightBase(eLightType, bool)

    Constructor.

    IsIntersectingCluster(const Geo::v128 &, const Geo::v128 &, const Geo::v128 &, const Geo::v128 &)

    Complex light V normalBoundingBox intersection test.

    IsIntersectingClusterGroup(const Geo::v128 &, const Geo::v128 &, const Geo::v128 &, const Geo::v128 &)

    Light v ClusterGroup Bounding box intersection test.

    IsIntersectingSystem(const Geo::v128 &, const Geo::v128 &)

    Simple Light V system BoundingBox intersection test.

    ShadeQuad(const Geo::v128 &, const Geo::v128 &, const Geo::v128 &, const Geo::v128 &, const Geo::v128 &, const Geo::v128 &, Geo::u32, Geo::u32)

    Shade the given quad.

    ShadeQuadIntensities(const Geo::v128 &, const Geo::v128 &, const Geo::v128 &, const Geo::v128 &, const Geo::v128 &, const Geo::v128 &, const Geo::v128 &)

    Shades the given quads.


    GEO_CONTROLLED_INLINE Enlighten::UE4::UnrealDirectionalLightFunction::CachedData::CachedData

    public: GEO_CONTROLLED_INLINE CachedData
    (
        const UnrealDirectionalLightFunction & directionalLight,
        const void * perDusterVisibility
    )

    Constructor.


    GEO_CONTROLLED_INLINE bool Enlighten::UE4::UnrealDirectionalLightFunction::CachedData::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.


    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.


    void Enlighten::UE4::UnrealDirectionalLightFunction::CachedData::Hash

    public: void Hash
    (
        Helpers::Hasher & hash,
        Geo::u32 clusterVisSize,
        Geo::u32 quadVisSize
    )

    Hash the light data.


    Enlighten::InputLightBase::InputLightBase

    protected: InputLightBase
    (
        eLightType lightType
    )

    Constructor.


    Enlighten::InputLightBase::InputLightBase

    protected: InputLightBase
    (
        eLightType lightType,
        bool hasChanged
    )

    Constructor.


    GEO_CONTROLLED_INLINE bool Enlighten::UE4::UnrealDirectionalLightFunction::CachedData::IsIntersectingCluster

    public: GEO_CONTROLLED_INLINE bool IsIntersectingCluster
    (
        const Geo::v128 & bbMin,
        const Geo::v128 & bbMax,
        const Geo::v128 & minNormalFlipped,
        const Geo::v128 & maxNormalFlipped
    ) const

    Complex light V normalBoundingBox intersection test.


    GEO_CONTROLLED_INLINE bool Enlighten::UE4::UnrealDirectionalLightFunction::CachedData::IsIntersectingClusterGroup

    public: GEO_CONTROLLED_INLINE bool IsIntersectingClusterGroup
    (
        const Geo::v128 & bbMin,
        const Geo::v128 & bbMax,
        const Geo::v128 & minNormalFlipped,
        const Geo::v128 & maxNormalFlipped
    ) const

    Light v ClusterGroup Bounding box intersection test.


    GEO_CONTROLLED_INLINE bool Enlighten::UE4::UnrealDirectionalLightFunction::CachedData::IsIntersectingSystem

    public: GEO_CONTROLLED_INLINE bool IsIntersectingSystem
    (
        const Geo::v128 & bbMin,
        const Geo::v128 & bbMax
    ) const

    Simple Light V system BoundingBox intersection test.


    GEO_CONTROLLED_INLINE Geo::v128 Enlighten::UE4::UnrealDirectionalLightFunction::CachedData::ShadeQuad

    public: GEO_CONTROLLED_INLINEGeo::v128 ShadeQuad
    (
        const Geo::v128 & positionsX,
        const Geo::v128 & positionsY,
        const Geo::v128 & positionsZ,
        const Geo::v128 & normalsX,
        const Geo::v128 & normalsY,
        const Geo::v128 & normalsZ,
        Geo::u32 clusterIdx,
        Geo::u32 quadIdx
    ) const

    Shade the given quad.


    GEO_CONTROLLED_INLINE Geo::v128 Enlighten::UE4::UnrealDirectionalLightFunction::CachedData::ShadeQuadIntensities

    public: GEO_CONTROLLED_INLINEGeo::v128 ShadeQuadIntensities
    (
        const Geo::v128 & positionsX,
        const Geo::v128 & positionsY,
        const Geo::v128 & positionsZ,
        const Geo::v128 & normalsX,
        const Geo::v128 & normalsY,
        const Geo::v128 & normalsZ,
        const Geo::v128 & visibilityMask
    ) const

    Shades the given quads.

    , multiple selections available,
    {"serverDuration": 11, "requestCorrelationId": "8ae172a7affd45f88a99166390e40244"}