[][src]Struct gdnative::common::Image

pub struct Image { /* fields omitted */ }

core class Image inherits Resource (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.

Feature flag

This type is behind the gdnative crate's common feature flag.

Class hierarchy

Image inherits methods from:

Methods

impl Image
[src]

pub fn new() -> Image
[src]

pub fn new_ref(&self) -> Image
[src]

Creates a new reference to the same reference-counted object.

pub fn get_width(&self) -> i64
[src]

pub fn get_height(&self) -> i64
[src]

pub fn get_size(&self) -> TypedVector2D<f32, UnknownUnit>
[src]

pub fn has_mipmaps(&self) -> bool
[src]

pub fn get_format(&self) -> ImageFormat
[src]

pub fn get_data(&self) -> ByteArray
[src]

pub fn convert(&mut self, format: i64)
[src]

pub fn get_mipmap_offset(&self, mipmap: i64) -> i64
[src]

pub fn resize_to_po2(&mut self, square: bool)
[src]

pub fn resize(&mut self, width: i64, height: i64, interpolation: i64)
[src]

pub fn shrink_x2(&mut self)
[src]

pub fn expand_x2_hq2x(&mut self)
[src]

pub fn crop(&mut self, width: i64, height: i64)
[src]

pub fn flip_x(&mut self)
[src]

pub fn flip_y(&mut self)
[src]

pub fn generate_mipmaps(&mut self, renormalize: bool) -> Result<(), GodotError>
[src]

pub fn clear_mipmaps(&mut self)
[src]

pub fn create(
    &mut self,
    width: i64,
    height: i64,
    use_mipmaps: bool,
    format: i64
)
[src]

pub fn create_from_data(
    &mut self,
    width: i64,
    height: i64,
    use_mipmaps: bool,
    format: i64,
    data: ByteArray
)
[src]

pub fn is_empty(&self) -> bool
[src]

pub fn load(&mut self, path: GodotString) -> Result<(), GodotError>
[src]

pub fn save_png(&self, path: GodotString) -> Result<(), GodotError>
[src]

pub fn detect_alpha(&self) -> ImageAlphaMode
[src]

pub fn is_invisible(&self) -> bool
[src]

pub fn compress(
    &mut self,
    mode: i64,
    source: i64,
    lossy_quality: f64
) -> Result<(), GodotError>
[src]

pub fn decompress(&mut self) -> Result<(), GodotError>
[src]

pub fn is_compressed(&self) -> bool
[src]

pub fn fix_alpha_edges(&mut self)
[src]

pub fn premultiply_alpha(&mut self)
[src]

pub fn srgb_to_linear(&mut self)
[src]

pub fn normalmap_to_xy(&mut self)
[src]

pub fn rgbe_to_srgb(&mut self) -> Option<Image>
[src]

pub fn bumpmap_to_normalmap(&mut self, bump_scale: f64)
[src]

pub fn blit_rect(
    &mut self,
    src: Option<Image>,
    src_rect: TypedRect<f32, UnknownUnit>,
    dst: TypedVector2D<f32, UnknownUnit>
)
[src]

pub fn blit_rect_mask(
    &mut self,
    src: Option<Image>,
    mask: Option<Image>,
    src_rect: TypedRect<f32, UnknownUnit>,
    dst: TypedVector2D<f32, UnknownUnit>
)
[src]

pub fn blend_rect(
    &mut self,
    src: Option<Image>,
    src_rect: TypedRect<f32, UnknownUnit>,
    dst: TypedVector2D<f32, UnknownUnit>
)
[src]

pub fn blend_rect_mask(
    &mut self,
    src: Option<Image>,
    mask: Option<Image>,
    src_rect: TypedRect<f32, UnknownUnit>,
    dst: TypedVector2D<f32, UnknownUnit>
)
[src]

pub fn fill(&mut self, color: Color)
[src]

pub fn get_used_rect(&self) -> TypedRect<f32, UnknownUnit>
[src]

pub fn get_rect(&self, rect: TypedRect<f32, UnknownUnit>) -> Option<Image>
[src]

pub fn copy_from(&mut self, src: Option<Image>)
[src]

pub fn _set_data(&mut self, data: Dictionary)
[src]

pub fn _get_data(&self) -> Dictionary
[src]

pub fn lock(&mut self)
[src]

pub fn unlock(&mut self)
[src]

pub fn get_pixelv(&self, src: TypedVector2D<f32, UnknownUnit>) -> Color
[src]

pub fn get_pixel(&self, x: i64, y: i64) -> Color
[src]

pub fn set_pixelv(&mut self, dst: TypedVector2D<f32, UnknownUnit>, color: Color)
[src]

pub fn set_pixel(&mut self, x: i64, y: i64, color: Color)
[src]

pub fn load_png_from_buffer(
    &mut self,
    buffer: ByteArray
) -> Result<(), GodotError>
[src]

pub fn load_jpg_from_buffer(
    &mut self,
    buffer: ByteArray
) -> Result<(), GodotError>
[src]

pub fn load_webp_from_buffer(
    &mut self,
    buffer: ByteArray
) -> Result<(), GodotError>
[src]

pub fn _setup_local_to_scene(&mut self)
[src]

Inherited from Resource.

pub fn set_path(&mut self, path: GodotString)
[src]

Inherited from Resource.

pub fn take_over_path(&mut self, path: GodotString)
[src]

Inherited from Resource.

pub fn get_path(&self) -> GodotString
[src]

Inherited from Resource.

pub fn set_name(&mut self, name: GodotString)
[src]

Inherited from Resource.

pub fn get_name(&self) -> GodotString
[src]

Inherited from Resource.

pub fn get_rid(&self) -> Rid
[src]

Inherited from Resource.

pub fn set_local_to_scene(&mut self, enable: bool)
[src]

Inherited from Resource.

pub fn is_local_to_scene(&self) -> bool
[src]

Inherited from Resource.

pub fn get_local_scene(&self) -> Option<Node>
[src]

Inherited from Resource.

pub fn setup_local_to_scene(&mut self)
[src]

Inherited from Resource.

pub fn duplicate(&self, subresources: bool) -> Option<Resource>
[src]

Inherited from Resource.

pub fn init_ref(&mut self) -> bool
[src]

Inherited from Reference.

pub fn _notification(&mut self, what: i64)
[src]

Inherited from Object.

pub fn _set(&mut self, property: GodotString, value: Variant) -> bool
[src]

Inherited from Object.

pub fn _get(&mut self, property: GodotString) -> Variant
[src]

Inherited from Object.

pub fn _get_property_list(&mut self) -> VariantArray
[src]

Inherited from Object.

pub fn _init(&mut self)
[src]

Inherited from Object.

pub fn get_class(&self) -> GodotString
[src]

Inherited from Object.

pub fn is_class(&self, _type: GodotString) -> bool
[src]

Inherited from Object.

pub fn set(&mut self, property: GodotString, value: Variant)
[src]

Inherited from Object.

pub fn get(&self, property: GodotString) -> Variant
[src]

Inherited from Object.

pub fn set_indexed(&mut self, property: NodePath, value: Variant)
[src]

Inherited from Object.

pub fn get_indexed(&self, property: NodePath) -> Variant
[src]

Inherited from Object.

pub fn get_property_list(&self) -> VariantArray
[src]

Inherited from Object.

pub fn get_method_list(&self) -> VariantArray
[src]

Inherited from Object.

pub fn notification(&mut self, what: i64, reversed: bool)
[src]

Inherited from Object.

pub fn get_instance_id(&self) -> i64
[src]

Inherited from Object.

pub fn set_script(&mut self, script: Option<Reference>)
[src]

Inherited from Object.

pub fn get_script(&self) -> Option<Reference>
[src]

Inherited from Object.

pub fn set_meta(&mut self, name: GodotString, value: Variant)
[src]

Inherited from Object.

pub fn get_meta(&self, name: GodotString) -> Variant
[src]

Inherited from Object.

pub fn has_meta(&self, name: GodotString) -> bool
[src]

Inherited from Object.

pub fn get_meta_list(&self) -> StringArray
[src]

Inherited from Object.

pub fn add_user_signal(&mut self, signal: GodotString, arguments: VariantArray)
[src]

Inherited from Object.

pub fn has_user_signal(&self, signal: GodotString) -> bool
[src]

Inherited from Object.

pub fn emit_signal(
    &mut self,
    signal: GodotString,
    varargs: &[Variant]
) -> Variant
[src]

Inherited from Object.

pub fn call(&mut self, method: GodotString, varargs: &[Variant]) -> Variant
[src]

Inherited from Object.

pub fn call_deferred(
    &mut self,
    method: GodotString,
    varargs: &[Variant]
) -> Variant
[src]

Inherited from Object.

pub fn callv(&mut self, method: GodotString, arg_array: VariantArray) -> Variant
[src]

Inherited from Object.

pub fn has_method(&self, method: GodotString) -> bool
[src]

Inherited from Object.

pub fn get_signal_list(&self) -> VariantArray
[src]

Inherited from Object.

pub fn get_signal_connection_list(&self, signal: GodotString) -> VariantArray
[src]

Inherited from Object.

pub fn get_incoming_connections(&self) -> VariantArray
[src]

Inherited from Object.

pub fn connect(
    &mut self,
    signal: GodotString,
    target: Option<Object>,
    method: GodotString,
    binds: VariantArray,
    flags: i64
) -> Result<(), GodotError>
[src]

Inherited from Object.

pub fn disconnect(
    &mut self,
    signal: GodotString,
    target: Option<Object>,
    method: GodotString
)
[src]

Inherited from Object.

pub fn is_connected(
    &self,
    signal: GodotString,
    target: Option<Object>,
    method: GodotString
) -> bool
[src]

Inherited from Object.

pub fn set_block_signals(&mut self, enable: bool)
[src]

Inherited from Object.

pub fn is_blocking_signals(&self) -> bool
[src]

Inherited from Object.

pub fn property_list_changed_notify(&mut self)
[src]

Inherited from Object.

pub fn set_message_translation(&mut self, enable: bool)
[src]

Inherited from Object.

pub fn can_translate_messages(&self) -> bool
[src]

Inherited from Object.

pub fn tr(&self, message: GodotString) -> GodotString
[src]

Inherited from Object.

pub fn is_queued_for_deletion(&self) -> bool
[src]

Inherited from Object.

pub fn to_resource(&self) -> Resource
[src]

Up-cast.

pub fn to_reference(&self) -> Reference
[src]

Up-cast.

pub fn to_object(&self) -> Object
[src]

Up-cast.

pub fn cast<T>(&self) -> Option<T> where
    T: GodotObject
[src]

Generic dynamic cast.

Trait Implementations

impl Debug for Image
[src]

impl ToVariant for Image
[src]

impl Drop for Image
[src]

impl GodotObject for Image
[src]

Auto Trait Implementations

impl !Send for Image

impl !Sync for Image

Blanket Implementations

impl<T> From for T
[src]

impl<T, U> Into for T where
    U: From<T>, 
[src]

impl<T, U> TryFrom for T where
    T: From<U>, 
[src]

type Error = !

🔬 This is a nightly-only experimental API. (try_from)

The type returned in the event of a conversion error.

impl<T> Borrow for T where
    T: ?Sized
[src]

impl<T> BorrowMut for T where
    T: ?Sized
[src]

impl<T, U> TryInto for T where
    U: TryFrom<T>, 
[src]

type Error = <U as TryFrom<T>>::Error

🔬 This is a nightly-only experimental API. (try_from)

The type returned in the event of a conversion error.

impl<T> Any for T where
    T: 'static + ?Sized
[src]