Struct godot_core::classes::Image

source ·
#[repr(C)]
pub struct Image { /* private fields */ }
Expand description

Godot class Image.

Inherits Resource.

Related symbols:

  • image: sidecar module with related enum/flag types
  • IImage: virtual methods

See also Godot docs for Image.

§Construction

This class is reference-counted. You can create a new instance using Image::new_gd().

Implementations§

source§

impl Image

source

pub fn get_width(&self) -> i32

source

pub fn get_height(&self) -> i32

source

pub fn get_size(&self) -> Vector2i

source

pub fn has_mipmaps(&self) -> bool

source

pub fn get_format(&self) -> Format

source

pub fn get_data(&self) -> PackedByteArray

source

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

source

pub fn get_mipmap_count(&self) -> i32

source

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

source

pub fn resize_to_po2(&mut self)

source

pub fn resize_to_po2_ex(&mut self) -> ExResizeToPo2<'_>

source

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

source

pub fn resize_ex(&mut self, width: i32, height: i32) -> ExResize<'_>

source

pub fn shrink_x2(&mut self)

source

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

source

pub fn flip_x(&mut self)

source

pub fn flip_y(&mut self)

source

pub fn generate_mipmaps(&mut self) -> Error

source

pub fn generate_mipmaps_ex(&mut self) -> ExGenerateMipmaps<'_>

source

pub fn clear_mipmaps(&mut self)

source

pub fn create( width: i32, height: i32, use_mipmaps: bool, format: Format, ) -> Option<Gd<Image>>

source

pub fn create_from_data( width: i32, height: i32, use_mipmaps: bool, format: Format, data: PackedByteArray, ) -> Option<Gd<Image>>

source

pub fn set_data( &mut self, width: i32, height: i32, use_mipmaps: bool, format: Format, data: PackedByteArray, )

source

pub fn is_empty(&self) -> bool

source

pub fn load(&mut self, path: GString) -> Error

source

pub fn load_from_file(path: GString) -> Option<Gd<Image>>

source

pub fn save_png(&self, path: GString) -> Error

source

pub fn save_png_to_buffer(&self) -> PackedByteArray

source

pub fn save_jpg(&self, path: GString) -> Error

source

pub fn save_jpg_ex(&self, path: GString) -> ExSaveJpg<'_>

source

pub fn save_jpg_to_buffer(&self) -> PackedByteArray

source

pub fn save_jpg_to_buffer_ex(&self) -> ExSaveJpgToBuffer<'_>

source

pub fn save_exr(&self, path: GString) -> Error

source

pub fn save_exr_ex(&self, path: GString) -> ExSaveExr<'_>

source

pub fn save_exr_to_buffer(&self) -> PackedByteArray

source

pub fn save_exr_to_buffer_ex(&self) -> ExSaveExrToBuffer<'_>

source

pub fn save_webp(&self, path: GString) -> Error

source

pub fn save_webp_ex(&self, path: GString) -> ExSaveWebp<'_>

source

pub fn save_webp_to_buffer(&self) -> PackedByteArray

source

pub fn save_webp_to_buffer_ex(&self) -> ExSaveWebpToBuffer<'_>

source

pub fn detect_alpha(&self) -> AlphaMode

source

pub fn is_invisible(&self) -> bool

source

pub fn detect_used_channels(&self) -> UsedChannels

source

pub fn detect_used_channels_ex(&self) -> ExDetectUsedChannels<'_>

source

pub fn compress(&mut self, mode: CompressMode) -> Error

source

pub fn compress_ex(&mut self, mode: CompressMode) -> ExCompress<'_>

source

pub fn compress_from_channels( &mut self, mode: CompressMode, channels: UsedChannels, ) -> Error

source

pub fn compress_from_channels_ex( &mut self, mode: CompressMode, channels: UsedChannels, ) -> ExCompressFromChannels<'_>

source

pub fn decompress(&mut self) -> Error

source

pub fn is_compressed(&self) -> bool

source

pub fn rotate_90(&mut self, direction: ClockDirection)

source

pub fn rotate_180(&mut self)

source

pub fn fix_alpha_edges(&mut self)

source

pub fn premultiply_alpha(&mut self)

source

pub fn srgb_to_linear(&mut self)

source

pub fn normal_map_to_xy(&mut self)

source

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

source

pub fn bump_map_to_normal_map(&mut self)

source

pub fn bump_map_to_normal_map_ex(&mut self) -> ExBumpMapToNormalMap<'_>

source

