module Low Level API

This module contains the interfaces/objects used when dealing with the Low Level API.

Classes

Functions

Enums

Typedefs

Variables

void GEO_CALL Enlighten::CalculateUvScaleAndWorldOutputPixelSize

---

public: void GEO_CALL CalculateUvScaleAndWorldOutputPixelSize
(
    float geomOutputPixelSize,
    const Geo::Matrix & instanceTransform,
    bool scaleUvsWithInstanceSize,
    float instanceAdditionalUvScale,
    Geo::s32 & outUvScale,
    float & outWorldOutputPixelSize
)

---

Utility to calculate the correct UV scaling and world-space output pixel size for a given instance of a given geometry.

This depends on the instance transform, the "ScaleUvsWithInstanceSize" flag on the instance, the "AdditionalUvScale" value on the instance and the output pixel size on the geom.

Parameters

PppiAtlasMaxima GEO_CALL Enlighten::ComputePppiAtlasMaxima

---

public: PppiAtlasMaxima GEO_CALL ComputePppiAtlasMaxima
(
    Geo::u32 probeSetCount,
    const PrecompOctreeCode * octreeCodes,
    const PppiAtlasFootprint * footprints
)

---

Return the maximum number of atlas tiles and probes that may be concurrently allocated for the given combination of probe sets.

Parameters

Geo::s32 GEO_CALL Enlighten::ConvertInputSystemToIPrecompGeneratedSystem

---

public: Geo::s32GEO_CALL ConvertInputSystemToIPrecompGeneratedSystem
(
    Enlighten::IPrecompInputSystem * inputSystem,
    const IPrecompInputGeometry *const * pInputGeoms,
    Geo::s32 numGeoms,
    Enlighten::IPrecompGeneratedSystems *& generatedSystem
)

---

Create an IPrecompGeneratedSystems object from inputSystem.

The generatedSystem object will have only one system in it (inputSystem) Note that the output object (generatedSystem) owns the input system, e.g. inputSystem will be destroyed when generatedSystem is destroyed.

Parameters

Returns

0 if successful, otherwise a non-zero value.

Enlighten::IClusteringOutput* GEO_CALL Enlighten::CreateDebugEnvironmentClustering

---

public: Enlighten::IClusteringOutput *GEO_CALL CreateDebugEnvironmentClustering
(
    Geo::s32 environmentResolution
)

---

Creates a debug IClusteringOutput interface representing the clustering of an environment at the given resolution.

IPrecompute* Enlighten::CreatePrecompute

---

public: IPrecompute * CreatePrecompute()

---

Create an instance of the Precompute.

Geo::TriGroupSelection* GEO_CALL Enlighten::CreateTriGroupsForPrecompInputMesh

---

public: Geo::TriGroupSelection *GEO_CALL CreateTriGroupsForPrecompInputMesh
(
    const IPrecompInputMesh * inputMesh
)

---

Utility to create the tri group structure defined by the input mesh.

This can be used to generate the same tri groups the precompute will generate when given this mesh. The tri groups are determined by the connectivity in the index buffer (ie. shared vertices) and the links (Geo::IdxLink) specified or generated by the user.

Parameters

The resulting structure should be released by the caller.

Returns

A valid tri group if successful, else null.

Geo::s32 GEO_CALL Enlighten::EstimateSystemDependencies

---

public: Geo::s32GEO_CALL EstimateSystemDependencies
(
    const Enlighten::InstanceDescMinimal< IPrecompInputGeometry > * instances,
    Geo::s32 numInstances,
    const Enlighten::SystemGrouping * iSystemGrouping,
    Enlighten::SystemDependencies *& oSystemDependencies
)

---

Estimate the dependencies between a set of systems.

Uses the instance bounding boxes to determine the system bounding boxes, and a collection of bounding box/sphere intersection tests to determine the dependencies. The function can be given either IPrecompInputGeometry or IPrecompPackedGeometry. Results will be identical.

Parameters

Returns

0 if successful, otherwise a non-zero value.

Geo::s32 GEO_CALL Enlighten::EstimateSystemDependencies

---

public: Geo::s32GEO_CALL EstimateSystemDependencies
(
    const Enlighten::InstanceDescMinimal< IPrecompPackedGeometry > * instances,
    Geo::s32 numInstances,
    const Enlighten::SystemGrouping * iSystemGrouping,
    Enlighten::SystemDependencies *& oSystemDependencies
)

---

Estimate the dependencies between a set of systems.

Uses the instance bounding boxes to determine the system bounding boxes, and a collection of bounding box/sphere intersection tests to determine the dependencies. The function can be given either IPrecompInputGeometry or IPrecompPackedGeometry. Results will be identical.

Parameters

Returns

0 if successful, otherwise a non-zero value.

