VirtualBox

source: vbox/trunk/include/VBox/RemoteDesktop/VRDEMousePtr.h@ 96407

Last change on this file since 96407 was 96407, checked in by vboxsync, 2 years ago

scm copyright and license note update

  • Property svn:eol-style set to native
  • Property svn:keywords set to Author Date Id Revision
File size: 2.7 KB
Line 
1/** @file
2 * VBox Remote Desktop Extension (VRDE) - Mouse pointer updates interface.
3 */
4
5/*
6 * Copyright (C) 2012-2022 Oracle and/or its affiliates.
7 *
8 * This file is part of VirtualBox base platform packages, as
9 * available from https://www.virtualbox.org.
10 *
11 * This program is free software; you can redistribute it and/or
12 * modify it under the terms of the GNU General Public License
13 * as published by the Free Software Foundation, in version 3 of the
14 * License.
15 *
16 * This program is distributed in the hope that it will be useful, but
17 * WITHOUT ANY WARRANTY; without even the implied warranty of
18 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
19 * General Public License for more details.
20 *
21 * You should have received a copy of the GNU General Public License
22 * along with this program; if not, see <https://www.gnu.org/licenses>.
23 *
24 * The contents of this file may alternatively be used under the terms
25 * of the Common Development and Distribution License Version 1.0
26 * (CDDL), a copy of it is provided in the "COPYING.CDDL" file included
27 * in the VirtualBox distribution, in which case the provisions of the
28 * CDDL are applicable instead of those of the GPL.
29 *
30 * You may elect to license modified versions of this file under the
31 * terms and conditions of either the GPL or the CDDL or both.
32 *
33 * SPDX-License-Identifier: GPL-3.0-only OR CDDL-1.0
34 */
35
36#ifndef VBOX_INCLUDED_RemoteDesktop_VRDEMousePtr_h
37#define VBOX_INCLUDED_RemoteDesktop_VRDEMousePtr_h
38#ifndef RT_WITHOUT_PRAGMA_ONCE
39# pragma once
40#endif
41
42#include <VBox/RemoteDesktop/VRDE.h>
43
44/*
45 * Interface for mouse pointer updates.
46 */
47
48#define VRDE_MOUSEPTR_INTERFACE_NAME "MOUSEPTR"
49
50#pragma pack(1)
51/* The color mouse pointer information: maximum allowed pointer size is 256x256. */
52typedef struct VRDEMOUSEPTRDATA
53{
54 uint16_t u16HotX;
55 uint16_t u16HotY;
56 uint16_t u16Width;
57 uint16_t u16Height;
58 uint16_t u16MaskLen; /* 0 for 32BPP pointers with alpha channel. */
59 uint32_t u32DataLen;
60 /* uint8_t au8Mask[u16MaskLen]; The 1BPP mask. Optional: does not exist if u16MaskLen == 0. */
61 /* uint8_t au8Data[u16DataLen]; The color bitmap, 32 bits color depth. */
62} VRDEMOUSEPTRDATA;
63#pragma pack()
64
65/** The VRDE server external mouse pointer updates interface entry points. Interface version 1. */
66typedef struct VRDEMOUSEPTRINTERFACE
67{
68 /** The header. */
69 VRDEINTERFACEHDR header;
70
71 /** Set the mouse pointer.
72 *
73 * @param hServer The server instance handle.
74 * @param pPointer The mouse pointer description.
75 *
76 */
77 DECLR3CALLBACKMEMBER(void, VRDEMousePtr, (HVRDESERVER hServer,
78 const VRDEMOUSEPTRDATA *pPointer));
79
80} VRDEMOUSEPTRINTERFACE;
81
82#endif /* !VBOX_INCLUDED_RemoteDesktop_VRDEMousePtr_h */
Note: See TracBrowser for help on using the repository browser.

© 2024 Oracle Support Privacy / Do Not Sell My Info Terms of Use Trademark Policy Automated Access Etiquette