Struct gdnative_bindings_lily::ReflectionProbe [−][src]
pub struct ReflectionProbe { /* fields omitted */ }
Expand description
core class ReflectionProbe
inherits VisualInstance
(unsafe).
Official documentation
See the documentation of this class in the Godot engine’s official documentation. The method descriptions are generated from it and typically contain code samples in GDScript, not Rust.
Memory management
Non reference counted objects such as the ones of this type are usually owned by the engine.
ReflectionProbe
is a reference-only type. Persistent references can
only exist in the unsafe Ref<ReflectionProbe>
form.
In the cases where Rust code owns an object of this type, for example if the object was just
created on the Rust side and not passed to the engine yet, ownership should be either given
to the engine or the object must be manually destroyed using Ref::free
, or Ref::queue_free
if it is a Node
.
Class hierarchy
ReflectionProbe inherits methods from:
Safety
All types in the Godot API have “interior mutability” in Rust parlance.
To enforce that the official thread-safety guidelines are
followed, the typestate pattern is used in the Ref
and TRef
smart pointers,
and the Instance
API. The typestate Access
in these types tracks whether the
access is unique, shared, or exclusive to the current thread. For more information,
see the type-level documentation on Ref
.
Implementations
Creates a new instance of this object.
Because this type is not reference counted, the lifetime of the returned object is not automatically managed.
Immediately after creation, the object is owned by the caller, and can be
passed to the engine (in which case the engine will be responsible for
destroying the object) or destroyed manually using Ref::free
, or preferably
Ref::queue_free
if it is a Node
.
If true
, 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].
Sets the cull mask which determines what objects are drawn by this probe. Every VisualInstance with a layer included in this cull mask will be rendered by the probe. It is best to only include large objects which are likely to take up a lot of space in the reflection in order to save on rendering cost.
The size of the reflection probe. The larger the extents the more space covered by the probe which will lower the perceived resolution. It is best to keep the extents only as large as you need them.
Defines the reflection intensity. Intensity modulates the strength of the reflection.
Sets the ambient light color to be used when this probe is set to [member interior_enable].
Sets the energy multiplier for this reflection probe’s ambient light contribution when set to [member interior_enable].
Sets the contribution value for how much the reflection affects the ambient light for this reflection probe when set to [member interior_enable]. Useful so that ambient light matches the color of the room.
Sets the max distance away from the probe an object can be before it is culled.
Sets the origin offset to be used when this reflection probe is in box project mode.
Sets how frequently the probe is updated. Can be [constant UPDATE_ONCE] or [constant UPDATE_ALWAYS].
If true
, enables box projection. This makes reflections look more correct in rectangle-shaped rooms by offsetting the reflection center depending on the camera’s location.
If true
, reflections will ignore sky contribution. Ambient lighting is then controlled by the interior_ambient_*
properties.
If true
, reflections will ignore sky contribution. Ambient lighting is then controlled by the interior_ambient_*
properties.
Sets the cull mask which determines what objects are drawn by this probe. Every VisualInstance with a layer included in this cull mask will be rendered by the probe. It is best to only include large objects which are likely to take up a lot of space in the reflection in order to save on rendering cost.
If true
, enables box projection. This makes reflections look more correct in rectangle-shaped rooms by offsetting the reflection center depending on the camera’s location.
If true
, 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].
The size of the reflection probe. The larger the extents the more space covered by the probe which will lower the perceived resolution. It is best to keep the extents only as large as you need them.
Defines the reflection intensity. Intensity modulates the strength of the reflection.
Sets the ambient light color to be used when this probe is set to [member interior_enable].
Sets the energy multiplier for this reflection probe’s ambient light contribution when set to [member interior_enable].
Sets the contribution value for how much the reflection affects the ambient light for this reflection probe when set to [member interior_enable]. Useful so that ambient light matches the color of the room.
Sets the max distance away from the probe an object can be before it is culled.
Sets the origin offset to be used when this reflection probe is in box project mode.
Sets how frequently the probe is updated. Can be [constant UPDATE_ONCE] or [constant UPDATE_ALWAYS].
Methods from Deref<Target = VisualInstance>
Returns the [AABB] (also known as the bounding box) for this VisualInstance. See also [method get_transformed_aabb].
Returns the RID of the resource associated with this VisualInstance. For example, if the Node is a MeshInstance, this will return the RID of the associated Mesh.
Returns the RID of this instance. This RID is the same as the RID returned by [method VisualServer.instance_create]. This RID is needed if you want to call VisualServer functions directly on this VisualInstance.
The render layer(s) this VisualInstance is drawn on. This object will only be visible for Cameras whose cull mask includes the render object this VisualInstance is set to.
Returns true
when the specified layer is enabled in [member layers] and false
otherwise.
Returns the transformed [AABB] (also known as the bounding box) for this VisualInstance. Transformed in this case means the [AABB] plus the position, rotation, and scale of the Spatial’s Transform. See also [method get_aabb].
Sets the resource that is instantiated by this VisualInstance, which changes how the engine handles the VisualInstance under the hood. Equivalent to [method VisualServer.instance_set_base].
The render layer(s) this VisualInstance is drawn on. This object will only be visible for Cameras whose cull mask includes the render object this VisualInstance is set to.
Enables a particular layer in [member layers].
Trait Implementations
type Target = VisualInstance
type Target = VisualInstance
The resulting type after dereferencing.
Dereferences the value.
Mutably dereferences the value.
type RefKind = ManuallyManaged
type RefKind = ManuallyManaged
Creates an explicitly null reference of Self
as a method argument. This makes type
inference easier for the compiler compared to Option
. Read more
Creates a new instance of Self
using a zero-argument constructor, as a Unique
reference. Read more
Performs a dynamic reference downcast to target type. Read more
Performs a static reference upcast to a supertype that is guaranteed to be valid. Read more
Creates a persistent reference to the same Godot object with shared thread access. Read more
unsafe fn assume_thread_local(&self) -> Ref<Self, ThreadLocal> where
Self: GodotObject<RefKind = RefCounted>,
unsafe fn assume_thread_local(&self) -> Ref<Self, ThreadLocal> where
Self: GodotObject<RefKind = RefCounted>,
Creates a persistent reference to the same Godot object with thread-local thread access. Read more
Creates a persistent reference to the same Godot object with unique access. Read more
Recovers a instance ID previously returned by Object::get_instance_id
if the object is
still alive. See also TRef::try_from_instance_id
. Read more
Auto Trait Implementations
impl RefUnwindSafe for ReflectionProbe
impl !Send for ReflectionProbe
impl !Sync for ReflectionProbe
impl Unpin for ReflectionProbe
impl UnwindSafe for ReflectionProbe