Component:ReflectionProbeSH2: Difference between revisions

Latest revision as of 03:16, 1 August 2025

Component image

Reflection Probe SH2 component as seen in the Scene Inspector

The Reflection Probe SH2 component is used to turn what a ReflectionProbe sees into a spherical harmonic for use in ambient lighting like a AmbientLightSH2 component.

Fields

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. Some components stop their functionality when this field is disabled, but some don't.
`Probe`	direct RelayRef`1<ReflectionProbe>	The probe to get color data from.
`AmbientLight`	raw output of SphericalHarmonicsL2`1<ColorX>	`Probe`'s sampled data as SH2 color data for ambient lighting usage.
`Order0Scale`	Float	The scale factor for Order 0 for the spherical harmonics.
`Order1Scale`	Float	The scale factor for Order 1 for the spherical harmonics.
`Order2Scale`	Float	The scale factor for Order 2 for the spherical harmonics.

Usage

Can be used to drive a AmbientLightSH2 component via a value copy or by drag and dropping this component's AmbientLight into that component's value

@@ Line 3: / Line 3: @@
 |Name=Reflection Probe SH2
 }}
-The '''Reflection Probe SH2''' component
+The '''Reflection Probe SH2''' component is used to turn what a [[Component:ReflectionProbe|ReflectionProbe]] sees into a spherical harmonic for use in ambient lighting like a [[Component:AmbientLightSH2|AmbientLightSH2]] component.
-{{stub}}
 == Fields ==
 {{Table ComponentFields
-|Probe|{{RootFieldType|RelayRef`1|[[Component:ReflectionProbe|ReflectionProbe]]}}|TypeAdv0=true|
+|Probe|{{RootFieldType|RelayRef`1|[[Component:ReflectionProbe|ReflectionProbe]]}}|TypeAdv0=true| The probe to get color data from.
-|AmbientLight|{{RootFieldType|RawOutput`1|[[Type:SphericalHarmonicsL2`1|SphericalHarmonicsL2`1]]&lt;[[Type:ColorX|ColorX]]&gt;}}|TypeAdv1=true|
+|AmbientLight|{{RootFieldType|RawOutput`1|[[Type:SphericalHarmonicsL2`1|SphericalHarmonicsL2`1]]&lt;[[Type:ColorX|ColorX]]&gt;}}|TypeAdv1=true| <code>Probe</code>'s sampled data as SH2 color data for ambient lighting usage.
-|Order0Scale|Float|
+|Order0Scale|Float| The scale factor for Order 0 for the spherical harmonics.
-|Order1Scale|Float|
+|Order1Scale|Float| The scale factor for Order 1 for the spherical harmonics.
-|Order2Scale|Float|
+|Order2Scale|Float| The scale factor for Order 2 for the spherical harmonics.
 }}
 == Usage ==
+Can be used to drive a [[Component:AmbientLightSH2|AmbientLightSH2]] component via a value copy or by drag and dropping this component's <code>AmbientLight</code> into that component's value
 == Examples ==
 == See Also ==
+* [[Component:AmbientLightSH2]]
 [[Category:Components:Rendering{{#translation:}}|Reflection Probe SH2]]
 [[Category:Components{{#translation:}}|Reflection Probe SH2]]
-[[Category:ComponentStubs]]