This is the documentation for Enlighten.

Defining a scene for the HLBS

The HLBS precompute takes the Enlighten scene description as input, and produces Enlighten runtime data as output. This page describes the folders and files composing the input and output.

Input folder structure

Each scene should be in its own directory, with the objects above located within it as follows:

ObjectFolderName
Geometry
<GeomName>
<GeomName>.geom
*.mesh
Scene
<SceneName>
<SceneName>.scene
Parameters
default.paramset

Output folder structure

The output of the precompute is stored in a folder called Build<SceneName>_. Within this folder the data is broken down by the stage that may use them.

FolderContentDescription
radiosity

Runtime data files

All of the RadDataBlocks that are required by the runtime are saved here.

precomp

Intermediate Precompute files

These are not required by the runtime.

debugging

Logging files

These are either plain text (.log) or XML fragments (.xlog) files. An HTML report for the scene is found here at <SceneName>.html

meshes

Sample Framework files.

Generated Meshes.

Required only for GeoRadiosity and other Sample Framework applications to render the scene.

geometry

Sample Framework files.

Generated UVs.

Required only for GeoRadiosity and other Sample Framework applications to render the scene.

textures

Sample Framework files

Required only for GeoRadiosity and other Sample Framework applications to render the scene.

intermediate

Intermediate build files

Generated by the build system to enable incremental builds.

fragments

High Level Build System files

Generated as a part of the dependency analysis.

This folder contains files that will be used to perform a minimal incremental build. Modifying these files may cause unexpected behaviour.
To force a full precompute, delete this folder.

MAX_PATH

Windows has a maximum file path limit of 260 characters on a local file system. The HLBS creates folders combining the scene, geometry, mesh and paramset names, so verbose or auto-generated descriptors may exceed this character limit. To avoid this, limit the length of such names, and choose a short path for the location of the scene root.

Data file types

Input file types

These files compose the Enlighten scene description.

ExtensionContentFormat
.geom

Geometry object

.geom

.scene

The scene

.scene

.paramset

Radiosity properties

.paramset

.mesh

Mesh object

GeoEngine::Mesh
.mats

Materials

.mats

.ips
InputProbeSet
IPrecompInputProbeSet
.ops
InputProbeOctree
IPrecompInputProbeOctree
Output file types

These files compose the Enlighten runtime data.

ExtensionFile contentClass
.rc
RadCore
RadSystemCore
.ps
ProbeSet
RadProbeSetCore
.dds
RadNormalTexture
DDS texture
.vis
Visibility
PrecomputedVisibilityData
.iw
InputWorkspace
InputWorkspace
.caw
ClusterAlbedoWorkspace
ClusterAlbedoWorkspaceMaterialData
.rcm
RadCubeMapCore
RadCubeMapCore
.mso
MeshSimpOutput

IMeshSimpOutput

.clo
ClusteringOutput

IClusteringOutput

.lto
LightTransportOutput

ILightTransportOutput

.uv
UVs

GeoEngine::UVStream

Some of the above files have a further platform suffix if the content varies depending on the Enlighten solver in use.

ExtensionSolver
.sse

SSE solver for all Windows/Linux platforms.

.neon

Neon solver for mobile platforms.

.ref

Reference. Should not be used in production.

Baking file types

The files are output when Baking with the High Level Build System.

ExtensionFile contentClass
.tex
Texture

GeoEngine::GeoFp16Texture

.rt
RuntimeTexture

GeoEngine::RuntimeTexture

.nrm
InputLightingNormals
IBakeInputGeometryLightingNormals
.bis
BakeInputSystem
IBakeInputSystem
.bvb
BakeVisibilityBuffer
IBakeVisibilityBuffer
.bod
BakeOutputDirect
IBakeOutputSystemDirect
.boi
BakeOutputIndirect
IBakeOutputSystemIndirect
.boao
BakeOutputAO
IBakeOutputSystemAO
.bov
BakeOutputVisibility
IBakeOutputSystemVisibility
.bpst
BakeOutputDirectProbes
IBakeOutputProbeSet
.bpsv
BakeOutputVisibilityProbes
IBakeOutputProbeSetVisibility
Intermediate precompute file types

The following files are created and saved in order to pass information from one stage of the precompute to the next.

ExtensionFile contentClass
.ig
InputGeometry
IPrecompInputGeometry
.pag
PackedGeometry
IPrecompPackedGeometry
.is
InputSystem
IPrecompInputSystem
.pas
PackedSystem
IPrecompPackedSystem
.prc
PreClustering
IPrecompSystemPreClustering
.clu
Clustering
IPrecompSystemClustering
.lt
LightTransport
IPrecompSystemLightTransport
.ltz
CompressedLightTransport
IPrecompSystemCompressedLightTransport
.ips
InputProbeSet
IPrecompInputProbeSet
.ops
OutputProbeSet
IPrecompOutputProbeSet
.dust
Dusters
IPrecompSystemDuster
.icm
InputCubeMap
IPrecompInputCubeMap
.ocm
OutputCubeMap
IPrecompOutputCubeMap