This is the documentation for Enlighten.

class Enlighten PrecompMaterialInfo

class Enlighten::PrecompMaterialInfo

Material precompute properties. Assign these to specific instance, mesh and material GUIDs using SetMaterialInfo on an IPrecompInputSystem object.

Variables

Name Description
ePrecompMaterialBackfaceBehaviourType m_BackfaceBehaviourType

Behaviour of triangle backfaces.

float m_IndirectReflectivity

Indirect reflectivity.

float m_IndirectTransparency

Indirect transparency.

bool m_IsEmissive

Is this material going to be emissive at runtime?

ePrecompMaterialShadowfaceBehaviourType m_ShadowfaceBehaviourType

Which triangle faces cast shadows.

Functions

Name Description
IsBackfaceValid()

Checks if backfaces of this material are considered valid.

IsClusteringImportant()

materials that are "clustering important" affect precompute preclustering and clustering.

IsEmissive()

Checks if this material is marked as emissive.

IsFullyTransparent()

Checks if this material is fully transparent.

IsOccluder()

Checks if this material is an occluder.

operator==(PrecompMaterialInfo const &)

Comparison between two PrecompMaterialInfos.

PrecompMaterialInfo()

Construct a new PrecompMaterialInfo object.


bool Enlighten::PrecompMaterialInfo::IsBackfaceValid


public: bool IsBackfaceValid() const


Checks if backfaces of this material are considered valid.


bool Enlighten::PrecompMaterialInfo::IsClusteringImportant


public: bool IsClusteringImportant() const


materials that are "clustering important" affect precompute preclustering and clustering.

preclustering: given leaf cluster can contain only triangles with either non-important materials or triangles with the same important materials i.e. there is no mixing of different important materials and no mixing of important and non-important materials in leaf clusters. clustering: leaf clusters with important materials are cut into separate cluster trees (one per important material)


bool Enlighten::PrecompMaterialInfo::IsEmissive


public: bool IsEmissive() const


Checks if this material is marked as emissive.


bool Enlighten::PrecompMaterialInfo::IsFullyTransparent


public: bool IsFullyTransparent() const


Checks if this material is fully transparent.


bool Enlighten::PrecompMaterialInfo::IsOccluder


public: bool IsOccluder() const


Checks if this material is an occluder.


bool Enlighten::PrecompMaterialInfo::operator==


public: bool operator==
(
    PrecompMaterialInfo const & other
) const


Comparison between two PrecompMaterialInfos.


Enlighten::PrecompMaterialInfo::PrecompMaterialInfo


public: PrecompMaterialInfo()


Construct a new PrecompMaterialInfo object.