HomeGuidesAPI Reference
HubBlogChangelogSupport ForumLog In
API Reference

Web SDK - Cursor

Home > @rainway/web > Cursor

Cursor interface

A structure which represents a remote cursor.

Signature:

export interface Cursor 

Properties

PropertyModifiersTypeDescription
extentHeightreadonlynumberThe height of the desktop the cursor is active on.
extentWidthreadonlynumberThe width of the desktop the cursor is active on.
hasPointerImagereadonlybooleanIndicates where the incoming cursor information contains a bitmap
pointerImagereadonlyArrayBufferA pointer bitmap image (say, a PNG file).
shapeHeightreadonlynumberHeight in pixels of the video frame which should correspond to the desktop size.
shapeWidthreadonlynumberWidth in pixels of the video frame which should correspond to the desktop size.
spotXreadonlynumberThe “spot” coordinates are the pixel in this image that acts as the interaction point of the cursor.
spotYreadonlynumberThe “spot” coordinates are the pixel in this image that acts as the interaction point of the cursor.
visiblereadonlybooleanThe current visibility of the remote cursor.
xreadonlynumberWidth in pixels of the video frame which should correspond to the desktop size.
yreadonlynumberHeight in pixels of the video frame which should correspond to the desktop size.