Embed format information along with default cursor image data. Refactor default curso...
[libguac-client-rdp.git] / include / default_pointer.h
1
2 /* ***** BEGIN LICENSE BLOCK *****
3  * Version: MPL 1.1/GPL 2.0/LGPL 2.1
4  *
5  * The contents of this file are subject to the Mozilla Public License Version
6  * 1.1 (the "License"); you may not use this file except in compliance with
7  * the License. You may obtain a copy of the License at
8  * http://www.mozilla.org/MPL/
9  *
10  * Software distributed under the License is distributed on an "AS IS" basis,
11  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
12  * for the specific language governing rights and limitations under the
13  * License.
14  *
15  * The Original Code is libguac-client-rdp.
16  *
17  * The Initial Developer of the Original Code is
18  * Michael Jumper.
19  * Portions created by the Initial Developer are Copyright (C) 2011
20  * the Initial Developer. All Rights Reserved.
21  *
22  * Contributor(s):
23  *
24  * Alternatively, the contents of this file may be used under the terms of
25  * either the GNU General Public License Version 2 or later (the "GPL"), or
26  * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
27  * in which case the provisions of the GPL or the LGPL are applicable instead
28  * of those above. If you wish to allow use of your version of this file only
29  * under the terms of either the GPL or the LGPL, and not to allow others to
30  * use your version of this file under the terms of the MPL, indicate your
31  * decision by deleting the provisions above and replace them with the notice
32  * and other provisions required by the GPL or the LGPL. If you do not delete
33  * the provisions above, a recipient may use your version of this file under
34  * the terms of any one of the MPL, the GPL or the LGPL.
35  *
36  * ***** END LICENSE BLOCK ***** */
37
38 #ifndef _GUAC_RDP_DEFAULT_POINTER_H
39 #define _GUAC_RDP_DEFAULT_POINTER_H
40
41 #include <cairo/cairo.h>
42 #include <guacamole/client.h>
43
44 /**
45  * Width of the embedded mouse cursor graphic.
46  */
47 extern const int guac_rdp_default_pointer_width;
48
49 /**
50  * Height of the embedded mouse cursor graphic.
51  */
52 extern const int guac_rdp_default_pointer_height;
53
54 /**
55  * Number of bytes in each row of the embedded mouse cursor graphic.
56  */
57 extern const int guac_rdp_default_pointer_stride;
58
59 /**
60  * The Cairo grapic format of the mouse cursor graphic.
61  */
62 extern const cairo_format_t guac_rdp_default_pointer_format;
63
64 /**
65  * Embedded mouse cursor graphic.
66  */
67 extern unsigned char guac_rdp_default_pointer[];
68
69 /**
70  * Set the cursor of the remote display to the embedded cursor graphic.
71  *
72  * @param client The guac_client to send the cursor to.
73  */
74 void guac_rdp_pointer_set_default(guac_client* client);
75
76 #endif