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.
  • 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 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
      • class Enlighten FrustumLight
      • class Enlighten FunctorCommand
      • class Enlighten GenericColourBuffer
      • class Enlighten GeoClusterNode
      • class Enlighten GeoClusterNodeForest
      • class Enlighten GeoClusterNodeTree
      • class Enlighten GeoDirectionalPoint
      • class Enlighten GeoRayOrigin
      • class Enlighten GlTextureUpdater
      • class Enlighten GpuTextureWrapper
      • class Enlighten IAsyncTask
      • class Enlighten IBake
      • class Enlighten IBakeInputGeometryLightingNormals
      • class Enlighten IBakeInputGeometryTangents
      • class Enlighten IBakeInputGeometryUvs
      • class Enlighten IBakeInputLighting
      • class Enlighten IBakeInputMaterial
      • class Enlighten IBakeInputMeshLightingNormals
      • class Enlighten IBakeInputMeshTangents
      • class Enlighten IBakeInputMeshUvs
      • class Enlighten IBakeInputProperties
      • class Enlighten IBakeInputRayOriginPositions
      • class Enlighten IBakeInputRuntime
    Calendars
You‘re viewing this with anonymous access, so some content might be blocked.
/
class Enlighten CpuEnvironment

    This is the documentation for Enlighten.

    class Enlighten CpuEnvironment

    Sept 09, 2025

    class Enlighten::CpuEnvironment

        └>Enlighten::BaseEnvironment
            └>Geo::IGeoReleasable

    Class used by the CPU and console update managers to represent an environment map.

    In particular, it allows the application to update the environment map in a thread-safe manner.

    Variables

    Name Description
    InputLightingBuffer * m_EmissiveEnvironment

    The underlying Enlighten object.

    PrecisionHint::Value m_InputLightingPrecisionHint

    Precision hint of the input lighting buffer.

    Geo::s32 m_Resolution

    Power-of-two face resolution of the environment cube map.

    Geo::v128 * m_Values

    The application-settable base values.

    Functions

    Name Description
    BaseEnvironment(Geo::s32, PrecisionHint::Value)

    Constructs an environment object of the given resolution.

    Clone()

    Creates a copy of the CPU environment and its data values.

    CpuEnvironment(Geo::s32, PrecisionHint::Value)

    Constructs a CPU environment of the given resolution.

    Create()

    Creates a CPU environment of (default) resolution 2. Used in GeoMobileDemo.

    CreateInputLightingBuffer()

    Creates the input lighting buffer.

    GetInputLightingPrecisionHint()

    Gets the precision hint of the input lighting buffer.

    Load(Geo::IGeoInputStream &, Geo::u32)

    Deserialises a CPU environment from a stream.

    NonCopyable(NonCopyable &&)

    Defaulted to allow move.

    operator=(NonCopyable &&)

    Defaulted to allow move.

    Release()

    Free this object that was created within the Enlighten libraries.

    Release()

    Free this object that was created within the Enlighten libraries.

    Save(Geo::IGeoStream &, Geo::u32)

    Serialises a CPU environment to a stream.

    UpdateEnvironmentInputLighting()

    Updates the input lighting buffer.

    UpdateEnvironmentInputLighting()

    Updates the input lighting buffer.


    Enlighten::BaseEnvironment::BaseEnvironment

    public: BaseEnvironment
    (
        Geo::s32 resolution,
        PrecisionHint::Value precision
    )

    Constructs an environment object of the given resolution.


    CpuEnvironment* Enlighten::CpuEnvironment::Clone

    public: CpuEnvironment * Clone() const

    Creates a copy of the CPU environment and its data values.


    Enlighten::CpuEnvironment::CpuEnvironment

    public: CpuEnvironment
    (
        Geo::s32 resolution,
        PrecisionHint::Value precision
    )

    Constructs a CPU environment of the given resolution.


    static CpuEnvironment* Enlighten::CpuEnvironment::Create

    public: CpuEnvironment * Create()

    Creates a CPU environment of (default) resolution 2. Used in GeoMobileDemo.


    virtual void Enlighten::BaseEnvironment::CreateInputLightingBuffer

    public: virtual void CreateInputLightingBuffer()

    Creates the input lighting buffer.


    PrecisionHint::Value Enlighten::BaseEnvironment::GetInputLightingPrecisionHint

    public: PrecisionHint::Value GetInputLightingPrecisionHint() const

    Gets the precision hint of the input lighting buffer.


    bool Enlighten::CpuEnvironment::Load

    public: bool Load
    (
        Geo::IGeoInputStream & stream,
        Geo::u32 section
    )

    Deserialises a CPU environment from a stream.


    Geo::NonCopyable::NonCopyable

    public: NonCopyable
    (
        NonCopyable &&
    )

    Defaulted to allow move.


    NonCopyable& Geo::NonCopyable::operator=

    public: NonCopyable & operator=
    (
        NonCopyable &&
    )

    Defaulted to allow move.


    virtual void Enlighten::BaseEnvironment::Release

    public: virtual void Release()

    Free this object that was created within the Enlighten libraries.

    Expect this to behave in a similar way to calling 'delete(this)'


    virtual void Geo::IGeoReleasable::Release

    public: void Release()

    Free this object that was created within the Enlighten libraries.

    Expect this to behave in a similar way to calling 'delete(this)'


    bool Enlighten::CpuEnvironment::Save

    public: bool Save
    (
        Geo::IGeoStream & stream,
        Geo::u32 section
    ) const

    Serialises a CPU environment to a stream.


    virtual void Enlighten::CpuEnvironment::UpdateEnvironmentInputLighting

    public: virtual void UpdateEnvironmentInputLighting()

    Updates the input lighting buffer.


    virtual void Enlighten::BaseEnvironment::UpdateEnvironmentInputLighting

    public: void UpdateEnvironmentInputLighting()

    Updates the input lighting buffer.

    , multiple selections available,
    {"serverDuration": 10, "requestCorrelationId": "dec4e0b2cdf54d7da45da9dd22e39e40"}