[−][src]Struct gdnative::api::CameraTexture
core class CameraTexture
inherits Texture
(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
CameraTexture inherits methods from:
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 CameraTexture
[src]
pub fn new() -> Ref<CameraTexture, Unique>
[src]
Creates a new instance of this object.
This is a reference-counted type. The returned object is automatically managed
by Ref
.
pub fn camera_active(&self) -> bool
[src]
Convenience property that gives access to the active property of the [CameraFeed].
pub fn camera_feed_id(&self) -> i64
[src]
The ID of the [CameraFeed] for which we want to display the image.
pub fn which_feed(&self) -> FeedImage
[src]
Which image within the [CameraFeed] we want access to, important if the camera image is split in a Y and CbCr component.
pub fn set_camera_active(&self, active: bool)
[src]
Convenience property that gives access to the active property of the [CameraFeed].
pub fn set_camera_feed_id(&self, feed_id: i64)
[src]
The ID of the [CameraFeed] for which we want to display the image.
pub fn set_which_feed(&self, which_feed: i64)
[src]
Which image within the [CameraFeed] we want access to, important if the camera image is split in a Y and CbCr component.
Methods from Deref<Target = Texture>
pub const FLAGS_DEFAULT: i64
[src]
pub const FLAG_ANISOTROPIC_FILTER: i64
[src]
pub const FLAG_CONVERT_TO_LINEAR: i64
[src]
pub const FLAG_FILTER: i64
[src]
pub const FLAG_MIPMAPS: i64
[src]
pub const FLAG_MIRRORED_REPEAT: i64
[src]
pub const FLAG_REPEAT: i64
[src]
pub const FLAG_VIDEO_SURFACE: i64
[src]
pub fn draw(
&self,
canvas_item: Rid,
position: Vector2D<f32, UnknownUnit>,
modulate: Color,
transpose: bool,
normal_map: impl AsArg<Texture>
)
[src]
&self,
canvas_item: Rid,
position: Vector2D<f32, UnknownUnit>,
modulate: Color,
transpose: bool,
normal_map: impl AsArg<Texture>
)
Draws the texture using a [CanvasItem] with the [VisualServer] API at the specified [code]position[/code]. Equivalent to [method VisualServer.canvas_item_add_texture_rect] with a rect at [code]position[/code] and the size of this [Texture].
Default Arguments
modulate
-Color( 1, 1, 1, 1 )
transpose
-false
normal_map
-null
pub fn draw_rect(
&self,
canvas_item: Rid,
rect: Rect<f32, UnknownUnit>,
tile: bool,
modulate: Color,
transpose: bool,
normal_map: impl AsArg<Texture>
)
[src]
&self,
canvas_item: Rid,
rect: Rect<f32, UnknownUnit>,
tile: bool,
modulate: Color,
transpose: bool,
normal_map: impl AsArg<Texture>
)
Draws the texture using a [CanvasItem] with the [VisualServer] API. Equivalent to [method VisualServer.canvas_item_add_texture_rect].
Default Arguments
modulate
-Color( 1, 1, 1, 1 )
transpose
-false
normal_map
-null
pub fn draw_rect_region(
&self,
canvas_item: Rid,
rect: Rect<f32, UnknownUnit>,
src_rect: Rect<f32, UnknownUnit>,
modulate: Color,
transpose: bool,
normal_map: impl AsArg<Texture>,
clip_uv: bool
)
[src]
&self,
canvas_item: Rid,
rect: Rect<f32, UnknownUnit>,
src_rect: Rect<f32, UnknownUnit>,
modulate: Color,
transpose: bool,
normal_map: impl AsArg<Texture>,
clip_uv: bool
)
Draws a part of the texture using a [CanvasItem] with the [VisualServer] API. Equivalent to [method VisualServer.canvas_item_add_texture_rect_region].
Default Arguments
modulate
-Color( 1, 1, 1, 1 )
transpose
-false
normal_map
-null
clip_uv
-true
pub fn get_data(&self) -> Option<Ref<Image, Shared>>
[src]
Returns an [Image] that is a copy of data from this [Texture]. [Image]s can be accessed and manipulated directly.
pub fn flags(&self) -> i64
[src]
The texture's [enum Flags]. [enum Flags] are used to set various properties of the [Texture].
pub fn get_height(&self) -> i64
[src]
Returns the texture height.
pub fn get_size(&self) -> Vector2D<f32, UnknownUnit>
[src]
Returns the texture size.
pub fn get_width(&self) -> i64
[src]
Returns the texture width.
pub fn has_alpha(&self) -> bool
[src]
Returns [code]true[/code] if this [Texture] has an alpha channel.
pub fn set_flags(&self, flags: i64)
[src]
The texture's [enum Flags]. [enum Flags] are used to set various properties of the [Texture].
Trait Implementations
impl Debug for CameraTexture
[src]
impl Deref for CameraTexture
[src]
impl DerefMut for CameraTexture
[src]
impl GodotObject for CameraTexture
[src]
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. Read more
fn class_name() -> &'static str
[src]
fn null() -> Null<Self>
[src]
fn new() -> Ref<Self, Unique> where
Self: Instanciable,
[src]
Self: Instanciable,
fn cast<T>(&self) -> Option<&T> where
T: GodotObject + SubClass<Self>,
[src]
T: GodotObject + SubClass<Self>,
fn upcast<T>(&self) -> &T where
Self: SubClass<T>,
T: GodotObject,
[src]
Self: SubClass<T>,
T: GodotObject,
unsafe fn assume_shared(&self) -> Ref<Self, Shared>
[src]
unsafe fn assume_thread_local(&self) -> Ref<Self, ThreadLocal> where
Self: GodotObject<RefKind = RefCounted>,
[src]
Self: GodotObject<RefKind = RefCounted>,
unsafe fn assume_unique(&self) -> Ref<Self, Unique>
[src]
impl Instanciable for CameraTexture
[src]
fn construct() -> Ref<CameraTexture, Unique>
[src]
impl SubClass<Object> for CameraTexture
[src]
impl SubClass<Reference> for CameraTexture
[src]
impl SubClass<Resource> for CameraTexture
[src]
impl SubClass<Texture> for CameraTexture
[src]
Auto Trait Implementations
impl RefUnwindSafe for CameraTexture
impl !Send for CameraTexture
impl !Sync for CameraTexture
impl Unpin for CameraTexture
impl UnwindSafe for CameraTexture
Blanket Implementations
impl<T> Any for T where
T: 'static + ?Sized,
[src]
T: 'static + ?Sized,
impl<T> Borrow<T> for T where
T: ?Sized,
[src]
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]
T: ?Sized,
fn borrow_mut(&mut self) -> &mut T
[src]
impl<T> From<T> for T
[src]
impl<T, U> Into<U> for T where
U: From<T>,
[src]
U: From<T>,
impl<T> SubClass<T> for T where
T: GodotObject,
[src]
T: GodotObject,
impl<T, U> TryFrom<U> for T where
U: Into<T>,
[src]
U: Into<T>,
type Error = Infallible
The type returned in the event of a conversion error.
fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>
[src]
impl<T, U> TryInto<U> for T where
U: TryFrom<T>,
[src]
U: TryFrom<T>,