| 1 | /** @file
|
|---|
| 2 | * VBox Remote Desktop Extension (VRDE) - Mouse pointer updates interface.
|
|---|
| 3 | */
|
|---|
| 4 |
|
|---|
| 5 | /*
|
|---|
| 6 | * Copyright (C) 2012-2020 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_INCLUDED_RemoteDesktop_VRDEMousePtr_h
|
|---|
| 27 | #define VBOX_INCLUDED_RemoteDesktop_VRDEMousePtr_h
|
|---|
| 28 | #ifndef RT_WITHOUT_PRAGMA_ONCE
|
|---|
| 29 | # pragma once
|
|---|
| 30 | #endif
|
|---|
| 31 |
|
|---|
| 32 | #include <VBox/RemoteDesktop/VRDE.h>
|
|---|
| 33 |
|
|---|
| 34 | /*
|
|---|
| 35 | * Interface for mouse pointer updates.
|
|---|
| 36 | */
|
|---|
| 37 |
|
|---|
| 38 | #define VRDE_MOUSEPTR_INTERFACE_NAME "MOUSEPTR"
|
|---|
| 39 |
|
|---|
| 40 | #pragma pack(1)
|
|---|
| 41 | /* The color mouse pointer information: maximum allowed pointer size is 256x256. */
|
|---|
| 42 | typedef struct VRDEMOUSEPTRDATA
|
|---|
| 43 | {
|
|---|
| 44 | uint16_t u16HotX;
|
|---|
| 45 | uint16_t u16HotY;
|
|---|
| 46 | uint16_t u16Width;
|
|---|
| 47 | uint16_t u16Height;
|
|---|
| 48 | uint16_t u16MaskLen; /* 0 for 32BPP pointers with alpha channel. */
|
|---|
| 49 | uint32_t u32DataLen;
|
|---|
| 50 | /* uint8_t au8Mask[u16MaskLen]; The 1BPP mask. Optional: does not exist if u16MaskLen == 0. */
|
|---|
| 51 | /* uint8_t au8Data[u16DataLen]; The color bitmap, 32 bits color depth. */
|
|---|
| 52 | } VRDEMOUSEPTRDATA;
|
|---|
| 53 | #pragma pack()
|
|---|
| 54 |
|
|---|
| 55 | /** The VRDE server external mouse pointer updates interface entry points. Interface version 1. */
|
|---|
| 56 | typedef struct VRDEMOUSEPTRINTERFACE
|
|---|
| 57 | {
|
|---|
| 58 | /** The header. */
|
|---|
| 59 | VRDEINTERFACEHDR header;
|
|---|
| 60 |
|
|---|
| 61 | /** Set the mouse pointer.
|
|---|
| 62 | *
|
|---|
| 63 | * @param hServer The server instance handle.
|
|---|
| 64 | * @param pPointer The mouse pointer description.
|
|---|
| 65 | *
|
|---|
| 66 | */
|
|---|
| 67 | DECLR3CALLBACKMEMBER(void, VRDEMousePtr, (HVRDESERVER hServer,
|
|---|
| 68 | const VRDEMOUSEPTRDATA *pPointer));
|
|---|
| 69 |
|
|---|
| 70 | } VRDEMOUSEPTRINTERFACE;
|
|---|
| 71 |
|
|---|
| 72 | #endif /* !VBOX_INCLUDED_RemoteDesktop_VRDEMousePtr_h */
|
|---|
