mirror of
https://github.com/godotengine/godot.git
synced 2024-12-21 10:25:24 +08:00
eb6e3003d5
Update doc/classes/ReflectionProbe.xml Co-Authored-By: Hugo Locurcio <hugo.locurcio@hugo.pro> Apply suggestions from code review Co-Authored-By: Hugo Locurcio <hugo.locurcio@hugo.pro> Update ReflectionProbe.xml
50 lines
2.8 KiB
XML
50 lines
2.8 KiB
XML
<?xml version="1.0" encoding="UTF-8" ?>
|
|
<class name="ReflectionProbe" inherits="VisualInstance" category="Core" version="3.2">
|
|
<brief_description>
|
|
Captures its surroundings to create reflections.
|
|
</brief_description>
|
|
<description>
|
|
Capture its surroundings as a dual parabolid image, and stores versions of it with increasing levels of blur to simulate different material roughnesses.
|
|
</description>
|
|
<tutorials>
|
|
<link>https://docs.godotengine.org/en/latest/tutorials/3d/reflection_probes.html</link>
|
|
</tutorials>
|
|
<methods>
|
|
</methods>
|
|
<members>
|
|
<member name="box_projection" type="bool" setter="set_enable_box_projection" getter="is_box_projection_enabled" default="false">
|
|
If [code]true[/code], enables box projection. This makes reflections look more correct in rectangle-shaped rooms by offsetting the reflection center depending on the camera's location.
|
|
</member>
|
|
<member name="cull_mask" type="int" setter="set_cull_mask" getter="get_cull_mask" default="1048575">
|
|
</member>
|
|
<member name="enable_shadows" type="bool" setter="set_enable_shadows" getter="are_shadows_enabled" default="false">
|
|
If [code]true[/code], computes shadows in the reflection probe. This makes the reflection probe slower to render; you may want to disable this if using the [constant UPDATE_ALWAYS] [member update_mode].
|
|
</member>
|
|
<member name="extents" type="Vector3" setter="set_extents" getter="get_extents" default="Vector3( 1, 1, 1 )">
|
|
</member>
|
|
<member name="intensity" type="float" setter="set_intensity" getter="get_intensity" default="1.0">
|
|
Defines the reflection intensity.
|
|
</member>
|
|
<member name="interior_ambient_color" type="Color" setter="set_interior_ambient" getter="get_interior_ambient" default="Color( 0, 0, 0, 1 )">
|
|
</member>
|
|
<member name="interior_ambient_contrib" type="float" setter="set_interior_ambient_probe_contribution" getter="get_interior_ambient_probe_contribution" default="0.0">
|
|
</member>
|
|
<member name="interior_ambient_energy" type="float" setter="set_interior_ambient_energy" getter="get_interior_ambient_energy" default="1.0">
|
|
</member>
|
|
<member name="interior_enable" type="bool" setter="set_as_interior" getter="is_set_as_interior" default="false">
|
|
</member>
|
|
<member name="max_distance" type="float" setter="set_max_distance" getter="get_max_distance" default="0.0">
|
|
</member>
|
|
<member name="origin_offset" type="Vector3" setter="set_origin_offset" getter="get_origin_offset" default="Vector3( 0, 0, 0 )">
|
|
</member>
|
|
<member name="update_mode" type="int" setter="set_update_mode" getter="get_update_mode" enum="ReflectionProbe.UpdateMode" default="0">
|
|
</member>
|
|
</members>
|
|
<constants>
|
|
<constant name="UPDATE_ONCE" value="0" enum="UpdateMode">
|
|
</constant>
|
|
<constant name="UPDATE_ALWAYS" value="1" enum="UpdateMode">
|
|
</constant>
|
|
</constants>
|
|
</class>
|