Skip to content
Entropy Documentation

EntropyCanvas::LightProbeComponent

EntropyCanvas::LightProbeComponent

Section titled “EntropyCanvas::LightProbeComponent”

Single light probe component for SG-based ambient lighting. More…

#include <GlobalIllumination.h>

Public Functions

Section titled “Public Functions”
Name
ENTROPY_REGISTER_TYPE(LightProbeComponent )
ENTROPY_FIELD_EXTENSION(uint32_t , captureResolution )
ENTROPY_FIELD(float , influenceRadius )
ENTROPY_FIELD(float , intensity )
ENTROPY_FIELD(SGLobeConfig , lobeConfig )
ENTROPY_FIELD(ProbeUpdatePriority , updatePriority )

Public Attributes

Section titled “Public Attributes”
Name
uint32_tprobeIndex
boolneedsCapture

Detailed Description

Section titled “Detailed Description”
struct EntropyCanvas::LightProbeComponent;

Single light probe component for SG-based ambient lighting.

Unlike ProbeVolumeComponent which creates a 3D grid of probes, this places a single SG light probe at a specific location. Simpler and more efficient for small scenes or isolated areas.

Public Functions Documentation

Section titled “Public Functions Documentation”

function ENTROPY_REGISTER_TYPE

Section titled “function ENTROPY_REGISTER_TYPE”
ENTROPY_REGISTER_TYPE(
    LightProbeComponent
)

function ENTROPY_FIELD_EXTENSION

Section titled “function ENTROPY_FIELD_EXTENSION”
ENTROPY_FIELD_EXTENSION(
    uint32_t ,
    captureResolution
)

function ENTROPY_FIELD

Section titled “function ENTROPY_FIELD”
ENTROPY_FIELD(
    float ,
    influenceRadius
)

function ENTROPY_FIELD

Section titled “function ENTROPY_FIELD”
ENTROPY_FIELD(
    float ,
    intensity
)

function ENTROPY_FIELD

Section titled “function ENTROPY_FIELD”
ENTROPY_FIELD(
    SGLobeConfig ,
    lobeConfig
)

function ENTROPY_FIELD

Section titled “function ENTROPY_FIELD”
ENTROPY_FIELD(
    ProbeUpdatePriority ,
    updatePriority
)

Public Attributes Documentation

Section titled “Public Attributes Documentation”

variable probeIndex

Section titled “variable probeIndex”
uint32_t probeIndex {UINT32_MAX};

variable needsCapture

Section titled “variable needsCapture”
bool needsCapture {true};

Updated on 2026-01-26 at 17:14:35 -0500