Component:ReflectionProbe: Difference between revisions

From Resonite Wiki
Automated: create new component page
 
add some info
Line 3: Line 3:
|Name=Reflection Probe
|Name=Reflection Probe
}}
}}
{{stub}}
A reflection probe component is used to make points in space that makes reflective surfaces within a box around the point show a different reflection map than the skybox. This is useful for controlling the lighting and look of a scene.


== Usage ==
== Usage ==
{{Table ComponentFields
{{Table ComponentFields
|ProbeType|'''[[#Type|Type]]'''|TypeAdv0=true|
|ProbeType|'''[[#Type|Type]]'''|TypeAdv0=true| What mode this reflection probe uses.
|Importance|Int|
|Importance|Int| How much priority this probe takes over another probe when two probes overlap
|Intensity|Float|
|Intensity|Float| how strong or bright the reflection is
|BlendDistance|Float|
|BlendDistance|Float| how far the probe will slowly take over the reflection map of objects as an object goes towards the center of influence
|BoxSize|Float3|
|BoxSize|Float3| the area that this reflection probe will affect the reflection maps of objects
|BoxProjection|Bool|
|BoxProjection|Bool| project the reflection map in a box shape from the reflection probe rather than a sphere.
|BakedCubemap|{{RootFieldType|AssetRef`1|[[Type:Cubemap|Cubemap]]}}|TypeAdv6=true|
|BakedCubemap|{{RootFieldType|AssetRef`1|[[Type:Cubemap|Cubemap]]}}|TypeAdv6=true| The cube map to replace the refection maps of reflective objects with in the influence area of this reflection probe
|TimeSlicing|'''[[#TimeSlicingMode|TimeSlicingMode]]'''|TypeAdv7=true|
|TimeSlicing|'''[[#TimeSlicingMode|TimeSlicingMode]]'''|TypeAdv7=true|
|Resolution|Int|
|Resolution|Int| the forced resolution of the reflection map from this reflection probe shown in the reflections of shiny objects.
|HDR|Bool|
|HDR|Bool|
|ShadowDistance|Float|
|ShadowDistance|Float| how far to render shadows from the reflection probe
|ClearFlags|'''[[#Clear|Clear]]'''|TypeAdv11=true|
|ClearFlags|'''[[#Clear|Clear]]'''|TypeAdv11=true| Whether to use the skybox or color when backing transparent pixels
|BackgroundColor|ColorX|
|BackgroundColor|ColorX| The color to clear with when <code>ClearFlags</code> is set to "Color"
|NearClip|Float|
|NearClip|Float| The closest distance to render from the reflection probe center when using "Realtime" on <code>ProbeType</code>
|FarClip|Float|
|FarClip|Float| The furthest distance to render from the reflection probe center when using "Realtime" on <code>ProbeType</code>
|ShowDebugVisuals|Bool|
|ShowDebugVisuals|Bool| Shows the box influence area and the center point of this reflection probe
|_debugVisual|{{RootFieldType|SlotCleanupRef`1|[[Type:Slot|Slot]]}}|TypeAdv16=true|
|_debugVisual|{{RootFieldType|SlotCleanupRef`1|[[Type:Slot|Slot]]}}|TypeAdv16=true| The current debug visual that this reflection probe is showing, if applicable.
}}
}}
== Type ==
An [[:Category:Enums|Enum]] of "Realtime" or "Baked" realtime renders a new cube map outwards from the center of the probe every second while baked will use the provided <code>BakedCubemap</code>
== Clear ==
An [[:Category:Enums|Enum]] of "Skybox" or "Color". Color backs the transparent parts of the reflection map with <code>BackgroundColor</code> due to far or near clipping with realtime, or transparent pixels in the provided <code>BakedCubemap</code>. Skybox when selected will instead back transparent parts with the Skybox of the world.


== Behavior ==
== Behavior ==

Revision as of 18:15, 12 May 2024

Component image 
Reflection Probe component as seen in the Scene Inspector

A reflection probe component is used to make points in space that makes reflective surfaces within a box around the point show a different reflection map than the skybox. This is useful for controlling the lighting and look of a scene.

Usage

Fields
Name Type Description
persistent Bool Determines whether or not this item will be saved to the server.
UpdateOrder Int Controls the order in which this component is updated.
Enabled Bool Controls whether or not this component is enabled.
ProbeType Type What mode this reflection probe uses.
Importance Int How much priority this probe takes over another probe when two probes overlap
Intensity Float how strong or bright the reflection is
BlendDistance Float how far the probe will slowly take over the reflection map of objects as an object goes towards the center of influence
BoxSize Float3 the area that this reflection probe will affect the reflection maps of objects
BoxProjection Bool project the reflection map in a box shape from the reflection probe rather than a sphere.
BakedCubemap Cubemap The cube map to replace the refection maps of reflective objects with in the influence area of this reflection probe
TimeSlicing TimeSlicingMode
Resolution Int the forced resolution of the reflection map from this reflection probe shown in the reflections of shiny objects.
HDR Bool
ShadowDistance Float how far to render shadows from the reflection probe
ClearFlags Clear Whether to use the skybox or color when backing transparent pixels
BackgroundColor ColorX The color to clear with when ClearFlags is set to "Color"
NearClip Float The closest distance to render from the reflection probe center when using "Realtime" on ProbeType
FarClip Float The furthest distance to render from the reflection probe center when using "Realtime" on ProbeType
ShowDebugVisuals Bool Shows the box influence area and the center point of this reflection probe
_debugVisual direct SlotCleanupRef`1<Slot> The current debug visual that this reflection probe is showing, if applicable.

Type

An Enum of "Realtime" or "Baked" realtime renders a new cube map outwards from the center of the probe every second while baked will use the provided BakedCubemap

Clear

An Enum of "Skybox" or "Color". Color backs the transparent parts of the reflection map with BackgroundColor due to far or near clipping with realtime, or transparent pixels in the provided BakedCubemap. Skybox when selected will instead back transparent parts with the Skybox of the world.

Behavior

Examples

See Also