Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

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

NameDescription
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.

ReadPrecomputedVisibilityDataFromFile(const char *)

Read a PrecomputedVisibilityData struct from a file.

ReadPrecomputedVisibilityDataInPlace(char *, size_t)

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

ReadProbeTaskOutput(Enlighten::RadProbeTask *, Geo::IGeoInputStream &)

Read the RadProbeTask results data from a file/stream.

ReadProbeTaskOutputFromFile(Enlighten::RadProbeTask *, const char *)

Read the RadProbeTask results data from a file/stream.

ReadRadCubeMapCore(Geo::IGeoInputStream &)

Read a RadCubeMapCore from a stream.

ReadRadCubeMapCoreFromFile(const char *)

Read a RadCubeMapCore from file.

ReadRadCubeMapCoreInPlace(char *, size_t)

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

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

Read run-time probeset data from a file.

ReadRadProbeSetCoreFromFile(const char *, Geo::u32)

Read run-time probe set data from a file.

ReadRadProbeSetCoreInPlace(char *, size_t)

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

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

Read a RadSystemCore from a stream.

ReadRadSystemCoreFromFile(const char *, Geo::u32)

Read a RadSystemCore from file.

ReadRadSystemCoreInPlace(char *, size_t)

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

ReadRadTaskOutput(Geo::s32 &, Geo::s32 &, eOutputFormat &, eOutputFormatByteOrder &, void *, void *, void *, Geo::IGeoInputStream &)

Read the RadIrradianceTask results data from a file/stream.

ReadRadTaskOutputFromFile(Geo::s32 &, Geo::s32 &, eOutputFormat &, eOutputFormatByteOrder &, void *, void *, void *, const char *)

Read the RadIrradianceTask results data from a file.

ReadTransparencyBufferInPlace(char *, size_t)

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

SkipDataBlock(Geo::IGeoInputStream &)

Skip a RadDataBlock in a Geo::IGeoStream. Will advance the stream past a RadDataBlock without reading the contents.

WriteAlbedoBuffer(const Enlighten::AlbedoBuffer *, Geo::IGeoStream &)

Write an AlbedoBuffer to a stream.

WriteAlbedoBufferForInPlace(const AlbedoBuffer *, Geo::IGeoStream &, Geo::EConvertEndianMode)

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

WriteClusterAlbedoWorkspaceMaterialData(const Enlighten::ClusterAlbedoWorkspaceMaterialData *, Geo::IGeoStream &)

Write an ClusterAlbedoWorkspaceMaterialData to a stream, ready to be loaded on the target platform.

WriteClusterAlbedoWorkspaceMaterialDataForInPlace(const ClusterAlbedoWorkspaceMaterialData *, Geo::IGeoStream &, Geo::EConvertEndianMode)

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

WriteClusterAlbedoWorkspaceMaterialDataToFile(const Enlighten::ClusterAlbedoWorkspaceMaterialData *, const char *)

Write an ClusterAlbedoWorkspaceMaterialData to file, ready to be loaded on the target platform.

WriteDataBlock(const RadDataBlock &, Geo::IGeoStream &)

Write a RadDataBlock to a Geo::IGeoStream.

WriteDataBlockForInPlace(const RadDataBlock &, char *&)

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

WriteDynamicMaterialWorkspace(const Enlighten::DynamicMaterialWorkspace *, Geo::IGeoStream &)

Write an DynamicMaterialWorkspace to a stream.

WriteDynamicMaterialWorkspaceForInPlace(const DynamicMaterialWorkspace *, Geo::IGeoStream &, Geo::EConvertEndianMode)

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

WriteEmissiveBuffer(const Enlighten::EmissiveBuffer *, Geo::IGeoStream &)

Write an EmissiveBuffer to a stream.

WriteEmissiveBufferForInPlace(const EmissiveBuffer *, Geo::IGeoStream &, Geo::EConvertEndianMode)

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

WriteIncidentLightingBuffer(const Enlighten::IncidentLightingBuffer *, Geo::IGeoStream &)

Write an IncidentLightingBuffer to a stream.

WriteIncidentLightingBufferForInPlace(const IncidentLightingBuffer *, Geo::IGeoStream &, Geo::EConvertEndianMode)

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

WriteInputLightingBuffer(const Enlighten::InputLightingBuffer *, Geo::IGeoStream &)

Write an InputLightingBuffer to a stream.

WriteInputLightingBufferForInPlace(const InputLightingBuffer *, Geo::IGeoStream &, Geo::EConvertEndianMode)

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

WriteInputLightingBufferToFile(const Enlighten::InputLightingBuffer *, const char *)

Write an InputLightingBuffer to file.

WriteInputWorkspace(const Enlighten::InputWorkspace *, Geo::IGeoStream &)

Write an InputWorkspace to a stream, ready to be loaded on the target platform.

WriteInputWorkspaceForInPlace(const InputWorkspace *, Geo::IGeoStream &, Geo::EConvertEndianMode)

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

WriteInputWorkspaceToFile(const Enlighten::InputWorkspace *, const char *)

Write an InputWorkspace to file, ready to be loaded on the target platform.

WritePrecomputedVisibilityData(const Enlighten::PrecomputedVisibilityData *, Geo::IGeoStream &)

Write a PrecomputedVisibilityData structure to a stream.

WritePrecomputedVisibilityDataForInPlace(const PrecomputedVisibilityData *, Geo::IGeoStream &, Geo::EConvertEndianMode)

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

WritePrecomputedVisibilityDataToFile(const Enlighten::PrecomputedVisibilityData *, const char *)

Write a PrecomputedVisibilityData structure to a file.

WriteProbeTaskOutput(const Enlighten::RadProbeTask *, Geo::IGeoStream &)

Write the RadProbeTask results data to a file/stream.

WriteProbeTaskOutputToFile(const Enlighten::RadProbeTask *, const char *)

Write the RadProbeTask results data to a file/stream.

WriteRadCubeMapCore(const Enlighten::RadCubeMapCore *, Geo::IGeoStream &)

Write a RadCubeMapCore to a stream, ready to be loaded on the target platform.

WriteRadCubeMapCoreForInPlace(const RadCubeMapCore *, Geo::IGeoStream &, Geo::EConvertEndianMode)

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

WriteRadCubeMapCoreToFile(const Enlighten::RadCubeMapCore *, const char *)

Write a RadCubeMapCore to file, ready to be loaded on the target platform.

WriteRadIrradianceTaskOutput(const RadIrradianceTask *, Geo::IGeoStream &)

Write the RadIrradianceTask results data to a file/stream.

WriteRadIrradianceTaskOutputToFile(const RadIrradianceTask *, const char *)

Write the RadIrradianceTask results data to a file/stream.

WriteRadProbeSetCore(const Enlighten::RadProbeSetCore *, Geo::IGeoStream &)

Write run-time probeset data to a stream, ready to be loaded on the target platform.

WriteRadProbeSetCoreForInPlace(const RadProbeSetCore *, Geo::IGeoStream &, Geo::EConvertEndianMode)

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

WriteRadProbeSetCoreToFile(const Enlighten::RadProbeSetCore *, const char *)

Write run-time probeset data to file, ready to be loaded on the target platform.

WriteRadSystemCore(const Enlighten::RadSystemCore *, Geo::IGeoStream &)

Write a RadSystemCore to a stream, ready to be loaded on the target platform.

WriteRadSystemCoreForInPlace(const RadSystemCore *, Geo::IGeoStream &, Geo::EConvertEndianMode)

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

WriteRadSystemCoreToFile(const Enlighten::RadSystemCore *, const char *)

Write a RadSystemCore to file, ready to be loaded on the target platform.

WriteTransparencyBufferForInPlace(const TransparencyBuffer *, Geo::IGeoStream &, Geo::EConvertEndianMode)

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


