image

Classes

Image

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

Extends

• Resource

Accessors

rid

get rid(): number

Returns

number

Inherited from

Resource.rid

Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/core.ts#L309

Methods

close()

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.

Returns

Promise<void>

Inherited from

Resource.close

Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/core.ts#L321

rgba()

rgba(): Promise<Uint8Array>

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

Returns

Promise<Uint8Array>

Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/image.ts#L89

size()

size(): Promise<ImageSize>

Returns the size of this image.

Returns

Promise<ImageSize>

Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/image.ts#L96

fromBytes()

static fromBytes(bytes): Promise<Image>

Creates a new image using the provided bytes by inferring the file format. If the format is known, prefer [@link Image.fromPngBytes] or [@link Image.fromIcoBytes].

Only ico and png are supported (based on activated feature flag).

Note that you need the image-ico or image-png Cargo features to use this API. To enable it, change your Cargo.toml file:

[dependencies]
tauri = { version = "...", features = ["...", "image-png"] }

Parameters

Parameter	Type
bytes	Uint8Array | number[] | ArrayBuffer

Returns

Promise<Image>

Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/image.ts#L62

fromPath()

static fromPath(path): Promise<Image>

Creates a new image using the provided path.

Only ico and png are supported (based on activated feature flag).

Note that you need the image-ico or image-png Cargo features to use this API. To enable it, change your Cargo.toml file:

[dependencies]
tauri = { version = "...", features = ["...", "image-png"] }

Parameters

Parameter	Type
path	string

Returns

Promise<Image>

Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/image.ts#L82

new()

static new(
   rgba,
   width,
height): Promise<Image>

Creates a new Image using RGBA data, in row-major order from top to bottom, and with specified width and height.

Parameters

Parameter	Type
rgba	Uint8Array | number[] | ArrayBuffer
width	number
height	number

Returns

Promise<Image>

Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/image.ts#L37

Interfaces

ImageSize

Properties

Property	Type	Defined in
height	number	Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/image.ts#L13
width	number	Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/image.ts#L11

Type Aliases

MenuIcon

type MenuIcon:
  | NativeIcon
  | string
  | Image
  | Uint8Array
  | ArrayBuffer
  | number[];

A type that represents an icon that can be used in menu items.

Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/image.ts#L17

Functions

transformImage()

function transformImage<T>(image): T

Transforms image from various types into a type acceptable by Rust.

See tauri::image::JsImage for more information. Note the API signature is not stable and might change.

Type Parameters

Type Parameter
T

Parameters

Parameter	Type
image	| null | string | Uint8Array | number[] | ArrayBuffer | Image

Returns

T

Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/image.ts#L107