scala-native-gdextension
API
Generated with
scala-native-gdextension/gdext/gdext.classes/Image

Image

gdext.classes.Image
See theImage companion object
abstract class Image extends Resource

Generated wrapper for Godot's Image, extends Resource.

Attributes

Companion
object
Graph
Supertypes
class Resource
class RefCounted
class Object
class Object
trait Matchable
class Any
Show all

Members list

Value members

Concrete methods

final def adjustBcs(brightness: Double, contrast: Double, saturation: Double): Unit

Image.adjust_bcs

Image.adjust_bcs

Attributes

final def blendRect(src: Image, src_rect: Rect2i, dst: Vector2i): Unit

Image.blend_rect

Image.blend_rect

Attributes

final def blendRectMask(src: Image, mask: Image, src_rect: Rect2i, dst: Vector2i): Unit

Image.blend_rect_mask

Image.blend_rect_mask

Attributes

final def blitRect(src: Image, src_rect: Rect2i, dst: Vector2i): Unit

Image.blit_rect

Image.blit_rect

Attributes

final def blitRectMask(src: Image, mask: Image, src_rect: Rect2i, dst: Vector2i): Unit

Image.blit_rect_mask

Image.blit_rect_mask

Attributes

final def bumpMapToNormalMap(bump_scale: Double): Unit

Image.bump_map_to_normal_map

Image.bump_map_to_normal_map

Attributes

final def clearMipmaps(): Unit

Image.clear_mipmaps

Image.clear_mipmaps

Attributes

final def compress(mode: Long, source: Long, astc_format: Long): Long

Image.compress

Image.compress

Attributes

final def compressFromChannels(mode: Long, channels: Long, astc_format: Long): Long

Image.compress_from_channels

Image.compress_from_channels

Attributes

final def convert(format: Long): Unit

Image.convert

Image.convert

Attributes

final def copyFrom(src: Image): Unit

Image.copy_from

Image.copy_from

Attributes

final def crop(width: Long, height: Long): Unit

Image.crop

Image.crop

Attributes

final def decompress(): Long

Image.decompress

Image.decompress

Attributes

final def detectAlpha(): Long

Image.detect_alpha

Image.detect_alpha

Attributes

final def detectUsedChannels(source: Long): Long

Image.detect_used_channels

Image.detect_used_channels

Attributes

final def fill(color: Color): Unit

Image.fill

Image.fill

Attributes

final def fillRect(rect: Rect2i, color: Color): Unit

Image.fill_rect

Image.fill_rect

Attributes

final def fixAlphaEdges(): Unit

Image.fix_alpha_edges

Image.fix_alpha_edges

Attributes

final def flipX(): Unit

Image.flip_x

Image.flip_x

Attributes

final def flipY(): Unit

Image.flip_y

Image.flip_y

Attributes

final def generateMipmaps(renormalize: Boolean): Long

Image.generate_mipmaps

Image.generate_mipmaps

Attributes

final def getDataSize(): Long

Image.get_data_size

Image.get_data_size

Attributes

final def getFormat(): Long

Image.get_format

Image.get_format

Attributes

final def getHeight(): Long

Image.get_height

Image.get_height

Attributes

final def getMipmapCount(): Long

Image.get_mipmap_count

Image.get_mipmap_count

Attributes

final def getMipmapOffset(mipmap: Long): Long

Image.get_mipmap_offset

Image.get_mipmap_offset

Attributes

final def getPixel(x: Long, y: Long): Color

Image.get_pixel

Image.get_pixel

Attributes

final def getPixelv(point: Vector2i): Color

Image.get_pixelv

Image.get_pixelv

Attributes

final def getRegion(region: Rect2i): Image

Image.get_region. Returns an owned reference: release it with unref() or inside Gd.scoped.

Image.get_region. Returns an owned reference: release it with unref() or inside Gd.scoped.

Attributes

final def getSize(): Vector2i

Image.get_size

Image.get_size

