Class Cursors

Container for the 8 mouse cursors in the CURS file.

Implements

Iterable<Cursor>

Index

Methods

[iterator] getCursor getCursorCount fromArray fromBlob

Methods

[iterator]

"[iterator]"(): Generator<Cursor>
Returns Generator<Cursor>
Yields
The cursors.
Implementation of Iterable.[iterator]
- Defined in cursor/Cursors.ts:27

getCursor

getCursor(index: number): Cursor
Returns the mouse cursor image with the given index.
Parameters
- index: number
  The index of the mouse cursor image.
Returns Cursor
The mouse cursor image.

Throws
RangeError if the index is out of bounds.
- Defined in cursor/Cursors.ts:38

getCursorCount

getCursorCount(): number
Returns number
The number of mouse cursors.
- Defined in cursor/Cursors.ts:48

`Static`fromArray

fromArray(array: Uint8Array): Cursors
Parses the mouse cursor images from the given array and returns it.
Parameters
- array: Uint8Array
  The array with the CURS file content to parse.
Returns Cursors
The parsed mouse cursors.
- Defined in cursor/Cursors.ts:58

`Static`fromBlob

fromBlob(blob: Blob): Promise<Cursors>
Reads mouse cursor images from the given blob and returns it.
Parameters
- blob: Blob
  The CURS blob to read.
Returns Promise<Cursors>
The read mouse cursors.
- Defined in cursor/Cursors.ts:73