Class ProbesRenderer

Probes rendering service

Inheritance

ProbesRenderer

Assembly: FlaxEngine.dll

File: Engine/Renderer/ProbesRenderer.h

Syntax

public class ProbesRenderer

Fields

MaxWorkPerFrame

Maximum amount of cubemap faces or filtering passes that can be performed per-frame (in total). Set it to 7 to perform whole cubemap capture within a single frame, lower values spread the work across multiple frames.

Declaration

public static int32 MaxWorkPerFrame

Field Value

int32

OnFinishBake

Declaration

public static Delegate<Actor* > OnFinishBake

Field Value

Delegate<Actor >

OnRegisterBake

Declaration

public static Delegate<Actor* > OnRegisterBake

Field Value

Delegate<Actor >

ReleaseTimeout

Timeout after the last probe rendered when resources used to render it should be released.

Declaration

public static TimeSpan ReleaseTimeout

Field Value

TimeSpan

UpdateDelay

Time delay between probe updates. Can be used to improve performance by rendering probes less often.

Declaration

public static TimeSpan UpdateDelay

Field Value

TimeSpan

Methods

Bake(class EnvironmentProbe* probe, float timeout = 0)

Register probe to baking service.

Declaration

public static void Bake(class EnvironmentProbe* probe, float timeout = 0)

Parameters

class EnvironmentProbe probe Probe to bake

float timeout Timeout in seconds left to bake it.

Bake(class SkyLight* probe, float timeout = 0)

Register probe to baking service.

Declaration

public static void Bake(class SkyLight* probe, float timeout = 0)

Parameters

class SkyLight probe Probe to bake

float timeout Timeout in seconds left to bake it.