Struct gdnative_bindings::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

Methods

impl Image

Constants

pub const ALPHA_BLEND: i64

pub const COMPRESS_SOURCE_NORMAL: i64

pub const INTERPOLATE_CUBIC: i64

pub const INTERPOLATE_TRILINEAR: i64

pub const FORMAT_ETC2_RG11: i64

pub const FORMAT_ETC2_R11: i64

pub const FORMAT_R8: i64

pub const FORMAT_MAX: i64

pub const FORMAT_LA8: i64

pub const FORMAT_L8: i64

pub const FORMAT_RGTC_RG: i64

pub const FORMAT_ETC2_RG11S: i64

pub const FORMAT_BPTC_RGBF: i64

pub const FORMAT_PVRTC2A: i64

pub const FORMAT_RG8: i64

pub const FORMAT_DXT1: i64

pub const MAX_HEIGHT: i64

pub const ALPHA_NONE: i64

pub const FORMAT_RGBA4444: i64

pub const FORMAT_PVRTC4A: i64

pub const FORMAT_RH: i64

pub const FORMAT_PVRTC4: i64

pub const FORMAT_ETC2_RGB8: i64

pub const FORMAT_RF: i64

pub const MAX_WIDTH: i64

pub const FORMAT_RGBAF: i64

pub const FORMAT_DXT5: i64

pub const FORMAT_ETC: i64

pub const COMPRESS_SOURCE_SRGB: i64

pub const FORMAT_RGH: i64

pub const COMPRESS_PVRTC4: i64

pub const COMPRESS_S3TC: i64

pub const FORMAT_ETC2_RGB8A1: i64

pub const COMPRESS_SOURCE_GENERIC: i64

pub const FORMAT_ETC2_R11S: i64

pub const FORMAT_RGF: i64

pub const COMPRESS_PVRTC2: i64

pub const FORMAT_BPTC_RGBFU: i64

pub const FORMAT_RGB8: i64

pub const COMPRESS_ETC: i64

pub const FORMAT_RGBA8: i64

pub const FORMAT_RGBE9995: i64

pub const FORMAT_RGTC_R: i64

pub const FORMAT_DXT3: i64

pub const INTERPOLATE_NEAREST: i64

pub const FORMAT_PVRTC2: i64

pub const FORMAT_RGBA5551: i64

pub const ALPHA_BIT: i64

pub const INTERPOLATE_BILINEAR: i64

pub const COMPRESS_ETC2: i64

pub const FORMAT_RGBAH: i64

pub const FORMAT_ETC2_RGBA8: i64

pub const FORMAT_RGBH: i64

pub const FORMAT_RGBF: i64

pub const FORMAT_BPTC_RGBA: i64

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_data(&self) -> Dictionary

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

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 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 bumpmap_to_normalmap(&mut self, bump_scale: f64)

pub fn clear_mipmaps(&mut self)

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

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

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

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 crop(&mut self, width: i64, height: i64)

pub fn decompress(&mut self) -> GodotResult

pub fn detect_alpha(&self) -> ImageAlphaMode

pub fn expand_x2_hq2x(&mut self)

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

pub fn fix_alpha_edges(&mut self)

pub fn flip_x(&mut self)

pub fn flip_y(&mut self)

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

pub fn get_data(&self) -> ByteArray

pub fn get_format(&self) -> ImageFormat

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: Vector2) -> Color

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

pub fn get_size(&self) -> Vector2

pub fn get_used_rect(&self) -> Rect2

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(&mut self, path: GodotString) -> GodotResult

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

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

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

pub fn lock(&mut self)

pub fn normalmap_to_xy(&mut self)

pub fn premultiply_alpha(&mut self)

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

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

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

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

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

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

pub fn shrink_x2(&mut self)

pub fn srgb_to_linear(&mut self)

pub fn unlock(&mut self)

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.

Methods from Deref<Target = Resource>

pub fn new_ref(&self) -> Self

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

pub fn _setup_local_to_scene(&mut self)

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

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

pub fn get_name(&self) -> GodotString

pub fn get_path(&self) -> GodotString

pub fn get_rid(&self) -> Rid

pub fn is_local_to_scene(&self) -> bool

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

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

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

pub fn setup_local_to_scene(&mut self)

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

pub fn init_ref(&mut self) -> bool

Inherited from Reference.

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 Clone for Image

fn clone(&self) -> Self

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Image

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

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 Drop for Image

fn drop(&mut self)

Executes the destructor for this type.

impl FromVariant for Image

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

impl GodotObject for Image

fn class_name() -> &'static str

unsafe fn from_sys(obj: *mut godot_object) -> Self

unsafe fn to_sys(&self) -> *mut godot_object

impl Instanciable for Image

fn construct() -> Self

impl ToVariant for Image

fn to_variant(&self) -> Variant