Struct gdnative_bindings::Image
source · pub struct Image { /* private fields */ }
Expand description
core class Image
inherits Resource
(reference-counted).
This class has related types in the image
module.
Official documentation
See the documentation of this class in the Godot engine’s official documentation. The method descriptions are generated from it and typically contain code samples in GDScript, not Rust.
Memory management
The lifetime of this object is automatically managed through reference counting.
Class hierarchy
Image inherits methods from:
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 Ownership
in these types tracks whether
ownership is unique, shared, or exclusive to the current thread. For more information,
see the type-level documentation on Ref
.
Implementations§
source§impl Image
impl Image
Constants
pub const ALPHA_NONE: i64 = 0i64
pub const COMPRESS_S3TC: i64 = 0i64
pub const COMPRESS_SOURCE_GENERIC: i64 = 0i64
pub const FORMAT_L8: i64 = 0i64
pub const INTERPOLATE_NEAREST: i64 = 0i64
pub const ALPHA_BIT: i64 = 1i64
pub const COMPRESS_PVRTC2: i64 = 1i64
pub const COMPRESS_SOURCE_SRGB: i64 = 1i64
pub const FORMAT_LA8: i64 = 1i64
pub const INTERPOLATE_BILINEAR: i64 = 1i64
pub const ALPHA_BLEND: i64 = 2i64
pub const COMPRESS_PVRTC4: i64 = 2i64
pub const COMPRESS_SOURCE_NORMAL: i64 = 2i64
pub const FORMAT_R8: i64 = 2i64
pub const INTERPOLATE_CUBIC: i64 = 2i64
pub const COMPRESS_ETC: i64 = 3i64
pub const COMPRESS_SOURCE_LAYERED: i64 = 3i64
pub const FORMAT_RG8: i64 = 3i64
pub const INTERPOLATE_TRILINEAR: i64 = 3i64
pub const COMPRESS_ETC2: i64 = 4i64
pub const FORMAT_RGB8: i64 = 4i64
pub const INTERPOLATE_LANCZOS: i64 = 4i64
pub const FORMAT_RGBA8: i64 = 5i64
pub const FORMAT_RGBA4444: i64 = 6i64
pub const FORMAT_RGBA5551: i64 = 7i64
pub const FORMAT_RF: i64 = 8i64
pub const FORMAT_RGF: i64 = 9i64
pub const FORMAT_RGBF: i64 = 10i64
pub const FORMAT_RGBAF: i64 = 11i64
pub const FORMAT_RH: i64 = 12i64
pub const FORMAT_RGH: i64 = 13i64
pub const FORMAT_RGBH: i64 = 14i64
pub const FORMAT_RGBAH: i64 = 15i64
pub const FORMAT_RGBE9995: i64 = 16i64
pub const FORMAT_DXT1: i64 = 17i64
pub const FORMAT_DXT3: i64 = 18i64
pub const FORMAT_DXT5: i64 = 19i64
pub const FORMAT_RGTC_R: i64 = 20i64
pub const FORMAT_RGTC_RG: i64 = 21i64
pub const FORMAT_BPTC_RGBA: i64 = 22i64
pub const FORMAT_BPTC_RGBF: i64 = 23i64
pub const FORMAT_BPTC_RGBFU: i64 = 24i64
pub const FORMAT_PVRTC2: i64 = 25i64
pub const FORMAT_PVRTC2A: i64 = 26i64
pub const FORMAT_PVRTC4: i64 = 27i64
pub const FORMAT_PVRTC4A: i64 = 28i64
pub const FORMAT_ETC: i64 = 29i64
pub const FORMAT_ETC2_R11: i64 = 30i64
pub const FORMAT_ETC2_R11S: i64 = 31i64
pub const FORMAT_ETC2_RG11: i64 = 32i64
pub const FORMAT_ETC2_RG11S: i64 = 33i64
pub const FORMAT_ETC2_RGB8: i64 = 34i64
pub const FORMAT_ETC2_RGBA8: i64 = 35i64
pub const FORMAT_ETC2_RGB8A1: i64 = 36i64
pub const FORMAT_MAX: i64 = 37i64
pub const MAX_HEIGHT: i64 = 16_384i64
pub const MAX_WIDTH: i64 = 16_384i64
source§impl Image
impl Image
sourcepub fn new() -> Ref<Self, Unique>
pub fn new() -> Ref<Self, Unique>
Creates a new instance of this object.
This is a reference-counted type. The returned object is automatically managed
by Ref
.
sourcepub fn blend_rect(&self, src: impl AsArg<Image>, src_rect: Rect2, dst: Vector2)
pub fn blend_rect(&self, src: impl AsArg<Image>, src_rect: Rect2, dst: Vector2)
Alpha-blends src_rect
from src
image to this image at coordinates dest
, clipped accordingly to both image bounds. This image and src
image must have the same format. src_rect
with not positive size is treated as empty.
sourcepub fn blend_rect_mask(
&self,
src: impl AsArg<Image>,
mask: impl AsArg<Image>,
src_rect: Rect2,
dst: Vector2
)
pub fn blend_rect_mask(
&self,
src: impl AsArg<Image>,
mask: impl AsArg<Image>,
src_rect: Rect2,
dst: Vector2
)
Alpha-blends src_rect
from src
image to this image using mask
image at coordinates dst
, clipped accordingly to both image bounds. Alpha channels are required for both src
and mask
. dst
pixels and src
pixels will blend if the corresponding mask pixel’s alpha value is not 0. This image and src
image must have the same format. src
image and mask
image must have the same size (width and height) but they can have different formats. src_rect
with not positive size is treated as empty.
sourcepub fn blit_rect(&self, src: impl AsArg<Image>, src_rect: Rect2, dst: Vector2)
pub fn blit_rect(&self, src: impl AsArg<Image>, src_rect: Rect2, dst: Vector2)
Copies src_rect
from src
image to this image at coordinates dst
, clipped accordingly to both image bounds. This image and src
image must have the same format. src_rect
with not positive size is treated as empty.
sourcepub fn blit_rect_mask(
&self,
src: impl AsArg<Image>,
mask: impl AsArg<Image>,
src_rect: Rect2,
dst: Vector2
)
pub fn blit_rect_mask(
&self,
src: impl AsArg<Image>,
mask: impl AsArg<Image>,
src_rect: Rect2,
dst: Vector2
)
Blits src_rect
area from src
image to this image at the coordinates given by dst
, clipped accordingly to both image bounds. src
pixel is copied onto dst
if the corresponding mask
pixel’s alpha value is not 0. This image and src
image must have the same format. src
image and mask
image must have the same size (width and height) but they can have different formats. src_rect
with not positive size is treated as empty.
sourcepub fn bumpmap_to_normalmap(&self, bump_scale: f64)
pub fn bumpmap_to_normalmap(&self, bump_scale: f64)
Converts a bumpmap to a normalmap. A bumpmap provides a height offset per-pixel, while a normalmap provides a normal direction per pixel.
Default Arguments
bump_scale
-1.0
sourcepub fn clear_mipmaps(&self)
pub fn clear_mipmaps(&self)
Removes the image’s mipmaps.
sourcepub fn compress(&self, mode: i64, source: i64, lossy_quality: f64) -> GodotResult
pub fn compress(&self, mode: i64, source: i64, lossy_quality: f64) -> GodotResult
Compresses the image to use less memory. Can not directly access pixel data while the image is compressed. Returns error if the chosen compression mode is not available. See CompressMode
and CompressSource
constants.
sourcepub fn create(&self, width: i64, height: i64, use_mipmaps: bool, format: i64)
pub fn create(&self, width: i64, height: i64, use_mipmaps: bool, format: i64)
Creates an empty image of given size and format. See Format
constants. If use_mipmaps
is true
then generate mipmaps for this image. See the generate_mipmaps
.
sourcepub fn create_from_data(
&self,
width: i64,
height: i64,
use_mipmaps: bool,
format: i64,
data: PoolArray<u8>
)
pub fn create_from_data(
&self,
width: i64,
height: i64,
use_mipmaps: bool,
format: i64,
data: PoolArray<u8>
)
Creates a new image of given size and format. See Format
constants. Fills the image with the given raw data. If use_mipmaps
is true
then loads mipmaps for this image from data
. See generate_mipmaps
.
sourcepub fn crop(&self, width: i64, height: i64)
pub fn crop(&self, width: i64, height: i64)
Crops the image to the given width
and height
. If the specified size is larger than the current size, the extra area is filled with black pixels.
sourcepub fn decompress(&self) -> GodotResult
pub fn decompress(&self) -> GodotResult
Decompresses the image if it is compressed. Returns an error if decompress function is not available.
sourcepub fn detect_alpha(&self) -> AlphaMode
pub fn detect_alpha(&self) -> AlphaMode
Returns ALPHA_BLEND
if the image has data for alpha values. Returns ALPHA_BIT
if all the alpha values are stored in a single bit. Returns ALPHA_NONE
if no data for alpha values is found.
sourcepub fn expand_x2_hq2x(&self)
pub fn expand_x2_hq2x(&self)
Stretches the image and enlarges it by a factor of 2. No interpolation is done.
sourcepub fn fix_alpha_edges(&self)
pub fn fix_alpha_edges(&self)
Blends low-alpha pixels with nearby pixels.
sourcepub fn generate_mipmaps(&self, renormalize: bool) -> GodotResult
pub fn generate_mipmaps(&self, renormalize: bool) -> GodotResult
Generates mipmaps for the image. Mipmaps are precalculated lower-resolution copies of the image that are automatically used if the image needs to be scaled down when rendered. They help improve image quality and performance when rendering. This method returns an error if the image is compressed, in a custom format, or if the image’s width/height is 0
.
Note: Mipmap generation is done on the CPU, is single-threaded and is always done on the main thread. This means generating mipmaps will result in noticeable stuttering during gameplay, even if generate_mipmaps
is called from a Thread
.
Default Arguments
renormalize
-false
sourcepub fn get_format(&self) -> Format
pub fn get_format(&self) -> Format
Returns the image’s format. See Format
constants.
sourcepub fn get_height(&self) -> i64
pub fn get_height(&self) -> i64
Returns the image’s height.
sourcepub fn get_mipmap_offset(&self, mipmap: i64) -> i64
pub fn get_mipmap_offset(&self, mipmap: i64) -> i64
Returns the offset where the image’s mipmap with index mipmap
is stored in the data
dictionary.
sourcepub fn get_pixel(&self, x: i64, y: i64) -> Color
pub fn get_pixel(&self, x: i64, y: i64) -> Color
Returns the color of the pixel at (x, y)
if the image is locked. If the image is unlocked, it always returns a Color
with the value (0, 0, 0, 1.0)
. This is the same as get_pixelv
, but two integer arguments instead of a Vector2 argument.
sourcepub fn get_pixelv(&self, src: Vector2) -> Color
pub fn get_pixelv(&self, src: Vector2) -> Color
sourcepub fn get_rect(&self, rect: Rect2) -> Option<Ref<Image, Shared>>
pub fn get_rect(&self, rect: Rect2) -> Option<Ref<Image, Shared>>
Returns a new image that is a copy of the image’s area specified with rect
.
sourcepub fn get_used_rect(&self) -> Rect2
pub fn get_used_rect(&self) -> Rect2
Returns a Rect2
enclosing the visible portion of the image, considering each pixel with a non-zero alpha channel as visible.
sourcepub fn has_mipmaps(&self) -> bool
pub fn has_mipmaps(&self) -> bool
Returns true
if the image has generated mipmaps.
sourcepub fn is_compressed(&self) -> bool
pub fn is_compressed(&self) -> bool
Returns true
if the image is compressed.
sourcepub fn is_invisible(&self) -> bool
pub fn is_invisible(&self) -> bool
Returns true
if all the image’s pixels have an alpha value of 0. Returns false
if any pixel has an alpha value higher than 0.
sourcepub fn load(&self, path: impl Into<GodotString>) -> GodotResult
pub fn load(&self, path: impl Into<GodotString>) -> GodotResult
Loads an image from file path
. See Supported image formats for a list of supported image formats and limitations.
Warning: This method should only be used in the editor or in cases when you need to load external images at run-time, such as images located at the user://
directory, and may not work in exported projects.
See also ImageTexture
description for usage examples.
sourcepub fn load_bmp_from_buffer(&self, buffer: PoolArray<u8>) -> GodotResult
pub fn load_bmp_from_buffer(&self, buffer: PoolArray<u8>) -> GodotResult
Loads an image from the binary contents of a BMP file. Note: Godot’s BMP module doesn’t support 16-bit per pixel images. Only 1-bit, 4-bit, 8-bit, 24-bit, and 32-bit per pixel images are supported.
sourcepub fn load_jpg_from_buffer(&self, buffer: PoolArray<u8>) -> GodotResult
pub fn load_jpg_from_buffer(&self, buffer: PoolArray<u8>) -> GodotResult
Loads an image from the binary contents of a JPEG file.
sourcepub fn load_png_from_buffer(&self, buffer: PoolArray<u8>) -> GodotResult
pub fn load_png_from_buffer(&self, buffer: PoolArray<u8>) -> GodotResult
Loads an image from the binary contents of a PNG file.
sourcepub fn load_tga_from_buffer(&self, buffer: PoolArray<u8>) -> GodotResult
pub fn load_tga_from_buffer(&self, buffer: PoolArray<u8>) -> GodotResult
Loads an image from the binary contents of a TGA file.
sourcepub fn load_webp_from_buffer(&self, buffer: PoolArray<u8>) -> GodotResult
pub fn load_webp_from_buffer(&self, buffer: PoolArray<u8>) -> GodotResult
Loads an image from the binary contents of a WebP file.
sourcepub fn lock(&self)
pub fn lock(&self)
Locks the data for reading and writing access. Sends an error to the console if the image is not locked when reading or writing a pixel.
sourcepub fn normalmap_to_xy(&self)
pub fn normalmap_to_xy(&self)
Converts the image’s data to represent coordinates on a 3D plane. This is used when the image represents a normalmap. A normalmap can add lots of detail to a 3D surface without increasing the polygon count.
sourcepub fn premultiply_alpha(&self)
pub fn premultiply_alpha(&self)
Multiplies color values with alpha values. Resulting color values for a pixel are (color * alpha)/256
.
sourcepub fn resize(&self, width: i64, height: i64, interpolation: i64)
pub fn resize(&self, width: i64, height: i64, interpolation: i64)
Resizes the image to the given width
and height
. New pixels are calculated using the interpolation
mode defined via Interpolation
constants.
Default Arguments
interpolation
-1
sourcepub fn resize_to_po2(&self, square: bool, interpolation: i64)
pub fn resize_to_po2(&self, square: bool, interpolation: i64)
Resizes the image to the nearest power of 2 for the width and height. If square
is true
then set width and height to be the same. New pixels are calculated using the interpolation
mode defined via Interpolation
constants.
Default Arguments
square
-false
interpolation
-1
sourcepub fn rgbe_to_srgb(&self) -> Option<Ref<Image, Shared>>
pub fn rgbe_to_srgb(&self) -> Option<Ref<Image, Shared>>
Converts a standard RGBE (Red Green Blue Exponent) image to an sRGB image.
sourcepub fn save_exr(
&self,
path: impl Into<GodotString>,
grayscale: bool
) -> GodotResult
pub fn save_exr(
&self,
path: impl Into<GodotString>,
grayscale: bool
) -> GodotResult
Saves the image as an EXR file to path
. If grayscale
is true
and the image has only one channel, it will be saved explicitly as monochrome rather than one red channel. This function will return [ERR_UNAVAILABLE
][Self::ERR_UNAVAILABLE] if Godot was compiled without the TinyEXR module.
Note: The TinyEXR module is disabled in non-editor builds, which means save_exr
will return [ERR_UNAVAILABLE
][Self::ERR_UNAVAILABLE] when it is called from an exported project.
Default Arguments
grayscale
-false
sourcepub fn save_png(&self, path: impl Into<GodotString>) -> GodotResult
pub fn save_png(&self, path: impl Into<GodotString>) -> GodotResult
Saves the image as a PNG file to path
.
sourcepub fn save_png_to_buffer(&self) -> PoolArray<u8>
pub fn save_png_to_buffer(&self) -> PoolArray<u8>
sourcepub fn set_pixel(&self, x: i64, y: i64, color: Color)
pub fn set_pixel(&self, x: i64, y: i64, color: Color)
Sample code is GDScript unless otherwise noted.
Sets the Color
of the pixel at (x, y)
if the image is locked. Example:
var img = Image.new()
img.create(img_width, img_height, false, Image.FORMAT_RGBA8)
img.lock()
img.set_pixel(x, y, color) # Works
img.unlock()
img.set_pixel(x, y, color) # Does not have an effect
sourcepub fn set_pixelv(&self, dst: Vector2, color: Color)
pub fn set_pixelv(&self, dst: Vector2, color: Color)
Sample code is GDScript unless otherwise noted.
Sets the Color
of the pixel at (dst.x, dst.y)
if the image is locked. Note that the dst
values must be integers. Example:
var img = Image.new()
img.create(img_width, img_height, false, Image.FORMAT_RGBA8)
img.lock()
img.set_pixelv(Vector2(x, y), color) # Works
img.unlock()
img.set_pixelv(Vector2(x, y), color) # Does not have an effect
sourcepub fn srgb_to_linear(&self)
pub fn srgb_to_linear(&self)
Converts the raw data from the sRGB colorspace to a linear scale.
Methods from Deref<Target = Resource>§
sourcepub fn duplicate(&self, subresources: bool) -> Option<Ref<Resource, Shared>>
pub fn duplicate(&self, subresources: bool) -> Option<Ref<Resource, Shared>>
Duplicates the resource, returning a new resource with the exported members copied. Note: To duplicate the resource the constructor is called without arguments. This method will error when the constructor doesn’t have default values.
By default, sub-resources are shared between resource copies for efficiency. This can be changed by passing true
to the subresources
argument which will copy the subresources.
Note: If subresources
is true
, this method will only perform a shallow copy. Nested resources within subresources will not be duplicated and will still be shared.
Note: When duplicating a resource, only export
ed properties are copied. Other properties will be set to their default value in the new resource.
Default Arguments
subresources
-false
sourcepub fn emit_changed(&self)
pub fn emit_changed(&self)
Sample code is GDScript unless otherwise noted.
Emits the changed
signal.
If external objects which depend on this resource should be updated, this method must be called manually whenever the state of this resource has changed (such as modification of properties).
The method is equivalent to:
emit_signal("changed")
Note: This method is called automatically for built-in resources.
sourcepub fn get_local_scene(&self) -> Option<Ref<Node, Shared>>
pub fn get_local_scene(&self) -> Option<Ref<Node, Shared>>
If [resource_local_to_scene
][Self::resource_local_to_scene] is enabled and the resource was loaded from a PackedScene
instantiation, returns the local scene where this resource’s unique copy is in use. Otherwise, returns null
.
sourcepub fn name(&self) -> GodotString
pub fn name(&self) -> GodotString
The name of the resource. This is an optional identifier. If [resource_name
][Self::resource_name] is not empty, its value will be displayed to represent the current resource in the editor inspector. For built-in scripts, the [resource_name
][Self::resource_name] will be displayed as the tab name in the script editor.
sourcepub fn path(&self) -> GodotString
pub fn path(&self) -> GodotString
The path to the resource. In case it has its own file, it will return its filepath. If it’s tied to the scene, it will return the scene’s path, followed by the resource’s index.
sourcepub fn is_local_to_scene(&self) -> bool
pub fn is_local_to_scene(&self) -> bool
If true
, the resource will be made unique in each instance of its local scene. It can thus be modified in a scene instance without impacting other instances of that same scene.
sourcepub fn set_local_to_scene(&self, enable: bool)
pub fn set_local_to_scene(&self, enable: bool)
If true
, the resource will be made unique in each instance of its local scene. It can thus be modified in a scene instance without impacting other instances of that same scene.
sourcepub fn set_name(&self, name: impl Into<GodotString>)
pub fn set_name(&self, name: impl Into<GodotString>)
The name of the resource. This is an optional identifier. If [resource_name
][Self::resource_name] is not empty, its value will be displayed to represent the current resource in the editor inspector. For built-in scripts, the [resource_name
][Self::resource_name] will be displayed as the tab name in the script editor.
sourcepub fn set_path(&self, path: impl Into<GodotString>)
pub fn set_path(&self, path: impl Into<GodotString>)
The path to the resource. In case it has its own file, it will return its filepath. If it’s tied to the scene, it will return the scene’s path, followed by the resource’s index.
sourcepub fn setup_local_to_scene(&self)
pub fn setup_local_to_scene(&self)
This method is called when a resource with [resource_local_to_scene
][Self::resource_local_to_scene] enabled is loaded from a PackedScene
instantiation. Its behavior can be customized by overriding [_setup_local_to_scene
][Self::_setup_local_to_scene] from script.
For most resources, this method performs no base logic. ViewportTexture
performs custom logic to properly set the proxy texture and flags in the local viewport.
sourcepub fn take_over_path(&self, path: impl Into<GodotString>)
pub fn take_over_path(&self, path: impl Into<GodotString>)
Sets the path of the resource, potentially overriding an existing cache entry for this path. This differs from setting [resource_path
][Self::resource_path], as the latter would error out if another resource was already cached for the given path.
Methods from Deref<Target = Object>§
pub const NOTIFICATION_POSTINITIALIZE: i64 = 0i64
pub const CONNECT_DEFERRED: i64 = 1i64
pub const NOTIFICATION_PREDELETE: i64 = 1i64
pub const CONNECT_PERSIST: i64 = 2i64
pub const CONNECT_ONESHOT: i64 = 4i64
pub const CONNECT_REFERENCE_COUNTED: i64 = 8i64
sourcepub fn add_user_signal(
&self,
signal: impl Into<GodotString>,
arguments: VariantArray
)
pub fn add_user_signal(
&self,
signal: impl Into<GodotString>,
arguments: VariantArray
)
Adds a user-defined signal
. Arguments are optional, but can be added as an Array
of dictionaries, each containing name: String
and type: int
(see [enum Variant.Type]) entries.
Default Arguments
arguments
-[ ]
sourcepub unsafe fn call(
&self,
method: impl Into<GodotString>,
varargs: &[Variant]
) -> Variant
pub unsafe fn call(
&self,
method: impl Into<GodotString>,
varargs: &[Variant]
) -> Variant
Sample code is GDScript unless otherwise noted.
Calls the method
on the object and returns the result. This method supports a variable number of arguments, so parameters are passed as a comma separated list. Example:
call("set", "position", Vector2(42.0, 0.0))
Note: In C#, the method name must be specified as snake_case if it is defined by a built-in Godot node. This doesn’t apply to user-defined methods where you should use the same convention as in the C# source (typically PascalCase).
Safety
This function bypasses Rust’s static type checks (aliasing, thread boundaries, calls to free(), …).
sourcepub unsafe fn call_deferred(
&self,
method: impl Into<GodotString>,
varargs: &[Variant]
) -> Variant
pub unsafe fn call_deferred(
&self,
method: impl Into<GodotString>,
varargs: &[Variant]
) -> Variant
Sample code is GDScript unless otherwise noted.
Calls the method
on the object during idle time. This method supports a variable number of arguments, so parameters are passed as a comma separated list. Example:
call_deferred("set", "position", Vector2(42.0, 0.0))
Note: In C#, the method name must be specified as snake_case if it is defined by a built-in Godot node. This doesn’t apply to user-defined methods where you should use the same convention as in the C# source (typically PascalCase).
Safety
This function bypasses Rust’s static type checks (aliasing, thread boundaries, calls to free(), …).
sourcepub unsafe fn callv(
&self,
method: impl Into<GodotString>,
arg_array: VariantArray
) -> Variant
pub unsafe fn callv(
&self,
method: impl Into<GodotString>,
arg_array: VariantArray
) -> Variant
Sample code is GDScript unless otherwise noted.
Calls the method
on the object and returns the result. Contrarily to call
, this method does not support a variable number of arguments but expects all parameters to be via a single Array
.
callv("set", [ "position", Vector2(42.0, 0.0) ])
Safety
This function bypasses Rust’s static type checks (aliasing, thread boundaries, calls to free(), …).
sourcepub fn can_translate_messages(&self) -> bool
pub fn can_translate_messages(&self) -> bool
Returns true
if the object can translate strings. See set_message_translation
and tr
.
sourcepub fn connect(
&self,
signal: impl Into<GodotString>,
target: impl AsArg<Object>,
method: impl Into<GodotString>,
binds: VariantArray,
flags: i64
) -> GodotResult
pub fn connect(
&self,
signal: impl Into<GodotString>,
target: impl AsArg<Object>,
method: impl Into<GodotString>,
binds: VariantArray,
flags: i64
) -> GodotResult
Sample code is GDScript unless otherwise noted.
Connects a signal
to a method
on a target
object. Pass optional binds
to the call as an Array
of parameters. These parameters will be passed to the method after any parameter used in the call to emit_signal
. Use flags
to set deferred or one-shot connections. See ConnectFlags
constants.
A signal
can only be connected once to a method
. It will print an error if already connected, unless the signal was connected with CONNECT_REFERENCE_COUNTED
. To avoid this, first, use is_connected
to check for existing connections.
If the target
is destroyed in the game’s lifecycle, the connection will be lost.
Examples:
connect("pressed", self, "_on_Button_pressed") # BaseButton signal
connect("text_entered", self, "_on_LineEdit_text_entered") # LineEdit signal
connect("hit", self, "_on_Player_hit", [ weapon_type, damage ]) # User-defined signal
An example of the relationship between binds
passed to connect
and parameters used when calling emit_signal
:
connect("hit", self, "_on_Player_hit", [ weapon_type, damage ]) # weapon_type and damage are passed last
emit_signal("hit", "Dark lord", 5) # "Dark lord" and 5 are passed first
func _on_Player_hit(hit_by, level, weapon_type, damage):
print("Hit by %s (lvl %d) with weapon %s for %d damage" % [hit_by, level, weapon_type, damage])
Default Arguments
binds
-[ ]
flags
-0
sourcepub fn disconnect(
&self,
signal: impl Into<GodotString>,
target: impl AsArg<Object>,
method: impl Into<GodotString>
)
pub fn disconnect(
&self,
signal: impl Into<GodotString>,
target: impl AsArg<Object>,
method: impl Into<GodotString>
)
Disconnects a signal
from a method
on the given target
.
If you try to disconnect a connection that does not exist, the method will print an error. Use is_connected
to ensure that the connection exists.
sourcepub fn emit_signal(
&self,
signal: impl Into<GodotString>,
varargs: &[Variant]
) -> Variant
pub fn emit_signal(
&self,
signal: impl Into<GodotString>,
varargs: &[Variant]
) -> Variant
Sample code is GDScript unless otherwise noted.
Emits the given signal
. The signal must exist, so it should be a built-in signal of this class or one of its parent classes, or a user-defined signal. This method supports a variable number of arguments, so parameters are passed as a comma separated list. Example:
emit_signal("hit", weapon_type, damage)
emit_signal("game_over")
sourcepub fn get(&self, property: impl Into<GodotString>) -> Variant
pub fn get(&self, property: impl Into<GodotString>) -> Variant
Returns the Variant
value of the given property
. If the property
doesn’t exist, this will return null
.
Note: In C#, the property name must be specified as snake_case if it is defined by a built-in Godot node. This doesn’t apply to user-defined properties where you should use the same convention as in the C# source (typically PascalCase).
sourcepub fn get_class(&self) -> GodotString
pub fn get_class(&self) -> GodotString
sourcepub fn get_incoming_connections(&self) -> VariantArray
pub fn get_incoming_connections(&self) -> VariantArray
Returns an Array
of dictionaries with information about signals that are connected to the object.
Each Dictionary
contains three String entries:
source
is a reference to the signal emitter.signal_name
is the name of the connected signal.method_name
is the name of the method to which the signal is connected.
sourcepub fn get_indexed(&self, property: impl Into<NodePath>) -> Variant
pub fn get_indexed(&self, property: impl Into<NodePath>) -> Variant
Gets the object’s property indexed by the given NodePath
. The node path should be relative to the current object and can use the colon character (:
) to access nested properties. Examples: "position:x"
or "material:next_pass:blend_mode"
.
Note: Even though the method takes NodePath
argument, it doesn’t support actual paths to Node
s in the scene tree, only colon-separated sub-property paths. For the purpose of nodes, use Node.get_node_and_resource
instead.
sourcepub fn get_instance_id(&self) -> i64
pub fn get_instance_id(&self) -> i64
Returns the object’s unique instance ID.
This ID can be saved in EncodedObjectAsID
, and can be used to retrieve the object instance with [method @GDScript.instance_from_id].
sourcepub fn get_meta(
&self,
name: impl Into<GodotString>,
default: impl OwnedToVariant
) -> Variant
pub fn get_meta(
&self,
name: impl Into<GodotString>,
default: impl OwnedToVariant
) -> Variant
Returns the object’s metadata entry for the given name
.
Throws error if the entry does not exist, unless default
is not null
(in which case the default value will be returned).
Default Arguments
default
-null
sourcepub fn get_meta_list(&self) -> PoolArray<GodotString>
pub fn get_meta_list(&self) -> PoolArray<GodotString>
Returns the object’s metadata as a PoolStringArray
.
sourcepub fn get_method_list(&self) -> VariantArray
pub fn get_method_list(&self) -> VariantArray
Returns the object’s methods and their signatures as an Array
.
sourcepub fn get_property_list(&self) -> VariantArray
pub fn get_property_list(&self) -> VariantArray
Returns the object’s property list as an Array
of dictionaries.
Each property’s Dictionary
contain at least name: String
and type: int
(see [enum Variant.Type]) entries. Optionally, it can also include hint: int
(see [PropertyHint
][PropertyHint]), hint_string: String
, and usage: int
(see [PropertyUsageFlags
][PropertyUsageFlags]).
sourcepub fn get_script(&self) -> Option<Ref<Reference, Shared>>
pub fn get_script(&self) -> Option<Ref<Reference, Shared>>
Returns the object’s Script
instance, or null
if none is assigned.
sourcepub fn get_signal_connection_list(
&self,
signal: impl Into<GodotString>
) -> VariantArray
pub fn get_signal_connection_list(
&self,
signal: impl Into<GodotString>
) -> VariantArray
Returns an Array
of connections for the given signal
.
sourcepub fn get_signal_list(&self) -> VariantArray
pub fn get_signal_list(&self) -> VariantArray
Returns the list of signals as an Array
of dictionaries.
sourcepub fn has_meta(&self, name: impl Into<GodotString>) -> bool
pub fn has_meta(&self, name: impl Into<GodotString>) -> bool
Returns true
if a metadata entry is found with the given name
.
sourcepub fn has_method(&self, method: impl Into<GodotString>) -> bool
pub fn has_method(&self, method: impl Into<GodotString>) -> bool
Returns true
if the object contains the given method
.
sourcepub fn has_signal(&self, signal: impl Into<GodotString>) -> bool
pub fn has_signal(&self, signal: impl Into<GodotString>) -> bool
Returns true
if the given signal
exists.
sourcepub fn has_user_signal(&self, signal: impl Into<GodotString>) -> bool
pub fn has_user_signal(&self, signal: impl Into<GodotString>) -> bool
Returns true
if the given user-defined signal
exists. Only signals added using add_user_signal
are taken into account.
sourcepub fn is_blocking_signals(&self) -> bool
pub fn is_blocking_signals(&self) -> bool
Returns true
if signal emission blocking is enabled.
sourcepub fn is_class(&self, class: impl Into<GodotString>) -> bool
pub fn is_class(&self, class: impl Into<GodotString>) -> bool
sourcepub fn is_connected(
&self,
signal: impl Into<GodotString>,
target: impl AsArg<Object>,
method: impl Into<GodotString>
) -> bool
pub fn is_connected(
&self,
signal: impl Into<GodotString>,
target: impl AsArg<Object>,
method: impl Into<GodotString>
) -> bool
Returns true
if a connection exists for a given signal
, target
, and method
.
sourcepub fn is_queued_for_deletion(&self) -> bool
pub fn is_queued_for_deletion(&self) -> bool
Returns true
if the Node.queue_free
method was called for the object.
sourcepub fn notification(&self, what: i64, reversed: bool)
pub fn notification(&self, what: i64, reversed: bool)
Send a given notification to the object, which will also trigger a call to the [_notification
][Self::_notification] method of all classes that the object inherits from.
If reversed
is true
, [_notification
][Self::_notification] is called first on the object’s own class, and then up to its successive parent classes. If reversed
is false
, [_notification
][Self::_notification] is called first on the highest ancestor (Object
itself), and then down to its successive inheriting classes.
Default Arguments
reversed
-false
sourcepub fn property_list_changed_notify(&self)
pub fn property_list_changed_notify(&self)
Notify the editor that the property list has changed, so that editor plugins can take the new values into account. Does nothing on export builds.
sourcepub fn remove_meta(&self, name: impl Into<GodotString>)
pub fn remove_meta(&self, name: impl Into<GodotString>)
Removes a given entry from the object’s metadata. See also set_meta
.
sourcepub fn set(&self, property: impl Into<GodotString>, value: impl OwnedToVariant)
pub fn set(&self, property: impl Into<GodotString>, value: impl OwnedToVariant)
Assigns a new value to the given property. If the property
does not exist or the given value’s type doesn’t match, nothing will happen.
Note: In C#, the property name must be specified as snake_case if it is defined by a built-in Godot node. This doesn’t apply to user-defined properties where you should use the same convention as in the C# source (typically PascalCase).
sourcepub fn set_block_signals(&self, enable: bool)
pub fn set_block_signals(&self, enable: bool)
If set to true
, signal emission is blocked.
sourcepub fn set_deferred(
&self,
property: impl Into<GodotString>,
value: impl OwnedToVariant
)
pub fn set_deferred(
&self,
property: impl Into<GodotString>,
value: impl OwnedToVariant
)
Assigns a new value to the given property, after the current frame’s physics step. This is equivalent to calling set
via call_deferred
, i.e. call_deferred("set", property, value)
.
Note: In C#, the property name must be specified as snake_case if it is defined by a built-in Godot node. This doesn’t apply to user-defined properties where you should use the same convention as in the C# source (typically PascalCase).
sourcepub fn set_indexed(
&self,
property: impl Into<NodePath>,
value: impl OwnedToVariant
)
pub fn set_indexed(
&self,
property: impl Into<NodePath>,
value: impl OwnedToVariant
)
Sample code is GDScript unless otherwise noted.
Assigns a new value to the property identified by the NodePath
. The node path should be relative to the current object and can use the colon character (:
) to access nested properties. Example:
set_indexed("position", Vector2(42, 0))
set_indexed("position:y", -10)
print(position) # (42, -10)
sourcepub fn set_message_translation(&self, enable: bool)
pub fn set_message_translation(&self, enable: bool)
Defines whether the object can translate strings (with calls to tr
). Enabled by default.
sourcepub fn set_meta(&self, name: impl Into<GodotString>, value: impl OwnedToVariant)
pub fn set_meta(&self, name: impl Into<GodotString>, value: impl OwnedToVariant)
Adds, changes or removes a given entry in the object’s metadata. Metadata are serialized and can take any Variant
value.
To remove a given entry from the object’s metadata, use remove_meta
. Metadata is also removed if its value is set to null
. This means you can also use set_meta("name", null)
to remove metadata for "name"
.
sourcepub fn set_script(&self, script: impl AsArg<Reference>)
pub fn set_script(&self, script: impl AsArg<Reference>)
Assigns a script to the object. Each object can have a single script assigned to it, which are used to extend its functionality.
If the object already had a script, the previous script instance will be freed and its variables and state will be lost. The new script’s [_init
][Self::_init] method will be called.
sourcepub fn to_string(&self) -> GodotString
pub fn to_string(&self) -> GodotString
sourcepub fn tr(&self, message: impl Into<GodotString>) -> GodotString
pub fn tr(&self, message: impl Into<GodotString>) -> GodotString
Translates a message using translation catalogs configured in the Project Settings.
Only works if message translation is enabled (which it is by default), otherwise it returns the message
unchanged. See set_message_translation
.
Trait Implementations§
source§impl GodotObject for Image
impl GodotObject for Image
§type Memory = RefCounted
type Memory = RefCounted
Ref
smart pointer. See its type-level documentation for more
information.fn class_name() -> &'static str
source§fn null() -> Null<Self>
fn null() -> Null<Self>
Self
as a method argument. This makes type
inference easier for the compiler compared to Option
.source§fn new() -> Ref<Self, Unique>where
Self: Instanciable,
fn new() -> Ref<Self, Unique>where
Self: Instanciable,
Self
using a zero-argument constructor, as a Unique
reference.