Class Image

constructor

• new Image(): Image

  创建没有像素的空图像。

  Returns Image
• new Image(source: Image): Image

  深复制图像的 RGBA 像素。

  Parameters

  • source: Image

  Returns Image
• new Image(
      size: Readonly<Vector2u>,
      colorOrPixels?: Uint8Array | ReadonlyValue<Color>,
  ): Image

  创建指定像素尺寸的图像；使用颜色填充或复制 RGBA8 字节，默认黑色。

  Parameters

  • size: Readonly<Vector2u>
  • OptionalcolorOrPixels: Uint8Array | ReadonlyValue<Color>

  Returns Image

Readonly[graphicsNative]

pixels

• get pixels(): Uint8Array

  Writable extension; old views retain old images after resize or load.

  Returns Uint8Array

copy

• copy(
      source: Image,
      dest: Readonly<Vector2u>,
      sourceRect?: ReadonlyValue<IntRect>,
      applyAlpha?: boolean,
  ): boolean

  复制 sourceRect（默认整个源图）到 dest；applyAlpha 启用透明度混合，返回是否成功。

  Parameters

  • source: Image
  • dest: Readonly<Vector2u>
  • OptionalsourceRect: ReadonlyValue<IntRect>
  • applyAlpha: boolean = false

  Returns boolean

createMaskFromColor

• createMaskFromColor(color: ReadonlyValue<Color>, alpha?: number): void

  将与 color 完全匹配的像素透明度设为 alpha（默认 0），保留 RGB。

  Parameters

  • color: ReadonlyValue<Color>
  • alpha: number = 0

  Returns void

flipHorizontally

• flipHorizontally(): void

  原地左右翻转像素。

  Returns void

flipVertically

• flipVertically(): void

  原地上下翻转像素。

  Returns void

getPixel

• getPixel(coords: Readonly<Vector2u>): Color

  返回指定像素的颜色副本；坐标越界抛出 RangeError。

  Parameters

  • coords: Readonly<Vector2u>

  Returns Color

getPixelsPtr

• getPixelsPtr(): | undefined
  | Readonly<
      Pick<
          Uint8Array,
          | number
          | typeof iterator
          | "length"
          | "slice"
          | "entries"
          | "keys"
          | "values"
          | "byteLength"
          | "byteOffset",
      >,
  >

  Empty images have no pixel pointer. Constness is enforced by TypeScript.

  Returns
      | undefined
      | Readonly<
          Pick<
              Uint8Array,
              | number
              | typeof iterator
              | "length"
              | "slice"
              | "entries"
              | "keys"
              | "values"
              | "byteLength"
              | "byteOffset",
          >,
      >

getSize

• getSize(): Vector2u

  返回图像像素宽度和高度的副本。

  Returns Vector2u

loadFromFile

• loadFromFile(filename: string): Promise<boolean>

  异步读取并解码图像文件，成功后替换像素存储，返回是否成功。

  Parameters

  • filename: string

  Returns Promise<boolean>

loadFromMemory

• loadFromMemory(data: Uint8Array): Promise<boolean>

  异步解码 PNG/JPEG 等编码图像字节，返回是否成功。

  Parameters

  • data: Uint8Array

  Returns Promise<boolean>

loadFromStream

• loadFromStream(stream: InputStream): Promise<boolean>

  从可寻址输入流异步解码图像；流异常会拒绝 Promise。

  Parameters

  • stream: InputStream

  Returns Promise<boolean>

resize

• resize(
      size: Readonly<Vector2u>,
      colorOrPixels?: Uint8Array | ReadonlyValue<Color>,
  ): void

  重建像素存储并填充颜色或复制 RGBA8 数据；之前的 pixels 视图保留旧存储。

  Parameters

  • size: Readonly<Vector2u>
  • colorOrPixels: Uint8Array | ReadonlyValue<Color> = Color.Black

  Returns void

saveToFile

• saveToFile(filename: string): Promise<boolean>

  按文件扩展名异步编码并保存图像，返回是否成功。

  Parameters

  • filename: string

  Returns Promise<boolean>

saveToMemory

• saveToMemory(format: string): Promise<undefined | Uint8Array>

  异步编码为 format（如 png）指定的格式，返回字节；编码失败返回 undefined。

  Parameters

  • format: string

  Returns Promise<undefined | Uint8Array>

setPixel

• setPixel(coords: Readonly<Vector2u>, color: ReadonlyValue<Color>): void

  复制颜色到指定像素；坐标越界抛出 RangeError。

  Parameters

  • coords: Readonly<Vector2u>
  • color: ReadonlyValue<Color>

  Returns void