Class Title

Container for the title image.

Hierarchy (View Summary)

PicImage
- Title

Index

Properties

data height width

Methods

draw getColor getData getHeight getWidth toCanvas toDataUrl toImage fromArray fromBlob

Properties

`Protected`data

data: Uint8Array

The image data.

`Protected`height

height: number

The image height in pixels.

`Protected`width

width: number

The image width in pixels.

Methods

draw

draw(ctx: CanvasRenderingContext2D, x?: number, y?: number): void
Draws the image onto the given rendering context.
Parameters
- ctx: CanvasRenderingContext2D
  The rendering context to draw the image to.
- x: number = 0
  Optional horizontal target position. Defaults to 0.
- y: number = 0
  Optional vertical target position. Defaults to 0.
Returns void
Inherited from PicImage.draw
- Defined in image/BaseImage.ts:64

getColor

getColor(x: number, y: number): number
Returns the RGBA color at the specified position.
Parameters
- x: number
  The horizontal pixel position.
- y: number
  The vertical pixel position.
Returns number
The RGBA color at the specified position.
Inherited from PicImage.getColor
- Defined in image/PicImage.ts:37

getData

getData(): Uint8Array
Returns a copy of the image data. Each byte contains two 4-bit colors.

Returns Uint8Array
The image data.
Inherited from PicImage.getData
- Defined in image/PicImage.ts:33

getHeight

getHeight(): number
Returns the image height in pixels.

Returns number
The image height in pixels.
Inherited from PicImage.getHeight
- Defined in image/BaseImage.ts:44

getWidth

getWidth(): number
Returns the image width in pixels.

Returns number
The image width in pixels.
Inherited from PicImage.getWidth
- Defined in image/BaseImage.ts:35

toCanvas

toCanvas(): HTMLCanvasElement
Creates and returns a new canvas containing the image.

Returns HTMLCanvasElement
The created canvas.
Inherited from PicImage.toCanvas
- Defined in image/BaseImage.ts:87

toDataUrl

toDataUrl(type?: string, quality?: number): string
Creates and returns an image data URL.
Parameters
- Optionaltype: string
  Optional image mime type. Defaults to image/png.
- Optionalquality: number
  Optional quality parameter for encoder. For image/jpeg this is the image quality between 0 and 1 with a default value of 0.92.
Returns string
The created data URL.
Inherited from PicImage.toDataUrl
- Defined in image/BaseImage.ts:105

toImage

toImage(type?: string, quality?: number): HTMLImageElement
Creates and returns a HTML image.
Parameters
- Optionaltype: string
  Optional image mime type. Defaults to image/png.
- Optionalquality: number
  Optional quality parameter for encoder. For image/jpeg this is the image quality between 0 and 1 with a default value of 0.92.
Returns HTMLImageElement
The created HTML image.
Inherited from PicImage.toImage
- Defined in image/BaseImage.ts:118

`Static`fromArray

fromArray(array: Uint8Array): Title
Parses a title image from the given array and returns it.
Parameters
- array: Uint8Array
  The vxor encoded array.
Returns Title
The parsed title.pic image.
- Defined in title/Title.ts:29

`Static`fromBlob

fromBlob(blob: Blob): Promise<Title>
Reads the title image from the given blob and returns it.
Parameters
- blob: Blob
  The TITLE.PIC blob to read.
Returns Promise<Title>
The read title image.
- Defined in title/Title.ts:39