module Extended Input Lighting

The extended input lighting api.

Classes

Functions

bool GEO_CALL Enlighten::AddDusterValuesToInputWorkspace

---

public: bool GEO_CALL AddDusterValuesToInputWorkspace
(
    const InputWorkspace * workspaceMemory,
    Enlighten::IncidentLightingBuffer * output,
    const Geo::v128 * dusterValues
)

---

Adds light values laid out in a duster block to an Enlighten input workspace.

Parameters

void GEO_CALL Enlighten::ApplyVolumeTransparency

---

public: void GEO_CALL ApplyVolumeTransparency
(
    const InputWorkspace * inputWorkspace,
    TransparencyWorkspace * transparencyWorkspace,
    const SphereVolume & volume
)

---

Mark the quads transparency value using a sphere volume.

Parameters

void GEO_CALL Enlighten::ApplyVolumeTransparency

---

public: void GEO_CALL ApplyVolumeTransparency
(
    const InputWorkspace * inputWorkspace,
    TransparencyWorkspace * transparencyWorkspace,
    const BoxVolume & volume
)

---

Mark the quads transparency value using a box volume.

Parameters

Geo::u32 GEO_CALL Enlighten::CalcBounceBufferSize

---

public: Geo::u32GEO_CALL CalcBounceBufferSize
(
    const Enlighten::InputWorkspace * inputWorkspace,
    PrecisionHint::Value precision
)

---

Tells you the amount of memory required to hold bounce lighting for a given system.

Parameters

Returns

Required memory in bytes, 0xFFFFFFFF upon error.

Geo::u32 GEO_CALL Enlighten::CalcIncidentLightingBufferSize

---

public: Geo::u32GEO_CALL CalcIncidentLightingBufferSize
(
    const Enlighten::InputWorkspace * inputWorkspace,
    PrecisionHint::Value precision
)

---

Tells you the amount of memory required to hold incident lighting for a given system.

Parameters

Returns

Required memory in bytes, 0xFFFFFFFF upon error.

Geo::u32 GEO_CALL Enlighten::CalcProbeBounceWorkspaceSize

---

public: Geo::u32GEO_CALL CalcProbeBounceWorkspaceSize
(
    const Enlighten::InputWorkspace * inputWorkspace,
    Geo::s32 numInterpolants
)

---

Tells you the amount of memory required for the probe bounce buffer for a given system.

Parameters

Returns

Required memory in bytes, 0xFFFFFFFF upon error.

Geo::u32 GEO_CALL Enlighten::CalcProbeBounceWorkspaceSize

---

public: Geo::u32GEO_CALL CalcProbeBounceWorkspaceSize
(
    const Enlighten::InputWorkspace * inputWorkspace,
    Geo::s32 numInterpolants,
    Geo::s32 numLods
)

---

Tells you the amount of memory required for the probe bounce buffer for a given system.

Parameters

Returns

Required memory in bytes, 0xFFFFFFFF upon error.

size_t Enlighten::CalcRequiredScratchSpaceMemory

---

public: size_t CalcRequiredScratchSpaceMemory
(
    InputLightBase ** lights,
    Geo::u32 numLights
)

---

Calculate how much scratchspace memory will be required by the DoDirectInputLighting() function given the lights to be shaded.

Parameters

Returns

Required memory in bytes

Geo::u32 GEO_CALL Enlighten::CalcTransparencyWorkspaceSize

---

public: Geo::u32GEO_CALL CalcTransparencyWorkspaceSize
(
    const InputWorkspace * inputWorkspace,
    Geo::s32 numInterpolants,
    PrecisionHint::Value precision
)

---

Tells you the amount of memory required for the transparency workspace for a given system.

Parameters

Returns

Required memory in bytes, 0xFFFFFFFF upon error.

Geo::u32 GEO_CALL Enlighten::CalcTransparencyWorkspaceSize

---

public: Geo::u32GEO_CALL CalcTransparencyWorkspaceSize
(
    const InputWorkspace * inputWorkspace,
    Geo::s32 numInterpolants,
    Geo::s32 numLods,
    PrecisionHint::Value precision
)

---

Tells you the amount of memory required for the transparency workspace for a given system.

Parameters

Returns

Required memory in bytes, 0xFFFFFFFF upon error.

