/
Deprecated List

This is the documentation for Enlighten.

Deprecated List

Sept 09, 2025

 

 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::DoProbeInterpolationTask (const Enlighten::ProbeInterpolationTask *task, Geo::u32 &timeUs)

Performs an interpolation of SH coefficients for a given set of points in space and probe sets.



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::GetProbeInterpolants (Geo::v128 point, const InterpolationInputSet *inputSet, ProbeInterpolant *interpolants, Geo::s32 numMaxInterpolants, Geo::s32 &numUsedInterpolants, Geo::u32 lod=0)

Retrieves the probes interpolants for a given point for a single probe set.



Member Enlighten::GetProbeInterpolants (Geo::v128 point, const InterpolationInputSet *inputSets, Geo::s32 numInputSets, ProbeInterpolant *interpolants, Geo::s32 numMaxInterpolants, Geo::s32 &numUsedInterpolants, Geo::u32 lod=0)

Retrieves the probes interpolants for a given point for multiple probe set.



Member Enlighten::GetProbeInterpolantsUnchecked (Geo::v128 point, const InterpolationInputSet *inputSets, Geo::s32 numInputSets, ProbeInterpolant *interpolants, Geo::s32 numMaxInterpolants, Geo::s32 &numUsedInterpolants, Geo::u32 lod=0)

Retrieves the probes interpolants for a given point for multiple probe set, without performing any kind of validation on the input arguments.



Member Enlighten::GetProbeSetInterpolants (Geo::v128 point, const InterpolationInputSet *inputSets, Geo::s32 numInputSets, ProbeInterpolant *interpolants, Geo::s32 numMaxInterpolants, Geo::s32 &numUsedInterpolants)

Retrieves the probe set interpolants for a given point. Note that this function creates an interpolant for a probe set and not for an individual probe.



Member Enlighten::GetProbeShCoefficients (Geo::v128 point, const InterpolationInputSet *inputSet, float *r, float *g, float *b, eSHOrder shOrder)

Retrieves the interpolated light probe spherical harmonics coefficients for a point based on a single input probe set. The interpolated coefficients get stored independently for each RGB channel in buffers that have to be provided to this function and which must be large enough to accommodate the coefficients that get generated. The number of generated coefficients depends on the requested SH order (L0, L1, L2), but also on the SH order of the probe set retrieved from the probe set metadata.