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