bool GEO_CALL Enlighten::CompareBounceBuffers

---

public: bool GEO_CALL CompareBounceBuffers
(
    Geo::Statistics & res,
    const Enlighten::BounceBuffer * bufA,
    const Enlighten::BounceBuffer * bufB
)

---

Compares Returns true if the bounce buffers could be compared.

Parameters

bool GEO_CALL Enlighten::CompareIncidentLightingBuffers

---

public: bool GEO_CALL CompareIncidentLightingBuffers
(
    Geo::Statistics & res,
    const Enlighten::IncidentLightingBuffer * bufA,
    const Enlighten::IncidentLightingBuffer * bufB
)

---

Compares Returns true if the lighting buffers could be compared.

Parameters

Enlighten::BounceBuffer* GEO_CALL Enlighten::CreateBounceBuffer

---

public: Enlighten::BounceBuffer *GEO_CALL CreateBounceBuffer
(
    void * memory,
    const Enlighten::InputWorkspace * inputWorkspace,
    PrecisionHint::Value precision
)

---

Construct a BounceBuffer inside the memory provided.

Parameters

Enlighten::IncidentLightingBuffer* GEO_CALL Enlighten::CreateIncidentLightingBuffer

---

public: Enlighten::IncidentLightingBuffer *GEO_CALL CreateIncidentLightingBuffer
(
    void * memory,
    const Enlighten::InputWorkspace * inputWorkspace,
    PrecisionHint::Value precision
)

---

Construct an IncidentLightingBuffer inside the memory provided.

Parameters

Enlighten::ProbeBounceWorkspace* GEO_CALL Enlighten::CreateProbeBounceWorkspace

---

public: Enlighten::ProbeBounceWorkspace *GEO_CALL CreateProbeBounceWorkspace
(
    void * memory,
    const Enlighten::InputWorkspace * inputWorkspace,
    Geo::s32 numInterpolants,
    Geo::s32 numLods
)

---

Construct a ProbeBounceBuffer inside the memory provided.

Parameters

Enlighten::ProbeBounceWorkspace* GEO_CALL Enlighten::CreateProbeBounceWorkspace

---

public: Enlighten::ProbeBounceWorkspace *GEO_CALL CreateProbeBounceWorkspace
(
    void * memory,
    const Enlighten::InputWorkspace * inputWorkspace,
    Geo::s32 numInterpolants
)

---

Construct a ProbeBounceBuffer inside the memory provided.

Parameters

TransparencyWorkspace* GEO_CALL Enlighten::CreateTransparencyWorkspace

---

public: TransparencyWorkspace *GEO_CALL CreateTransparencyWorkspace
(
    void * memory,
    const InputWorkspace * inputWorkspace,
    Geo::s32 numInterpolants,
    PrecisionHint::Value precision
)

---

Construct an TransparencyWorkspace inside the memory provided.

Parameters

TransparencyWorkspace* GEO_CALL Enlighten::CreateTransparencyWorkspace

---

public: TransparencyWorkspace *GEO_CALL CreateTransparencyWorkspace
(
    void * memory,
    const InputWorkspace * inputWorkspace,
    Geo::s32 numInterpolants,
    Geo::s32 numLods,
    PrecisionHint::Value precision
)

---

Construct an TransparencyWorkspace inside the memory provided.

Parameters

bool Enlighten::DoDirectInputLighting

---

public: bool DoDirectInputLighting
(
    DirectInputLightingParameters * params,
    void * scratchspace,
    size_t scratchspacSize,
    Geo::u32 & timeUs
)

---

Do the Direct input lighting stage.

Parameters

Returns

true on success

bool Enlighten::DoIndirectInputLighting

---

public: bool DoIndirectInputLighting
(
    IndirectInputLightingParameters * params,
    Geo::u32 & timeUs
)

---

Do the indirect input lighting stage.

Parameters

Returns

true on success

Geo::u32 GEO_CALL Enlighten::GetBounceBufferSize

---

public: Geo::u32GEO_CALL GetBounceBufferSize
(
    const Enlighten::BounceBuffer * bounceBuffer,
    PrecisionHint::Value precision
)

---

Returns the size of the specified BounceBuffer object.

Parameters

Returns

