This is the documentation for Enlighten.
class Enlighten DynamicMaterialWorkspace
class Enlighten::DynamicMaterialWorkspace
Enlighten object used for dynamic material updates at runtime.
Functions
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.
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 |