Anchor
a23604e917ac2dabb698f02317853c09b
a23604e917ac2dabb698f02317853c09b

Enlighten::AlbedoBuffer *GEO_CALL Enlighten::CopyAlbedoBufferBuffer

...

public: Enlighten::AlbedoBuffer *GEO_CALL CopyAlbedoBufferBuffer
(
    const Enlighten::InputWorkspace * inputWorkspace,
    const Enlighten::AlbedoBuffer * sourceAlbedoBuffer
)

...

Copy an InputLightingBuffer object.

Parameters
[in]inputWorkspace

- The Inputworkspace to use to create the input lighting buffer.

[in]sourceAlbedoBuffer

- The AlbedoBuffer to copy from.


Anchor
aaba19c39d070d2a1428871e738bff4ec
aaba19c39d070d2a1428871e738bff4ec

Enlighten::DynamicMaterialWorkspace *GEO_CALL Enlighten::CopyDynamicMaterialWorkspaceBuffer

...

public: Enlighten::DynamicMaterialWorkspace *GEO_CALL CopyDynamicMaterialWorkspaceBuffer
(
    const Enlighten::InputWorkspace * inputWorkspace,
    const Enlighten::DynamicMaterialWorkspace * materialWorkspace
)

...

Copy an DynamicMaterialWorkspace object.

Parameters
[in]inputWorkspace

- The Inputworkspace to use to create the input lighting buffer.

[in]materialWorkspace

- The DynamicMaterialWorkspace to copy from.


Anchor
a97680f45f93e66ef3caa9d5aa4617dda
a97680f45f93e66ef3caa9d5aa4617dda

Enlighten::EmissiveBuffer *GEO_CALL Enlighten::CopyEmissiveBuffer

...

public: Enlighten::EmissiveBuffer *GEO_CALL CopyEmissiveBuffer
(
    const Enlighten::InputWorkspace * inputWorkspace,
    const Enlighten::EmissiveBuffer * sourceEmissiveBuffer
)

...

Copy an InputLightingBuffer object.

Parameters
[in]inputWorkspace

- The InputWorkspace to use to create the input lighting buffer.

[in]sourceEmissiveBuffer

- The EmissiveBuffer to copy from.


Anchor
afe62f0934dbcb0f565a50827bcd39330
afe62f0934dbcb0f565a50827bcd39330

Enlighten::IncidentLightingBuffer *GEO_CALL Enlighten::CopyIncidentLightingBuffer

...

public: Enlighten::IncidentLightingBuffer *GEO_CALL CopyIncidentLightingBuffer
(
    const Enlighten::InputWorkspace * inputWorkspace,
    const Enlighten::IncidentLightingBuffer * sourceIncidentLightingBuffer
)

...

Copy an IncidentLightingBuffer object.

Parameters
[in]inputWorkspace

- The Inputworkspace to use to create the input lighting buffer.

[in]sourceIncidentLightingBuffer

- TheIncidentLightingBuffer to copy from.


Anchor
a9a1e8700a8309123858ae172f49a7f55
a9a1e8700a8309123858ae172f49a7f55

Enlighten::InputLightingBuffer *GEO_CALL Enlighten::CopyInputLightingBuffer

...

public: Enlighten::InputLightingBuffer *GEO_CALL CopyInputLightingBuffer
(
    const Enlighten::InputWorkspace * inputWorkspace,
    const Enlighten::InputLightingBuffer * sourceInputLightingBuffer
)

...

Copy an InputLightingBuffer object.

Parameters
[in]inputWorkspace

- The Inputworkspace to use to create the input lighting buffer.

[in]sourceInputLightingBuffer

- The InputLightingBuffer to copy from.


Anchor
a0c55798ec762b433740875a23066eb97
a0c55798ec762b433740875a23066eb97

void GEO_CALL Enlighten::CopyRadCubeMapCore

...

public: void GEO_CALL CopyRadCubeMapCore
(
    const Enlighten::RadCubeMapCore * from,
    Enlighten::RadCubeMapCore * to
)

...

Copies a RadCubeMapCore.

Parameters
[in]from

- The core to copy from.

[in]to

- The core to copy to.


Anchor
ad0d01fa0340cb1889d8d9c1d6682434e
ad0d01fa0340cb1889d8d9c1d6682434e

void GEO_CALL Enlighten::CopyRadSystemCore

...

public: void GEO_CALL CopyRadSystemCore
(
    const Enlighten::RadSystemCore * from,
    Enlighten::RadSystemCore * to
)

...

Copies a RadSystemCore.

Parameters
[in]from

- The core to copy from.

[in]to

- The core to copy to.


Anchor
a2fb811469efb6e069473eefcd27a8788
a2fb811469efb6e069473eefcd27a8788

void GEO_CALL Enlighten::DeleteAlbedoBuffer

...

public: void GEO_CALL DeleteAlbedoBuffer
(
    Enlighten::AlbedoBuffer *& albedoBuffer
)

...

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

Parameters
[in]albedoBuffer

- The AlbedoBuffer to free.


Anchor
a4b184c5ab5fbd4a1cf023a64a5a5c63c
a4b184c5ab5fbd4a1cf023a64a5a5c63c

void GEO_CALL Enlighten::DeleteClusterAlbedoWorkspaceMaterialData

...

public: void GEO_CALL DeleteClusterAlbedoWorkspaceMaterialData
(
    Enlighten::ClusterAlbedoWorkspaceMaterialData *& materialData
)

...

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

This is intended to be used to delete objects created with one of the ReadCluster* functions.

Parameters
[in]materialData

- The ClusterAlbedoWorkspaceMaterialData to free.


Anchor
a8bdc714e49cf4c9262fc3423da704f90
a8bdc714e49cf4c9262fc3423da704f90

void GEO_CALL Enlighten::DeleteDynamicMaterialWorkspace

...

public: void GEO_CALL DeleteDynamicMaterialWorkspace
(
    Enlighten::DynamicMaterialWorkspace *& materialWorkspace
)

...

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

Parameters
[in]materialWorkspace

- The DynamicMaterialWorkspace to free.


Anchor
a395e98a25cb134c195189f561fc6e6e7
a395e98a25cb134c195189f561fc6e6e7

void GEO_CALL Enlighten::DeleteEmissiveBuffer

...

public: void GEO_CALL DeleteEmissiveBuffer
(
    Enlighten::EmissiveBuffer *& emissiveBuffer
)

...

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

Parameters
[in]emissiveBuffer

- The EmissiveBuffer to free.


Anchor
afcc88ff63abc9767d8df5dff8f208e31
afcc88ff63abc9767d8df5dff8f208e31

void GEO_CALL Enlighten::DeleteIncidentLightingBuffer

...

public: void GEO_CALL DeleteIncidentLightingBuffer
(
    Enlighten::IncidentLightingBuffer *& incidentLightingBuffer
)

...

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

Parameters
[in]incidentLightingBuffer

- The IncidentLightingBuffer to free.


Anchor
a048888d468f459503991223c3e087f1d
a048888d468f459503991223c3e087f1d

void GEO_CALL Enlighten::DeleteInputLightingBuffer

...

public: void GEO_CALL DeleteInputLightingBuffer
(
    Enlighten::InputLightingBuffer *& inputLightingBuffer
)

...

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

Parameters
[in]inputLightingBuffer

- The InputLightingBuffer to free.


Anchor
af3d32ba6ca9eaef03b039cdd01c0f0ce
af3d32ba6ca9eaef03b039cdd01c0f0ce

void GEO_CALL Enlighten::DeleteInputWorkspace

...

public: void GEO_CALL DeleteInputWorkspace
(
    Enlighten::InputWorkspace *& inputWorkspace
)

...

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

Parameters
[in]inputWorkspace

