orx 1.16
Portable Game Engine
Loading...
Searching...
No Matches
orxMouse.h
Go to the documentation of this file.
1/* Orx - Portable Game Engine
2 *
3 * Copyright (c) 2008- Orx-Project
4 *
5 * This software is provided 'as-is', without any express or implied
6 * warranty. In no event will the authors be held liable for any damages
7 * arising from the use of this software.
8 *
9 * Permission is granted to anyone to use this software for any purpose,
10 * including commercial applications, and to alter it and redistribute it
11 * freely, subject to the following restrictions:
12 *
13 * 1. The origin of this software must not be misrepresented; you must not
14 * claim that you wrote the original software. If you use this software
15 * in a product, an acknowledgment in the product documentation would be
16 * appreciated but is not required.
17 *
18 * 2. Altered source versions must be plainly marked as such, and must not be
19 * misrepresented as being the original software.
20 *
21 * 3. This notice may not be removed or altered from any source
22 * distribution.
23 */
24
32
41
42
43#ifndef _orxMOUSE_H_
44#define _orxMOUSE_H_
45
46#include "orxInclude.h"
48#include "math/orxVector.h"
49#include "utils/orxString.h"
50
51
71
72typedef enum __orxMOUSE_AXIS_t
73{
77
78 orxMOUSE_AXIS_NONE = orxENUM_NONE
79
81
82#define orxMOUSE_KZ_CONFIG_SECTION "Mouse"
83#define orxMOUSE_KZ_CONFIG_SHOW_CURSOR "ShowCursor"
84#define orxMOUSE_KZ_CONFIG_GRAB "Grab"
85
86
87/***************************************************************************
88 * Functions directly implemented by orx core
89 ***************************************************************************/
90
93extern orxDLLAPI void orxFASTCALL orxMouse_Setup();
94
95
96/***************************************************************************
97 * Functions extended by plugins
98 ***************************************************************************/
99
103extern orxDLLAPI orxSTATUS orxFASTCALL orxMouse_Init();
104
107extern orxDLLAPI void orxFASTCALL orxMouse_Exit();
108
113extern orxDLLAPI orxSTATUS orxFASTCALL orxMouse_SetPosition(const orxVECTOR *_pvPosition);
114
119extern orxDLLAPI orxVECTOR *orxFASTCALL orxMouse_GetPosition(orxVECTOR *_pvPosition);
120
125extern orxDLLAPI orxBOOL orxFASTCALL orxMouse_IsButtonPressed(orxMOUSE_BUTTON _eButton);
126
131extern orxDLLAPI orxVECTOR *orxFASTCALL orxMouse_GetMoveDelta(orxVECTOR *_pvMoveDelta);
132
136extern orxDLLAPI orxFLOAT orxFASTCALL orxMouse_GetWheelDelta();
137
142extern orxDLLAPI orxSTATUS orxFASTCALL orxMouse_ShowCursor(orxBOOL _bShow);
143
148extern orxDLLAPI orxSTATUS orxFASTCALL orxMouse_Grab(orxBOOL _bGrab);
149
155extern orxDLLAPI orxSTATUS orxFASTCALL orxMouse_SetCursor(const orxSTRING _zName, const orxVECTOR *_pvPivot);
156
161extern orxDLLAPI const orxSTRING orxFASTCALL orxMouse_GetButtonName(orxMOUSE_BUTTON _eButton);
162
167extern orxDLLAPI const orxSTRING orxFASTCALL orxMouse_GetAxisName(orxMOUSE_AXIS _eAxis);
168
169#endif /* _orxMOUSE_H_ */
170
#define orxDLLAPI
Definition orxDecl.h:381
orxDLLAPI const orxSTRING orxFASTCALL orxMouse_GetButtonName(orxMOUSE_BUTTON _eButton)
orxDLLAPI orxSTATUS orxFASTCALL orxMouse_SetCursor(const orxSTRING _zName, const orxVECTOR *_pvPivot)
orxDLLAPI orxSTATUS orxFASTCALL orxMouse_ShowCursor(orxBOOL _bShow)
orxMOUSE_BUTTON
Definition orxMouse.h:55
orxDLLAPI void orxFASTCALL orxMouse_Setup()
orxDLLAPI orxVECTOR *orxFASTCALL orxMouse_GetPosition(orxVECTOR *_pvPosition)
orxMOUSE_AXIS
Definition orxMouse.h:73
orxDLLAPI orxSTATUS orxFASTCALL orxMouse_Grab(orxBOOL _bGrab)
orxDLLAPI orxSTATUS orxFASTCALL orxMouse_SetPosition(const orxVECTOR *_pvPosition)
orxDLLAPI orxFLOAT orxFASTCALL orxMouse_GetWheelDelta()
orxDLLAPI const orxSTRING orxFASTCALL orxMouse_GetAxisName(orxMOUSE_AXIS _eAxis)
orxDLLAPI orxBOOL orxFASTCALL orxMouse_IsButtonPressed(orxMOUSE_BUTTON _eButton)
orxDLLAPI void orxFASTCALL orxMouse_Exit()
orxDLLAPI orxSTATUS orxFASTCALL orxMouse_Init()
orxDLLAPI orxVECTOR *orxFASTCALL orxMouse_GetMoveDelta(orxVECTOR *_pvMoveDelta)
@ orxMOUSE_BUTTON_EXTRA_4
Definition orxMouse.h:62
@ orxMOUSE_BUTTON_LEFT
Definition orxMouse.h:56
@ orxMOUSE_BUTTON_NUMBER
Definition orxMouse.h:66
@ orxMOUSE_BUTTON_NONE
Definition orxMouse.h:68
@ orxMOUSE_BUTTON_RIGHT
Definition orxMouse.h:57
@ orxMOUSE_BUTTON_EXTRA_5
Definition orxMouse.h:63
@ orxMOUSE_BUTTON_WHEEL_DOWN
Definition orxMouse.h:65
@ orxMOUSE_BUTTON_EXTRA_1
Definition orxMouse.h:59
@ orxMOUSE_BUTTON_MIDDLE
Definition orxMouse.h:58
@ orxMOUSE_BUTTON_EXTRA_3
Definition orxMouse.h:61
@ orxMOUSE_BUTTON_EXTRA_2
Definition orxMouse.h:60
@ orxMOUSE_BUTTON_WHEEL_UP
Definition orxMouse.h:64
@ orxMOUSE_AXIS_Y
Definition orxMouse.h:75
@ orxMOUSE_AXIS_NUMBER
Definition orxMouse.h:76
@ orxMOUSE_AXIS_NONE
Definition orxMouse.h:78
@ orxMOUSE_AXIS_X
Definition orxMouse.h:74
orxSTATUS
Definition orxType.h:270

Generated for orx by doxygen 1.8.11