Geo::v128 GEO_CALL Enlighten::GetOctreeCodeWorldPositionAndSize

---

public: Geo::v128GEO_CALL GetOctreeCodeWorldPositionAndSize
(
    PrecompOctreeCode octreeCode,
    float voxelSize
)

---

Return the world space position (xyz) and size (w) of the octree block identified by the specified octree code with the specified voxel size.

bool Enlighten::IsClosedMesh

---

public: bool IsClosedMesh
(
    Geo::StridedArrayView< PrecompIndex3 > faces
)

---

Return true if the mesh is closed.

Geo::GeoArray<PrecompIndex3> Enlighten::RepairHoles

---

public: Geo::GeoArray< PrecompIndex3 > RepairHoles
(
    Geo::StridedArrayView< PrecompIndex3 > faces
)

---

Return the faces which must be added to the mesh to repair holes.

Each hole is filled with a triangle fan. The mesh cannot be repaired if any two holes share a common vertex.

void GEO_CALL Enlighten::StoreTemporaryScaleAndTranslation

---

public: void GEO_CALL StoreTemporaryScaleAndTranslation
(
    Enlighten::PrecompOutputInstance * outputInstance,
    Geo::s32 uvScale,
    Geo::s32 precompBlockSize
)

---

Utility to temporarily pack scale and translation into the PrecompOutputInstance object.

This later gets overridden

Parameters

eAutoSimpMode

---

public: enum eAutoSimpMode
{
    ASM_NONE = 0,
    ASM_SIMPLIFY_NO_UVS,
    ASM_SIMPLIFY_USING_UVS,
    NUM_AUTO_SIMP_MODES
}

---

The UV auto generation / simplification mode for a mesh.

Used as part of PrecompMeshProperties.

enumerators

eMeshClassificationLightingType

---

public: enum eMeshClassificationLightingType
{
    MCLT_LIGHTMAP,
    MCLT_PROBE
}

---

Enumeration for reporting results of the first step of Mesh Classification (lightmap-lit or probe-lit).

enumerators

ePrecompCubeMapQuality

---

public: enum ePrecompCubeMapQuality
{
    PCMQ_LOW = 1,
    PCMQ_MEDIUM = 4,
    PCMQ_HIGH = 16,
    PCMQ_VERY_HIGH = 64
}

---

Quality levels for the raytracing in the cube map precompute.

Each levels correspond to a number of rays that get generated and cast per pixel.

enumerators

ePrecompQuality

---

public: enum ePrecompQuality
{
    PCQ_DEBUG = 16,
    PCQ_DRAFT = 512,
    PCQ_LOW = 2048,
    PCQ_MEDIUM = 8192,
    PCQ_HIGH = 32768,
    PCQ_VERY_HIGH = 131072
}

---

Quality levels for majority of raytracing in the precompute, except cube maps.

Each levels correspond to a number of rays that get generated and than cast over the sphere and/or hemisphere. More rays result in a better approximation and therefore higher quality.

enumerators

GeometryBuildResult

---

public: enum GeometryBuildResult
{
    GEOM_BUILD_SUCCESS = 0,
    GEOM_BUILD_INVALID_MESH_INPUT = -1,
    GEOM_BUILD_INVALID_MESH_PROPERTIES = -2,
    GEOM_BUILD_PRECOMPUTE_FAILURE = -3,
    GEOM_BUILD_EMPTY = -4,
    GEOM_BUILD_USER_CANCELLED = -5,
    GEOM_BUILD_INVALID_TERRAIN = -6,
    GEOM_BUILD_INVALID_GEOM_PROPERTIES = -7
}

---

Enumeration for reporting geometry build success/fail.

enumerators

ProbeOctreeResolution

---

public: enum ProbeOctreeResolution
{
    PROBEOCTREERESOLUTION_FULL,
    PROBEOCTREERESOLUTION_HALF,
    PROBEOCTREERESOLUTION_QUARTER,
    PROBEOCTREERESOLUTION_EIGHTH,
    PROBEOCTREERESOLUTION_SIXTEENTH,
    PROBEOCTREERESOLUTION_1_IN_32,
    PROBEOCTREERESOLUTION_1_IN_64,
    PROBEOCTREERESOLUTION_1_IN_128,
    PROBEOCTREERESOLUTION_1_IN_256,
    PROBEOCTREERESOLUTIONCOUNT,
    PROBEOCTREERESOLUTION_NONE = PROBEOCTREERESOLUTIONCOUNT
}

---

The resolution at which probes should be placed.

enumerators

VolumeQueryResult

---

public: enum VolumeQueryResult
{
    VOLUMEQUERYESULT_OUTSIDE,
    VOLUMEQUERYESULT_PARTIAL,
    VOLUMEQUERYESULT_INSIDE
}

---

The result of a volume query.

enumerators