- The InputWorkspace to free.


Anchor
aed5b675c924d2d0076b3ed474df47d01
aed5b675c924d2d0076b3ed474df47d01

void GEO_CALL Enlighten::DeletePrecomputedVisibilityData

...

public: void GEO_CALL DeletePrecomputedVisibilityData
(
    Enlighten::PrecomputedVisibilityData *& visibilityData
)

...

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

Parameters
[in]visibilityData

- The PrecomputedVisibilityData to free.


Anchor
aa6a7e78cb4b7568f214ef148774587e9
aa6a7e78cb4b7568f214ef148774587e9

void GEO_CALL Enlighten::DeleteRadCubeMapCore

...

public: void GEO_CALL DeleteRadCubeMapCore
(
    Enlighten::RadCubeMapCore *& cubeMapCore
)

...

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

Parameters
[in]cubeMapCore

- The RadCubeMapCore to free.


Anchor
aba089a9420fe3909659e058434fe6f0e
aba089a9420fe3909659e058434fe6f0e

void GEO_CALL Enlighten::DeleteRadProbeSetCore

...

public: void GEO_CALL DeleteRadProbeSetCore
(
    Enlighten::RadProbeSetCore *& probeSet
)

...

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

Parameters
[in]probeSet

- The RadProbeSetCore to free.


Anchor
ac5a2a39b77e0238dbedbd7d962a4eaea
ac5a2a39b77e0238dbedbd7d962a4eaea

void GEO_CALL Enlighten::DeleteRadSystemCore

...

public: void GEO_CALL DeleteRadSystemCore
(
    Enlighten::RadSystemCore *& system
)

...

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

Parameters
[in]system

- The RadSystemCore to free.


Anchor
af530990bfda0982a521c9366204cfdb4
af530990bfda0982a521c9366204cfdb4

void GEO_CALL Enlighten::DeleteTransparencyBuffer

...

public: void GEO_CALL DeleteTransparencyBuffer
(
    Enlighten::TransparencyBuffer *& transparencyBuffer
)

...

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

Parameters
[in]transparencyBuffer

- The TransparencyBuffer to free.


Anchor
a136c9462d54138062cd766fe64e88119
a136c9462d54138062cd766fe64e88119

void GEO_CALL Enlighten::FreeDataBlockContents

...

public: void GEO_CALL FreeDataBlockContents
(
    RadDataBlock * block
)

...

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


Anchor
a8ea44a530dfa135129895bb636421f5e
a8ea44a530dfa135129895bb636421f5e

const char* Enlighten::GetSolverSuffix

...

public: const char * GetSolverSuffix
(
    eSolverType solverType
)

...

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


Anchor
ae71259d95cea53c01758c8461cb08f69
ae71259d95cea53c01758c8461cb08f69

Enlighten::AlbedoBuffer *GEO_CALL Enlighten::ReadAlbedoBuffer

...

public: Enlighten::AlbedoBuffer *GEO_CALL ReadAlbedoBuffer
(
    Geo::IGeoInputStream & stream
)

...

Read an AlbedoBuffer from a stream.

Parameters
[in]stream

- The Geo::IGeoStream to read.


Anchor
a31056af5aa1ba10839e300b64555102f
a31056af5aa1ba10839e300b64555102f

Enlighten::AlbedoBuffer *GEO_CALL Enlighten::ReadAlbedoBufferInPlace

...

public: AlbedoBuffer *GEO_CALL ReadAlbedoBufferInPlace
(
    char * data,
    size_t size
)

...

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

Make sure any buffers passed to Read*InPlace functions are 16 byte aligned.


Anchor
a17dc97c13f9ad2d02de11f4a5bc4787c
a17dc97c13f9ad2d02de11f4a5bc4787c

Enlighten::ClusterAlbedoWorkspaceMaterialData *GEO_CALL Enlighten::ReadClusterAlbedoWorkspaceMaterialData

...

public: Enlighten::ClusterAlbedoWorkspaceMaterialData *GEO_CALL ReadClusterAlbedoWorkspaceMaterialData
(
    Geo::IGeoInputStream & stream,
    Geo::u32 sections
)

...

Read an ClusterAlbedoWorkspaceMaterialData from a stream.

Parameters
[in]stream

- The Geo::IGeoStream to read.

[in]sections

- Which of the optional data blocks to allocate and read. Pass 0 to load no optional data, or Enlighten::Iff::ClusterAlbedoWorkspaceMaterialGuidsSection to load the optional material guids data

Returns

Non-null if successful - remember to delete the pointer using DeleteClusterAlbedoWorkspaceMaterialData.


Anchor
a13945e2dafbd2d987ced9608de46d126
a13945e2dafbd2d987ced9608de46d126

Enlighten::ClusterAlbedoWorkspaceMaterialData *GEO_CALL Enlighten::ReadClusterAlbedoWorkspaceMaterialDataFromFile

...

public: Enlighten::ClusterAlbedoWorkspaceMaterialData *GEO_CALL ReadClusterAlbedoWorkspaceMaterialDataFromFile
(
    const char * filename,
    Geo::u32 sections
)

...

Read an ClusterAlbedoWorkspaceMaterialData from file.

Parameters
[in]filename

- The name of the file to read.

[in]sections

- Which of the optional data blocks to allocate and read. Pass 0 to load no optional data, or Enlighten::Iff::ClusterAlbedoWorkspaceMaterialGuidsSection to load the optional material guids data

Returns

Non-null if successful - remember to delete the pointer using DeleteClusterAlbedoWorkspaceMaterialData.


Anchor
aa225a4033e2a4bfe50cc604c6bfe3219
aa225a4033e2a4bfe50cc604c6bfe3219

ClusterAlbedoWorkspaceMaterialData *GEO_CALL Enlighten::ReadClusterAlbedoWorkspaceMaterialDataInPlace

...

public: ClusterAlbedoWorkspaceMaterialData *GEO_CALL ReadClusterAlbedoWorkspaceMaterialDataInPlace
(
    char * data,
    size_t size
)

...

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

Make sure any buffers passed to Read*InPlace functions are 16 byte aligned.


Anchor
a34459527451bf10e9b022053db468bed
a34459527451bf10e9b022053db468bed

void GEO_CALL Enlighten::ReadDataBlock

...

public: void GEO_CALL ReadDataBlock
(
    RadDataBlock * block,
    Geo::IGeoInputStream & stream
)

...

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

Always returns a relocatable data block.


Anchor
a3ae314a79d655a2ccf9a6c9b969e5633
a3ae314a79d655a2ccf9a6c9b969e5633

void Enlighten::ReadDataBlockInPlace

...

public: void ReadDataBlockInPlace
(
    RadDataBlock & block,
    char *& ptr
)

...

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

Make sure any buffers passed to Read*InPlace functions are 16 byte aligned.


Anchor
a481c250b09e81cc8e1088ee6ab6f9f5a
a481c250b09e81cc8e1088ee6ab6f9f5a

Enlighten::DynamicMaterialWorkspace *GEO_CALL Enlighten::ReadDynamicMaterialWorkspace

...

public: Enlighten::DynamicMaterialWorkspace *GEO_CALL ReadDynamicMaterialWorkspace
(
    Geo::IGeoInputStream & stream
)

...

Read an DynamicMaterialWorkspace from a stream.

Parameters
[in]stream

- The Geo::IGeoStream to read.


Anchor
aa99a8f6673bad42443da02677dcd1c7c
aa99a8f6673bad42443da02677dcd1c7c

Enlighten::DynamicMaterialWorkspace *GEO_CALL Enlighten::ReadDynamicMaterialWorkspaceInPlace

...

public: DynamicMaterialWorkspace *GEO_CALL ReadDynamicMaterialWorkspaceInPlace
(
    char * data,
    size_t size
)

