/
Deprecated List

This is the documentation for Enlighten.

Deprecated List

Dec 22, 2020

 

 Member Enlighten::API_ENLIGHTEN_PPPI_ATLAS_BLOCK_COUNT

Will be removed.



Member Enlighten::CalcMaterialGuidsLookupWorkspaceSize (const ClusterAlbedoWorkspaceMaterialData *materialData)

Gets the size in bytes of the temporary workspace buffer which must be passed to Albedo handling functions which use instance, mesh and material GUIDs. Note that the memory must be 8-byte aligned.



Member Enlighten::GetInstanceGuids (const ClusterAlbedoWorkspaceMaterialData *materialData, Geo::GeoGuid *pInstanceGuids)

Gets the GUIDs of instances in a system.



Member Enlighten::GetMaterialGuids (const ClusterAlbedoWorkspaceMaterialData *materialData, Geo::GeoGuid instanceGuid, Geo::GeoGuid meshGuid, Geo::GeoGuid *pMaterialGuids)

Gets the GUIDs of materials in a system, optionally filtered to a specific instance and/or a specific mesh.



Member Enlighten::GetMeshGuids (const ClusterAlbedoWorkspaceMaterialData *materialData, Geo::GeoGuid instanceGuid, Geo::GeoGuid *pMeshGuids)

Gets the GUIDs of meshes in a system, optionally filtered to a specific instance.



Member Enlighten::GetNumInstanceGuids (const ClusterAlbedoWorkspaceMaterialData *materialData)

Gets the number of instances in a system.



Member Enlighten::GetNumMaterialGuids (const ClusterAlbedoWorkspaceMaterialData *materialData, Geo::GeoGuid instanceGuid, Geo::GeoGuid meshGuid)

Gets the number of material GUIDs in a system, optionally filtered to a specific instance and/or a specific mesh.



Member Enlighten::GetNumMeshGuids (const ClusterAlbedoWorkspaceMaterialData *materialData, Geo::GeoGuid instanceGuid)

Gets the number of mesh GUIDs in a system, optionally filtered to a specific instance.



Member Enlighten::InitialiseMaterialAlbedoAsDynamic (DynamicMaterialWorkspace *materialWorkspace, const Enlighten::ClusterAlbedoWorkspaceMaterialData *materialData, const Geo::GeoGuid &instanceGuid, const Geo::GeoGuid &meshGuid, const Geo::GeoGuid &materialGuid, void *workspaceMemory)

This function is replaced by InitialiseMaterialDynamicity. Initialise a material albedo component in the DynamicMaterialWorkspace as dynamic. This is used to distinguish dynamic material values from static values when initialising or reconstructing the AlbedoBuffer. If a material albedo component is not initialised as dynamic, any calls to SetMaterialAlbedoColour() will require the AlbedoBuffer to be re-initialised.



Member Enlighten::InitialiseMaterialAlbedoAsStatic (DynamicMaterialWorkspace *materialWorkspace, const Enlighten::ClusterAlbedoWorkspaceMaterialData *materialData, const Geo::GeoGuid &instanceGuid, const Geo::GeoGuid &meshGuid, const Geo::GeoGuid &materialGuid, void *workspaceMemory)

This function is replaced by InitialiseMaterialDynamicity. Initialise a material albedo component in the DynamicMaterialWorkspace as static. This is used to distinguish dynamic material values from static values when initialising or reconstructing the AlbedoBuffer. If a material albedo component is not initialised as dynamic, any calls to SetMaterialAlbedoColour() will require the AlbedoBuffer to be re-initialised.



Member Enlighten::InitialiseMaterialEmissiveAsDynamic (DynamicMaterialWorkspace *materialWorkspace, const Enlighten::ClusterAlbedoWorkspaceMaterialData *materialData, const Geo::GeoGuid &instanceGuid, const Geo::GeoGuid &meshGuid, const Geo::GeoGuid &materialGuid, void *workspaceMemory)

This function is replaced by InitialiseMaterialDynamicity. Initialise a material emissive component in the DynamicMaterialWorkspace as dynamic. This is used to distinguish dynamic material values from static values when initialising or reconstructing the EmissiveBuffer. If a material emissive component is not initialised as dynamic, any calls to SetMaterialEmissiveColour() will require the EmissiveBuffer to be re-initialised.



Member Enlighten::InitialiseMaterialEmissiveAsStatic (DynamicMaterialWorkspace *materialWorkspace, const Enlighten::ClusterAlbedoWorkspaceMaterialData *materialData, const Geo::GeoGuid &instanceGuid, const Geo::GeoGuid &meshGuid, const Geo::GeoGuid &materialGuid, void *workspaceMemory)

This function is replaced by InitialiseMaterialDynamicity. Initialise a material emissive component in the DynamicMaterialWorkspace as static. This is used to distinguish dynamic material values from static values when initialising or reconstructing the EmissiveBuffer. If a material emissive component is not initialised as dynamic, any calls to SetMaterialEmissiveColour() will require the EmissiveBuffer to be re-initialised.



Member Enlighten::InitialiseMaterialTransparencyAsDynamic (DynamicMaterialWorkspace *materialWorkspace, const Enlighten::ClusterAlbedoWorkspaceMaterialData *materialData, const Geo::GeoGuid &instanceGuid, const Geo::GeoGuid &meshGuid, const Geo::GeoGuid &materialGuid, void *workspaceMemory)

This function is replaced by InitialiseMaterialDynamicity. Initialise a material transparency component in the DynamicMaterialWorkspace as dynamic. This is used to distinguish dynamic material values from static values when initialising or reconstructing the TransparencyBuffer. If a material component is not initialised as dynamic, any calls to SetMaterialTransparency() will require the TransparencyBuffer to be re-initialised.