View Source

Overview

This section describes the low level baking API (the EnlightenBake library).

As an additional resource, the Enlighten SDK includes a sample application called BasicLightmapBaking that implements all these steps on a simple scene. Executing the compiled binary will generate light maps for direct and indirect lighting and ambient occlusion as well as the .scene files that can be viewed in GeoRadiosity. See the source files for more information.

Key

node [fontname=Helvetica, fontsize=10];
a [ shape=folder fillcolor=white color=firebrick label="Input object" ];
b [ shape=note fillcolor=white color=darkslategrey label="Intermediate object" ];
c [ shape=note fillcolor=white color=green4 label="Output object" ];
d [ shape=box fillcolor=white color=goldenrod1 style=rounded label="IBake function" ];
e [ shape=box fillcolor=white color=blue style=rounded label="Other class function" ];

Enlighten SDK 3.10 Documentation > Baking with the low level bake API > fc1.PNG

Bake system definition

The initial stage of the baking is:

Decide which Enlighten IPrecompInputGeometry instances you want in each bake system. Each bake system represents one output lightmap.
Create an IBakeInputSystem for each bake system you want. Ensure the name is unique.
Set the resolution of the system in the Enlighten IBakeInputProperties, and if you are not creating your own lightmap UV stream, turn packing on here also. Use IBakeInputSystem::SetBakeProperties to pass the properties to the bake system.
For each instance in that system, create a Enlighten BakeInputMeshInfo object filling out the fields appropriately, and then call IBakeInputSystem::AddMesh().
Call IBakeInputSystem::Finalise(), and extract the new lightmap UV stream if packing was required.

Outputs from a previous stage are never modified by a later one, so you can often run these stages in parallel (for example, through distributed build systems such as IncrediBuild).

The diagram below shows the creation of one IBakeInputSystem. Repeat for each output map required.

node [fontname=Helvetica, fontsize=10];

ig1	 [ shape=folder fillcolor=white color=firebrick label="IPrecompInputGeometry" URL="API:class IPrecompInputGeometry" ];
ig2	 [ shape=folder fillcolor=white color=firebrick label="IPrecompInputGeometry" URL="API:class IPrecompInputGeometry" ];

pg1	 [ shape=note fillcolor=white color=darkslategrey label="IPrecompPackedGeometry" URL="API:class IPrecompPackedGeometry" ];
pg2	 [ shape=note fillcolor=white color=darkslategrey label="IPrecompPackedGeometry" URL="API:class IPrecompPackedGeometry" ];

ag1	 [ shape=box fillcolor=white color=blue style=rounded label="IBakeInputSystem::AddMesh" URL="API:class IBakeInputSystem" ];
ag2	 [ shape=box fillcolor=white color=blue style=rounded label="IBakeInputSystem::AddMesh" URL="API:class IBakeInputSystem" ];

bs1	 [ shape=folder fillcolor=white color=firebrick label="IBakeInputSystem" URL="API:class IBakeInputSystem" ];

pg1 -> ag1;
ig1 -> ag1 -> bs1;
pg2 -> ag2;
ig2 -> ag2 -> bs1;

Enlighten SDK 3.10 Documentation > Baking with the low level bake API > fc2.PNG

Direct light baking

First, all the bake systems have to be combined into a BakeSystemResource object. This object is used to create a KD tree for the other stages to trace against, so requires updating if any geometry changes.
Next, copy lighting information into an IBakeInputLighting object.
Now, for each BakeSystemResource, create an IBakeVisibilityBuffer with the IBake API. This operation is slow; therefore if only the lights have changed (and not the geometry) you can pass in an IBakeVisibilityBuffer from a previous run and it will be updated.
Call IBake::BakeSystemDirect() to create the IBakeOutputSystemDirect. Optionally pass in a BakeSystemResource object to be able to apply a visibility-aware post-processing filter, with its size set as the filter size baking property. The final output texture, in FP16 format, can be pulled from this object.

The diagrams below show a scene with two IBakeInputSystems; there may be more or fewer than this.

node [fontname=Helvetica, fontsize=10];