...

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

Make sure any buffers passed to Read*InPlace functions are 16 byte aligned.


Anchor
ad25787e763959cb5b0ee1f4b604b002f
ad25787e763959cb5b0ee1f4b604b002f

Enlighten::EmissiveBuffer *GEO_CALL Enlighten::ReadEmissiveBuffer

...

public: Enlighten::EmissiveBuffer *GEO_CALL ReadEmissiveBuffer
(
    Geo::IGeoInputStream & stream
)

...

Read an EmissiveBuffer from a stream.

Parameters
[in]stream

- The Geo::IGeoStream to read.


Anchor
a8bb35c49fc09b6e2037b353253e71e9d
a8bb35c49fc09b6e2037b353253e71e9d

Enlighten::EmissiveBuffer *GEO_CALL Enlighten::ReadEmissiveBufferInPlace

...

public: EmissiveBuffer *GEO_CALL ReadEmissiveBufferInPlace
(
    char * data,
    size_t size
)

...

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

Make sure any buffers passed to Read*InPlace functions are 16 byte aligned.


Anchor
ab4191a00f0fd3eabda464b7776906735
ab4191a00f0fd3eabda464b7776906735

Enlighten::IncidentLightingBuffer *GEO_CALL Enlighten::ReadIncidentLightingBuffer

...

public: Enlighten::IncidentLightingBuffer *GEO_CALL ReadIncidentLightingBuffer
(
    Geo::IGeoInputStream & stream
)

...

Read an IncidentLightingBuffer from a stream.

Parameters
[in]stream

- The Geo::IGeoStream to read.


Anchor
a6e31e75b4fe2e1c19e5655169913143e
a6e31e75b4fe2e1c19e5655169913143e

Enlighten::IncidentLightingBuffer *GEO_CALL Enlighten::ReadIncidentLightingBufferInPlace

...

public: IncidentLightingBuffer *GEO_CALL ReadIncidentLightingBufferInPlace
(
    char * data,
    size_t size
)

...

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

Make sure any buffers passed to Read*InPlace functions are 16 byte aligned.


Anchor
a93708d3a990e4b5b591c420821ad01af
a93708d3a990e4b5b591c420821ad01af

Enlighten::InputLightingBuffer *GEO_CALL Enlighten::ReadInputLightingBuffer

...

public: Enlighten::InputLightingBuffer *GEO_CALL ReadInputLightingBuffer
(
    Geo::IGeoInputStream & stream
)

...

Read an InputLightingBuffer from a stream.

Parameters
[in]stream

- The Geo::IGeoStream to read.


Anchor
a2033e05ccda023b4e3c74206d9a8042d
a2033e05ccda023b4e3c74206d9a8042d

Enlighten::InputLightingBuffer *GEO_CALL Enlighten::ReadInputLightingBufferInPlace

...

public: InputLightingBuffer *GEO_CALL ReadInputLightingBufferInPlace
(
    char * data,
    size_t size
)

...

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

Make sure any buffers passed to Read*InPlace functions are 16 byte aligned.


Anchor
aae4c7ed0b330fd6869ce539a7138e380
aae4c7ed0b330fd6869ce539a7138e380

Enlighten::InputWorkspace *GEO_CALL Enlighten::ReadInputWorkspace

...

public: Enlighten::InputWorkspace *GEO_CALL ReadInputWorkspace
(
    Geo::IGeoInputStream & stream,
    Geo::u32 sections
)

...

Read an InputWorkspace from a stream.

Parameters
[in]stream

- The Geo::IGeoStream to read.

[in]sections

- Which of the optional data blocks to allocate and read. Pass 0 to load no optional data, or Enlighten::Iff::DynamicInputWorkspaceDataSection to load the optional dynamic data and/or Enlighten::Iff::ProjectedPointsInputWorkspaceDataSection to load the optional duster projection data and/or Enlighten::Iff::HighQualityBounceCoordinateDataSection to load the optional high quality bounce data

Returns

Non-null if successful - you must delete the pointer using DeleteInputWorkspace.


Anchor
af0d563a79b165e17b416987625d564ed
af0d563a79b165e17b416987625d564ed

Enlighten::InputWorkspace *GEO_CALL Enlighten::ReadInputWorkspaceFromFile

...

public: Enlighten::InputWorkspace *GEO_CALL ReadInputWorkspaceFromFile
(
    const char * filename,
    Geo::u32 sections
)

...

Read an InputWorkspace from file.

Parameters
[in]filename

- The name of the file to read.

[in]sections

- Which of the optional data blocks to allocate and read. Pass 0 to load no optional data, or Enlighten::Iff::DynamicInputWorkspaceDataSection to load the optional dynamic data and/or Enlighten::Iff::ProjectedPointsInputWorkspaceDataSection to load the optional duster projection data and/or Enlighten::Iff::HighQualityBounceCoordinateDataSection to load the optional high quality bounce data


Anchor
a55a4819fcfa0f6f6bde801e47219f37a
a55a4819fcfa0f6f6bde801e47219f37a

InputWorkspace *GEO_CALL Enlighten::ReadInputWorkspaceInPlace

...

public: InputWorkspace *GEO_CALL ReadInputWorkspaceInPlace
(
    char * data,
    size_t size
)

...

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

Make sure any buffers passed to Read*InPlace functions are 16 byte aligned.


Anchor
aa6e63828181ea5e9975fef467672aa12
aa6e63828181ea5e9975fef467672aa12

void GEO_CALL Enlighten::ReadOptionalDataBlock

...

public: void GEO_CALL ReadOptionalDataBlock
(
    RadDataBlock * dataBlock,
    Geo::IGeoInputStream & stream,
    Geo::u32 sections,
    Geo::u32 optionalBlock
)

...

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


Anchor
a46e0d3cafdfe7673607ed82d1cd4ce72
a46e0d3cafdfe7673607ed82d1cd4ce72

Enlighten::PrecomputedVisibilityData *GEO_CALL Enlighten::ReadPrecomputedVisibilityData

...

public: Enlighten::PrecomputedVisibilityData *GEO_CALL ReadPrecomputedVisibilityData
(
    Geo::IGeoInputStream & stream
)

...

Read a PrecomputedVisibilityData struct from a stream.

Parameters
[in]stream

- The Geo::IGeoStream to read


Anchor
aab8a5ec669fea8ed0e0f528c9cc5b578
aab8a5ec669fea8ed0e0f528c9cc5b578

Enlighten::PrecomputedVisibilityData *GEO_CALL Enlighten::ReadPrecomputedVisibilityDataFromFile

...

public: Enlighten::PrecomputedVisibilityData *GEO_CALL ReadPrecomputedVisibilityDataFromFile
(
    const char * filename
)

...

Read a PrecomputedVisibilityData struct from a file.

Parameters
[in]filename

- The name of the file to read


Anchor
ab765f917161c2517ef60f5ec1c633d20
ab765f917161c2517ef60f5ec1c633d20

PrecomputedVisibilityData *GEO_CALL Enlighten::ReadPrecomputedVisibilityDataInPlace

...

public: PrecomputedVisibilityData *GEO_CALL ReadPrecomputedVisibilityDataInPlace
(
    char * data,
    size_t size
)

...

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

Make sure any buffers passed to Read*InPlace functions are 16 byte aligned.


Anchor
a24a8f831d796cf7f6e2e0cb18f347fce
a24a8f831d796cf7f6e2e0cb18f347fce

bool GEO_CALL Enlighten::ReadProbeTaskOutput

...

public: bool GEO_CALL ReadProbeTaskOutput
(
    Enlighten::RadProbeTask * probeTask,
    Geo::IGeoInputStream & stream
)

...

Read the RadProbeTask results data from a file/stream.

Note
titleNote

