This is the documentation for Enlighten.

class Enlighten MetaBlockBuilder

Owned by

Sept 06, 2020

2 min read

class Enlighten::MetaBlockBuilder

Builds compact blocks of metadata which can be loaded by the Enlighten3Meta library.

Usage:

Call the AddXXX() methods to register all the different bits of scene metadata.
Call Compile() to compress all the registered metadata into a single metadata block (MetaBlock).
(Optionally) save the MetaBlock to a stream/file using the functions in Enlighten3Meta/MetaUtils.h.

Classes

Name	Description
Enlighten::MetaBlockBuilder::BaseLightMeta	Input data describing a base light (shared by spotlights, point lights etc.).
Enlighten::MetaBlockBuilder::CubeMapMeta	Input data describing a cube map.
Enlighten::MetaBlockBuilder::DirectionalLightMeta	Input data describing a directional light.
Enlighten::MetaBlockBuilder::EnvironmentLightMeta	Input data describing an environment light.
Enlighten::MetaBlockBuilder::GeomMeshMeta	Input data describing a geom mesh.
Enlighten::MetaBlockBuilder::GeomMeta	Input data describing a geom.
Enlighten::MetaBlockBuilder::InstanceMeta	Input data describing an instance.
Enlighten::MetaBlockBuilder::ParamSetMeta	Input data describing a paramset.
Enlighten::MetaBlockBuilder::PointLightMeta	Input data describing a point light.
Enlighten::MetaBlockBuilder::ProbeSetMeta	Input data describing a probe set.
Enlighten::MetaBlockBuilder::SourceMeshInstanceMeta	Input data describing a source mesh instance.
Enlighten::MetaBlockBuilder::SpotlightMeta	Input data describing a spotlight.
Enlighten::MetaBlockBuilder::SystemMeta	Input data describing a system.

Functions

Name	Description
AddCubeMap(const CubeMapMeta &)	Register scene metadata with the builder.
AddDirectionalLight(const DirectionalLightMeta &)	Register scene metadata with the builder.
AddEnvironmentLight(const EnvironmentLightMeta &)	Register scene metadata with the builder.
AddGeom(const GeomMeta &)	Register scene metadata with the builder.
AddGeomMesh(const GeomMeshMeta &)	Register scene metadata with the builder.
AddInstance(const InstanceMeta &)	Register scene metadata with the builder.
AddParamSet(const ParamSetMeta &)	Register scene metadata with the builder.
AddPointLight(const PointLightMeta &)	Register scene metadata with the builder.
AddProbeSet(const ProbeSetMeta &)	Register scene metadata with the builder.
AddSourceMeshInstance(const SourceMeshInstanceMeta &)	Register scene metadata with the builder.
AddSpotlight(const SpotlightMeta &)	Register scene metadata with the builder.
AddSystem(const SystemMeta &)	Register scene metadata with the builder.

void Enlighten::MetaBlockBuilder::AddCubeMap

public: void AddCubeMap
(
const CubeMapMeta & cubeMap
)

Register scene metadata with the builder.

void Enlighten::MetaBlockBuilder::AddDirectionalLight

public: void AddDirectionalLight
(
const DirectionalLightMeta & directionalLight
)

Register scene metadata with the builder.

void Enlighten::MetaBlockBuilder::AddEnvironmentLight

public: void AddEnvironmentLight
(
const EnvironmentLightMeta & environmentLight
)

Register scene metadata with the builder.

void Enlighten::MetaBlockBuilder::AddGeom

public: void AddGeom
(
const GeomMeta & geom
)

Register scene metadata with the builder.

void Enlighten::MetaBlockBuilder::AddGeomMesh

public: void AddGeomMesh
(
const GeomMeshMeta & geomMesh
)

Register scene metadata with the builder.

void Enlighten::MetaBlockBuilder::AddInstance

public: void AddInstance
(
const InstanceMeta & instance
)

Register scene metadata with the builder.

void Enlighten::MetaBlockBuilder::AddParamSet

public: void AddParamSet
(
const ParamSetMeta & paramSet
)

Register scene metadata with the builder.

void Enlighten::MetaBlockBuilder::AddPointLight

public: void AddPointLight
(
const PointLightMeta & pointLight
)

Register scene metadata with the builder.

void Enlighten::MetaBlockBuilder::AddProbeSet

public: void AddProbeSet
(
const ProbeSetMeta & probeSet
)

Register scene metadata with the builder.

void Enlighten::MetaBlockBuilder::AddSourceMeshInstance

public: void AddSourceMeshInstance
(
const SourceMeshInstanceMeta & sourceMeshInstance
)

Register scene metadata with the builder.

void Enlighten::MetaBlockBuilder::AddSpotlight

public: void AddSpotlight
(
const SpotlightMeta & spotlight
)

Register scene metadata with the builder.

void Enlighten::MetaBlockBuilder::AddSystem

public: void AddSystem
(
const SystemMeta & system
)

Register scene metadata with the builder.