pub fn compute_image_metrics( &mut self, compared_image: Gd<Image>, use_luma: bool, ) -> Dictionary

source

pub fn blit_rect(&mut self, src: Gd<Image>, src_rect: Rect2i, dst: Vector2i)

source

pub fn blit_rect_mask( &mut self, src: Gd<Image>, mask: Gd<Image>, src_rect: Rect2i, dst: Vector2i, )

source

pub fn blend_rect(&mut self, src: Gd<Image>, src_rect: Rect2i, dst: Vector2i)

source

pub fn blend_rect_mask( &mut self, src: Gd<Image>, mask: Gd<Image>, src_rect: Rect2i, dst: Vector2i, )

source

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

source

pub fn fill_rect(&mut self, rect: Rect2i, color: Color)

source

pub fn get_used_rect(&self) -> Rect2i

source

pub fn get_region(&self, region: Rect2i) -> Option<Gd<Image>>

source

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

source

pub fn get_pixelv(&self, point: Vector2i) -> Color

source

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

source

pub fn set_pixelv(&mut self, point: Vector2i, color: Color)

source

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

source

pub fn adjust_bcs(&mut self, brightness: f32, contrast: f32, saturation: f32)

source

pub fn load_png_from_buffer(&mut self, buffer: PackedByteArray) -> Error

source

pub fn load_jpg_from_buffer(&mut self, buffer: PackedByteArray) -> Error

source

pub fn load_webp_from_buffer(&mut self, buffer: PackedByteArray) -> Error

source

pub fn load_tga_from_buffer(&mut self, buffer: PackedByteArray) -> Error

source

pub fn load_bmp_from_buffer(&mut self, buffer: PackedByteArray) -> Error

source

pub fn load_ktx_from_buffer(&mut self, buffer: PackedByteArray) -> Error

source

pub fn load_svg_from_buffer(&mut self, buffer: PackedByteArray) -> Error

source

pub fn load_svg_from_buffer_ex( &mut self, buffer: PackedByteArray, ) -> ExLoadSvgFromBuffer<'_>

source

pub fn load_svg_from_string(&mut self, svg_str: GString) -> Error

source

pub fn load_svg_from_string_ex( &mut self, svg_str: GString, ) -> ExLoadSvgFromString<'_>

source

pub const MAX_WIDTH: i32 = 16_777_216i32

source

pub const MAX_HEIGHT: i32 = 16_777_216i32

Methods from Deref<Target = Resource>§

source

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

source

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

source

pub fn get_path(&self) -> GString

source

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

source

pub fn get_name(&self) -> GString

source

pub fn get_rid(&self) -> Rid

source

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

source

pub fn is_local_to_scene(&self) -> bool

source

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

source

pub fn setup_local_to_scene(&mut self)

source

pub fn emit_changed(&mut self)

source

pub fn duplicate(&self) -> Option<Gd<Resource>>

source

pub fn duplicate_ex(&self) -> ExDuplicate<'_>

Methods from Deref<Target = RefCounted>§

Methods from Deref<Target = Object>§

source

pub fn get_class(&self) -> GString

source

pub fn is_class(&self, class: GString) -> bool

source

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

source

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

source

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

source

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

source

pub fn get_property_list(&self) -> Array<Dictionary>

source

pub fn get_method_list(&self) -> Array<Dictionary>

source

pub fn property_can_revert(&self, property: StringName) -> bool

source

pub fn property_get_revert(&self, property: StringName) -> Variant

source

pub fn set_script(&mut self, script: Variant)

source

pub fn get_script(&self) -> Variant

source

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

source

pub fn remove_meta(&mut self, name: StringName)

source

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

source

pub fn get_meta_ex(&self, name: StringName) -> ExGetMeta<'_>

source

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

source

pub fn get_meta_list(&self) -> Array<StringName>

source

pub fn add_user_signal(&mut self, signal: GString)

source

pub fn add_user_signal_ex(&mut self, signal: GString) -> ExAddUserSignal<'_>

source

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

source

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

§Panics

This is a varcall method, meaning parameters and return values are passed as Variant. It can detect call failures and will panic in such a case.

source

pub fn try_emit_signal( &mut self, signal: StringName, varargs: &[Variant], ) -> Result<Error, CallError>

§Return type

This is a varcall method, meaning parameters and return values are passed as Variant. It can detect call failures and will return Err in such a case.

source

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

§Panics

This is a varcall method, meaning parameters and return values are passed as Variant. It can detect call failures and will panic in such a case.

source

pub fn try_call( &mut self, method: StringName, varargs: &[Variant], ) -> Result<Variant, CallError>

