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.
  • Modules
  • 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
    Calendars
You‘re viewing this with anonymous access, so some content might be blocked.
/
class Enlighten BakeMaterialInfo

    This is the documentation for Enlighten.

    class Enlighten BakeMaterialInfo

    Sept 09, 2025

    class Enlighten::BakeMaterialInfo

    The material description for baking.

    Functions

    Name Description
    ConvertToOpacityBasedOnMode(const Geo::v128 &)

    Convert the transparency/opacity based on TransparencyOrOpacityMode.

    ConvertToTransparencyBasedOnMode(const Geo::v128 &)

    Returns the Opacity colour.

    GetOpacityColourBasedOnMode()

    Returns the Transparency colour.

    GetTransparencyColourBasedOnMode()

    Returns the Opacity colour.

    Variables

    Name Description
    ePrecompMaterialBackfaceBehaviourType BackfaceBehaviourType

    How backfaces should behave.

    float NormalScale

    Scale applied to normal to exaggerate normal perturbation.

    GeoTextureString NormalTexture

    Texture defining tangent-space normal-mapping.

    Geo::v128 NormalUvOffset

    Offset applied to UVs used for normal-mapping. This is applied after the UV scale.

    Geo::v128 NormalUvScale

    Scale applied to UVs used for normal-mapping.

    eShadowfaceBehaviourType ShadowfaceBehaviourType

    Shadow casting faces.

    Geo::v128 TransparencyOrOpacityColour

    Solid colour material transparency/opacity. Not used if a texture is defined.

    eTransparencyOrOpacityMode TransparencyOrOpacityMode

    Returns the Transparency colour.

    GeoTextureString TransparencyOrOpacityTexture

    Texture defining the transparency/opacity over the material. UVs are taken from channel 0 (the albedo channel).

    Geo::v128 TransparencyOrOpacityUvOffset

    Offset applied to UVs used for transparency/opacity texture.

    Geo::v128 TransparencyOrOpacityUvScale

    Scale applied to UVs used for transparency/opacity texture.

    Enums

    Name Description
    eShadowfaceBehaviourType

    Shadowface behaviour type.

    eTransparencyOrOpacityMode

    A choice of transparency or opacity.


    Geo::v128 Enlighten::BakeMaterialInfo::ConvertToOpacityBasedOnMode

    public: Geo::v128 ConvertToOpacityBasedOnMode
    (
        const Geo::v128 & colour
    ) const

    Convert the transparency/opacity based on TransparencyOrOpacityMode.


    Geo::v128 Enlighten::BakeMaterialInfo::ConvertToTransparencyBasedOnMode

    public: Geo::v128 ConvertToTransparencyBasedOnMode
    (
        const Geo::v128 & colour
    ) const

    Returns the Opacity colour.


    Geo::v128 Enlighten::BakeMaterialInfo::GetOpacityColourBasedOnMode

    public: Geo::v128 GetOpacityColourBasedOnMode() const

    Returns the Transparency colour.


    Geo::v128 Enlighten::BakeMaterialInfo::GetTransparencyColourBasedOnMode

    public: Geo::v128 GetTransparencyColourBasedOnMode() const

    Returns the Opacity colour.


    eShadowfaceBehaviourType

    public: enum eShadowfaceBehaviourType
    {
        ShadowfaceBehaviourTypeFront,
        ShadowfaceBehaviourTypeBack,
        ShadowfaceBehaviourTypeBoth,
        ShadowfaceBehaviourTypeBothWithInvalidBack,
        ShadowfaceBehaviourTypeDefault = ShadowfaceBehaviourTypeBoth
    }

    Shadowface behaviour type.

    enumerators
    ShadowfaceBehaviourTypeFront
    ShadowfaceBehaviourTypeBack
    ShadowfaceBehaviourTypeBoth
    ShadowfaceBehaviourTypeBothWithInvalidBack
    ShadowfaceBehaviourTypeDefault


    eTransparencyOrOpacityMode

    public: enum eTransparencyOrOpacityMode
    {
        Transparency,
        Opacity
    }

    A choice of transparency or opacity.

    enumerators
    Transparency

    Interpret transparency values as transparency.

    Opacity

    Interpret transparency values as opacity.

    , multiple selections available,
    {"serverDuration": 14, "requestCorrelationId": "2ae386f5e0534a228fd98af3083db165"}