vmmouse_client.h revision d075918c 
1/*
2 * Copyright 2002-2006 by VMware, Inc.
3 *
4 * Permission is hereby granted, free of charge, to any person obtaining a
5 * copy of this software and associated documentation files (the "Software"),
6 * to deal in the Software without restriction, including without limitation
7 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
8 * and/or sell copies of the Software, and to permit persons to whom the
9 * Software is furnished to do so, subject to the following conditions:
10 *
11 * The above copyright notice and this permission notice shall be included in
12 * all copies or substantial portions of the Software.
13 *
14 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
15 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
16 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL
17 * THE COPYRIGHT HOLDER(S) OR AUTHOR(S) BE LIABLE FOR ANY CLAIM, DAMAGES OR
18 * OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
19 * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
20 * OTHER DEALINGS IN THE SOFTWARE.
21 *
22 * Except as contained in this notice, the name of the copyright holder(s)
23 * and author(s) shall not be used in advertising or otherwise to promote
24 * the sale, use or other dealings in this Software without prior written
25 * authorization from the copyright holder(s) and author(s).
26 */
27
28/*
29 * vmmouse_client.h --
30 *
31 *     VMware Virtual Mouse Client
32 *
33 * This module provides functions to enable/disable, operate and
34 * process packets via the VMMouse absolute positioning module
35 * hosted in the VMX.
36 *
37 */
38
39#ifndef _VMMOUSE_CLIENT_H_
40#define _VMMOUSE_CLIENT_H_
41
42#include "xf86_OSproc.h"
43
44/*
45 * VMMouse Input packet data structure
46 */
47typedef struct _VMMOUSE_INPUT_DATA {
48   unsigned short Flags;
49   unsigned short Buttons;
50   int X;
51   int Y;
52   int Z;
53} VMMOUSE_INPUT_DATA, *PVMMOUSE_INPUT_DATA;
54
55/*
56 * Public Functions
57 */
58Bool VMMouseClient_Enable(void);
59void VMMouseClient_Disable(void);
60unsigned int VMMouseClient_GetInput(PVMMOUSE_INPUT_DATA pvmmouseInput);
61void VMMouseClient_RequestRelative(void);
62void VMMouseClient_RequestAbsolute(void);
63
64#ifdef VMX86_DEVEL
65#define VMwareLog(args) ErrorF args
66#else
67#define VMwareLog(args)
68#endif
69
70#include "vmmouse_defs.h"
71
72#endif /* _VMMOUSE_CLIENT_H_ */
73
74