Image

constructor

• new Image(): Image

  Creates an empty image without pixels.

  Returns

  Image

  Source & inheritance
• new Image(source: Image): Image

  Deep-copies an image's RGBA pixels.

  Parameters

  source

  Image

  Returns

  Image

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

  Creates an image of the specified pixel size; fills with a color or copies RGBA8 bytes, defaulting to black.

  Parameters

  size

  Readonly<Vector2u>

  colorOrPixelsOptional

  Uint8Array | ReadonlyValue<Color>

  Returns

  Image

  Source & inheritance

pixels

• get pixels(): Uint8Array

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

  Returns

  Uint8Array

  Source & inheritance

copy

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

  Copies sourceRect (the entire source by default) to dest; applyAlpha enables alpha blending. Returns whether it succeeded.

  Parameters

  source

  Image

  dest

  Readonly<Vector2u>

  sourceRectOptional

  ReadonlyValue<IntRect>

  applyAlpha

  boolean = false

  Returns

  boolean

  Source & inheritance

createMaskFromColor

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

  Sets the alpha of pixels exactly matching color to alpha (default 0), preserving RGB.

  Parameters

  color

  ReadonlyValue<Color>

  alpha

  number = 0

  Returns

  void

  Source & inheritance

flipHorizontally

• flipHorizontally(): void

  Flips pixels horizontally in place.

  Returns

  void

  Source & inheritance

flipVertically

• flipVertically(): void

  Flips pixels vertically in place.

  Returns

  void

  Source & inheritance

getPixel

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

  Returns a copy of the specified pixel's color; throws RangeError for out-of-bounds coordinates.

  Parameters

  coords

  Readonly<Vector2u>

  Returns

  Color

  Source & inheritance

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",
          >,
      >

  Source & inheritance

getSize

• getSize(): Vector2u

  Returns a copy of the image width and height in pixels.

  Returns

  Vector2u

  Source & inheritance

loadFromFile

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

  Reads and decodes an image file asynchronously, replacing pixel storage on success; returns whether it succeeded.

  Parameters

  filename

  string

  Returns

  Promise<boolean>

  Source & inheritance

loadFromMemory

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

  Decodes encoded image bytes such as PNG/JPEG asynchronously and returns whether it succeeded.

  Parameters

  data

  Uint8Array

  Returns

  Promise<boolean>

  Source & inheritance

loadFromStream

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

  Decodes an image asynchronously from a seekable input stream; stream errors reject the Promise.

  Parameters

  stream

  InputStream

  Returns

  Promise<boolean>

  Source & inheritance

resize

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

  Rebuilds pixel storage and fills with a color or copies RGBA8 data; previous pixels views retain the old storage.

  Parameters

  size

  Readonly<Vector2u>

  colorOrPixels

  Uint8Array | ReadonlyValue<Color> = Color.Black

  Returns

  void

  Source & inheritance

saveToFile

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

  Encodes and saves an image asynchronously using the file extension; returns whether it succeeded.

  Parameters

  filename

  string

  Returns

  Promise<boolean>

  Source & inheritance

saveToMemory

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

  Encodes asynchronously to format (such as png) and returns bytes; returns undefined if encoding fails.

  Parameters

  format

  string

  Returns

  Promise<undefined | Uint8Array>

  Source & inheritance

setPixel

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

  Copies a color into the specified pixel; throws RangeError for out-of-bounds coordinates.

  Parameters

  coords

  Readonly<Vector2u>

  color

  ReadonlyValue<Color>

  Returns

  void

  Source & inheritance

Readonly[graphicsNative]