Home > @rainway/web > Cursor
Cursor interface
A structure which represents a remote cursor.
Signature:
export interface Cursor
Properties
| Property | Modifiers | Type | Description |
|---|---|---|---|
| extentHeight | readonly | number | The height of the desktop the cursor is active on. |
| extentWidth | readonly | number | The width of the desktop the cursor is active on. |
| hasPointerImage | readonly | boolean | Indicates where the incoming cursor information contains a bitmap |
| pointerImage | readonly | ArrayBuffer | A pointer bitmap image (say, a PNG file). |
| shapeHeight | readonly | number | Height in pixels of the video frame which should correspond to the desktop size. |
| shapeWidth | readonly | number | Width in pixels of the video frame which should correspond to the desktop size. |
| spotX | readonly | number | The “spot” coordinates are the pixel in this image that acts as the interaction point of the cursor. |
| spotY | readonly | number | The “spot” coordinates are the pixel in this image that acts as the interaction point of the cursor. |
| visible | readonly | boolean | The current visibility of the remote cursor. |
| x | readonly | number | Width in pixels of the video frame which should correspond to the desktop size. |
| y | readonly | number | Height in pixels of the video frame which should correspond to the desktop size. |
