kotlin-tauri-apps-api/tauri.apps.api.image/Image

Image

An RGBA Image in row-major order from top to bottom.

Instances are created with {@linkcode Image.new}, {@linkcode Image.fromBytes} or {@linkcode Image.fromPath} and can be passed wherever a {@linkcode JsImage} is accepted, such as Window.setIcon, TrayIcon.setIcon or an icon menu item.

Since

2.0.0

Constructors

Image

constructor(rid: Double)

Creates an Image from a resource ID. For internal use only.

Types

Companion

external object Companion

Properties

rid

external val rid: Double

Functions

external fun close(): Promise<Void>

Destroys and cleans up this resource from memory. You should not call any method on this object anymore and should drop any reference to it.

rgba

external fun rgba(): Promise<Uint8Array<ArrayBuffer>>

Returns the RGBA data for this image, in row-major order from top to bottom.

size

external fun size(): Promise<ImageSize>

Returns the size of this image, in pixels.