Struct Image

pub struct Image { /* private fields */ }

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:

• Resource
• Reference
• Object

Implementations

impl Image

pub fn new() -> Self

pub fn new_ref(&self) -> Self

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

pub fn get_width(&self) -> i64

pub fn get_height(&self) -> i64

pub fn get_size(&self) -> Vector2

pub fn has_mipmaps(&self) -> bool

pub fn get_format(&self) -> ImageFormat

pub fn get_data(&self) -> ByteArray

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

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

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

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

pub fn shrink_x2(&mut self)

pub fn expand_x2_hq2x(&mut self)

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

pub fn flip_x(&mut self)

pub fn flip_y(&mut self)

pub fn generate_mipmaps(&mut self, renormalize: bool) -> GodotResult

pub fn clear_mipmaps(&mut self)

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

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

pub fn is_empty(&self) -> bool

pub fn load(&mut self, path: GodotString) -> GodotResult

pub fn save_png(&self, path: GodotString) -> GodotResult

pub fn detect_alpha(&self) -> ImageAlphaMode

pub fn is_invisible(&self) -> bool

pub fn compress( &mut self, mode: i64, source: i64, lossy_quality: f64, ) -> GodotResult

pub fn decompress(&mut self) -> GodotResult

pub fn is_compressed(&self) -> bool

pub fn fix_alpha_edges(&mut self)

pub fn premultiply_alpha(&mut self)

pub fn srgb_to_linear(&mut self)

pub fn normalmap_to_xy(&mut self)

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

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

pub fn blit_rect(&mut self, src: Option<Image>, src_rect: Rect2, dst: Vector2)

pub fn blit_rect_mask( &mut self, src: Option<Image>, mask: Option<Image>, src_rect: Rect2, dst: Vector2, )

pub fn blend_rect(&mut self, src: Option<Image>, src_rect: Rect2, dst: Vector2)

pub fn blend_rect_mask( &mut self, src: Option<Image>, mask: Option<Image>, src_rect: Rect2, dst: Vector2, )

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

pub fn get_used_rect(&self) -> Rect2

pub fn get_rect(&self, rect: Rect2) -> Option<Image>

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

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

pub fn _get_data(&self) -> Dictionary

pub fn lock(&mut self)

pub fn unlock(&mut self)

pub fn get_pixelv(&self, src: Vector2) -> Color

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

pub fn set_pixelv(&mut self, dst: Vector2, color: Color)

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

pub fn load_png_from_buffer(&mut self, buffer: ByteArray) -> GodotResult

pub fn load_jpg_from_buffer(&mut self, buffer: ByteArray) -> GodotResult

pub fn load_webp_from_buffer(&mut self, buffer: ByteArray) -> GodotResult

pub fn _setup_local_to_scene(&mut self)

Inherited from Resource.

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

Inherited from Resource.

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

Inherited from Resource.

pub fn get_path(&self) -> GodotString

Inherited from Resource.

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

Inherited from Resource.

pub fn get_name(&self) -> GodotString

Inherited from Resource.

pub fn get_rid(&self) -> Rid

Inherited from Resource.

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

Inherited from Resource.

pub fn is_local_to_scene(&self) -> bool

Inherited from Resource.

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

Inherited from Resource.

pub fn setup_local_to_scene(&mut self)

Inherited from Resource.

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

Inherited from Resource.

pub fn init_ref(&mut self) -> bool

Inherited from Reference.

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

Inherited from Object.

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

Inherited from Object.

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

Inherited from Object.

pub fn _get_property_list(&mut self) -> VariantArray

Inherited from Object.

pub fn _init(&mut self)

Inherited from Object.

pub fn get_class(&self) -> GodotString

Inherited from Object.

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

Inherited from Object.

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

Inherited from Object.

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

Inherited from Object.

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

Inherited from Object.

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

Inherited from Object.

pub fn get_property_list(&self) -> VariantArray

Inherited from Object.

pub fn get_method_list(&self) -> VariantArray

Inherited from Object.

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

Inherited from Object.

pub fn get_instance_id(&self) -> i64

Inherited from Object.

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

Inherited from Object.

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

Inherited from Object.

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

Inherited from Object.

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

Inherited from Object.

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

Inherited from Object.

pub fn get_meta_list(&self) -> StringArray

Inherited from Object.

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

Inherited from Object.

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

Inherited from Object.

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

Inherited from Object.

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

Inherited from Object.

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

Inherited from Object.

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

Inherited from Object.

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

Inherited from Object.

pub fn get_signal_list(&self) -> VariantArray

Inherited from Object.

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

Inherited from Object.

pub fn get_incoming_connections(&self) -> VariantArray

Inherited from Object.

pub fn connect( &mut self, signal: GodotString, target: Option<Object>, method: GodotString, binds: VariantArray, flags: i64, ) -> GodotResult

Inherited from Object.

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

Inherited from Object.

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

Inherited from Object.

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

Inherited from Object.

pub fn is_blocking_signals(&self) -> bool

Inherited from Object.

pub fn property_list_changed_notify(&mut self)

Inherited from Object.

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

Inherited from Object.

pub fn can_translate_messages(&self) -> bool

Inherited from Object.

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

Inherited from Object.

pub fn is_queued_for_deletion(&self) -> bool

Inherited from Object.

pub fn to_resource(&self) -> Resource

Up-cast.

pub fn to_reference(&self) -> Reference

Up-cast.

pub fn to_object(&self) -> Object

Up-cast.

pub fn cast<T: GodotObject>(&self) -> Option<T>

Generic dynamic cast.

Trait Implementations

impl Debug for Image

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

Formats the value using the given formatter.

impl Drop for Image

fn drop(&mut self)

Executes the destructor for this type.

impl GodotObject for Image

fn class_name() -> &'static str

impl ToVariant for Image

fn to_variant(&self) -> Variant

fn from_variant(variant: &Variant) -> Option<Self>