class Enlighten BaseSystemSolutionSpace

This is the documentation for Enlighten.

class Enlighten BaseSystemSolutionSpace

class Enlighten::BaseSystemSolutionSpace

    └>Enlighten::ISystemSolutionSpace
        └>Geo::IGeoReleasable

Base implementation of ISystemSolutionSpace.

Functions

Name

Description

Name

Description

BaseSystemSolutionSpace(const Enlighten::RadSystemCore *, IGpuTexture *, eOutputFormat)

Constructor.

CacheSystemOutputInfo()

Function to cache the pointers and strides for output textures.

DisableUpdatesAndFreeMemory()

Disable Updates and Free memory.

GetDeviceTextureFormat(OutputTextureType, eOutputFormat)

Helper function to convert the Enlighten format specifier to a device-specific format.

GetDirectionalOutputStride()

Returns the row stride of the directional output cpu data.

GetDoFullSolutionSolveNextFrame()

Gets/sets a flag which determines if we should do a full solve next frame.

GetIrradianceOutputFormat()

Get the output format if the irradiance texture.

GetIrradianceOutputStride()

Returns the row stride of the irradiance output cpu data.

GetOutputPitchInBytes(OutputTextureType)

Returns the pitch that Enlighten should use when writing the output buffer (texture)

GetOutputPointer(OutputTextureType)

Returns the memory location where Enlighten should write the output data.

GetOutputTexture(OutputTextureType, bool)

Get the output textures.

GetOutputTexture(OutputTextureType, bool)

Get the output texture from the solution space. Useful when you use IGpuTextureAllocator to allocate the textures.

GetRadiosityCore()

Get the immutable Radiosity System core.

GetRadiosityCore()

Get the RadSystemCore object which this solution space represents.

GetStale()

Gets/sets a flag which when true indicates that a solution space should have been solved but was not for some reason (e.g.

HasEnvironmentOnlyBounceData()

Determine if the environment only bounce data is present. Requires excludeEnvironmentInPrimaryBounce="true" in paramset.

IsReadyForRendering(OutputTextureType)

Returns true if the texture has been solved at least once and is ready for rendering.

IsReadyForRendering(OutputTextureType)

Returns true if the texture has been solved at least once and is ready for rendering.

MarkUpdate(Geo::u32)

Sets or clears the update status flag of the given output texture.

Release()

Free this object that was created within the Enlighten libraries.

Release()

Release the resources which are owned by this object.

ReleaseOwnResources()

Releases owned resources.

SetDoFullSolutionSolveNextFrame(bool)

Gets/sets a flag which determines if we should do a full solve next frame.

SetGpuTexture(OutputTextureType, IGpuTexture *)

Set the GPU textures on SystemSolutionSpace objects. This should be called via the command processor.

SetIsReadyForRendering(bool)

Set is ready for rendering textures flag.

SetStale(bool)

Gets/sets a flag which when true indicates that a solution space should have been solved but was not for some reason (e.g.

UpdateGpuTextures()

Update the Gpu textures. This should be called on the render thread. Returns true if any work was done.

Variables

Name

Description

Name

Description

bool m_IsReadyForRendering

Has the output been solved at least once and is ready for rendering.



Enlighten::BaseSystemSolutionSpace::BaseSystemSolutionSpace