bs1_  [ shape=folder fillcolor=white color=firebrick label="IBakeInputSystem" URL="" ];
bs2_  [ shape=folder fillcolor=white color=firebrick label="IBakeInputSystem" URL="" ];
csr_  [ shape=box fillcolor=white color=goldenrod1 style=rounded label="IBake::CreateSystemResource" URL="" ];
sr_   [ shape=note fillcolor=white color=darkslategrey label="IBakeSystemResource" URL="" ];
bs1_ -> csr_;
bs2_ -> csr_;
csr_ -> sr_;

bs1  [ shape=folder fillcolor=white color=firebrick label="IBakeInputSystem" URL="" ];
bs2  [ shape=folder fillcolor=white color=firebrick label="IBakeInputSystem" URL="" ];

light [ shape=folder fillcolor=white color=firebrick label="IBakeInputLighting" URL="" ];
sr   [ shape=note fillcolor=white color=darkslategrey label="IBakeSystemResource" URL="" ];

uvb1 [ shape=box fillcolor=white color=goldenrod1 style=rounded label="IBake::UpdateVisibilityBuffer" URL="" ];
uvb2 [ shape=box fillcolor=white color=goldenrod1 style=rounded label="IBake::UpdateVisibilityBuffer" URL="" ];

vis1 [ shape=note fillcolor=white color=darkslategrey label="IBakeVisibilityBuffer" URL="" ];
vis2 [ shape=note fillcolor=white color=darkslategrey label="IBakeVisibilityBuffer" URL="" ];

bsd1 [ shape=box fillcolor=white color=goldenrod1 style=rounded label="IBake::BakeSystemDirect" URL="" ];
bsd2 [ shape=box fillcolor=white color=goldenrod1 style=rounded label="IBake::BakeSystemDirect" URL="" ];

od1  [ shape=note fillcolor=white color=green4 label="IBakeOutputSystemDirect" URL="" ];
od2  [ shape=note fillcolor=white color=green4 label="IBakeOutputSystemDirect" URL="" ];


bs1 -> uvb1 -> vis1 -> bsd1 -> od1;
bs2 -> uvb2 -> vis2 -> bsd2 -> od2;

vis1 -> uvb1 [constraint=false style=dashed];
vis2 -> uvb2 [constraint=false style=dashed];

light -> uvb1;
light -> uvb2;
sr -> uvb1;
sr -> uvb2;

Enlighten SDK 3.10 Documentation > Baking with the low level bake API > direct_light_baking.png

Indirect light baking

Create an IBakeInputRuntime and fill it with the RadSystemCore and InputWorkspace of each Enlighten system.
For each Enlighten system, create an IBakeInputSystem using all the Radiosity objects of the Enlighten system. This is required later in the process in order to fit the Enlighten lit instances to the bake system instances. Set the resolution of the IBakeInputSystem to the resolution of the Enlighten lightmap via an IBakeInputProperties object passed to the IBakeInputSystem::SetBakeProperties method.
For each Enlighten system, call IBake::CreateRuntimeLighting to create an IBakeRuntimeLighting from:
1. the IBakeInputSystem that you just made
2. the IPrecompSystemDuster
3. the IPrecompPackedSystem
4. the global IBakeInputLighting
For each runtime lighting you made:
1. For each bake system representing the output lightmaps:
  1. Call IBake::UpdateRuntimeLighting to apply the light and albedo information for each bake system to the Enlighten system.
2. Call IBake::FinaliseRuntimeLighting
Call IBake::RunEnlightenSolver; this takes all the information and spins a small Enlighten Runtime until the lighting values settle. This is run only once as it contains information about every system in the bake.
For each bake system, call IBake::BakeSystemIndirect and extract the indirect lighting from the IBakeOutputSystemIndirect it creates. Optionally pass in a BakeSystemResource object and a IBakeInputRayOriginPositions to be able to enable visibility-aware upsampling with the identically named baking property.

node [fontname=Helvetica, fontsize=10];

