class Enlighten::TransparencyWorkspace

Workspace used for authored destruction of lightmapped geometry (internal).

The transparency workspace.

The data for this class lies immediately after it in memory.

An optional feature of the extended input lighting api. This is created using CreateTransparencyWorkspace() from an existing InputWorkspace. The implementation of this class should be considered internal, but is readable in InputWorkspace.h. Normal operation should be through the api below.

Functions

Name	Description
CalculateSize(const InputWorkspace *, Geo::s32, Geo::s32, PrecisionHint::Value)	Determine the required size of the buffer.
Create(const InputWorkspace , Geo::s32, Geo::s32, void , PrecisionHint::Value)	Construct the buffer in the provided memory.
GetClusterValues()	Gets the cluster values.
GetClusterValues()	Gets the cluster values.
GetInputLightingSurroundings()	Gets the input lighting surroundings.
GetLastUsedOffset()	Gets/sets the last used offset.
GetMaxNumInterpolants()	Gets the max number of interpolants.
GetNumInterpolantsArray(Geo::s32)	Gets the num interpolants array for a cluster. Size of array equals NumLods.
GetNumLods()	Gets number of LODs.
GetNumPositions()	Gets the number of positions.
GetProbeInterpolants(Geo::s32, Geo::s32)	Gets the probe interpolants for a cluster at a given lod.
GetProbeInterpolants(Geo::s32, Geo::s32)	Gets the probe interpolants for a cluster at a given lod.
GetQuadTransparencyValues()	Get the quad transparency values.
GetQuadTransparencyValues()	Get the quad transparency values.
GetSamplePositions()	Get the cluster positions.
GetSamplePositions()	Get the cluster positions.
GetTransparencyBuffer()	Gets the transparency buffer.
GetTransparencyBuffer()	Gets the transparency buffer.
SetLastUsedOffset(float)	Gets/sets the last used offset.

static Geo::u32 Enlighten::TransparencyWorkspace::CalculateSize

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

Determine the required size of the buffer.

static TransparencyWorkspace* Enlighten::TransparencyWorkspace::Create

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

Construct the buffer in the provided memory.

LightValueIterator Enlighten::TransparencyWorkspace::GetClusterValues

public: LightValueIterator GetClusterValues()

Gets the cluster values.

There is one value per cluster. Each represents the probe sampled lighting through the cluster.

ConstLightValueIterator Enlighten::TransparencyWorkspace::GetClusterValues

public: ConstLightValueIterator GetClusterValues() const

Gets the cluster values.

There is one value per cluster. Each represents the probe sampled lighting through the cluster.

const Geo::v128* Enlighten::TransparencyWorkspace::GetInputLightingSurroundings

public: const Geo::v128 * GetInputLightingSurroundings() const

Gets the input lighting surroundings.

float Enlighten::TransparencyWorkspace::GetLastUsedOffset

public: float GetLastUsedOffset() const

Gets/sets the last used offset.

Geo::s32 Enlighten::TransparencyWorkspace::GetMaxNumInterpolants

public: Geo::s32 GetMaxNumInterpolants() const

Gets the max number of interpolants.

Geo::u8* Enlighten::TransparencyWorkspace::GetNumInterpolantsArray

public: Geo::u8 * GetNumInterpolantsArray
(
Geo::s32 cluster
)

Gets the num interpolants array for a cluster. Size of array equals NumLods.

Geo::s32 Enlighten::TransparencyWorkspace::GetNumLods

public: Geo::s32 GetNumLods() const

Gets number of LODs.

Geo::s32 Enlighten::TransparencyWorkspace::GetNumPositions

public: Geo::s32 GetNumPositions() const

Gets the number of positions.

ProbeInterpolant* Enlighten::TransparencyWorkspace::GetProbeInterpolants

public: ProbeInterpolant * GetProbeInterpolants
(
Geo::s32 cluster,
Geo::s32 lod
)

Gets the probe interpolants for a cluster at a given lod.

Size of array equals MaxNumInterpolants.

const ProbeInterpolant* Enlighten::TransparencyWorkspace::GetProbeInterpolants

public: const ProbeInterpolant * GetProbeInterpolants
(
Geo::s32 cluster,
Geo::s32 lod
) const

Gets the probe interpolants for a cluster at a given lod.

Size of array equals MaxNumInterpolants.

const Geo::u8* Enlighten::TransparencyWorkspace::GetQuadTransparencyValues

public: const Geo::u8 * GetQuadTransparencyValues() const

Get the quad transparency values.

This layout matches the InputWorkspace layout.

Geo::u8* Enlighten::TransparencyWorkspace::GetQuadTransparencyValues

public: Geo::u8 * GetQuadTransparencyValues()

Get the quad transparency values.

This layout matches the InputWorkspace layout.

const Geo::v128* Enlighten::TransparencyWorkspace::GetSamplePositions

public: const Geo::v128 * GetSamplePositions() const

Get the cluster positions.

Geo::v128* Enlighten::TransparencyWorkspace::GetSamplePositions

public: Geo::v128 * GetSamplePositions()

Get the cluster positions.

TransparencyBuffer* Enlighten::TransparencyWorkspace::GetTransparencyBuffer

public: TransparencyBuffer * GetTransparencyBuffer()

Gets the transparency buffer.

const TransparencyBuffer* Enlighten::TransparencyWorkspace::GetTransparencyBuffer

public: const TransparencyBuffer * GetTransparencyBuffer() const

Gets the transparency buffer.

void Enlighten::TransparencyWorkspace::SetLastUsedOffset

public: void SetLastUsedOffset
(
float offset
)

Gets/sets the last used offset.