summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorChristian Beier <cb@shoutrlabs.com>2015-12-03 20:02:02 +0100
committerChristian Beier <cb@shoutrlabs.com>2015-12-03 20:02:02 +0100
commit9d4cb568b70443f9137108dd5eaad34523c3664d (patch)
treea1c13e7f6e4bdc56bc9470d5e39b627e87c8b790
parent4665af4950023c194453fe7517dbe06ee811ea15 (diff)
downloadlibtdevnc-9d4cb568.tar.gz
libtdevnc-9d4cb568.zip
Be a bit clearer with the cursorshape documentation for libvncclient.
-rw-r--r--rfb/rfbclient.h5
1 files changed, 4 insertions, 1 deletions
diff --git a/rfb/rfbclient.h b/rfb/rfbclient.h
index 0ae001a..157461e 100644
--- a/rfb/rfbclient.h
+++ b/rfb/rfbclient.h
@@ -175,7 +175,10 @@ typedef void (*GotXCutTextProc)(struct _rfbClient* client, const char *text, int
typedef void (*BellProc)(struct _rfbClient* client);
/**
Called when a cursor shape update was received from the server. The decoded cursor shape
- will be in client->rcSource.
+ will be in client->rcSource. It's up to the application to do something with this, e.g. draw
+ into a viewer's window. If you want the server to draw the cursor into the framebuffer, be
+ careful not to announce remote cursor support, i.e. not include rfbEncodingXCursor or
+ rfbEncodingRichCursor in SetFormatAndEncodings().
*/
typedef void (*GotCursorShapeProc)(struct _rfbClient* client, int xhot, int yhot, int width, int height, int bytesPerPixel);
typedef void (*GotCopyRectProc)(struct _rfbClient* client, int src_x, int src_y, int w, int h, int dest_x, int dest_y);