epd1 [ shape=note fillcolor=white color=darkslategrey label="Enlighten Precompute Data" URL="" ];
ebs1 [ shape=folder fillcolor=white color=firebrick label="IBakeInputSystem (Enlighten)" URL="" ];
ebs2 [ shape=folder fillcolor=white color=firebrick label="IBakeInputSystem (Enlighten)" URL="" ];
epd2 [ shape=folder fillcolor=white color=darkslategrey label="Enlighten Precompute Data" URL="" ];

light1  [ shape=folder fillcolor=white color=firebrick label="IBakeInputLighting" URL="" ];

crl1 [ shape=box fillcolor=white color=goldenrod1 style=rounded label="IBake::CreateRuntimeLighting" URL="" ];
crl2 [ shape=box fillcolor=white color=goldenrod1 style=rounded label="IBake::CreateRuntimeLighting" URL="" ];

rl1  [ shape=note fillcolor=white color=darkslategrey label="IBakeRuntimeLighting" URL="" ];
rl2  [ shape=note fillcolor=white color=darkslategrey label="IBakeRuntimeLighting" URL="" ];


bs1  [ shape=folder fillcolor=white color=firebrick label="IBakeInputSystem (Baking)" URL="" ];
bs2  [ shape=folder fillcolor=white color=firebrick label="IBakeInputSystem (Baking)" URL="" ];

url11 [ shape=box fillcolor=white color=goldenrod1 style=rounded label="IBake::UpdateRuntimeLighting" URL="" ];
url12 [ shape=box fillcolor=white color=goldenrod1 style=rounded label="IBake::UpdateRuntimeLighting" URL="" ];
url21 [ shape=box fillcolor=white color=goldenrod1 style=rounded label="IBake::UpdateRuntimeLighting" URL="" ];
url22 [ shape=box fillcolor=white color=goldenrod1 style=rounded label="IBake::UpdateRuntimeLighting" URL="" ];

rl1a [ shape=note fillcolor=white color=darkslategrey label="IBakeRuntimeLighting" URL="" ];
rl2a [ shape=note fillcolor=white color=darkslategrey label="IBakeRuntimeLighting" URL="" ];

frl1 [ shape=box fillcolor=white color=goldenrod1 style=rounded label="IBake::FinaliseRuntimeLighting" URL="" ];
frl2 [ shape=box fillcolor=white color=goldenrod1 style=rounded label="IBake::FinaliseRuntimeLighting" URL="" ];

rl1b [ shape=note fillcolor=white color=darkslategrey label="IBakeRuntimeLighting" URL="" ];
rl2b [ shape=note fillcolor=white color=darkslategrey label="IBakeRuntimeLighting" URL="" ];

rs   [ shape=box fillcolor=white color=goldenrod1 style=rounded label="IBake::RunEnlightenSolver" URL="" ];

bsr  [ shape=note fillcolor=white color=darkslategrey label="IBakeSolvedRuntime" URL="" ];

sr1  [ shape=note fillcolor=white color=darkslategrey label="IBakeSystemResource" URL="" ];
sr2  [ shape=note fillcolor=white color=darkslategrey label="IBakeSystemResource" URL="" ];

bsi1   [ shape=box fillcolor=white color=goldenrod1 style=rounded label="IBake::BakeSystemIndirect" URL="" ];
bsi2   [ shape=box fillcolor=white color=goldenrod1 style=rounded label="IBake::BakeSystemIndirect" URL="" ];

oi1  [ shape=note fillcolor=white color=green4 label="IBakeOutputSystemIndirect" URL="" ];
oi2  [ shape=note fillcolor=white color=green4 label="IBakeOutputSystemIndirect" URL="" ];


ebs1 -> crl1 -> rl1;
epd1 -> crl1;
rl1 -> url11 -> rl1a;
rl1 -> url12 -> rl1a;
rl1a -> frl1 -> rl1b -> rs;

ebs2 -> crl2 -> rl2;
epd2 -> crl2;
rl2 -> url21 -> rl2a;
rl2 -> url22 -> rl2a;
rl2a -> frl2 -> rl2b -> rs;

bs1 -> url11 [style=dashed];
bs1 -> url21 [constraint=false style=dashed];
bs2 -> url12 [constraint=false style=dashed];
bs2 -> url22 [style=dashed];

light1 -> crl1;
light1 -> crl2;

