This is the documentation for Enlighten.
module Extended Input Lighting
The extended input lighting api.
Classes
Name | Description |
|---|---|
A class containing the parameters to be used as input to the direct input lighting stage. | |
A buffer containing the incident lighting for a system's input sample points (internal). | |
A class containing the parameters to be used as input to the indirect input lighting stage. | |
Probe bounce workspace. | |
Workspace used for authored destruction of lightmapped geometry (internal). |
Functions
Name | Description |
|---|---|
Adds light values laid out in a duster block to an Enlighten input workspace. | |
ApplyVolumeTransparency(const InputWorkspace *, TransparencyWorkspace *, const SphereVolume &) | Mark the quads transparency value using a sphere volume. |
ApplyVolumeTransparency(const InputWorkspace *, TransparencyWorkspace *, const BoxVolume &) | Mark the quads transparency value using a box volume. |
CalcBounceBufferSize(const Enlighten::InputWorkspace *, PrecisionHint::Value) | Tells you the amount of memory required to hold bounce lighting for a given system. |
CalcIncidentLightingBufferSize(const Enlighten::InputWorkspace *, PrecisionHint::Value) | Tells you the amount of memory required to hold incident lighting for a given system. |
CalcProbeBounceWorkspaceSize(const Enlighten::InputWorkspace *, Geo::s32) | Tells you the amount of memory required for the probe bounce buffer for a given system. |
CalcProbeBounceWorkspaceSize(const Enlighten::InputWorkspace *, Geo::s32, Geo::s32) | Tells you the amount of memory required for the probe bounce buffer for a given system. |
Calculate how much scratchspace memory will be required by the DoDirectInputLighting() function given the lights to be shaded. | |
CalcTransparencyWorkspaceSize(const InputWorkspace *, Geo::s32, PrecisionHint::Value) | Tells you the amount of memory required for the transparency workspace for a given system. |
CalcTransparencyWorkspaceSize(const InputWorkspace *, Geo::s32, Geo::s32, PrecisionHint::Value) | Tells you the amount of memory required for the transparency workspace for a given system. |
Compares Returns true if the bounce buffers could be compared. | |
Compares Returns true if the lighting buffers could be compared. | |
CreateBounceBuffer(void *, const Enlighten::InputWorkspace *, PrecisionHint::Value) | Construct a BounceBuffer inside the memory provided. |
CreateIncidentLightingBuffer(void *, const Enlighten::InputWorkspace *, PrecisionHint::Value) | Construct an IncidentLightingBuffer inside the memory provided. |
CreateProbeBounceWorkspace(void *, const Enlighten::InputWorkspace *, Geo::s32, Geo::s32) | Construct a ProbeBounceBuffer inside the memory provided. |
CreateProbeBounceWorkspace(void *, const Enlighten::InputWorkspace *, Geo::s32) | Construct a ProbeBounceBuffer inside the memory provided. |
CreateTransparencyWorkspace(void *, const InputWorkspace *, Geo::s32, PrecisionHint::Value) | Construct an TransparencyWorkspace inside the memory provided. |
Construct an TransparencyWorkspace inside the memory provided. | |
DoDirectInputLighting(DirectInputLightingParameters *, void *, size_t, Geo::u32 &) | Do the Direct input lighting stage. |
DoIndirectInputLighting(IndirectInputLightingParameters *, Geo::u32 &) | Do the indirect input lighting stage. |
GetBounceBufferSize(const Enlighten::BounceBuffer *, PrecisionHint::Value) | Returns the size of the specified BounceBuffer object. |
Get system id from BounceBuffer. | |
GetIncidentLightingBufferSize(const Enlighten::IncidentLightingBuffer *, PrecisionHint::Value) | Returns the size of the specified IncidentLightingBuffer object. |
GetIncidentLightingBufferSystemId(const Enlighten::IncidentLightingBuffer *) | Get system id from IncidentLightingBuffer. |
SetTransparency(const InputWorkspace *, TransparencyWorkspace *, float) | Set all transparency values of transparencyWorkspace to the given value. |
Update the probe bounce buffer with values calculated from interpolated probes. | |
Update the probe bounce buffer with values calculated from interpolated probes. | |
Update the transparency workspace with values calculated from interpolated probes. | |
Update the transparency workspace with values calculated from interpolated probes. | |
Returns true if there are no NaN's or non-finite numbers in the specified BounceBuffer object. | |
VerifyIncidentLightingBufferData(const Enlighten::IncidentLightingBuffer *) | Returns true if there are no NaN's or non-finite numbers in the specified InputLightingBuffer object. |
bool GEO_CALL Enlighten::AddDusterValuesToInputWorkspace
public: bool GEO_CALL AddDusterValuesToInputWorkspace
(
const InputWorkspace * workspaceMemory,
Enlighten::IncidentLightingBuffer * output,
const Geo::v128 * dusterValues
)