The caller takes ownership of the loaded data, which includes deleting m_NumIndexesToSolve, m_OutputPointers and m_OutputPointers[0] (which is the main block of floats)


Anchor
aca5661b6e713b60e3b2877628bb80818
aca5661b6e713b60e3b2877628bb80818

bool GEO_CALL Enlighten::ReadProbeTaskOutputFromFile

...

public: bool GEO_CALL ReadProbeTaskOutputFromFile
(
    Enlighten::RadProbeTask * probeTask,
    const char * filename
)

...

Read the RadProbeTask results data from a file/stream.

Note
titleNote

The caller takes ownership of the loaded data, which includes deleting m_NumIndexesToSolve, m_OutputPointers and m_OutputPointers[0] (which is the main block of floats)


Anchor
a951ee7349b8db81574e81719544e0ef5
a951ee7349b8db81574e81719544e0ef5

Enlighten::RadCubeMapCore *GEO_CALL Enlighten::ReadRadCubeMapCore

...

public: Enlighten::RadCubeMapCore *GEO_CALL ReadRadCubeMapCore
(
    Geo::IGeoInputStream & stream
)

...

Read a RadCubeMapCore from a stream.

The data is written in little-endian format, so the loading code must handle this.

Parameters
[in]stream

- The Geo::IGeoStream to read.

Returns

Non-null if successful - you must delete the pointer using DeleteRadCubeMapCore.

Note
titleNote

the RadDataBlock contained within the returned RadCubeMapCore is always relocatable after load.


Anchor
afcd27586981ffdede017dd8edf793984
afcd27586981ffdede017dd8edf793984

Enlighten::RadCubeMapCore *GEO_CALL Enlighten::ReadRadCubeMapCoreFromFile

...

public: Enlighten::RadCubeMapCore *GEO_CALL ReadRadCubeMapCoreFromFile
(
    const char * filename
)

...

Read a RadCubeMapCore from file.

The files are written in target-endian format, so the same loading code works for all platforms.

Parameters
[in]filename

- The name of the file to read.

Returns

Non-null if successful - you must delete the pointer using DeleteRadCubeMapCore.

Note
titleNote

the RadDataBlock contained within the returned RadCubeMapCore is always relocatable after load.


Anchor
ad9ec37eae1db2423132ea265bc7b2b7e
ad9ec37eae1db2423132ea265bc7b2b7e

RadCubeMapCore *GEO_CALL Enlighten::ReadRadCubeMapCoreInPlace

...

public: RadCubeMapCore *GEO_CALL ReadRadCubeMapCoreInPlace
(
    char * data,
    size_t size
)

...

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

Make sure any buffers passed to Read*InPlace functions are 16 byte aligned.


Anchor
a9b02711386c25f6e25c5f939feaa3843
a9b02711386c25f6e25c5f939feaa3843

RadProbeSetCore *GEO_CALL Enlighten::ReadRadProbeSetCore

...

public: Enlighten::RadProbeSetCore *GEO_CALL ReadRadProbeSetCore
(
    Geo::IGeoInputStream & stream,
    Geo::u32 sections
)

...

Read run-time probeset data from a file.

The files are written in target-endian format, so the same loading code works for all platforms.

Parameters
[in]stream

- The Geo::IGeoStream to read

[in]sections

- Pass 0 to load no optional data or any combination of the following: Enlighten::Iff::ProbeSetPrecompSection Enlighten::Iff::EntireProbeSetPrecompSection Enlighten::Iff::ProbeSetInterpolationDataSection Enlighten::Iff::ProbeSetVisibilityDataSection Enlighten::Iff::ProbeSetDebugDataSection

Returns

Non-null if successful - you must delete the pointer using DeleteRadProbeSetCore.

Note
titleNote

the returned RadDataBlock is always relocatable.


Anchor
a4444b8e6ac33733e1ed5ae106d987b84
a4444b8e6ac33733e1ed5ae106d987b84

RadProbeSetCore *GEO_CALL Enlighten::ReadRadProbeSetCoreFromFile

...

public: Enlighten::RadProbeSetCore *GEO_CALL ReadRadProbeSetCoreFromFile
(
    const char * filename,
    Geo::u32 sections
)

...

Read run-time probe set data from a file.

The files are written in target-endian format, so the same loading code works for all platforms. Note this doesn't do any endian swapping. It assumes you are reading/writing the file on the same platform.

Parameters
[in]filename

- The name of the file to read

[in]sections

- Pass 0 to load no optional data or any combination of the following: Enlighten::Iff::ProbeSetPrecompSection Enlighten::Iff::EntireProbeSetPrecompSection Enlighten::Iff::ProbeSetInterpolationDataSection Enlighten::Iff::ProbeSetVisibilityDataSection Enlighten::Iff::ProbeSetDebugDataSection

Returns

Non-null if successful - you must delete the pointer using DeleteRadProbeSetCore.

Note
titleNote

the returned RadDataBlock is always relocatable.


Anchor
af92ce9bd083b5954abc2c9f64785e17f
af92ce9bd083b5954abc2c9f64785e17f

RadProbeSetCore *GEO_CALL Enlighten::ReadRadProbeSetCoreInPlace

...

public: RadProbeSetCore *GEO_CALL ReadRadProbeSetCoreInPlace
(
    char * data,
    size_t size
)

...

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

Make sure any buffers passed to Read*InPlace functions are 16 byte aligned.


Anchor
ae330c371ca1a51ca0a5b4e55c7772820
ae330c371ca1a51ca0a5b4e55c7772820

RadSystemCore *GEO_CALL Enlighten::ReadRadSystemCore

...

public: Enlighten::RadSystemCore *GEO_CALL ReadRadSystemCore
(
    Geo::IGeoInputStream & stream,
    Geo::u32 sections
)

...

Read a RadSystemCore from a stream.

The data is written in little-endian format, so the loading code must handle this.

Parameters
[in]stream

- The Geo::IGeoInputStream to read.

[in]sections

- Which of the optional data blocks to allocate and read. Pass 0 to load no optional data, or a combination of Enlighten::Iff::ProjectionDataSection and/or Enlighten::Iff::DynamicRadiosityDataSection

Returns

Non-null if successful - you must delete the pointer using DeleteRadSystemCore.

Note
titleNote

the RadDataBlock contained within the returned RadSystemCore is always relocatable after load.


Anchor
a80cbc194b98b899c257f95a0496d3645
a80cbc194b98b899c257f95a0496d3645

RadSystemCore *GEO_CALL Enlighten::ReadRadSystemCoreFromFile

...

public: Enlighten::RadSystemCore *GEO_CALL ReadRadSystemCoreFromFile
(
    const char * filename,
    Geo::u32 sections
)

...

Read a RadSystemCore from file.

The files are written in target-endian format, so the same loading code works for all platforms.

Parameters
[in]filename

- The name of the file to read.

[in]sections

- Which of the optional data blocks to allocate and read. Pass 0 to load no optional data, or a combination of Enlighten::Iff::ProjectionDataSection and/or Enlighten::Iff::DynamicRadiosityDataSection

Returns

Non-null if successful - you must delete the pointer using DeleteRadSystemCore.

Note
titleNote

the RadDataBlock contained within the returned RadSystemCore is always relocatable after load.


Anchor
a26a6e472b8f1850558c890e00cbbc6fc
a26a6e472b8f1850558c890e00cbbc6fc

RadSystemCore *GEO_CALL Enlighten::ReadRadSystemCoreInPlace

...

public: RadSystemCore *GEO_CALL ReadRadSystemCoreInPlace
(
    char * data,
    size_t Size
)

...

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

Make sure any buffers passed to Read*InPlace functions are 16 byte aligned.


Anchor
a556b8919626a21621fafea1514c07fa5
a556b8919626a21621fafea1514c07fa5

