image

类

图像

一个按行主序自上而下的 RGBA 图像。

继承 (Extends)

• 资源

访问器

rid

get rid(): number

返回

数字

继承自 (Inherited from)

Resource.rid

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

方法

close()

close(): Promise<void>

销毁并从内存中清理此资源。您不应再对此对象调用任何方法，并应放弃对它的任何引用。

返回

Promise<void>

继承自 (Inherited from)

Resource.close

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

rgba()

rgba(): Promise<Uint8Array>

返回此图像的 RGBA 数据，按行主序自上而下。

返回

Promise<Uint8Array>

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

size()

size(): Promise<ImageSize>

返回此图像的大小。

返回

Promise<ImageSize>

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

fromBytes()

static fromBytes(bytes): Promise<Image>

通过推断文件格式，使用提供的字节创建新图像。如果已知格式，则优先使用 [@link Image.fromPngBytes] 或 [@link Image.fromIcoBytes]。

仅支持 ico 和 png（取决于激活的功能标志）。

请注意，您需要 image-ico 或 image-png Cargo 功能才能使用此 API。要启用它，请更改您的 Cargo.toml 文件

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

参数

参数	类型
字节	Uint8Array | number[] | ArrayBuffer

返回

Promise<Image>

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

fromPath()

static fromPath(path): Promise<Image>

使用提供的路径创建新图像。

仅支持 ico 和 png（取决于激活的功能标志）。

请注意，您需要 image-ico 或 image-png Cargo 功能才能使用此 API。要启用它，请更改您的 Cargo.toml 文件

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

参数

参数	类型
path	字符串

返回

Promise<Image>

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

new()

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

使用 RGBA 数据（按行主序自上而下）以及指定的宽度和高度创建新图像。

参数

参数	类型
rgba	Uint8Array | number[] | ArrayBuffer
宽度	数字
高度	数字

返回

Promise<Image>

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

接口

ImageSize

属性

属性	类型	定义于
height	数字	来源: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/image.ts#L13
width	数字	来源: 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[];

一种表示可在菜单项中使用的图标的类型。

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

函数

transformImage()

function transformImage<T>(image): T

将图像从各种类型转换为 Rust 可接受的类型。

有关更多信息，请参阅 tauri::image::JsImage。请注意，API 签名不稳定，可能会更改。

类型参数

类型参数
T

参数

参数	类型
image	| null | string | Uint8Array | number[] | ArrayBuffer | Image

返回

T

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