Struct gdnative::prelude::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.

Class hierarchy

Image inherits methods from:

• Resource
• 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 Image

Constants

pub const ALPHA_BIT: i64

pub const ALPHA_BLEND: i64

pub const ALPHA_NONE: i64

pub const COMPRESS_ETC: i64

pub const COMPRESS_ETC2: i64

pub const COMPRESS_PVRTC2: i64

pub const COMPRESS_PVRTC4: i64

pub const COMPRESS_S3TC: i64

pub const COMPRESS_SOURCE_GENERIC: i64

pub const COMPRESS_SOURCE_NORMAL: i64

pub const COMPRESS_SOURCE_SRGB: i64

pub const FORMAT_BPTC_RGBA: i64

pub const FORMAT_BPTC_RGBF: i64

pub const FORMAT_BPTC_RGBFU: i64

pub const FORMAT_DXT1: i64

pub const FORMAT_DXT3: i64

pub const FORMAT_DXT5: i64

pub const FORMAT_ETC: i64

pub const FORMAT_ETC2_R11: i64

pub const FORMAT_ETC2_R11S: i64

pub const FORMAT_ETC2_RG11: i64

pub const FORMAT_ETC2_RG11S: i64

pub const FORMAT_ETC2_RGB8: i64

pub const FORMAT_ETC2_RGB8A1: i64

pub const FORMAT_ETC2_RGBA8: i64

pub const FORMAT_L8: i64

pub const FORMAT_LA8: i64

pub const FORMAT_MAX: i64

pub const FORMAT_PVRTC2: i64

pub const FORMAT_PVRTC2A: i64

pub const FORMAT_PVRTC4: i64

pub const FORMAT_PVRTC4A: i64

pub const FORMAT_R8: i64

pub const FORMAT_RF: i64

pub const FORMAT_RG8: i64

pub const FORMAT_RGB8: i64

pub const FORMAT_RGBA4444: i64

pub const FORMAT_RGBA5551: i64

pub const FORMAT_RGBA8: i64

pub const FORMAT_RGBAF: i64

pub const FORMAT_RGBAH: i64

pub const FORMAT_RGBE9995: i64

pub const FORMAT_RGBF: i64

pub const FORMAT_RGBH: i64

pub const FORMAT_RGF: i64

pub const FORMAT_RGH: i64

pub const FORMAT_RGTC_R: i64

pub const FORMAT_RGTC_RG: i64

pub const FORMAT_RH: i64

pub const INTERPOLATE_BILINEAR: i64

pub const INTERPOLATE_CUBIC: i64

pub const INTERPOLATE_LANCZOS: i64

pub const INTERPOLATE_NEAREST: i64

pub const INTERPOLATE_TRILINEAR: i64

pub const MAX_HEIGHT: i64

pub const MAX_WIDTH: i64

impl Image

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

Creates a new instance of this object.

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

pub fn blend_rect(
    &self,
    src: impl AsArg<Image>,
    src_rect: Rect<f32, UnknownUnit>,
    dst: Vector2D<f32, UnknownUnit>
)

pub fn blend_rect_mask(
    &self,
    src: impl AsArg<Image>,
    mask: impl AsArg<Image>,
    src_rect: Rect<f32, UnknownUnit>,
    dst: Vector2D<f32, UnknownUnit>
)

pub fn blit_rect(
    &self,
    src: impl AsArg<Image>,
    src_rect: Rect<f32, UnknownUnit>,
    dst: Vector2D<f32, UnknownUnit>
)

pub fn blit_rect_mask(
    &self,
    src: impl AsArg<Image>,
    mask: impl AsArg<Image>,
    src_rect: Rect<f32, UnknownUnit>,
    dst: Vector2D<f32, UnknownUnit>
)

pub fn bumpmap_to_normalmap(&self, bump_scale: f64)

pub fn clear_mipmaps(&self)

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

pub fn convert(&self, format: i64)

pub fn copy_from(&self, src: impl AsArg<Image>)

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

pub fn create_from_data(
    &self,
    width: i64,
    height: i64,
    use_mipmaps: bool,
    format: i64,
    data: TypedArray<u8>
)

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

pub fn decompress(&self) -> Result<(), GodotError>

pub fn detect_alpha(&self) -> AlphaMode

pub fn expand_x2_hq2x(&self)

pub fn fill(&self, color: Color)

pub fn fix_alpha_edges(&self)

pub fn flip_x(&self)

pub fn flip_y(&self)

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

pub fn get_data(&self) -> TypedArray<u8>

pub fn get_format(&self) -> Format

pub fn get_height(&self) -> i64

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

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

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

pub fn get_rect(
    &self,
    rect: Rect<f32, UnknownUnit>
) -> Option<Ref<Image, Shared>>

pub fn get_size(&self) -> Vector2D<f32, UnknownUnit>

pub fn get_used_rect(&self) -> Rect<f32, UnknownUnit>

pub fn get_width(&self) -> i64

pub fn has_mipmaps(&self) -> bool

pub fn is_compressed(&self) -> bool

pub fn is_empty(&self) -> bool

pub fn is_invisible(&self) -> bool

pub fn load(&self, path: impl Into<GodotString>) -> Result<(), GodotError>

pub fn load_jpg_from_buffer(
    &self,
    buffer: TypedArray<u8>
) -> Result<(), GodotError>

pub fn load_png_from_buffer(
    &self,
    buffer: TypedArray<u8>
) -> Result<(), GodotError>

pub fn load_webp_from_buffer(
    &self,
    buffer: TypedArray<u8>
) -> Result<(), GodotError>

pub fn lock(&self)

pub fn normalmap_to_xy(&self)

pub fn premultiply_alpha(&self)

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

pub fn resize_to_po2(&self, square: bool)

pub fn rgbe_to_srgb(&self) -> Option<Ref<Image, Shared>>

pub fn save_exr(
    &self,
    path: impl Into<GodotString>,
    grayscale: bool
) -> Result<(), GodotError>

pub fn save_png(&self, path: impl Into<GodotString>) -> Result<(), GodotError>

pub fn save_png_to_buffer(&self) -> TypedArray<u8>

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

pub fn set_pixelv(&self, dst: Vector2D<f32, UnknownUnit>, color: Color)

pub fn shrink_x2(&self)

pub fn srgb_to_linear(&self)

pub fn unlock(&self)

Methods from Deref<Target = Resource>

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

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

pub fn name(&self) -> GodotString

pub fn path(&self) -> GodotString

pub fn get_rid(&self) -> Rid

pub fn is_local_to_scene(&self) -> bool

pub fn set_local_to_scene(&self, enable: bool)

pub fn set_name(&self, name: impl Into<GodotString>)

pub fn set_path(&self, path: impl Into<GodotString>)

pub fn setup_local_to_scene(&self)

pub fn take_over_path(&self, path: impl Into<GodotString>)

Trait Implementations

impl Debug for Image

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

Formats the value using the given formatter.

impl Deref for Image

type Target = Resource

The resulting type after dereferencing.

fn deref(&self) -> &Resource

Dereferences the value.

impl DerefMut for Image

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

Mutably dereferences the value.

impl GodotObject for Image

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 Image

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

impl SubClass<Object> for Image

impl SubClass<Reference> for Image

impl SubClass<Resource> for Image