Reflection Probe Component

The Reflection Probe creates specular reflections in the environment around a probe (capture point). A probe stores information about the surrounding environment as a cubemap. Then, it applies the cubemap to meshes that are located inside the probe’s volume. This allows the mesh to display environment reflections based on its location in the environment.

Provider

Atom Gem

Dependencies

Box Shape component

Properties

Reflection Probe component properties

Cubemap Bake properties

PropertyDescriptionValuesDefault
Bake Reflection ProbeBakes the surrounding environment to a cubemap.--

Inner Extents properties

PropertyDescriptionValuesDefault
HeightThe height of the reflection probe’s inner volume. The height is dependent on the Box Shape component’s dimension along the z-axis.0 to the Box Shape component’s Dimensions-Z propertyThe value of the Box Shape component’s Dimensions-Z property.
LengthThe length of the reflection probe’s inner volume. The length is dependent on the Box Shape component’s dimension along the y-axis.0 to the Box Shape component’s Dimensions-Y propertyThe value of the Box Shape component’s Dimensions-Y property.
WidthThe width of the reflection probe’s inner volume. The width is dependent on the Box Shape component’s dimension along the x-axis.0 to the Box Shape component’s Dimensions-X propertyThe value of the Box Shape component’s Dimensions-X property.

Settings properties

PropertyDescriptionValuesDefault
Parallax CorrectionCorrects the reflection by adjusting an offset from the capture position.BooleanEnabled
Show VisualizationShows a sphere to visualize the probe.BooleanEnabled

Cubemap properties

PropertyDescriptionValuesDefault
Use Baked CubemapIf enabled, uses a baked cubemap to create reflections.BooleanEnabled
Baked Cubemap QualityThe resolution of the baked cubemap.Very Low, Low, Medium, High, Very HighMedium
Baked Cubemap pathThe path to the baked cubemap file. When you bake a cubemap, this property automatically generates the path to the cubemap file.--

Copyright © 2022 Open 3D Engine Contributors

Documentation Distributed under CC BY 4.0.
For our trademark, privacy and antitrust policies, code of conduct, and terms of use, please click the applicable link below or see https://www.lfprojects.org.


The Linux Foundation has registered trademarks and uses trademarks. For a list of trademarks of The Linux Foundation, please see our Trademark Policy page.