rs -> bsr;

sr1 -> bsi1 -> oi1;
sr2 -> bsi2 -> oi2;
bsr -> bsi1;
bsr-> bsi2;

Enlighten SDK 3.10 Documentation > Baking with the low level bake API > fc4.PNG

Final Gather light baking

Final Gather creates a refined version of the indirect lightmap through ray tracing, by using previously calculated indirect and direct lightmaps. The final gather baking thus has a dependency on all the IBakeOutputSystemIndirect and all the IBakeOutputSystemDirect objects previously created for the baked scene, as well as their matching IBakeInputSystem objects. It also has a dependency on the IBakeSystemResource object (used for raytracing) and the IBakeSolvedRuntime objects for the baked scene.

For each IBakeInputSystem, call IBake::BakeSystemFinalGather.
Extract the FP16 output textures from the resulting IBakeOutputSystemFinalGather objects.

node [fontname=Helvetica, fontsize=10];
ips [ shape=folder fillcolor=white color=firebrick label="IBakeInputSystem" URL="" ];
sr [ shape=note fillcolor=white color=darkslategrey label="IBakeSystemResource" URL="" ];
srt [ shape=note fillcolor=white color=darkslategrey label="IBakeSolvedRuntime" URL="" ];
sod [ shape=note fillcolor=white color=green4 label="IBakeOutputSystemDirect" URL="" ];
soi [ shape=note fillcolor=white color=green4 label="IBakeOutputSystemIndirect" URL="" ];
bsfg [ shape=box fillcolor=white color=goldenrod1 style=rounded label="IBake::BakeSystemFinalGather" URL="" ];
sfg [ shape=note fillcolor=white color=green4 label="IBakeOutputSystemFinalGather" URL="" ];
ips -> bsfg;
sr -> bsfg;
srt -> bsfg;
sod -> bsfg;
soi -> bsfg;
bsfg -> sfg;

Enlighten SDK 3.10 Documentation > Baking with the low level bake API > Final Gather flowchart.png

Ambient occlusion

For each BakeSystemResource, call IBake::BakeSystemAO.
Extract the FP16 output textures from the resulting IBakeOutputSystemAO objects.

node [fontname=Helvetica, fontsize=10];
sr1  [ shape=folder fillcolor=white color=firebrick label="IBakeSystemResource" URL="" ];
bao1 [ shape=box fillcolor=white color=goldenrod1 style=rounded label="IBake::BakeSystemAO" URL="" ];
ao1  [ shape=note fillcolor=white color=green4 label="IBakeOutputSystemAO" URL="" ];
sr1 -> bao1 -> ao1;

Enlighten SDK 3.10 Documentation > Baking with the low level bake API > fc5.PNG

Direct light baking for probes

First, copy lighting information into an IBakeInputLighting object.
Now, for each probe set represented by an IPrecompInputProbeSet, create an IBakeVisibilityBuffer with the IBake API. You also need to pass in a BakeSystemResource object, with all the systems that can influence the direct lighting for the probes. This operation is slow; therefore if only the lights have changed (and not the geometry) you can pass in an IBakeVisibilityBuffer from a previous run and it will be updated.
Call IBake::BakeProbeSetDirect() to create the IBakeOutputProbeSet. Use the IBakeOutputProbeSet::GetOutput() method to retrieve the SH coefficients of all probes in the probe set.

node [fontname=Helvetica, fontsize=10];
ips1  [ shape=folder fillcolor=white color=firebrick label="IPrecompInputProbeSet" URL="" ];
bsr1  [ shape=folder fillcolor=white color=firebrick label="IBakeSystemResource" URL="" ];
upvb1 [ shape=box fillcolor=white color=goldenrod1 style=rounded label="IBake::UpdateProbeVisibilityBuffer" URL="" ];
bvb1  [ shape=folder fillcolor=white color=firebrick label="IBakeVisibilityBuffer" URL="" ];

