module Debugging Utilities

A collection of debugging utility classes to help unpick problems in the API and the lighting.

Classes

Name	Description

Name	Description
Enlighten::ClusterRange	The ClusterRange describes a range of leaf clusters that belong to a certain cluster in the tree.
Enlighten::GeoClusterNode	Debugging output representation of a value in the clustering metric.
Enlighten::GeoClusterNodeForest	Debugging output representation of a set of clustering metric hierarchies.
Enlighten::GeoClusterNodeTree	Debugging output representation of a hierarchy of clustering metrics.
Enlighten::GeoDirectionalPoint	Debugging output representation of a point with a normal.
Enlighten::GeoRayOrigin	Debugging output representation of a ray origin.
Enlighten::IClusteringOutput	An interface for diagnosing the quality and any issues with the clustering process in EnlightenPrecomp2.
Enlighten::ILightTransportOutput	An interface for diagnosing the quality and any issues with the light transport process in EnlightenPrecomp2.
Enlighten::IMeshSimpOutput	An interface for diagnosing the quality and any issues with the mesh simplification process in EnlightenPrecomp2.
Enlighten::IrradianceOutputDesc	Irradiance and directional irradiance output capture.
Enlighten::LightTransportPixel	Debugging output representation of an output pixel.
Enlighten::ProbeBucketPattern	The bit-packed probe group data structure class.
Enlighten::RadDebugBucketSelectionTask	Structure describing an internal debugging task to colour output pixels according to debug data.
Enlighten::RadDebugColouringTask	Structure describing a task to colour output pixels according to debug data.
Enlighten::RadDebugPixelInfo	Extended information about a pixel in the Enlighten output for internal debugging purposes.

Functions

Name	Description

Name	Description
CompareIrradianceOutputBuffers(Geo::Statistics &, Geo::Statistics &, const Enlighten::IrradianceOutputDesc &, const Enlighten::IrradianceOutputDesc &)	Compares a pair of Enlighten irradiance outputs.
DoDebugColouring(const Enlighten::RadDebugColouringTask *)	Write debugging colours to an output texture.
FindDebugClusterInfo(RadDebugPixelInfo , Geo::s32, const RadSystemCore )	Fill in a RadDebugPixelInfo for a specified leaf cluster index (for internal debugging purposes).
FindDebugPixelInfo(RadDebugPixelInfo , float, float, const RadSystemCore , const ILightTransportOutput *)	Fill in a RadDebugPixelInfo for a specified UV coordinate (for internal debugging purposes).
GetProbeBucketPatternArray(const RadProbeSetCore *)	Return an array of bucket pattern codes, with one entry for each solved probe.
IsValid(const RadSystemCore , const char )	Function that tests if the data object provided is valid (pointer checks, metadata, etc).
IsValid(const RadProbeSetCore , Geo::u32, const char )	Function that tests if the data object provided is valid (pointer checks, metadata, etc).
IsValid(const RadProbeSetCore , const char )	Function that tests if the data object provided is valid (pointer checks, metadata, etc).
IsValid(const RadCubeMapCore , const char )	Function that tests if the data object provided is valid (pointer checks, metadata, etc).
IsValid(const InputWorkspace , const char , bool)	Function that tests if the data object provided is valid (pointer checks, metadata, etc).
IsValid(const ClusterAlbedoWorkspaceMaterialData , const char , bool)	Function that tests if the data object provided is valid (pointer checks, metadata, etc).
IsValid(const PrecomputedVisibilityData , const char )	Function that tests if the data object provided is valid (pointer checks, metadata, etc).
IsValid(const PrecomputedVisibilityWorkspace , const char )	Function that tests if the data object provided is valid (pointer checks, metadata, etc).
IsValid(const InterpolationInputSet , const char )	Function that tests if the data object provided is valid (pointer checks, metadata, etc).
IsValid(const ResamplingData , const char )	Function that tests if the data object provided is valid (pointer checks, metadata, etc).
RunDebugBucketSelectionTask(const Enlighten::RadDebugBucketSelectionTask *)	Generate a texture that highlights the information specified in the task object.

Typedefs

Name	Description

Name	Description
Geo::GeoMap< Geo::s32, const GeoClusterNodeTree * > ClusterIdLookup	Lookup from linear cluster ID to node.
Geo::GeoArray< ClusterRange > ClusterRangeArray	Collection of cluster ranges.
Geo::GeoArray< GeoDirectionalPoint > GeoDirectionalPointList	Collection of points with normals for debugging.
Geo::GeoArray< GeoRayOrigin > GeoRayOriginList	Collection of ray origins for debugging.
Geo::GeoArray< GeoRayOrigin * > GeoRayOriginListPtr	Collection of ray origins for debugging.
Geo::GeoArray< Geo::GeoTriangle > GeoTriangleList	Collection of triangles for debugging.