orx  1.10
Portable Game Engine
orxMouse.h
Go to the documentation of this file.
1 /* Orx - Portable Game Engine
2  *
3  * Copyright (c) 2008-2019 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 
43 #ifndef _orxMOUSE_H_
44 #define _orxMOUSE_H_
45 
46 #include "orxInclude.h"
47 #include "plugin/orxPluginCore.h"
48 #include "math/orxVector.h"
49 #include "utils/orxString.h"
50 
51 
54 typedef enum __orxMOUSE_BUTTON_t
55 {
67 
68  orxMOUSE_BUTTON_NONE = orxENUM_NONE
69 
71 
72 typedef 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 
85 
86 /***************************************************************************
87  * Functions directly implemented by orx core
88  ***************************************************************************/
89 
92 extern orxDLLAPI void orxFASTCALL orxMouse_Setup();
93 
94 
95 /***************************************************************************
96  * Functions extended by plugins
97  ***************************************************************************/
98 
102 extern orxDLLAPI orxSTATUS orxFASTCALL orxMouse_Init();
103 
106 extern orxDLLAPI void orxFASTCALL orxMouse_Exit();
107 
112 extern orxDLLAPI orxSTATUS orxFASTCALL orxMouse_SetPosition(const orxVECTOR *_pvPosition);
113 
118 extern orxDLLAPI orxVECTOR *orxFASTCALL orxMouse_GetPosition(orxVECTOR *_pvPosition);
119 
124 extern orxDLLAPI orxBOOL orxFASTCALL orxMouse_IsButtonPressed(orxMOUSE_BUTTON _eButton);
125 
130 extern orxDLLAPI orxVECTOR *orxFASTCALL orxMouse_GetMoveDelta(orxVECTOR *_pvMoveDelta);
131 
135 extern orxDLLAPI orxFLOAT orxFASTCALL orxMouse_GetWheelDelta();
136 
140 extern orxDLLAPI orxSTATUS orxFASTCALL orxMouse_ShowCursor(orxBOOL _bShow);
141 
147 extern orxDLLAPI orxSTATUS orxFASTCALL orxMouse_SetCursor(const orxSTRING _zName, const orxVECTOR *_pvPivot);
148 
153 extern orxDLLAPI const orxSTRING orxFASTCALL orxMouse_GetButtonName(orxMOUSE_BUTTON _eButton);
154 
159 extern orxDLLAPI const orxSTRING orxFASTCALL orxMouse_GetAxisName(orxMOUSE_AXIS _eAxis);
160 
161 #endif /* _orxMOUSE_H_ */
162 
orxDLLAPI orxVECTOR *orxFASTCALL orxMouse_GetMoveDelta(orxVECTOR *_pvMoveDelta)
orxMOUSE_AXIS
Definition: orxMouse.h:72
orxDLLAPI orxSTATUS orxFASTCALL orxMouse_ShowCursor(orxBOOL _bShow)
orxDLLAPI orxSTATUS orxFASTCALL orxMouse_SetPosition(const orxVECTOR *_pvPosition)
orxDLLAPI orxFLOAT orxFASTCALL orxMouse_GetWheelDelta()
orxDLLAPI orxBOOL orxFASTCALL orxMouse_IsButtonPressed(orxMOUSE_BUTTON _eButton)
orxDLLAPI const orxSTRING orxFASTCALL orxMouse_GetButtonName(orxMOUSE_BUTTON _eButton)
orxSTATUS
Definition: orxType.h:246
orxDLLAPI orxSTATUS orxFASTCALL orxMouse_SetCursor(const orxSTRING _zName, const orxVECTOR *_pvPivot)
orxDLLAPI orxSTATUS orxFASTCALL orxMouse_Init()
orxDLLAPI orxVECTOR *orxFASTCALL orxMouse_GetPosition(orxVECTOR *_pvPosition)
#define orxDLLAPI
Definition: orxDecl.h:381
orxDLLAPI void orxFASTCALL orxMouse_Setup()
orxMOUSE_BUTTON
Definition: orxMouse.h:54
orxDLLAPI void orxFASTCALL orxMouse_Exit()
orxDLLAPI const orxSTRING orxFASTCALL orxMouse_GetAxisName(orxMOUSE_AXIS _eAxis)

Generated for orx by doxygen 1.8.11