image

Clases

Image

Una imagen RGBA en orden mayor por filas (row-major order) de arriba a abajo.

Extiende

• Resource

Accesores

rid

get rid(): number

Devuelve

number

Heredado de

Resource.rid

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

Métodos

close()

close(): Promise<void>

Destruye y limpia este recurso de la memoria. Ya no deberías llamar a ningún método de este objeto y deberías descartar cualquier referencia a él.

Devuelve

Promise<void>

Heredado de

Resource.close

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

rgba()

rgba(): Promise<Uint8Array>

Devuelve los datos RGBA para esta imagen, en orden mayor por filas de arriba a abajo.

Devuelve

Promise<Uint8Array>

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

size()

size(): Promise<ImageSize>

Devuelve el tamaño de esta imagen.

Devuelve

Promise<ImageSize>

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

fromBytes()

static fromBytes(bytes): Promise<Image>

Crea una nueva imagen usando los bytes proporcionados al inferir el formato del archivo. Si el formato es conocido, prefiere [@link Image.fromPngBytes] o [@link Image.fromIcoBytes].

Solo se admiten ico y png (según la flag de función activada).

Ten en cuenta que necesitas las funciones de Cargo image-ico o image-png para usar esta API. Para habilitarla, cambia tu archivo Cargo.toml:

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

Parámetros

Parámetro	Tipo
bytes	Uint8Array | number[] | ArrayBuffer

Devuelve

Promise<Image>

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

fromPath()

static fromPath(path): Promise<Image>

Crea una nueva imagen utilizando la ruta proporcionada.

Solo se admiten ico y png (según la flag de función activada).

Ten en cuenta que necesitas las funciones de Cargo image-ico o image-png para usar esta API. Para habilitarla, cambia tu archivo Cargo.toml:

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

Parámetros

Parámetro	Tipo
path	string

Devuelve

Promise<Image>

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

new()

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

Crea una nueva Image utilizando datos RGBA, en orden mayor por filas de arriba a abajo, y con el ancho y alto especificados.

Parámetros

Parámetro	Tipo
rgba	Uint8Array | number[] | ArrayBuffer
width	number
height	number

Devuelve

Promise<Image>

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

Interfaces

ImageSize

Propiedades

Propiedad	Tipo	Definido en
height	number	Origen: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/image.ts#L13
width	number	Origen: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/image.ts#L11

Alias de tipos

MenuIcon

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

Un tipo que representa un icono que se puede usar en elementos de menú.

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

Funciones

transformImage()

function transformImage<T>(image): T

Transforma la imagen desde varios tipos a un tipo aceptable por Rust.

Consulta tauri::image::JsImage para obtener más información. Ten en cuenta que la firma de la API no es estable y podría cambiar.

Parámetros de tipo

Parámetro de tipo
T

Parámetros

Parámetro	Tipo
image	| null | string | Uint8Array | number[] | ArrayBuffer | Image

Devuelve

T

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