Struct gdnative::ClippedCamera

pub struct ClippedCamera { /* fields omitted */ }

core class ClippedCamera inherits Camera (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.

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

Class hierarchy

ClippedCamera inherits methods from:

• Camera
• Spatial
• Node
• Object

Implementations

impl ClippedCamera

Constants

pub const CLIP_PROCESS_IDLE: i64

pub const CLIP_PROCESS_PHYSICS: i64

impl ClippedCamera

pub fn new() -> ClippedCamera

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

pub unsafe fn free(self)

Manually deallocate the object.

pub unsafe fn add_exception(&mut self, node: Option<Object>)

pub unsafe fn add_exception_rid(&mut self, rid: Rid)

pub unsafe fn clear_exceptions(&mut self)

pub unsafe fn get_clip_offset(&self) -> f64

pub unsafe fn get_collision_mask(&self) -> i64

pub unsafe fn get_collision_mask_bit(&self, bit: i64) -> bool

pub unsafe fn get_margin(&self) -> f64

pub unsafe fn get_process_mode(&self) -> ClippedCameraProcessMode

pub unsafe fn is_clip_to_areas_enabled(&self) -> bool

pub unsafe fn is_clip_to_bodies_enabled(&self) -> bool

pub unsafe fn remove_exception(&mut self, node: Option<Object>)

pub unsafe fn remove_exception_rid(&mut self, rid: Rid)

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

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

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

pub unsafe fn set_collision_mask_bit(&mut self, bit: i64, value: bool)

pub unsafe fn set_margin(&mut self, margin: f64)

pub unsafe fn set_process_mode(&mut self, process_mode: i64)

pub unsafe fn to_camera(&self) -> Camera

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 = Camera>

pub const DOPPLER_TRACKING_IDLE_STEP: i64

pub const PROJECTION_PERSPECTIVE: i64

pub const PROJECTION_ORTHOGONAL: i64

pub const DOPPLER_TRACKING_PHYSICS_STEP: i64

pub const DOPPLER_TRACKING_DISABLED: i64

pub const KEEP_HEIGHT: i64

pub const KEEP_WIDTH: i64

pub const PROJECTION_FRUSTUM: i64

pub unsafe fn clear_current(&mut self, enable_next: bool)

pub unsafe fn get_camera_rid(&self) -> Rid

pub unsafe fn get_camera_transform(&self) -> Transform

pub unsafe fn get_cull_mask(&self) -> i64

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

pub unsafe fn get_doppler_tracking(&self) -> CameraDopplerTracking

pub unsafe fn get_environment(&self) -> Option<Environment>

pub unsafe fn get_fov(&self) -> f64

pub unsafe fn get_frustum(&self) -> VariantArray

pub unsafe fn get_frustum_offset(&self) -> Vector2D<f32, UnknownUnit>

pub unsafe fn get_h_offset(&self) -> f64

pub unsafe fn get_keep_aspect_mode(&self) -> CameraKeepAspect

pub unsafe fn get_projection(&self) -> CameraProjection

pub unsafe fn get_size(&self) -> f64

pub unsafe fn get_v_offset(&self) -> f64

pub unsafe fn get_zfar(&self) -> f64

pub unsafe fn get_znear(&self) -> f64

pub unsafe fn is_current(&self) -> bool

pub unsafe fn is_position_behind(
    &self,
    world_point: Vector3D<f32, UnknownUnit>
) -> bool

pub unsafe fn make_current(&mut self)

pub unsafe fn project_local_ray_normal(
    &self,
    screen_point: Vector2D<f32, UnknownUnit>
) -> Vector3D<f32, UnknownUnit>

pub unsafe fn project_position(
    &self,
    screen_point: Vector2D<f32, UnknownUnit>,
    z_depth: f64
) -> Vector3D<f32, UnknownUnit>

pub unsafe fn project_ray_normal(
    &self,
    screen_point: Vector2D<f32, UnknownUnit>
) -> Vector3D<f32, UnknownUnit>

pub unsafe fn project_ray_origin(
    &self,
    screen_point: Vector2D<f32, UnknownUnit>
) -> Vector3D<f32, UnknownUnit>

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

pub unsafe fn set_cull_mask_bit(&mut self, layer: i64, enable: bool)

pub unsafe fn set_current(&mut self, arg0: bool)

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

pub unsafe fn set_environment(&mut self, env: Option<Environment>)

pub unsafe fn set_fov(&mut self, arg0: f64)

pub unsafe fn set_frustum(
    &mut self,
    size: f64,
    offset: Vector2D<f32, UnknownUnit>,
    z_near: f64,
    z_far: f64
)

pub unsafe fn set_frustum_offset(&mut self, arg0: Vector2D<f32, UnknownUnit>)

pub unsafe fn set_h_offset(&mut self, ofs: f64)

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

pub unsafe fn set_orthogonal(&mut self, size: f64, z_near: f64, z_far: f64)

pub unsafe fn set_perspective(&mut self, fov: f64, z_near: f64, z_far: f64)

pub unsafe fn set_projection(&mut self, arg0: i64)

pub unsafe fn set_size(&mut self, arg0: f64)

pub unsafe fn set_v_offset(&mut self, ofs: f64)

pub unsafe fn set_zfar(&mut self, arg0: f64)

pub unsafe fn set_znear(&mut self, arg0: f64)

pub unsafe fn unproject_position(
    &self,
    world_point: Vector3D<f32, UnknownUnit>
) -> Vector2D<f32, UnknownUnit>

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 ClippedCamera

fn clone(&self) -> ClippedCamera

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for ClippedCamera

impl Debug for ClippedCamera

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

Formats the value using the given formatter.

impl Deref for ClippedCamera

type Target = Camera

The resulting type after dereferencing.

fn deref(&self) -> &Camera

Dereferences the value.

impl DerefMut for ClippedCamera

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

Mutably dereferences the value.

impl Free for ClippedCamera

unsafe fn godot_free(self)

impl FromVariant for ClippedCamera

fn from_variant(variant: &Variant) -> Result<ClippedCamera, FromVariantError>

impl GodotObject for ClippedCamera

fn class_name() -> &'static str

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

unsafe fn from_return_position_sys(obj: *mut c_void) -> ClippedCamera

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

unsafe fn claim(&self) -> Self

Creates a wrapper around the same Godot object that has 'static lifetime.

impl Instanciable for ClippedCamera

fn construct() -> ClippedCamera

impl QueueFree for ClippedCamera

unsafe fn godot_queue_free(&mut self)

impl ToVariant for ClippedCamera

fn to_variant(&self) -> Variant