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 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
  • class Enlighten IBakeInputSystem
  • class Enlighten IBakeOutputProbeSet
  • class Enlighten IBakeOutputProbeSetVisibility
  • class Enlighten IBakeOutputSystemAO
  • class Enlighten IBakeOutputSystemDirect
  • class Enlighten IBakeOutputSystemFinalGather
  • class Enlighten IBakeOutputSystemIndirect
  • class Enlighten IBakeOutputSystemRadiosityNormal
  • class Enlighten IBakeOutputSystemVisibility
  • class Enlighten IBakeRuntimeLighting
    Calendars
You‘re viewing this with anonymous access, so some content might be blocked.
/
class Enlighten DynamicMaterialWorkspace

    This is the documentation for Enlighten.

    class Enlighten DynamicMaterialWorkspace

    Sept 09, 2025

    class Enlighten::DynamicMaterialWorkspace

    Enlighten object used for dynamic material updates at runtime.

    Functions

    Name Description
    CalculateSize(const ClusterMaterials *)

    Calculates the size (in bytes) required for a DynamicMaterialWorkspace.

    ConvertEndian(Geo::EConvertEndianMode)

    Convert the endian-ness of this DynamicMaterialWorkspace.

    Copy(const DynamicMaterialWorkspace &)

    Copy the given DynamicMaterialWorkspace into this one.

    Create(const ClusterMaterials *, void *)

    Creates a DynamicMaterialWorkspace.

    Create(const DynamicMaterialWorkspace &, void *)

    Creates a DynamicMaterialWorkspace.

    GetMaterialAlbedo(Geo::u32)

    Gets the material component with the given index.

    GetMaterialAlbedo(Geo::u32)

    Gets the material component with the given index.

    GetMaterialEmissive(Geo::u32)

    Gets the material component with the given index.

    GetMaterialEmissive(Geo::u32)

    Gets the material component with the given index.

    GetMaterialTransparency(Geo::u32)

    Gets the material component with the given index.

    GetMaterialTransparency(Geo::u32)

    Gets the material component with the given index.

    GetSize()

    Gets the total size (in bytes) of this DynamicMaterialWorkspace.

    IsAlbedoInitialiseRequired()

    Albedo.

    IsAlbedoUpdateRequired()

    Albedo.

    IsEmissiveInitialiseRequired()

    Emissive.

    IsEmissiveUpdateRequired()

    Emissive.

    IsTransparencyInitialiseRequired()

    Transparency.

    IsTransparencyUpdateRequired()

    Transparency.

    NonCopyable(NonCopyable &&)

    Defaulted to allow move.

    operator=(NonCopyable &&)

    Defaulted to allow move.

    SetAlbedoInitialised()

    Albedo.

    SetAlbedoRequiresInitialise()

    Albedo.

    SetAlbedoRequiresUpdate()

    Albedo.

    SetAlbedoUpdated()

    Albedo.

    SetEmissiveInitialised()

    Emissive.

    SetEmissiveRequiresInitialise()

    Emissive.

    SetEmissiveRequiresUpdate()

    Emissive.

    SetEmissiveUpdated()

    Emissive.

    SetTransparencyInitialised()

    Transparency.

    SetTransparencyRequiresInitialise()

    Transparency.

    SetTransparencyRequiresUpdate()

    Transparency.

    SetTransparencyUpdated()

    Transparency.

    Enums

    Name Description
    Status

    Status for material components.


    static Geo::u32 Enlighten::DynamicMaterialWorkspace::CalculateSize

    public: Geo::u32 CalculateSize
    (
        const ClusterMaterials * materials
    )

    Calculates the size (in bytes) required for a DynamicMaterialWorkspace.


    void Enlighten::DynamicMaterialWorkspace::ConvertEndian

    public: void ConvertEndian
    (
        Geo::EConvertEndianMode mode
    )

    Convert the endian-ness of this DynamicMaterialWorkspace.


    bool Enlighten::DynamicMaterialWorkspace::Copy

    public: bool Copy
    (
        const DynamicMaterialWorkspace & source
    )

    Copy the given DynamicMaterialWorkspace into this one.


    static DynamicMaterialWorkspace* Enlighten::DynamicMaterialWorkspace::Create

    public: DynamicMaterialWorkspace * Create
    (
        const ClusterMaterials * materials,
        void * memory
    )

    Creates a DynamicMaterialWorkspace.


    static DynamicMaterialWorkspace* Enlighten::DynamicMaterialWorkspace::Create

    public: DynamicMaterialWorkspace * Create
    (
        const DynamicMaterialWorkspace & source,
        void * memory
    )

    Creates a DynamicMaterialWorkspace.


    MaterialAlbedoComponent* Enlighten::DynamicMaterialWorkspace::GetMaterialAlbedo

    public: MaterialAlbedoComponent * GetMaterialAlbedo
    (
        Geo::u32 materialIndex
    )

    Gets the material component with the given index.


    const MaterialAlbedoComponent* Enlighten::DynamicMaterialWorkspace::GetMaterialAlbedo

    public: const MaterialAlbedoComponent * GetMaterialAlbedo
    (
        Geo::u32 materialIndex
    ) const

    Gets the material component with the given index.


    MaterialEmissiveComponent* Enlighten::DynamicMaterialWorkspace::GetMaterialEmissive

    public: MaterialEmissiveComponent * GetMaterialEmissive
    (
        Geo::u32 materialIndex
    )

    Gets the material component with the given index.


    const MaterialEmissiveComponent* Enlighten::DynamicMaterialWorkspace::GetMaterialEmissive

    public: const MaterialEmissiveComponent * GetMaterialEmissive
    (
        Geo::u32 materialIndex
    ) const

    Gets the material component with the given index.


    MaterialTransparencyComponent* Enlighten::DynamicMaterialWorkspace::GetMaterialTransparency

    public: MaterialTransparencyComponent * GetMaterialTransparency
    (
        Geo::u32 materialIndex
    )

    Gets the material component with the given index.


    const MaterialTransparencyComponent* Enlighten::DynamicMaterialWorkspace::GetMaterialTransparency

    public: const MaterialTransparencyComponent * GetMaterialTransparency
    (
        Geo::u32 materialIndex
    ) const

    Gets the material component with the given index.


    Geo::u32 Enlighten::DynamicMaterialWorkspace::GetSize

    public: Geo::u32 GetSize() const

    Gets the total size (in bytes) of this DynamicMaterialWorkspace.


    bool Enlighten::DynamicMaterialWorkspace::IsAlbedoInitialiseRequired

    public: bool IsAlbedoInitialiseRequired() const

    Albedo.


    bool Enlighten::DynamicMaterialWorkspace::IsAlbedoUpdateRequired

    public: bool IsAlbedoUpdateRequired() const

    Albedo.


    bool Enlighten::DynamicMaterialWorkspace::IsEmissiveInitialiseRequired

    public: bool IsEmissiveInitialiseRequired() const

    Emissive.


    bool Enlighten::DynamicMaterialWorkspace::IsEmissiveUpdateRequired

    public: bool IsEmissiveUpdateRequired() const

    Emissive.


    bool Enlighten::DynamicMaterialWorkspace::IsTransparencyInitialiseRequired

    public: bool IsTransparencyInitialiseRequired() const

    Transparency.


    bool Enlighten::DynamicMaterialWorkspace::IsTransparencyUpdateRequired

    public: bool IsTransparencyUpdateRequired() const

    Transparency.


    Geo::NonCopyable::NonCopyable

    public: NonCopyable
    (
        NonCopyable &&
    )

    Defaulted to allow move.


    NonCopyable& Geo::NonCopyable::operator=

    public: NonCopyable & operator=
    (
        NonCopyable &&
    )

    Defaulted to allow move.


    void Enlighten::DynamicMaterialWorkspace::SetAlbedoInitialised

    public: void SetAlbedoInitialised()

    Albedo.


    void Enlighten::DynamicMaterialWorkspace::SetAlbedoRequiresInitialise

    public: void SetAlbedoRequiresInitialise()

    Albedo.


    void Enlighten::DynamicMaterialWorkspace::SetAlbedoRequiresUpdate

    public: void SetAlbedoRequiresUpdate()

    Albedo.


    void Enlighten::DynamicMaterialWorkspace::SetAlbedoUpdated

    public: void SetAlbedoUpdated()

    Albedo.


    void Enlighten::DynamicMaterialWorkspace::SetEmissiveInitialised

    public: void SetEmissiveInitialised()

    Emissive.


    void Enlighten::DynamicMaterialWorkspace::SetEmissiveRequiresInitialise

    public: void SetEmissiveRequiresInitialise()

    Emissive.


    void Enlighten::DynamicMaterialWorkspace::SetEmissiveRequiresUpdate

    public: void SetEmissiveRequiresUpdate()

    Emissive.


    void Enlighten::DynamicMaterialWorkspace::SetEmissiveUpdated

    public: void SetEmissiveUpdated()

    Emissive.


    void Enlighten::DynamicMaterialWorkspace::SetTransparencyInitialised

    public: void SetTransparencyInitialised()

    Transparency.


    void Enlighten::DynamicMaterialWorkspace::SetTransparencyRequiresInitialise

    public: void SetTransparencyRequiresInitialise()

    Transparency.


    void Enlighten::DynamicMaterialWorkspace::SetTransparencyRequiresUpdate

    public: void SetTransparencyRequiresUpdate()

    Transparency.


    void Enlighten::DynamicMaterialWorkspace::SetTransparencyUpdated

    public: void SetTransparencyUpdated()

    Transparency.


    Status

    public: enum Status
    {
        STATUS_OK = 0,
        STATUS_REQUIRES_UPDATE = 1,
        STATUS_REQUIRES_INITIALISE = 2
    }

    Status for material components.

    enumerators
    STATUS_OK
    STATUS_REQUIRES_UPDATE
    STATUS_REQUIRES_INITIALISE
    , multiple selections available,
    {"serverDuration": 10, "requestCorrelationId": "bec4c2bba69e410988bcc72ae1ba1949"}