Attributes

final def getUsedRect(): Rect2i

Image.get_used_rect

Image.get_used_rect

Attributes

final def getWidth(): Long

Image.get_width

Image.get_width

Attributes

override def godotClassName: String

The Godot class name for this instance. Engine wrappers override with the baked literal; user classes fall back to their Scala simple name (which is how registration names them).

The Godot class name for this instance. Engine wrappers override with the baked literal; user classes fall back to their Scala simple name (which is how registration names them).

Attributes

Definition Classes
final def hasMipmaps(): Boolean

Image.has_mipmaps

Image.has_mipmaps

Attributes

final def isCompressed(): Boolean

Image.is_compressed

Image.is_compressed

Attributes

final def isEmpty(): Boolean

Image.is_empty

Image.is_empty

Attributes

final def isInvisible(): Boolean

Image.is_invisible

Image.is_invisible

Attributes

final def linearToSrgb(): Unit

Image.linear_to_srgb

Image.linear_to_srgb

Attributes

final def load(path: String): Long

Image.load

Image.load

Attributes

final def loadSvgFromString(svg_str: String, scale: Double): Long

Image.load_svg_from_string

Image.load_svg_from_string

Attributes

final def normalMapToXy(): Unit

Image.normal_map_to_xy

Image.normal_map_to_xy

Attributes

final def premultiplyAlpha(): Unit

Image.premultiply_alpha

Image.premultiply_alpha

Attributes

final def resize(width: Long, height: Long, interpolation: Long): Unit

Image.resize

Image.resize

Attributes

final def resizeToPo2(square: Boolean, interpolation: Long): Unit

Image.resize_to_po2

Image.resize_to_po2

Attributes

final def rgbeToSrgb(): Image

Image.rgbe_to_srgb. Returns an owned reference: release it with unref() or inside Gd.scoped.

Image.rgbe_to_srgb. Returns an owned reference: release it with unref() or inside Gd.scoped.

Attributes

final def rotate180(): Unit

Image.rotate_180

Image.rotate_180

Attributes

final def rotate90(direction: Long): Unit

Image.rotate_90

Image.rotate_90

Attributes

final def saveDds(path: String): Long

Image.save_dds

Image.save_dds

Attributes

final def saveExr(path: String, grayscale: Boolean): Long

Image.save_exr

Image.save_exr

Attributes

final def saveJpg(path: String, quality: Double): Long

Image.save_jpg

Image.save_jpg

Attributes

final def savePng(path: String): Long

Image.save_png

Image.save_png

Attributes

final def saveWebp(path: String, lossy: Boolean, quality: Double): Long

Image.save_webp

Image.save_webp

Attributes

final def setPixel(x: Long, y: Long, color: Color): Unit

Image.set_pixel

Image.set_pixel

Attributes

final def setPixelv(point: Vector2i, color: Color): Unit

Image.set_pixelv

Image.set_pixelv

Attributes

final def shrinkX2(): Unit

Image.shrink_x2

Image.shrink_x2

Attributes

final def srgbToLinear(): Unit

Image.srgb_to_linear

Image.srgb_to_linear

Attributes

Inherited methods

def _can_handle(obj: GodotObject): Boolean

EditorInspectorPlugin: can this plugin handle obj's inspector?

EditorInspectorPlugin: can this plugin handle obj's inspector?

Attributes

Inherited from:
GodotScriptClass
def _enter_tree(): Unit

EditorPlugin/Node: entered the (editor) tree.

EditorPlugin/Node: entered the (editor) tree.

Attributes

Inherited from:
GodotScriptClass
def _exit_tree(): Unit

EditorPlugin/Node: leaving the (editor) tree.

EditorPlugin/Node: leaving the (editor) tree.

Attributes

Inherited from:
GodotScriptClass
def _input(event: InputEvent): Unit

Called for every unhandled-or-not input event (Node._input).

Called for every unhandled-or-not input event (Node._input).

Attributes

