Struct gdnative::GIProbe

pub struct GIProbe { /* fields omitted */ }

core class GIProbe 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.

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

Class hierarchy

GIProbe inherits methods from:

• VisualInstance
• Spatial
• Node
• Object

Methods

impl GIProbe

Constants

pub const SUBDIV_512: i64

pub const SUBDIV_MAX: i64

pub const SUBDIV_128: i64

pub const SUBDIV_256: i64

pub const SUBDIV_64: i64

impl GIProbe

pub fn new() -> GIProbe

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

pub unsafe fn free(self)

Manually deallocate the object.

pub unsafe fn bake(
    &mut self,
    from_node: Option<Node>,
    create_visual_debug: bool
)

pub unsafe fn debug_bake(&mut self)

pub unsafe fn get_bias(&self) -> f64

pub unsafe fn get_dynamic_range(&self) -> i64

pub unsafe fn get_energy(&self) -> f64

pub unsafe fn get_extents(&self) -> Vector3D<f32, UnknownUnit>

pub unsafe fn get_normal_bias(&self) -> f64

pub unsafe fn get_probe_data(&self) -> Option<GIProbeData>

pub unsafe fn get_propagation(&self) -> f64

pub unsafe fn get_subdiv(&self) -> GIProbeSubdiv

pub unsafe fn is_compressed(&self) -> bool

pub unsafe fn is_interior(&self) -> bool

pub unsafe fn set_bias(&mut self, max: f64)

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

pub unsafe fn set_dynamic_range(&mut self, max: i64)

pub unsafe fn set_energy(&mut self, max: f64)

pub unsafe fn set_extents(&mut self, extents: Vector3D<f32, UnknownUnit>)

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

pub unsafe fn set_normal_bias(&mut self, max: f64)

pub unsafe fn set_probe_data(&mut self, data: Option<GIProbeData>)

pub unsafe fn set_propagation(&mut self, max: f64)

pub unsafe fn set_subdiv(&mut self, subdiv: 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>(&self) -> Option<T> where
    T: GodotObject, 

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>(&self) -> Option<T> where
    T: GodotObject, 

Generic dynamic cast.

Trait Implementations

impl Clone for GIProbe

fn clone(&self) -> GIProbe

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for GIProbe

impl Debug for GIProbe

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

Formats the value using the given formatter.

impl Deref for GIProbe

type Target = VisualInstance

The resulting type after dereferencing.

fn deref(&self) -> &VisualInstance

Dereferences the value.

impl DerefMut for GIProbe

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

Mutably dereferences the value.

impl Free for GIProbe

unsafe fn godot_free(self)

impl FromVariant for GIProbe

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

impl GodotObject for GIProbe

fn class_name() -> &'static str

unsafe fn from_sys(obj: *mut c_void) -> GIProbe

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

impl Instanciable for GIProbe

fn construct() -> GIProbe

impl QueueFree for GIProbe

unsafe fn godot_queue_free(&mut self)

impl ToVariant for GIProbe

fn to_variant(&self) -> Variant