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
        • struct Enlighten ClusterMaterials ClusterMaterialCount
      • 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
      • class Enlighten DefaultThreadGroup
      • class Enlighten DirectInputLightingParameters
      • class Enlighten DirectionalLight
      • class Enlighten DirectionalLightMeta
      • class Enlighten Dx9TextureUpdater
      • class Enlighten Dx11TextureUpdater
      • class Enlighten DynamicMaterialWorkspace
      • class Enlighten DynamicObject
      • class Enlighten EnlightenDataBlock
      • class Enlighten EnlightenProfile
      • class Enlighten EnlightenTask
      • class Enlighten EntireProbeSetTask
    Calendars
You‘re viewing this with anonymous access, so some content might be blocked.
/
class Enlighten ClusterMaterials

    This is the documentation for Enlighten.

    class Enlighten ClusterMaterials

    Nov 21, 2019

    class Enlighten::ClusterMaterials

    Enlighten internal implementation for cluster albedo materials.

    Runtime mapping between duster and albedo data.

    Classes

    Name Description
    Enlighten::ClusterMaterials::ClusterMaterialCount

    Number of dusters and a material index which is assigned to them.

    Functions

    Name Description
    ConvertEndian(Geo::EConvertEndianMode)

    Convert the endian-ness of this ClusterMaterials.

    GetClusterMaterialIndicesArray()

    Raw access to the cluster material indices array.

    GetClusterMaterialIndicesArray()

    Raw access to the cluster material indices array.

    GetClusterMaterialPixelsArray()

    Raw access to the cluster material pixels array.

    GetClusterMaterialPixelsArray()

    Raw access to the cluster material pixels array.

    GetClusterMaterialPixelWeightsArray()

    Raw access to the cluster material pixel weights array.

    GetClusterMaterialPixelWeightsArray()

    Raw access to the cluster material pixel weights array.

    GetMaterialIds()

    Raw access to the material IDs array.

    GetMaterialIds()

    Raw access to the material IDs array.

    GetNumMaterialsArray()

    Raw access the the num materials array.

    GetNumMaterialsArray()

    Raw access the the num materials array.

    Variables

    Name Description
    Geo::u32 m_ClusterMaterialIndicesOffset

    Array of ClusterMaterialCount (x SUM{matsInCluster})

    Geo::u32 m_ClusterMaterialPixelsOffset

    Array of ClusterMaterialPixels.

    Geo::u32 m_ClusterMaterialPixelWeightsOffset

    Array of weights for cluster materials.

    Geo::u32 m_ClusterNumMaterialsOffset

    Array of u16 (x numClusters)

    Geo::u32 m_MaterialIdsOffset

    Array of u64 (x numMaterials)

    Geo::s32 m_NumClusters

    Num clusters.

    Geo::s32 m_NumMaterials

    Num materials.

    Geo::s32 m_NumPixels

    Num pixels.

    Geo::u32 m_ObjectSize

    Size of this object in bytes.

    Geo::u32 m_Padding[3]

    Unused padding.


    void Enlighten::ClusterMaterials::ConvertEndian

    public: void ConvertEndian
    (
        Geo::EConvertEndianMode mode
    )

    Convert the endian-ness of this ClusterMaterials.


    ClusterMaterialCount* Enlighten::ClusterMaterials::GetClusterMaterialIndicesArray

    public: ClusterMaterialCount * GetClusterMaterialIndicesArray()

    Raw access to the cluster material indices array.


    const ClusterMaterialCount* Enlighten::ClusterMaterials::GetClusterMaterialIndicesArray

    public: const ClusterMaterialCount * GetClusterMaterialIndicesArray() const

    Raw access to the cluster material indices array.


    PixelCoord* Enlighten::ClusterMaterials::GetClusterMaterialPixelsArray

    public: PixelCoord * GetClusterMaterialPixelsArray()

    Raw access to the cluster material pixels array.


    const PixelCoord* Enlighten::ClusterMaterials::GetClusterMaterialPixelsArray

    public: const PixelCoord * GetClusterMaterialPixelsArray() const

    Raw access to the cluster material pixels array.


    Geo::u16* Enlighten::ClusterMaterials::GetClusterMaterialPixelWeightsArray

    public: Geo::u16 * GetClusterMaterialPixelWeightsArray()

    Raw access to the cluster material pixel weights array.


    const Geo::u16* Enlighten::ClusterMaterials::GetClusterMaterialPixelWeightsArray

    public: const Geo::u16 * GetClusterMaterialPixelWeightsArray() const

    Raw access to the cluster material pixel weights array.


    Geo::u64* Enlighten::ClusterMaterials::GetMaterialIds

    public: Geo::u64 * GetMaterialIds()

    Raw access to the material IDs array.


    const Geo::u64* Enlighten::ClusterMaterials::GetMaterialIds

    public: const Geo::u64 * GetMaterialIds() const

    Raw access to the material IDs array.


    Geo::u16* Enlighten::ClusterMaterials::GetNumMaterialsArray

    public: Geo::u16 * GetNumMaterialsArray()

    Raw access the the num materials array.


    const Geo::u16* Enlighten::ClusterMaterials::GetNumMaterialsArray

    public: const Geo::u16 * GetNumMaterialsArray() const

    Raw access the the num materials array.

    , multiple selections available,
    {"serverDuration": 9, "requestCorrelationId": "6ec006f367f34660b2d3a901a7fb91c1"}