Inherited from:
GodotScriptClass
def _parse_property(obj: GodotObject, varType: Long, name: String, hintType: Long, hintString: String, usage: Long, wide: Boolean): Boolean

EditorInspectorPlugin: inspect one property. Return true to take it over (after calling addPropertyEditor), false to let the default editor render.

EditorInspectorPlugin: inspect one property. Return true to take it over (after calling addPropertyEditor), false to let the default editor render.

Attributes

Inherited from:
GodotScriptClass
def _physics_process(delta: Double): Unit

Called every physics frame; delta is the fixed physics step.

Called every physics frame; delta is the fixed physics step.

Attributes

Inherited from:
GodotScriptClass
def _process(delta: Double): Unit

Called every rendered frame; delta is seconds since the last frame.

Called every rendered frame; delta is seconds since the last frame.

Attributes

Inherited from:
GodotScriptClass
def _ready(): Unit

Called when the node enters the scene tree and is ready.

Called when the node enters the scene tree and is ready.

Attributes

Inherited from:
GodotScriptClass
def _shortcut_input(event: InputEvent): Unit

Called for shortcut input before _unhandled_input (Node._shortcut_input).

Called for shortcut input before _unhandled_input (Node._shortcut_input).

Attributes

Inherited from:
GodotScriptClass
def _unhandled_input(event: InputEvent): Unit

Called for input not consumed by the UI (Node._unhandled_input).

Called for input not consumed by the UI (Node._unhandled_input).

Attributes

Inherited from:
GodotScriptClass
def _unhandled_key_input(event: InputEvent): Unit

Called for unhandled key input (Node._unhandled_key_input).

Called for unhandled key input (Node._unhandled_key_input).

Attributes

Inherited from:
GodotScriptClass
def _update_property(): Unit

EditorProperty: refresh the widget from the edited property's value.

EditorProperty: refresh the widget from the edited property's value.

Attributes

Inherited from:
GodotScriptClass
final def canTranslateMessages(): Boolean

Object.can_translate_messages

Object.can_translate_messages

Attributes

Inherited from:
Object
final def cancelFree(): Unit

Object.cancel_free

Object.cancel_free

Attributes

Inherited from:
Object
def cast[U <: GodotScriptClass](using meta: ClassMeta[U]): U

Cast to a (super- or sub-) class U. Returns null if the object is not actually a U. Uses object_cast_to with U's class tag — a real engine type check, not a Scala cast.

Cast to a (super- or sub-) class U. Returns null if the object is not actually a U. Uses object_cast_to with U's class tag — a real engine type check, not a Scala cast.

Attributes

Inherited from:
GodotScriptClass
final def duplicate(deep: Boolean): Resource

Resource.duplicate. Returns an owned reference: release it with unref() or inside Gd.scoped.

Resource.duplicate. Returns an owned reference: release it with unref() or inside Gd.scoped.

Attributes

Inherited from:
Resource
final def duplicateDeep(deep_subresources_mode: Long): Resource

Resource.duplicate_deep. Returns an owned reference: release it with unref() or inside Gd.scoped.

Resource.duplicate_deep. Returns an owned reference: release it with unref() or inside Gd.scoped.

Attributes

Inherited from:
Resource
final def emitChanged(): Unit

Resource.emit_changed

Resource.emit_changed

Attributes

Inherited from:
Resource
def free(): Unit

Free a manually-managed object via object_destroy. No-op for reference-counted objects — use unref for those. The wrapper is dead afterwards: calling an engine method on it throws.

Free a manually-managed object via object_destroy. No-op for reference-counted objects — use unref for those. The wrapper is dead afterwards: calling an engine method on it throws.

Attributes

Inherited from:
GodotScriptClass
final def getIdForPath(path: String): String

Resource.get_id_for_path

Resource.get_id_for_path

Attributes

Inherited from:
Resource
final def getInstanceId(): Long

Object.get_instance_id

Object.get_instance_id

