Class Cursor

Container for a single mouse cursor image.

Hierarchy (View Summary)

BaseImage
- Cursor

Index

Properties

Methods

draw getColor getHeight getWidth toCanvas toDataUrl toImage fromArray

Properties

`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 BaseImage.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.
Overrides BaseImage.getColor
- Defined in cursor/Cursor.ts:26

getHeight

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

Returns number
The image height in pixels.
Inherited from BaseImage.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 BaseImage.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 BaseImage.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 BaseImage.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 BaseImage.toImage
- Defined in image/BaseImage.ts:118

`Static`fromArray

fromArray(array: Uint8Array, offset?: number): Cursor
Parses a mouse cursor image from the given array.
Parameters
- array: Uint8Array
  The array containing the image data.
- offset: number = 0
  Optional start offset within the array. Defaults to 0.
Returns Cursor
The parsed mouse cursor image.
- Defined in cursor/Cursor.ts:55