ips2  [ shape=folder fillcolor=white color=firebrick label="IPrecompInputProbeSet" URL="" ];
bvb2  [ shape=folder fillcolor=white color=firebrick label="IBakeVisibilityBuffer" URL="" ];
bpsd2 [ shape=box fillcolor=white color=goldenrod1 style=rounded label="IBake::BakeProbeSetDirect" URL="" ];
bops2  [ shape=note fillcolor=white color=green4 label="IBakeOutputProbeSet" URL="" ];

ips1 -> upvb1;
bsr1 -> upvb1;
upvb1 -> bvb1;

ips2 -> bpsd2;
bvb2 -> bpsd2;
bpsd2 -> bops2;

Enlighten SDK 3.10 Documentation > Baking with the low level bake API > Direct light baking for probes flowchart.png

Indirect light baking for probes

First follow the steps described in Indirect light baking.
Now, for each probe in a probe set, use the IBakeSolvedRuntime::GetSolvedProbe() method of IBakeSolvedRuntime to retrieve the SH coefficients.

bsr1 [ shape=folder fillcolor=white color=firebrick label="IBakeSolvedRuntime" URL="" ];
gsp1 [ shape=box fillcolor=white color=blue style=rounded label="IBakeSolvedRuntime::GetSolvedProbe" URL="" ];
ipv1  [ shape=note fillcolor=white color=green4 label="Individual probe value" URL="" ];

bsr1 -> gsp1;
gsp1 -> ipv1;

Enlighten SDK 3.10 Documentation > Baking with the low level bake API > Indirect light baking for probes flowchart.png

Baked Radiosity Normal Texture

The baked radiosity normal texture is needed when using baked directional irradiance to better bring out features when the fine-grained shading normal used in runtime deviates from the cruder normal used for computing radiosity. (typical example is re-lighting normal maps)

For each BakeInputSystem, call IBake::BakeSystemRadiosityNormal, providing the BakeSolvedRuntime for all Enlighten systems.
Extract the FP16 output textures from the resulting IBakeOutputSystemRadiosityNormal objects.

node [fontname=Helvetica, fontsize=10];
ips  [ shape=folder fillcolor=white color=firebrick label="IBakeInputSystem" URL="" ];
sr  [ shape=note fillcolor=white color=darkslategrey label="IBakeSolvedRuntime" URL="" ];
bsrn [ shape=box fillcolor=white color=goldenrod1 style=rounded label="IBake::BakeSystemRadiosityNormal" URL="" ];
srn  [ shape=note fillcolor=white color=green4 label="IBakeOutputSystemRadiosityNormal" URL="" ];
ips -> bsrn;
sr -> bsrn;
bsrn -> srn;

Enlighten SDK 3.10 Documentation > Baking with the low level bake API > Baked Radiosity Normal Texture flowchart.png

Message reporting and error handling

If you experience problems when using the Low Level Precompute API, call the GeoAttachSystemLoggers/GeoAttachLogger functions to issue error and warning messages. For more information, see the API documentation at module Message Reporting and Error Handling.

Debugging using GeoRadiosity

To debug scenes with baked light maps using GeoRadiosity, follow the steps required for the low-level precompute API. In addition to the precompute input files, you also need to serialise the IBakeInputSystem and IBakeInputProperties objects. Please note that you should have assigned a GUID to the IBakeInputProperties because this identifier is used to link the properties with the generated light maps.

If you pass in different chart UVs to the low-level baking API than to the low-level precompute API, you must generate an object of the IBakeInputGeometryUvs class for each geometry in your scene. This file must have the same file name as the serialised IPrecompInputGeometry object, but with the extension changed to .buv.

Additionally, to support materials in baking, you must generate XML-based material files as used in the high-level build system. For each IPrecompInputGeometry you have, a material file can be created for each mesh with the index of the mesh appended to the file name and the extension changed to .mats. For example, if your serialized IPrecompInputGeometry is called Geom.ig and contains two meshes, then you should create two materials files called Geom_0.mats and Geom_1.mats. Please note that this is optional and only required if you need to reproduce the materials in the reconstructed scene; for example if it important for your debugging effort.

Any referenced texture in the materials file should have a file path relative to the material file. Use the GeoRGBXTexture class to serialise the texture.

Only scenes which assign instances to light maps can be extracted. Scenes which map individual meshes to light maps are currently not supported.