Attributes

Inherited from:
Object
final def getLocalScene(): Node

Resource.get_local_scene

Resource.get_local_scene

Attributes

Inherited from:
Resource
final def getMethodArgumentCount(method: StringName): Long

Object.get_method_argument_count

Object.get_method_argument_count

Attributes

Inherited from:
Object
final def getName(): String

Resource.get_name

Resource.get_name

Attributes

Inherited from:
Resource
final def getPath(): String

Resource.get_path

Resource.get_path

Attributes

Inherited from:
Resource
final def getReferenceCount(): Long

RefCounted.get_reference_count

RefCounted.get_reference_count

Attributes

Inherited from:
RefCounted
final def getSceneUniqueId(): String

Resource.get_scene_unique_id

Resource.get_scene_unique_id

Attributes

Inherited from:
Resource
final def getTranslationDomain(): StringName

Object.get_translation_domain

Object.get_translation_domain

Attributes

Inherited from:
Object
final def hasConnections(signal: StringName): Boolean

Object.has_connections

Object.has_connections

Attributes

Inherited from:
Object
final def hasMeta(name: StringName): Boolean

Object.has_meta

Object.has_meta

Attributes

Inherited from:
Object
final def hasMethod(method: StringName): Boolean

Object.has_method

Object.has_method

Attributes

Inherited from:
Object
final def hasSignal(signal: StringName): Boolean

Object.has_signal

Object.has_signal

Attributes

Inherited from:
Object
final def hasUserSignal(signal: StringName): Boolean

Object.has_user_signal

Object.has_user_signal

Attributes

Inherited from:
Object
final def hostObject: GodotObject

The engine-side object handle for this instance.

The engine-side object handle for this instance.

Attributes

Inherited from:
GodotScriptClass
final def initRef(): Boolean

RefCounted.init_ref

RefCounted.init_ref

Attributes

Inherited from:
RefCounted
final def instanceId: InstanceId

This object's stable Godot InstanceId (the null sentinel if unbound). Mirrors Object.get_instance_id, but typed — pass it to APIs that key off a node's identity.

This object's stable Godot InstanceId (the null sentinel if unbound). Mirrors Object.get_instance_id, but typed — pass it to APIs that key off a node's identity.

Attributes

Inherited from:
GodotScriptClass
final def isBlockingSignals(): Boolean

Object.is_blocking_signals

Object.is_blocking_signals

Attributes

Inherited from:
Object
final def isBuiltIn(): Boolean

Resource.is_built_in

Resource.is_built_in

Attributes

Inherited from:
Resource
final def isClass(`class`: String): Boolean

Object.is_class

Object.is_class

Attributes

Inherited from:
Object
final def isLocalToScene(): Boolean

Resource.is_local_to_scene

Resource.is_local_to_scene

Attributes

Inherited from:
Resource
final def isQueuedForDeletion(): Boolean

Object.is_queued_for_deletion

Object.is_queued_for_deletion

Attributes

Inherited from:
Object
final def isRefCounted: Boolean

True if this object is reference-counted (RefCounted subtree, e.g. a Resource) vs manually-managed (Object/Node subtree). Drives the lifetime methods below.

True if this object is reference-counted (RefCounted subtree, e.g. a Resource) vs manually-managed (Object/Node subtree). Drives the lifetime methods below.

Attributes

Inherited from:
GodotScriptClass
def keep(): this.type

Keep a reference adopted inside Gd.scoped past the end of the block: the caller now owns it and releases it with unref. Returns this.

Keep a reference adopted inside Gd.scoped past the end of the block: the caller now owns it and releases it with unref. Returns this.

Attributes

Inherited from:
GodotScriptClass
final def notification(what: Long, reversed: Boolean): Unit

Object.notification

Object.notification

Attributes

Inherited from:
Object
final def notifyPropertyListChanged(): Unit

Object.notify_property_list_changed

Object.notify_property_list_changed

Attributes

