1 | /** @file
|
---|
2 | * VBox Remote Desktop Extension (VRDE) - Mouse pointer updates interface.
|
---|
3 | */
|
---|
4 |
|
---|
5 | /*
|
---|
6 | * Copyright (C) 2012-2016 Oracle Corporation
|
---|
7 | *
|
---|
8 | * This file is part of VirtualBox Open Source Edition (OSE), as
|
---|
9 | * available from http://www.virtualbox.org. This file is free software;
|
---|
10 | * you can redistribute it and/or modify it under the terms of the GNU
|
---|
11 | * General Public License (GPL) as published by the Free Software
|
---|
12 | * Foundation, in version 2 as it comes in the "COPYING" file of the
|
---|
13 | * VirtualBox OSE distribution. VirtualBox OSE is distributed in the
|
---|
14 | * hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
|
---|
15 | *
|
---|
16 | * The contents of this file may alternatively be used under the terms
|
---|
17 | * of the Common Development and Distribution License Version 1.0
|
---|
18 | * (CDDL) only, as it comes in the "COPYING.CDDL" file of the
|
---|
19 | * VirtualBox OSE distribution, in which case the provisions of the
|
---|
20 | * CDDL are applicable instead of those of the GPL.
|
---|
21 | *
|
---|
22 | * You may elect to license modified versions of this file under the
|
---|
23 | * terms and conditions of either the GPL or the CDDL or both.
|
---|
24 | */
|
---|
25 |
|
---|
26 | #ifndef ___VBox_RemoteDesktop_VRDEMousePtr_h
|
---|
27 | #define ___VBox_RemoteDesktop_VRDEMousePtr_h
|
---|
28 |
|
---|
29 | #include <VBox/RemoteDesktop/VRDE.h>
|
---|
30 |
|
---|
31 | /*
|
---|
32 | * Interface for mouse pointer updates.
|
---|
33 | */
|
---|
34 |
|
---|
35 | #define VRDE_MOUSEPTR_INTERFACE_NAME "MOUSEPTR"
|
---|
36 |
|
---|
37 | #pragma pack(1)
|
---|
38 | /* The color mouse pointer information: maximum allowed pointer size is 256x256. */
|
---|
39 | typedef struct VRDEMOUSEPTRDATA
|
---|
40 | {
|
---|
41 | uint16_t u16HotX;
|
---|
42 | uint16_t u16HotY;
|
---|
43 | uint16_t u16Width;
|
---|
44 | uint16_t u16Height;
|
---|
45 | uint16_t u16MaskLen; /* 0 for 32BPP pointers with alpha channel. */
|
---|
46 | uint32_t u32DataLen;
|
---|
47 | /* uint8_t au8Mask[u16MaskLen]; The 1BPP mask. Optional: does not exist if u16MaskLen == 0. */
|
---|
48 | /* uint8_t au8Data[u16DataLen]; The color bitmap, 32 bits color depth. */
|
---|
49 | } VRDEMOUSEPTRDATA;
|
---|
50 | #pragma pack()
|
---|
51 |
|
---|
52 | /** The VRDE server external mouse pointer updates interface entry points. Interface version 1. */
|
---|
53 | typedef struct VRDEMOUSEPTRINTERFACE
|
---|
54 | {
|
---|
55 | /** The header. */
|
---|
56 | VRDEINTERFACEHDR header;
|
---|
57 |
|
---|
58 | /** Set the mouse pointer.
|
---|
59 | *
|
---|
60 | * @param hServer The server instance handle.
|
---|
61 | * @param pPointer The mouse pointer description.
|
---|
62 | *
|
---|
63 | */
|
---|
64 | DECLR3CALLBACKMEMBER(void, VRDEMousePtr, (HVRDESERVER hServer,
|
---|
65 | const VRDEMOUSEPTRDATA *pPointer));
|
---|
66 |
|
---|
67 | } VRDEMOUSEPTRINTERFACE;
|
---|
68 |
|
---|
69 | #endif
|
---|