§Return type

This is a varcall method, meaning parameters and return values are passed as Variant. It can detect call failures and will return Err in such a case.

source

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

§Panics

This is a varcall method, meaning parameters and return values are passed as Variant. It can detect call failures and will panic in such a case.

source

pub fn try_call_deferred( &mut self, method: StringName, varargs: &[Variant], ) -> Result<Variant, CallError>

§Return type

This is a varcall method, meaning parameters and return values are passed as Variant. It can detect call failures and will return Err in such a case.

source

pub fn set_deferred(&mut self, property: StringName, value: Variant)

source

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

source

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

source

pub fn has_signal(&self, signal: StringName) -> bool

source

pub fn get_signal_list(&self) -> Array<Dictionary>

source

pub fn get_signal_connection_list( &self, signal: StringName, ) -> Array<Dictionary>

source

pub fn get_incoming_connections(&self) -> Array<Dictionary>

source

pub fn connect(&mut self, signal: StringName, callable: Callable) -> Error

source

pub fn connect_ex( &mut self, signal: StringName, callable: Callable, ) -> ExConnect<'_>

source

pub fn disconnect(&mut self, signal: StringName, callable: Callable)

source

pub fn is_connected(&self, signal: StringName, callable: Callable) -> bool

source

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

source

pub fn is_blocking_signals(&self) -> bool

source

pub fn notify_property_list_changed(&mut self)

source

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

source

pub fn can_translate_messages(&self) -> bool

source

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

source

pub fn tr_ex(&self, message: StringName) -> ExTr<'_>

source

pub fn tr_n( &self, message: StringName, plural_message: StringName, n: i32, ) -> GString

source

pub fn tr_n_ex( &self, message: StringName, plural_message: StringName, n: i32, ) -> ExTrN<'_>

source

pub fn is_queued_for_deletion(&self) -> bool

source

pub fn cancel_free(&mut self)

source

pub fn notify(&mut self, what: ObjectNotification)

⚠️ Sends a Godot notification to all classes inherited by the object.

Triggers calls to on_notification(), and depending on the notification, also to Godot’s lifecycle callbacks such as ready().

Starts from the highest ancestor (the Object class) and goes down the hierarchy. See also Godot docs for Object::notification().

§Panics

If you call this method on a user-defined object while holding a GdRef or GdMut guard on the instance, you will encounter a panic. The reason is that the receiving virtual method on_notification() acquires a GdMut lock dynamically, which must be exclusive.

source

pub fn notify_reversed(&mut self, what: ObjectNotification)

⚠️ Like Self::notify(), but starts at the most-derived class and goes up the hierarchy.

See docs of that method, including the panics.

Trait Implementations§

source§

impl Bounds for Image

§

type Memory = MemRefCounted

Defines the memory strategy of the static type.
§

type Declarer = DeclEngine

Whether this class is a core Godot class provided by the engine, or declared by the user as a Rust struct.
source§

impl Debug for Image

source§

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

Formats the value using the given formatter. Read more
source§

impl Deref for Image

§

type Target = Resource

The resulting type after dereferencing.
source§

fn deref(&self) -> &Self::Target

Dereferences the value.
source§

impl DerefMut for Image

source§

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.
source§

impl GodotClass for Image

§

type Base = Resource

The immediate superclass of T. This is always a Godot engine class.
source§

fn class_name() -> ClassName

The name of the class, under which it is registered in Godot. Read more
source§

const INIT_LEVEL: InitLevel = crate::init::InitLevel::Scene

Initialization level, during which this class should be initialized with Godot. Read more
source§

fn inherits<U: GodotClass>() -> bool

Returns whether Self inherits from U. Read more
source§

impl GodotDefault for Image

source§

impl Inherits<Object> for Image

source§

impl Inherits<RefCounted> for Image

source§

impl Inherits<Resource> for Image

Auto Trait Implementations§

§

impl Freeze for Image

§

impl RefUnwindSafe for Image

§

impl !Send for Image

§

impl !Sync for Image

§

impl Unpin for Image

§

impl UnwindSafe for Image

Blanket Implementations§

source§

impl<T> Any for T
where T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for T
where T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T, U> Into<U> for T
where U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T> NewGd for T
where T: GodotDefault<Memory = MemRefCounted> + Bounds,

source§

fn new_gd() -> Gd<T>

Return a new, ref-counted Gd containing a default-constructed instance. Read more
source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

§

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

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
source§

impl<T> Inherits<T> for T
where T: GodotClass,