module Debugging Utilities

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

Classes

Functions

Typedefs

bool GEO_CALL Enlighten::CompareIrradianceOutputBuffers

---

public: bool GEO_CALL CompareIrradianceOutputBuffers
(
    Geo::Statistics & irrResult,
    Geo::Statistics & dirResult,
    const Enlighten::IrradianceOutputDesc & descA,
    const Enlighten::IrradianceOutputDesc & descB
)

---

Compares a pair of Enlighten irradiance outputs.

Returns true if the output buffers could be compared.

Parameters

bool GEO_CALL Enlighten::DoDebugColouring

---

public: bool GEO_CALL DoDebugColouring
(
    const Enlighten::RadDebugColouringTask * task
)

---

Write debugging colours to an output texture.

The default is to colour naughty pixels in red, and wings in blue in an irradiance output. To use this function with SH-style output, call it three times (once for each output texture), with appropriate debugging values. Or to say if differently: If you clear the texture to zero (including alpha) in advance you could render with the results as an additive overlay, but it will also work just as well if you want to add the results on top of the usual radiosity output.

Parameters

bool GEO_CALL Enlighten::FindDebugClusterInfo

---

public: bool GEO_CALL FindDebugClusterInfo
(
    RadDebugPixelInfo * infoOut,
    Geo::s32 clusterIndex,
    const RadSystemCore * radCore
)

---

Fill in a RadDebugPixelInfo for a specified leaf cluster index (for internal debugging purposes).

Given a cluster index, find the pixel and related indices that the cluster index corresponds to. Returns false if nothing was found at the location.

bool GEO_CALL Enlighten::FindDebugPixelInfo

---

public: bool GEO_CALL FindDebugPixelInfo
(
    RadDebugPixelInfo * infoOut,
    float u,
    float v,
    const RadSystemCore * radCore,
    const ILightTransportOutput * ltOutput
)

---

Fill in a RadDebugPixelInfo for a specified UV coordinate (for internal debugging purposes).

Given a UV coordinate find the pixel and related indices that the UV coordinate corresponds to. The ltOutput parameter is optional, but the other arguments are not. Returns false if nothing was found at the location.

bool GEO_CALL Enlighten::IsValid

---

public: bool GEO_CALL IsValid
(
    const RadSystemCore * radCore,
    const char * functionName
)

---

Function that tests if the data object provided is valid (pointer checks, metadata, etc).

bool GEO_CALL Enlighten::IsValid

---

public: bool GEO_CALL IsValid
(
    const RadProbeSetCore * probeSetCore,
    Geo::u32 sectionMask,
    const char * functionName
)

---

Function that tests if the data object provided is valid (pointer checks, metadata, etc).

bool GEO_CALL Enlighten::IsValid

---

public: bool GEO_CALL IsValid
(
    const RadProbeSetCore * probeSetCore,
    const char * functionName
)

---

Function that tests if the data object provided is valid (pointer checks, metadata, etc).

bool GEO_CALL Enlighten::IsValid

---

public: bool GEO_CALL IsValid
(
    const RadCubeMapCore * cubeMapCore,
    const char * functionName
)

---

Function that tests if the data object provided is valid (pointer checks, metadata, etc).

bool GEO_CALL Enlighten::IsValid

---

public: bool GEO_CALL IsValid
(
    const InputWorkspace * inputWorkspace,
    const char * functionName,
    bool requireProjectedPoints
)

---

Function that tests if the data object provided is valid (pointer checks, metadata, etc).

bool GEO_CALL Enlighten::IsValid

---

public: bool GEO_CALL IsValid
(
    const ClusterAlbedoWorkspaceMaterialData * cawData,
    const char * functionName,
    bool requireMaterialGuids
)

---

Function that tests if the data object provided is valid (pointer checks, metadata, etc).

bool GEO_CALL Enlighten::IsValid

---

public: bool GEO_CALL IsValid
(
    const PrecomputedVisibilityData * visData,
    const char * functionName
)

---

Function that tests if the data object provided is valid (pointer checks, metadata, etc).

bool GEO_CALL Enlighten::IsValid

---

public: bool GEO_CALL IsValid
(
    const PrecomputedVisibilityWorkspace * visWorkspace,
    const char * functionName
)

---

Function that tests if the data object provided is valid (pointer checks, metadata, etc).

bool GEO_CALL Enlighten::IsValid

---

public: bool GEO_CALL IsValid
(
    const InterpolationInputSet * inputSet,
    const char * functionName
)

---

Function that tests if the data object provided is valid (pointer checks, metadata, etc).

bool GEO_CALL Enlighten::IsValid

---

public: bool GEO_CALL IsValid
(
    const ResamplingData * resamplingData,
    const char * functionName
)

---

Function that tests if the data object provided is valid (pointer checks, metadata, etc).

bool GEO_CALL Enlighten::RunDebugBucketSelectionTask

---

public: bool GEO_CALL RunDebugBucketSelectionTask
(
    const Enlighten::RadDebugBucketSelectionTask * task
)

---

Generate a texture that highlights the information specified in the task object.

Parameters