Required memory in bytes, 0xFFFFFFFF upon error.

Geo::GeoGuid GEO_CALL Enlighten::GetBounceBufferSystemId

---

public: Geo::GeoGuidGEO_CALL GetBounceBufferSystemId
(
    const Enlighten::BounceBuffer * bounceBuffer
)

---

Get system id from BounceBuffer.

Parameters

Geo::u32 GEO_CALL Enlighten::GetIncidentLightingBufferSize

---

public: Geo::u32GEO_CALL GetIncidentLightingBufferSize
(
    const Enlighten::IncidentLightingBuffer * incidentLightingBuffer,
    PrecisionHint::Value precision
)

---

Returns the size of the specified IncidentLightingBuffer object.

Parameters

Returns

Required memory in bytes, 0xFFFFFFFF upon error.

Geo::GeoGuid GEO_CALL Enlighten::GetIncidentLightingBufferSystemId

---

public: Geo::GeoGuidGEO_CALL GetIncidentLightingBufferSystemId
(
    const Enlighten::IncidentLightingBuffer * incidentLightingBuffer
)

---

Get system id from IncidentLightingBuffer.

Parameters

bool GEO_CALL Enlighten::SetTransparency

---

public: bool GEO_CALL SetTransparency
(
    const InputWorkspace * inputWorkspace,
    TransparencyWorkspace * transparencyWorkspace,
    float transparencyValue
)

---

Set all transparency values of transparencyWorkspace to the given value.

Parameters

bool GEO_CALL Enlighten::UpdateProbeBounceBuffer

---

public: bool GEO_CALL UpdateProbeBounceBuffer
(
    const InputWorkspace * inputWorkspace,
    Enlighten::ProbeBounceWorkspace * probeBounceWorkspace,
    Enlighten::BounceBuffer * bounceBufferOutput,
    const InterpolationInputSet * interpolationInputs,
    Geo::s32 numInterpolationInputs,
    bool recomputeInterpolants,
    Geo::u32 & timeUs
)

---

Update the probe bounce buffer with values calculated from interpolated probes.

Parameters

Returns

TRUE if successful, FALSE on error

bool GEO_CALL Enlighten::UpdateProbeBounceBuffer

---

public: bool GEO_CALL UpdateProbeBounceBuffer
(
    const InputWorkspace * inputWorkspace,
    Enlighten::ProbeBounceWorkspace * probeBounceWorkspace,
    Enlighten::BounceBuffer * bounceBufferOutput,
    Enlighten::IProbeSetManager * probeSetManager,
    bool recomputeInterpolants,
    Geo::u32 & timeUs
)

---

Update the probe bounce buffer with values calculated from interpolated probes.

Parameters

Returns

TRUE if successful, FALSE on error

void GEO_CALL Enlighten::UpdateTransparencyWorkspace

---

public: void GEO_CALL UpdateTransparencyWorkspace
(
    const InputWorkspace * inputWorkspace,
    TransparencyWorkspace * transparencyWorkspace,
    const InterpolationInputSet * interpolationInputs,
    Geo::s32 numInterpolationInputs,
    bool recomputeInterpolants
)

---

Update the transparency workspace with values calculated from interpolated probes.

Parameters

void GEO_CALL Enlighten::UpdateTransparencyWorkspace

---

public: void GEO_CALL UpdateTransparencyWorkspace
(
    const InputWorkspace * inputWorkspace,
    TransparencyWorkspace * transparencyWorkspace,
    Enlighten::IProbeSetManager * probeSetManager,
    bool recomputeInterpolants
)

---

Update the transparency workspace with values calculated from interpolated probes.

Parameters

bool GEO_CALL Enlighten::VerifyBounceBufferData

---

public: bool GEO_CALL VerifyBounceBufferData
(
    const Enlighten::BounceBuffer * bounceBuffer
)

---

Returns true if there are no NaN's or non-finite numbers in the specified BounceBuffer object.

Parameters

bool GEO_CALL Enlighten::VerifyIncidentLightingBufferData

---

public: bool GEO_CALL VerifyIncidentLightingBufferData
(
    const Enlighten::IncidentLightingBuffer * incidentLightingBuffer
)

---

Returns true if there are no NaN's or non-finite numbers in the specified InputLightingBuffer object.

Parameters