Inherited from:
Object
final def propertyCanRevert(property: StringName): Boolean

Object.property_can_revert

Object.property_can_revert

Attributes

Inherited from:
Object
def refInc(): this.type

Take one more reference on a reference-counted object, owned by this wrapper until a matching unref. No-op for manually-managed objects (nodes). Returns this. (Named refInc rather than reference to avoid clashing with the generated RefCounted.reference(): Boolean method.)

Take one more reference on a reference-counted object, owned by this wrapper until a matching unref. No-op for manually-managed objects (nodes). Returns this. (Named refInc rather than reference to avoid clashing with the generated RefCounted.reference(): Boolean method.)

Attributes

Inherited from:
GodotScriptClass
final def reference(): Boolean

RefCounted.reference

RefCounted.reference

Attributes

Inherited from:
RefCounted
final def removeMeta(name: StringName): Unit

Object.remove_meta

Object.remove_meta

Attributes

Inherited from:
Object
final def removeUserSignal(signal: StringName): Unit

Object.remove_user_signal

Object.remove_user_signal

Attributes

Inherited from:
Object
final def resetState(): Unit

Resource.reset_state

Resource.reset_state

Attributes

Inherited from:
Resource
final def setBlockSignals(enable: Boolean): Unit

Object.set_block_signals

Object.set_block_signals

Attributes

Inherited from:
Object
final def setIdForPath(path: String, id: String): Unit

Resource.set_id_for_path

Resource.set_id_for_path

Attributes

Inherited from:
Resource
final def setLocalToScene(enable: Boolean): Unit

Resource.set_local_to_scene

Resource.set_local_to_scene

Attributes

Inherited from:
Resource
final def setMessageTranslation(enable: Boolean): Unit

Object.set_message_translation

Object.set_message_translation

Attributes

Inherited from:
Object
final def setName(name: String): Unit

Resource.set_name

Resource.set_name

Attributes

Inherited from:
Resource
final def setPath(path: String): Unit

Resource.set_path

Resource.set_path

Attributes

Inherited from:
Resource
final def setPathCache(path: String): Unit

Resource.set_path_cache

Resource.set_path_cache

Attributes

Inherited from:
Resource
final def setSceneUniqueId(id: String): Unit

Resource.set_scene_unique_id

Resource.set_scene_unique_id

Attributes

Inherited from:
Resource
final def setTranslationDomain(domain: StringName): Unit

Object.set_translation_domain

Object.set_translation_domain

Attributes

Inherited from:
Object
final def setupLocalToScene(): Unit

Resource.setup_local_to_scene

Resource.setup_local_to_scene

Attributes

Inherited from:
Resource
final def takeOverPath(path: String): Unit

Resource.take_over_path

Resource.take_over_path

Attributes

Inherited from:
Resource
final def tr(message: StringName, context: StringName): String

Object.tr

Object.tr

Attributes

Inherited from:
Object
final def trN(message: StringName, plural_message: StringName, n: Long, context: StringName): String

Object.tr_n

Object.tr_n

Attributes

Inherited from:
Object
def unref(): Unit

Release one reference this wrapper owns (an engine Ref<T> return, Gd.create, or refInc), destroying the object if it was the last reference. Does nothing when the wrapper owns no reference, so a borrowed object can never be freed from under the engine.

Release one reference this wrapper owns (an engine Ref<T> return, Gd.create, or refInc), destroying the object if it was the last reference. Does nothing when the wrapper owns no reference, so a borrowed object can never be freed from under the engine.

Attributes

Inherited from:
GodotScriptClass
final def unreference(): Boolean

RefCounted.unreference

RefCounted.unreference

Attributes

Inherited from:
RefCounted
final def withHost(o: GDExtensionObjectPtr): this.type

Set the handle and return this (fluent, for wrapping fetched objects).

Set the handle and return this (fluent, for wrapping fetched objects).

Attributes

Inherited from:
GodotScriptClass
Generated with