Struct gdnative::Camera

pub struct Camera { /* fields omitted */ }

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

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

Class hierarchy

Camera inherits methods from:

• Spatial
• Node
• Object

Methods

impl Camera

Constants

pub const DOPPLER_TRACKING_PHYSICS_STEP: i64

pub const KEEP_WIDTH: i64

pub const DOPPLER_TRACKING_DISABLED: i64

pub const KEEP_HEIGHT: i64

pub const PROJECTION_PERSPECTIVE: i64

pub const PROJECTION_FRUSTUM: i64

pub const PROJECTION_ORTHOGONAL: i64

pub const DOPPLER_TRACKING_IDLE_STEP: i64

impl Camera

pub fn new() -> Camera

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

pub unsafe fn free(self)

Manually deallocate the object.

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.

Methods from Deref<Target = Spatial>

pub const NOTIFICATION_ENTER_WORLD: i64

pub const NOTIFICATION_EXIT_WORLD: i64

pub const NOTIFICATION_TRANSFORM_CHANGED: i64

pub const NOTIFICATION_VISIBILITY_CHANGED: i64

pub unsafe fn _update_gizmo(&mut self)

pub unsafe fn force_update_transform(&mut self)

pub unsafe fn get_gizmo(&self) -> Option<SpatialGizmo>

pub unsafe fn get_global_transform(&self) -> Transform

pub unsafe fn get_parent_spatial(&self) -> Option<Spatial>

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

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

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

pub unsafe fn get_transform(&self) -> Transform

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

pub unsafe fn get_world(&self) -> Option<World>

pub unsafe fn global_rotate(
    &mut self,
    axis: Vector3D<f32, UnknownUnit>,
    angle: f64
)

pub unsafe fn global_scale(&mut self, scale: Vector3D<f32, UnknownUnit>)

pub unsafe fn global_translate(&mut self, offset: Vector3D<f32, UnknownUnit>)

pub unsafe fn hide(&mut self)

pub unsafe fn is_local_transform_notification_enabled(&self) -> bool

pub unsafe fn is_scale_disabled(&self) -> bool

pub unsafe fn is_set_as_toplevel(&self) -> bool

pub unsafe fn is_transform_notification_enabled(&self) -> bool

pub unsafe fn is_visible(&self) -> bool

pub unsafe fn is_visible_in_tree(&self) -> bool

pub unsafe fn look_at(
    &mut self,
    target: Vector3D<f32, UnknownUnit>,
    up: Vector3D<f32, UnknownUnit>
)

pub unsafe fn look_at_from_position(
    &mut self,
    position: Vector3D<f32, UnknownUnit>,
    target: Vector3D<f32, UnknownUnit>,
    up: Vector3D<f32, UnknownUnit>
)

pub unsafe fn orthonormalize(&mut self)

pub unsafe fn rotate(&mut self, axis: Vector3D<f32, UnknownUnit>, angle: f64)

pub unsafe fn rotate_object_local(
    &mut self,
    axis: Vector3D<f32, UnknownUnit>,
    angle: f64
)

pub unsafe fn rotate_x(&mut self, angle: f64)

pub unsafe fn rotate_y(&mut self, angle: f64)

pub unsafe fn rotate_z(&mut self, angle: f64)

pub unsafe fn scale_object_local(&mut self, scale: Vector3D<f32, UnknownUnit>)

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

pub unsafe fn set_disable_scale(&mut self, disable: bool)

pub unsafe fn set_gizmo(&mut self, gizmo: Option<SpatialGizmo>)

pub unsafe fn set_global_transform(&mut self, global: Transform)

pub unsafe fn set_identity(&mut self)

pub unsafe fn set_ignore_transform_notification(&mut self, enabled: bool)

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

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

pub unsafe fn set_rotation(&mut self, euler: Vector3D<f32, UnknownUnit>)

pub unsafe fn set_rotation_degrees(
    &mut self,
    euler_degrees: Vector3D<f32, UnknownUnit>
)

pub unsafe fn set_scale(&mut self, scale: Vector3D<f32, UnknownUnit>)

pub unsafe fn set_transform(&mut self, local: Transform)

pub unsafe fn set_translation(
    &mut self,
    translation: Vector3D<f32, UnknownUnit>
)

pub unsafe fn set_visible(&mut self, visible: bool)

pub unsafe fn show(&mut self)

pub unsafe fn to_global(
    &self,
    local_point: Vector3D<f32, UnknownUnit>
) -> Vector3D<f32, UnknownUnit>

pub unsafe fn to_local(
    &self,
    global_point: Vector3D<f32, UnknownUnit>
) -> Vector3D<f32, UnknownUnit>

pub unsafe fn translate(&mut self, offset: Vector3D<f32, UnknownUnit>)

pub unsafe fn translate_object_local(
    &mut self,
    offset: Vector3D<f32, UnknownUnit>
)

pub unsafe fn update_gizmo(&mut self)

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 Camera

fn clone(&self) -> Camera

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for Camera

impl Debug for Camera

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

Formats the value using the given formatter.

impl Deref for Camera

type Target = Spatial

The resulting type after dereferencing.

fn deref(&self) -> &Spatial

Dereferences the value.

impl DerefMut for Camera

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

Mutably dereferences the value.

impl Free for Camera

unsafe fn godot_free(self)

impl FromVariant for Camera

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

impl GodotObject for Camera

fn class_name() -> &'static str

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

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

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

impl Instanciable for Camera

fn construct() -> Camera

impl QueueFree for Camera

unsafe fn godot_queue_free(&mut self)

impl ToVariant for Camera

fn to_variant(&self) -> Variant