Struct gdnative::api::CameraFeed

pub struct CameraFeed { /* fields omitted */ }

core class CameraFeed inherits Reference (reference counted).

Official documentation

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

Memory management

The lifetime of this object is automatically managed through reference counting.

Class hierarchy

CameraFeed inherits methods from:

• Reference
• Object

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

impl CameraFeed

Constants

pub const FEED_BACK: i64

pub const FEED_FRONT: i64

pub const FEED_NOIMAGE: i64

pub const FEED_RGB: i64

pub const FEED_UNSPECIFIED: i64

pub const FEED_YCBCR: i64

pub const FEED_YCBCR_SEP: i64

impl CameraFeed

pub fn new() -> Ref<CameraFeed, Unique>

Creates a new instance of this object.

This is a reference-counted type. The returned object is automatically managed by Ref.

pub fn get_id(&self) -> i64

Returns the unique ID for this feed.

pub fn get_name(&self) -> GodotString

Returns the camera's name.

pub fn get_position(&self) -> FeedPosition

Returns the position of camera on the device.

pub fn transform(&self) -> Transform2D<f32, UnknownUnit, UnknownUnit>

The transform applied to the camera's image.

pub fn is_active(&self) -> bool

If [code]true[/code], the feed is active.

pub fn set_active(&self, active: bool)

If [code]true[/code], the feed is active.

pub fn set_transform(
    &self,
    transform: Transform2D<f32, UnknownUnit, UnknownUnit>
)

The transform applied to the camera's image.

Methods from Deref<Target = Reference>

pub fn init_ref(&self) -> bool

Initializes the internal reference counter. Use this only if you really know what you are doing.
				Returns whether the initialization was successful.

Trait Implementations

impl Debug for CameraFeed

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

Formats the value using the given formatter.

impl Deref for CameraFeed

type Target = Reference

The resulting type after dereferencing.

fn deref(&self) -> &Reference

Dereferences the value.

impl DerefMut for CameraFeed

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

Mutably dereferences the value.

impl GodotObject for CameraFeed

type RefKind = RefCounted

The memory management kind of this type. This modifies the behavior of the Ref smart pointer. See its type-level documentation for more information.

fn class_name() -> &'static str

fn null() -> Null<Self>

Creates an explicitly null reference of Self as a method argument. This makes type inference easier for the compiler compared to Option.

fn new() -> Ref<Self, Unique> where
    Self: Instanciable, 

Creates a new instance of Self using a zero-argument constructor, as a Unique reference.

fn cast<T>(&self) -> Option<&T> where
    T: GodotObject + SubClass<Self>, 

Performs a dynamic reference downcast to target type.

fn upcast<T>(&self) -> &T where
    Self: SubClass<T>,
    T: GodotObject, 

Performs a static reference upcast to a supertype that is guaranteed to be valid.

unsafe fn assume_shared(&self) -> Ref<Self, Shared>

Creates a persistent reference to the same Godot object with shared thread access.

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.

unsafe fn assume_unique(&self) -> Ref<Self, Unique>

Creates a persistent reference to the same Godot object with unique access.

impl Instanciable for CameraFeed

fn construct() -> Ref<CameraFeed, Unique>

impl SubClass<Object> for CameraFeed

impl SubClass<Reference> for CameraFeed