Struct gdnative_bindings::ReflectionProbe

pub struct ReflectionProbe { /* fields omitted */ }

core class ReflectionProbe inherits VisualInstance (unsafe).

Official documentation

See the documentation of this class in the Godot engine's official documentation.

Memory management

Non reference counted objects such as the ones of this type are usually owned by the engine.

ReflectionProbe is an unsafe pointer, and all of its methods are unsafe.

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 ReflectionProbe::free.

Class hierarchy

ReflectionProbe inherits methods from:

• VisualInstance
• Spatial
• Node
• Object

Methods

impl ReflectionProbe

Constants

pub const UPDATE_ONCE: i64

pub const UPDATE_ALWAYS: i64

impl ReflectionProbe

pub fn new() -> Self

Constructor.

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 ReflectionProbe::free.

pub unsafe fn free(self)

Manually deallocate the object.

pub unsafe fn are_shadows_enabled(&self) -> bool

pub unsafe fn get_cull_mask(&self) -> i64

pub unsafe fn get_extents(&self) -> Vector3

pub unsafe fn get_intensity(&self) -> f64

pub unsafe fn get_interior_ambient(&self) -> Color

pub unsafe fn get_interior_ambient_energy(&self) -> f64

pub unsafe fn get_interior_ambient_probe_contribution(&self) -> f64

pub unsafe fn get_max_distance(&self) -> f64

pub unsafe fn get_origin_offset(&self) -> Vector3

pub unsafe fn get_update_mode(&self) -> ReflectionProbeUpdateMode

pub unsafe fn is_box_projection_enabled(&self) -> bool

pub unsafe fn is_set_as_interior(&self) -> bool

pub unsafe fn set_as_interior(&mut self, enable: bool)

pub unsafe fn set_cull_mask(&mut self, layers: i64)

pub unsafe fn set_enable_box_projection(&mut self, enable: bool)

pub unsafe fn set_enable_shadows(&mut self, enable: bool)

pub unsafe fn set_extents(&mut self, extents: Vector3)

pub unsafe fn set_intensity(&mut self, intensity: f64)

pub unsafe fn set_interior_ambient(&mut self, ambient: Color)

pub unsafe fn set_interior_ambient_energy(&mut self, ambient_energy: f64)

pub unsafe fn set_interior_ambient_probe_contribution(
    &mut self,
    ambient_probe_contribution: f64
)

pub unsafe fn set_max_distance(&mut self, max_distance: f64)

pub unsafe fn set_origin_offset(&mut self, origin_offset: Vector3)

pub unsafe fn set_update_mode(&mut self, mode: i64)

pub unsafe fn to_visual_instance(&self) -> VisualInstance

Up-cast.

pub unsafe fn to_spatial(&self) -> Spatial

Up-cast.

pub unsafe fn to_node(&self) -> Node

Up-cast.

pub unsafe fn to_object(&self) -> Object

Up-cast.

pub unsafe fn cast<T: GodotObject>(&self) -> Option<T>

Generic dynamic cast.

Methods from Deref<Target = VisualInstance>

pub unsafe fn _get_visual_instance_rid(&self) -> Rid

pub unsafe fn get_aabb(&self) -> Aabb

pub unsafe fn get_base(&self) -> Rid

pub unsafe fn get_instance(&self) -> Rid

pub unsafe fn get_layer_mask(&self) -> i64

pub unsafe fn get_layer_mask_bit(&self, layer: i64) -> bool

pub unsafe fn get_transformed_aabb(&self) -> Aabb

pub unsafe fn set_base(&mut self, base: Rid)

pub unsafe fn set_layer_mask(&mut self, mask: i64)

pub unsafe fn set_layer_mask_bit(&mut self, layer: i64, enabled: bool)

pub unsafe fn to_spatial(&self) -> Spatial

Up-cast.

pub unsafe fn to_node(&self) -> Node

Up-cast.

pub unsafe fn to_object(&self) -> Object

Up-cast.

pub unsafe fn cast<T: GodotObject>(&self) -> Option<T>

Generic dynamic cast.

Trait Implementations

impl Clone for ReflectionProbe

fn clone(&self) -> ReflectionProbe

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Copy for ReflectionProbe

impl Debug for ReflectionProbe

fn fmt(&self, f: &mut Formatter) -> Result

Formats the value using the given formatter.

impl Deref for ReflectionProbe

type Target = VisualInstance

The resulting type after dereferencing.

fn deref(&self) -> &VisualInstance

Dereferences the value.

impl DerefMut for ReflectionProbe

fn deref_mut(&mut self) -> &mut VisualInstance

Mutably dereferences the value.

impl Free for ReflectionProbe

unsafe fn godot_free(self)

impl FromVariant for ReflectionProbe

fn from_variant(variant: &Variant) -> Option<Self>

impl GodotObject for ReflectionProbe

fn class_name() -> &'static str

unsafe fn from_sys(obj: *mut godot_object) -> Self

unsafe fn to_sys(&self) -> *mut godot_object

impl Instanciable for ReflectionProbe

fn construct() -> Self

impl QueueFree for ReflectionProbe

unsafe fn godot_queue_free(&mut self)

impl ToVariant for ReflectionProbe

fn to_variant(&self) -> Variant