Api Sandbox EnvmapProbe
class

EnvmapProbe

public sealed class EnvmapProbe : Component

A cubemap probe that captures the environment around it.

Constructors

EnvmapProbe()

Properties

Name Type Description
Mode EnvmapProbeMode
Projection ProjectionMode
TintColor Color
Bounds BBox
Feathering Single
Priority Int32 Gets or sets the priority level for the object.
Texture Texture If this is set, the EnvmapProbe will use a custom cubemap texture instead of rendering dynamically
BakedTexture Texture The texture that was baked for this envmap probe
RenderDynamically Boolean
Resolution CubemapResolution Resolution of the cubemap texture
ZNear Single
ZFar Single
UpdateStrategy CubemapDynamicUpdate
MaxDistance Single Only update dynamically if we're this close to it
DelayBetweenUpdates Single
FrameInterval Int32
MultiBounce Boolean Minimum amount of reflection bounces to render when first enabled before settling, at cost of extra performance on load Often times you don't need this
ComponentVersion virtual Int32

Methods

Task Bake(CancellationToken ct = null)

Bake this envmap now. This will stop it being dynamic if it was.

static Task BakeAll()

Fields

Name Type Description
Dirty Boolean
Assembly: Sandbox.Engine Namespace: Sandbox Full Name: Sandbox.EnvmapProbe