bool GEO_CALL Enlighten::ReadRadTaskOutput

...

public: bool GEO_CALL ReadRadTaskOutput
(
    Geo::s32 & outputWidth,
    Geo::s32 & outputHeight,
    eOutputFormat & outputFormat,
    eOutputFormatByteOrder & outputFormatByteOrder,
    void * irradianceOutput64,
    void * irradianceOutput32,
    void * directionalOutput,
    Geo::IGeoInputStream & stream
)

...

Read the RadIrradianceTask results data from a file/stream.

Note
titleNote

If the output width or height are set to zero, then only the header of the file is read, and the width, height outputFormat and outputFormatByteOrder are filled in. The function then returns true. If the output size is non-zero, the function assumes that the various output pointers are large enough to hold the incoming data. In general, users should not have to call these functions in their integration.

Parameters
[out]outputWidth

- The width of the output texture

[out]outputHeight

- The height of the output texture

[out]outputFormat

- The format of the output texture

[out]outputFormatByteOrder

- The byte order of the LRB irradiance/directional output texture

[in]irradianceOutput64

- pointer large enough to hold 64-bit-per-pixel output data (e.g. FP16). Pass NULL if not required

[in]irradianceOutput32

- pointer large enough to hold 32-bit-per-pixel output data (e.g. LRB). Pass NULL if not required

[in]directionalOutput

- pointer large enough to hold directional output data. Pass NULL if not required

[in]stream

- The file stream from which to read the rad task data from


Anchor
ad3431952b3c03003bf79753fbe6054e5
ad3431952b3c03003bf79753fbe6054e5

bool GEO_CALL Enlighten::ReadRadTaskOutputFromFile

...

public: bool GEO_CALL ReadRadTaskOutputFromFile
(
    Geo::s32 & outputWidth,
    Geo::s32 & outputHeight,
    eOutputFormat & outputFormat,
    eOutputFormatByteOrder & outputFormatByteOrder,
    void * irradianceOutput64,
    void * irradianceOutput32,
    void * directionalOutput,
    const char * filename
)

...

Read the RadIrradianceTask results data from a file.

Please see ReadRadTaskOutput for details.

Parameters
[out]outputWidth

- The width of the output texture

[out]outputHeight

- The height of the output texture

[out]outputFormat

- The format of the output texture

[out]outputFormatByteOrder

- The byte order of the LRB irradiance/directional output texture

[in]irradianceOutput64

- pointer large enough to hold 64-bit-per-pixel output data (e.g. FP16). Pass NULL if not required

[in]irradianceOutput32

- pointer large enough to hold 32-bit-per-pixel output data (e.g. LRB). Pass NULL if not required

[in]directionalOutput

- pointer large enough to hold directional output data. Pass NULL if not required

[in]filename

- The name of the rad task output file to read data from


Anchor
afd79be78274f789fc2c11a07f76a47d5
afd79be78274f789fc2c11a07f76a47d5

Enlighten::TransparencyBuffer *GEO_CALL Enlighten::ReadTransparencyBufferInPlace

...

public: TransparencyBuffer *GEO_CALL ReadTransparencyBufferInPlace
(
    char * data,
    size_t size
)

...

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

Make sure any buffers passed to Read*InPlace functions are 16 byte aligned.


Anchor
a5c56556a12e2fc4538b91b2a159591af
a5c56556a12e2fc4538b91b2a159591af

void GEO_CALL Enlighten::SkipDataBlock

...

public: void GEO_CALL SkipDataBlock
(
    Geo::IGeoInputStream & stream
)

...

Skip a RadDataBlock in a Geo::IGeoStream. Will advance the stream past a RadDataBlock without reading the contents.


Anchor
a7807b665c471b29b374d722a3059f773
a7807b665c471b29b374d722a3059f773

bool GEO_CALL Enlighten::WriteAlbedoBuffer

...

public: bool GEO_CALL WriteAlbedoBuffer
(
    const Enlighten::AlbedoBuffer * albedoBuffer,
    Geo::IGeoStream & stream
)

...

Write an AlbedoBuffer to a stream.

Parameters
[in]albedoBuffer

- The AlbedoBuffer to write.

[in]stream

- The Geo::IGeoStream to write.


Anchor
a71eeaad278d8abb2e055fe4c5279ac44
a71eeaad278d8abb2e055fe4c5279ac44

bool GEO_CALL Enlighten::WriteAlbedoBufferForInPlace

...

public: bool GEO_CALL WriteAlbedoBufferForInPlace
(
    const AlbedoBuffer * albedoBuffer,
    Geo::IGeoStream & stream,
    Geo::EConvertEndianMode endianMode
)

...

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

Make sure any buffers passed to Read*InPlace functions are 16 byte aligned.


Anchor
a1fc23844ef308a5d119b9b118821b863
a1fc23844ef308a5d119b9b118821b863

bool GEO_CALL Enlighten::WriteClusterAlbedoWorkspaceMaterialData

...

public: bool GEO_CALL WriteClusterAlbedoWorkspaceMaterialData
(
    const Enlighten::ClusterAlbedoWorkspaceMaterialData * materialData,
    Geo::IGeoStream & stream
)

...

Write an ClusterAlbedoWorkspaceMaterialData to a stream, ready to be loaded on the target platform.

Parameters
[in]materialData

- The ClusterAlbedoWorkspaceMaterialData to write.

[in]stream

- The Geo::IGeoStream to write to.


Anchor
a642b23a0a108836b96289d2b2b7af5ba
a642b23a0a108836b96289d2b2b7af5ba

bool GEO_CALL Enlighten::WriteClusterAlbedoWorkspaceMaterialDataForInPlace

...

public: bool GEO_CALL WriteClusterAlbedoWorkspaceMaterialDataForInPlace
(
    const ClusterAlbedoWorkspaceMaterialData * materialData,
    Geo::IGeoStream & stream,
    Geo::EConvertEndianMode endianMode
)

...

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

Make sure any buffers passed to Read*InPlace functions are 16 byte aligned.


Anchor
aa1bdf89196f6ef8e59d8224db03a7739
aa1bdf89196f6ef8e59d8224db03a7739

bool GEO_CALL Enlighten::WriteClusterAlbedoWorkspaceMaterialDataToFile

...

public: bool GEO_CALL WriteClusterAlbedoWorkspaceMaterialDataToFile
(
    const Enlighten::ClusterAlbedoWorkspaceMaterialData * materialData,
    const char * filename
)

...

Write an ClusterAlbedoWorkspaceMaterialData to file, ready to be loaded on the target platform.

Parameters
[in]materialData

- The ClusterAlbedoWorkspaceMaterialData to write.

[in]filename

- The name of the file to write.


Anchor
ac5e45cd16b2425658e36c5f2a2c992db
ac5e45cd16b2425658e36c5f2a2c992db

bool GEO_CALL Enlighten::WriteDataBlock

...

public: bool GEO_CALL WriteDataBlock
(
    const RadDataBlock & data,
    Geo::IGeoStream & stream
)

...

Write a RadDataBlock to a Geo::IGeoStream.


Anchor
a716d7af33e3c5836c5fda6365babfb67
a716d7af33e3c5836c5fda6365babfb67

void * Enlighten::WriteDataBlockForInPlace

...

public: void * WriteDataBlockForInPlace
(
    const RadDataBlock & block,
    char *& ptr
)

...

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

Make sure any buffers passed to Read*InPlace functions are 16 byte aligned.


Anchor
a7bb202d82205c1892b989b640d6aaeb6
a7bb202d82205c1892b989b640d6aaeb6

bool GEO_CALL Enlighten::WriteDynamicMaterialWorkspace

...

public: bool GEO_CALL WriteDynamicMaterialWorkspace
(
    const Enlighten::DynamicMaterialWorkspace * materialWorkspace,
    Geo::IGeoStream & stream
)

