module Utilities

This is the documentation for Enlighten.

module Utilities

Defines file formats for saving run-time data structures to file and provides helper classes to drive the run-time radiosity system.

The code for Enlighten Utilities is included in the SDK distribution so that you can:

  1. Modify the way in which EnlightenPrecompute saves data to file.

  2. See how to drive the radiosity run-time on different platforms and different threading models.

 

Functions

Name

Description

CopyAlbedoBufferBuffer(const Enlighten::InputWorkspace *, const Enlighten::AlbedoBuffer *)

Copy an InputLightingBuffer object.

CopyDynamicMaterialWorkspaceBuffer(const Enlighten::InputWorkspace *, const Enlighten::DynamicMaterialWorkspace *)

Copy an DynamicMaterialWorkspace object.

CopyEmissiveBuffer(const Enlighten::InputWorkspace *, const Enlighten::EmissiveBuffer *)

Copy an InputLightingBuffer object.

CopyIncidentLightingBuffer(const Enlighten::InputWorkspace *, const Enlighten::IncidentLightingBuffer *)

Copy an IncidentLightingBuffer object.

CopyInputLightingBuffer(const Enlighten::InputWorkspace *, const Enlighten::InputLightingBuffer *)

Copy an InputLightingBuffer object.

CopyRadCubeMapCore(const Enlighten::RadCubeMapCore *, Enlighten::RadCubeMapCore *)

Copies a RadCubeMapCore.

CopyRadSystemCore(const Enlighten::RadSystemCore *, Enlighten::RadSystemCore *)

Copies a RadSystemCore.

DeleteAlbedoBuffer(Enlighten::AlbedoBuffer *&)

Free an AlbedoBuffer object, and all the memory it owns.

DeleteClusterAlbedoWorkspaceMaterialData(Enlighten::ClusterAlbedoWorkspaceMaterialData *&)

Free an ClusterAlbedoWorkspaceMaterialData object, and all the memory (RadDataBlocks) it owns.

DeleteDynamicMaterialWorkspace(Enlighten::DynamicMaterialWorkspace *&)

Free an DynamicMaterialWorkspace object, and all the memory it owns.

DeleteEmissiveBuffer(Enlighten::EmissiveBuffer *&)

Free an EmissiveBuffer object, and all the memory it owns.

DeleteIncidentLightingBuffer(Enlighten::IncidentLightingBuffer *&)

Free an IncidentLightingBuffer object, and all the memory it owns.

DeleteInputLightingBuffer(Enlighten::InputLightingBuffer *&)

Free an InputLightingBuffer object, and all the memory it owns.

DeleteInputWorkspace(Enlighten::InputWorkspace *&)

Free an InputWorkspace object, and all the memory (RadDataBlocks) it owns.

DeletePrecomputedVisibilityData(Enlighten::PrecomputedVisibilityData *&)

Free a PrecomputedVisibilityData object, and all the memory (RadDataBlocks) it owns.

DeleteRadCubeMapCore(Enlighten::RadCubeMapCore *&)

Free a RadCubeMapCore object, and all the memory (RadDataBlocks) it owns.

DeleteRadProbeSetCore(Enlighten::RadProbeSetCore *&)

Free a RadProbeSetCore object, and all the memory (RadDataBlocks) it owns.

DeleteRadSystemCore(Enlighten::RadSystemCore *&)

Free a RadSystemCore object, and all the memory (RadDataBlocks) it owns.

DeleteTransparencyBuffer(Enlighten::TransparencyBuffer *&)

Free a TransparencyBuffer object, and all the memory it owns.

FreeDataBlockContents(RadDataBlock *)

Free a RadDataBlock object, and all the memory it owns.

GetSolverSuffix(eSolverType)

Defines a platform specific extension for some files, such as the InputWorkspace, that differ in content between platforms.

ReadAlbedoBuffer(Geo::IGeoInputStream &)

Read an AlbedoBuffer from a stream.

ReadAlbedoBufferInPlace(char *, size_t)

These utilities perform in-place fixup of the various enlighten data structures.

ReadClusterAlbedoWorkspaceMaterialData(Geo::IGeoInputStream &, Geo::u32)

Read an ClusterAlbedoWorkspaceMaterialData from a stream.

ReadClusterAlbedoWorkspaceMaterialDataFromFile(const char *, Geo::u32)

Read an ClusterAlbedoWorkspaceMaterialData from file.

ReadClusterAlbedoWorkspaceMaterialDataInPlace(char *, size_t)

These utilities perform in-place fixup of the various enlighten data structures.

ReadDataBlock(RadDataBlock *, Geo::IGeoInputStream &)

Read a RadDataBlock from a Geo::IGeoInputStream. Will return an object that should be released with FreeDataBlockContents().

ReadDataBlockInPlace(RadDataBlock &, char *&)

These utilities perform in-place fixup of the various enlighten data structures.

ReadDynamicMaterialWorkspace(Geo::IGeoInputStream &)

Read an DynamicMaterialWorkspace from a stream.

ReadDynamicMaterialWorkspaceInPlace(char *, size_t)

These utilities perform in-place fixup of the various enlighten data structures.

ReadEmissiveBuffer(Geo::IGeoInputStream &)

Read an EmissiveBuffer from a stream.

ReadEmissiveBufferInPlace(char *, size_t)

These utilities perform in-place fixup of the various enlighten data structures.

ReadIncidentLightingBuffer(Geo::IGeoInputStream &)

Read an IncidentLightingBuffer from a stream.

ReadIncidentLightingBufferInPlace(char *, size_t)

These utilities perform in-place fixup of the various enlighten data structures.

ReadInputLightingBuffer(Geo::IGeoInputStream &)

Read an InputLightingBuffer from a stream.

ReadInputLightingBufferInPlace(char *, size_t)

These utilities perform in-place fixup of the various enlighten data structures.

ReadInputWorkspace(Geo::IGeoInputStream &, Geo::u32)

Read an InputWorkspace from a stream.

ReadInputWorkspaceFromFile(const char *, Geo::u32)

Read an InputWorkspace from file.

ReadInputWorkspaceInPlace(char *, size_t)

These utilities perform in-place fixup of the various enlighten data structures.

ReadOptionalDataBlock(RadDataBlock *, Geo::IGeoInputStream &, Geo::u32, Geo::u32)

Read or skip a RadDataBlock in a Geo::IGeoInputStream, depending on the sections requested and the id of the block.

ReadPrecomputedVisibilityData(Geo::IGeoInputStream &)

Read a PrecomputedVisibilityData struct from a stream.