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 3.10 Documentation
Results will update as you type.
  • Modules
  • Namespaces
    • namespace Enlighten
      • class Enlighten A8CpuTextureSampler
      • class Enlighten Alpha8Normalised
      • class Enlighten AsyncTaskThreadGroup
      • class Enlighten AutoProbeVolumes
      • 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 BaseLightMeta
      • class Enlighten BaseProbeSet
      • class Enlighten BaseSystem
      • class Enlighten BaseSystemSolutionSpace
      • class Enlighten BaseUpdateManager
      • 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 ClusterProbeBounceSampleData
      • class Enlighten ClusterProbeSample
      • 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 CpuUpdateManager
      • class Enlighten CpuWorker
      • class Enlighten CubeMapDataBlock
      • class Enlighten CubeMapMeta
      • class Enlighten DefaultGeometryTransparencySampler
    Calendars
You‘re viewing this with anonymous access, so some content might be blocked.
/
class Enlighten BaseEnvironment

    This is the documentation for Enlighten.

    class Enlighten BaseEnvironment

    Nov 21, 2019

    class Enlighten::BaseEnvironment

        └>Geo::IGeoReleasable

    Trivial base class used to lend a base type to environment maps.

    This class is extended for use with the CPU manager.

    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.

    Functions

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

    Constructs an environment object of the given resolution.

    CreateInputLightingBuffer()

    Creates the input lighting buffer.

    GetInputLightingPrecisionHint()

    Gets the precision hint of the input lighting buffer.

    Release()

    Free this object that was created within the Enlighten libraries.

    Release()

    Free this object that was created within the Enlighten libraries.

    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.


    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.


    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)'


    virtual void Enlighten::BaseEnvironment::UpdateEnvironmentInputLighting

    public: void UpdateEnvironmentInputLighting()

    Updates the input lighting buffer.

    , multiple selections available,
    {"serverDuration": 9, "requestCorrelationId": "70d9b917fb9a4b779892f20502b30880"}