This is the documentation for Enlighten.

class Enlighten BakeMaterialInfo

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.