@zturnlibs/ztron-api

---

image#

Classes#

Image#

Defined in: image.ts:38

注册在 host 中的原生图像。用 fromPath/fromBytes（以及 fromRGBA）创建，传给 tray.setIcon / setIcon 使用。

Properties#

rid#

readonly rid: number

Defined in: image.ts:40

host 侧图像注册表 id。

Methods#

close()#

close(): Promise<void>

Defined in: image.ts:112

释放 host 中的该图像。

Returns#

Promise<void>

rgba()#

rgba(): Promise<Uint8Array<ArrayBufferLike> | undefined>

Defined in: image.ts:96

构建该图像所用的原始 RGBA 像素。仅经 fromRGBA/new 创建的图像携带像素；path/PNG 加载的图像在 C 层解码落地前 resolve 为 undefined（GAP.md B11）。

Returns#

Promise<Uint8Array<ArrayBufferLike> | undefined>

size()#

size(): Promise<{ height: number; width: number; } | null>

Defined in: image.ts:104

像素尺寸（未知时为 null——见 Image.rgba）。

Returns#

Promise<{ height: number; width: number; } | null>

fromBytes()#

static fromBytes(bytes): Promise<Image>

Defined in: image.ts:54

从原始字节加载图像。

Parameters#

bytes#

number[] | Uint8Array<ArrayBufferLike>

Returns#

Promise<Image>

fromPath()#

static fromPath(path): Promise<Image>

Defined in: image.ts:47

从文件路径加载图像。

Parameters#

path#

string

Returns#

Promise<Image>

fromRGBA()#

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

Defined in: image.ts:64

从 RGBA 像素数据构建图像（上游名称：Image.new）。

Parameters#

rgba#

number[] | Uint8Array<ArrayBufferLike>

width#

number

height#

number

Returns#

Promise<Image>

new()#

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

Defined in: image.ts:83

Image.fromRGBA 的上游对齐别名。

Parameters#

rgba#

number[] | Uint8Array<ArrayBufferLike>

width#

number

height#

number

Returns#

Promise<Image>

Type Aliases#

ImageLike#

ImageLike = string | Image | Uint8Array | ArrayBuffer | number[] | null

Defined in: image.ts:26

图标类 API 接受的任意值（路径 / Image / 原始字节 / 无）。

Functions#

fromBase64()#

fromBase64(b64): Uint8Array

Defined in: image.ts:18

把 base64 字符串解码为字节（分块处理，面向大载荷）。

Parameters#

b64#

string

Returns#

Uint8Array

---

toBase64()#

toBase64(bytes): string

Defined in: image.ts:8

把字节转换为 base64 字符串以供传输。

Parameters#

bytes#

Uint8Array

Returns#

string

---

transformImage()#

transformImage(image): Promise<{ image_id?: number; path?: string; } | null>

Defined in: image.ts:122

把图标参数归一化为 wire 形状：路径字符串保持为路径，Image 变为其注册表 id，原始字节先注册（host 侧解码）——移植自 @tauri-apps/api 的 transformImage。

Parameters#

image#

ImageLike

Returns#

Promise<{ image_id?: number; path?: string; } | null>