...

Write an DynamicMaterialWorkspace to a stream.

Parameters
[in]materialWorkspace

- The DynamicMaterialWorkspace to write.

[in]stream

- The Geo::IGeoStream to write.


Anchor
a6b10e4e5198c15991211f01884cee8de
a6b10e4e5198c15991211f01884cee8de

bool GEO_CALL Enlighten::WriteDynamicMaterialWorkspaceForInPlace

...

public: bool GEO_CALL WriteDynamicMaterialWorkspaceForInPlace
(
    const DynamicMaterialWorkspace * workspace,
    Geo::IGeoStream & stream,
    Geo::EConvertEndianMode endianMode
)

...

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

Make sure any buffers passed to Read*InPlace functions are 16 byte aligned.


Anchor
a580618917cfbc58561fc4d55a0ac3115
a580618917cfbc58561fc4d55a0ac3115

bool GEO_CALL Enlighten::WriteEmissiveBuffer

...

public: bool GEO_CALL WriteEmissiveBuffer
(
    const Enlighten::EmissiveBuffer * emissiveBuffer,
    Geo::IGeoStream & stream
)

...

Write an EmissiveBuffer to a stream.

Parameters
[in]emissiveBuffer

- The EmissiveBuffer to write.

[in]stream

- The Geo::IGeoStream to write.


Anchor
a02e49ab231c2a7804979c6d396135b7b
a02e49ab231c2a7804979c6d396135b7b

bool GEO_CALL Enlighten::WriteEmissiveBufferForInPlace

...

public: bool GEO_CALL WriteEmissiveBufferForInPlace
(
    const EmissiveBuffer * emissiveBuffer,
    Geo::IGeoStream & stream,
    Geo::EConvertEndianMode endianMode
)

...

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

Make sure any buffers passed to Read*InPlace functions are 16 byte aligned.


Anchor
aa0337f5b73058966301834ee8a254348
aa0337f5b73058966301834ee8a254348

bool GEO_CALL Enlighten::WriteIncidentLightingBuffer

...

public: bool GEO_CALL WriteIncidentLightingBuffer
(
    const Enlighten::IncidentLightingBuffer * incidentLightingBuffer,
    Geo::IGeoStream & stream
)

...

Write an IncidentLightingBuffer to a stream.

Parameters
[in]incidentLightingBuffer

- The IncidentLightingBuffer to write.

[in]stream

- The Geo::IGeoStream to write.


Anchor
a3280cdc5177aea778293d7f1c1eedf04
a3280cdc5177aea778293d7f1c1eedf04

bool GEO_CALL Enlighten::WriteIncidentLightingBufferForInPlace

...

public: bool GEO_CALL WriteIncidentLightingBufferForInPlace
(
    const IncidentLightingBuffer * incidentLightingBuffer,
    Geo::IGeoStream & stream,
    Geo::EConvertEndianMode endianMode
)

...

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

Make sure any buffers passed to Read*InPlace functions are 16 byte aligned.


Anchor
a49d64e3ec46c23a0501ce4abc3e840b8
a49d64e3ec46c23a0501ce4abc3e840b8

bool GEO_CALL Enlighten::WriteInputLightingBuffer

...

public: bool GEO_CALL WriteInputLightingBuffer
(
    const Enlighten::InputLightingBuffer * inputLightingBuffer,
    Geo::IGeoStream & stream
)

...

Write an InputLightingBuffer to a stream.

Parameters
[in]inputLightingBuffer

- The InputLightingBuffer to write.

[in]stream

- The Geo::IGeoStream to write.


Anchor
ac109991c08dfa716d22e26f27d76a0c7
ac109991c08dfa716d22e26f27d76a0c7

bool GEO_CALL Enlighten::WriteInputLightingBufferForInPlace

...

public: bool GEO_CALL WriteInputLightingBufferForInPlace
(
    const InputLightingBuffer * inputLightingBuffer,
    Geo::IGeoStream & stream,
    Geo::EConvertEndianMode endianMode
)

...

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

Make sure any buffers passed to Read*InPlace functions are 16 byte aligned.


Anchor
a34d362e326dda9683d205e6b93aff8f7
a34d362e326dda9683d205e6b93aff8f7

bool GEO_CALL Enlighten::WriteInputLightingBufferToFile

...

public: bool GEO_CALL WriteInputLightingBufferToFile
(
    const Enlighten::InputLightingBuffer * inputLightingBuffer,
    const char * filename
)

...

Write an InputLightingBuffer to file.

Parameters
[in]inputLightingBuffer

- The InputLightingBuffer to write.

[in]filename

- The name of the file to write.


Anchor
a783f14e596fae91705c7af427436dad0
a783f14e596fae91705c7af427436dad0

bool GEO_CALL Enlighten::WriteInputWorkspace

...

public: bool GEO_CALL WriteInputWorkspace
(
    const Enlighten::InputWorkspace * inputWorkspace,
    Geo::IGeoStream & stream
)

...

Write an InputWorkspace to a stream, ready to be loaded on the target platform.

Parameters
[in]inputWorkspace

- The InputWorkspace to write.

[in]stream

- The Geo::IGeoStream to write to.


Anchor
ac8a388fed84e40c24c3a3735b40a7634
ac8a388fed84e40c24c3a3735b40a7634

bool GEO_CALL Enlighten::WriteInputWorkspaceForInPlace

...

public: bool GEO_CALL WriteInputWorkspaceForInPlace
(
    const InputWorkspace * inputWorkspace,
    Geo::IGeoStream & stream,
    Geo::EConvertEndianMode endianMode
)

...

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

Make sure any buffers passed to Read*InPlace functions are 16 byte aligned.


Anchor
a1fb7ecbdc7cefafe2f2f19efb790293e
a1fb7ecbdc7cefafe2f2f19efb790293e

bool GEO_CALL Enlighten::WriteInputWorkspaceToFile

...

public: bool GEO_CALL WriteInputWorkspaceToFile
(
    const Enlighten::InputWorkspace * inputWorkspace,
    const char * filename
)

...

Write an InputWorkspace to file, ready to be loaded on the target platform.

Parameters
[in]inputWorkspace

- The InputWorkspace to write.

[in]filename

- The name of the file to write.


Anchor
a9b48274f101643c862962406e8b381b1
a9b48274f101643c862962406e8b381b1

bool GEO_CALL Enlighten::WritePrecomputedVisibilityData

...

public: bool GEO_CALL WritePrecomputedVisibilityData
(
    const Enlighten::PrecomputedVisibilityData * visibilityData,
    Geo::IGeoStream & stream
)

...

Write a PrecomputedVisibilityData structure to a stream.

Parameters
[in]visibilityData

- The PrecomputedVisibilityData structure data to write.

[in]stream

- The Geo::IGeoStream to write.


Anchor
af633eb9d580fbe65c78a3e53273c51e0
af633eb9d580fbe65c78a3e53273c51e0

bool GEO_CALL Enlighten::WritePrecomputedVisibilityDataForInPlace

...

public: bool GEO_CALL WritePrecomputedVisibilityDataForInPlace
(
    const PrecomputedVisibilityData * visibilityData,
    Geo::IGeoStream & stream,
    Geo::EConvertEndianMode endianMode
)

...

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

Make sure any buffers passed to Read*InPlace functions are 16 byte aligned.


Anchor
adbeb2c0701cb27314ca7bf49b966de36
adbeb2c0701cb27314ca7bf49b966de36

bool GEO_CALL Enlighten::WritePrecomputedVisibilityDataToFile

...

public: bool GEO_CALL WritePrecomputedVisibilityDataToFile
(
    const Enlighten::PrecomputedVisibilityData * visibilityData,
    const char * filename
)

...

Write a PrecomputedVisibilityData structure to a file.

Parameters
[in]visibilityData

- The PrecomputedVisibilityData structure data to write.

[in]filename

- The name of the file to write.


Anchor
a27a7ea02e7fa13e25dad7ee239c2cc2e
a27a7ea02e7fa13e25dad7ee239c2cc2e

bool GEO_CALL Enlighten::WriteProbeTaskOutput

...

public: bool GEO_CALL WriteProbeTaskOutput
(
    const Enlighten::RadProbeTask * probeTask,
    Geo::IGeoStream & stream
)

...

Write the RadProbeTask results data to a file/stream.


Anchor
a918589fd7df8edb7e3310aaae07e6cd7
a918589fd7df8edb7e3310aaae07e6cd7

bool GEO_CALL Enlighten::WriteProbeTaskOutputToFile

...

public: bool GEO_CALL WriteProbeTaskOutputToFile
(
    const Enlighten::RadProbeTask * probeTask,
    const char * filename
)

...

Write the RadProbeTask results data to a file/stream.


Anchor
a2550f8c5b146cb97c0472f9e922dd421
a2550f8c5b146cb97c0472f9e922dd421

bool GEO_CALL Enlighten::WriteRadCubeMapCore

...

public: bool GEO_CALL WriteRadCubeMapCore
(
    const Enlighten::RadCubeMapCore * cubeMapCore,
    Geo::IGeoStream & stream
)

...

Write a RadCubeMapCore to a stream, ready to be loaded on the target platform.

Parameters
[in]cubeMapCore

- The RadCubeMapCore to write.

[in]stream

- The Geo::IGeoStream to write to.

Note
titleNote

the RadDataBlock contained in the RadCubeMapCore must be relocatable for this function to succeed.


Anchor
ae805a6233c16f385ea818dd2228c7fcb
ae805a6233c16f385ea818dd2228c7fcb

bool GEO_CALL Enlighten::WriteRadCubeMapCoreForInPlace

...

public: bool GEO_CALL WriteRadCubeMapCoreForInPlace
(
    const RadCubeMapCore * cubeMap,
    Geo::IGeoStream & stream,
    Geo::EConvertEndianMode endianMode
)

...

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

Make sure any buffers passed to Read*InPlace functions are 16 byte aligned.


Anchor
a7b3fe14d2b520815c70af4b31410916d
a7b3fe14d2b520815c70af4b31410916d

bool GEO_CALL Enlighten::WriteRadCubeMapCoreToFile

...

public: bool GEO_CALL WriteRadCubeMapCoreToFile
(
    const Enlighten::RadCubeMapCore * cubeMapCore,
    const char * filename
)

...

Write a RadCubeMapCore to file, ready to be loaded on the target platform.

Parameters
[in]cubeMapCore

- The RadCubeMapCore to write.

[in]filename

- The name of the file to write.

Note
titleNote

the RadDataBlock contained in the RadCubeMapCore must be relocatable for this function to succeed.


Anchor
af6c472a713f00bbd28ec94578ecac2c8
af6c472a713f00bbd28ec94578ecac2c8

bool Enlighten::WriteRadIrradianceTaskOutput

...

public: bool WriteRadIrradianceTaskOutput
(
    const RadIrradianceTask * task,
    Geo::IGeoStream & stream
)

...

Write the RadIrradianceTask results data to a file/stream.


Anchor
a6f463f09cad1972334e390eb669888c4
a6f463f09cad1972334e390eb669888c4

bool Enlighten::WriteRadIrradianceTaskOutputToFile

...

public: bool WriteRadIrradianceTaskOutputToFile
(
    const RadIrradianceTask * task,
    const char * filename
)

...

Write the RadIrradianceTask results data to a file/stream.


Anchor
a88bae00332f8dfc52e8ebb49e938fbbd
a88bae00332f8dfc52e8ebb49e938fbbd

bool GEO_CALL Enlighten::WriteRadProbeSetCore

...

public: bool GEO_CALL WriteRadProbeSetCore
(
    const Enlighten::RadProbeSetCore * probeSet,
    Geo::IGeoStream & stream
)

...

Write run-time probeset data to a stream, ready to be loaded on the target platform.

Parameters
[in]probeSet

- The probe set data to write.

[in]stream

- The Geo::IGeoStream to write.

Note
titleNote

the RadDataBlock must be relocatable for this function to succeed.


Anchor
a6a3df33399feef3002b80623a45adf50
a6a3df33399feef3002b80623a45adf50

bool GEO_CALL Enlighten::WriteRadProbeSetCoreForInPlace

...

public: bool GEO_CALL WriteRadProbeSetCoreForInPlace
(
    const RadProbeSetCore * probeSet,
    Geo::IGeoStream & stream,
    Geo::EConvertEndianMode endianMode
)

...

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

Make sure any buffers passed to Read*InPlace functions are 16 byte aligned.


Anchor
ae33a1605bb557c71188b9880d51d8384
ae33a1605bb557c71188b9880d51d8384

bool GEO_CALL Enlighten::WriteRadProbeSetCoreToFile

...

public: bool GEO_CALL WriteRadProbeSetCoreToFile
(
    const Enlighten::RadProbeSetCore * probeSet,
    const char * filename
)

...

Write run-time probeset data to file, ready to be loaded on the target platform.

The data is written in little-endian format, so the loading code must handle this.

Parameters
[in]probeSet

- The probe set data to write.

[in]filename

- The name of the file to write.

Note
titleNote

the RadDataBlock must be relocatable for this function to succeed.


Anchor
a99402f30b986d21d93abaecd92ee198a
a99402f30b986d21d93abaecd92ee198a

bool GEO_CALL Enlighten::WriteRadSystemCore

...

public: bool GEO_CALL WriteRadSystemCore
(
    const Enlighten::RadSystemCore * system,
    Geo::IGeoStream & stream
)

...

Write a RadSystemCore to a stream, ready to be loaded on the target platform.

Parameters
[in]system

- The RadSystemCore to write.

[in]stream

- The Geo::IGeoStream to write to.

Note
titleNote

the RadDataBlock contained in the RadSystemCore must be relocatable for this function to succeed.


Anchor
a4d24a95cc1fd70951c771ff3136e6ed9
a4d24a95cc1fd70951c771ff3136e6ed9

bool GEO_CALL Enlighten::WriteRadSystemCoreForInPlace

...

public: bool GEO_CALL WriteRadSystemCoreForInPlace
(
    const RadSystemCore * system,
    Geo::IGeoStream & stream,
    Geo::EConvertEndianMode endianMode
)

...

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

Make sure any buffers passed to Read*InPlace functions are 16 byte aligned.


Anchor
a06ba63a62d638ad5eea500c08dd53c09
a06ba63a62d638ad5eea500c08dd53c09

bool GEO_CALL Enlighten::WriteRadSystemCoreToFile

...

public: bool GEO_CALL WriteRadSystemCoreToFile
(
    const Enlighten::RadSystemCore * system,
    const char * filename
)

...

Write a RadSystemCore to file, ready to be loaded on the target platform.

Parameters
[in]system

- The RadSystemCore to write.

[in]filename

- The name of the file to write.

Note
titleNote

the RadDataBlock contained in the RadSystemCore must be relocatable for this function to succeed.


Anchor
abf8e882109201d02197555160d6257bb
abf8e882109201d02197555160d6257bb

bool GEO_CALL Enlighten::WriteTransparencyBufferForInPlace

...

public: bool GEO_CALL WriteTransparencyBufferForInPlace
(
    const TransparencyBuffer * transparencyBuffer,
    Geo::IGeoStream & stream,
    Geo::EConvertEndianMode endianMode
)

...

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

Make sure any buffers passed to Read*InPlace functions are 16 byte aligned.