Go to the source code of this file.
Enumerations | |
| enum | sfMouseButton { sfMouseLeft , sfMouseRight , sfMouseMiddle , sfMouseXButton1 , sfMouseXButton2 , sfMouseButtonCount } |
| Mouse buttons. More... | |
| enum | sfMouseWheel { sfMouseVerticalWheel , sfMouseHorizontalWheel } |
| Mouse wheels. More... | |
Functions | |
| sfBool | sfMouse_isButtonPressed (sfMouseButton button) |
| Check if a mouse button is pressed. | |
| sfVector2i | sfMouse_getPosition (const sfWindow *relativeTo) |
| Get the current position of the mouse. | |
| void | sfMouse_setPosition (sfVector2i position, const sfWindow *relativeTo) |
| Set the current position of the mouse. | |
| sfVector2i | sfMouse_getPositionWindowBase (const sfWindowBase *relativeTo) |
| Get the current position of the mouse relative to a window base. | |
| void | sfMouse_setPositionWindowBase (sfVector2i position, const sfWindowBase *relativeTo) |
| Set the current position of the mouse relative to a window base. | |
Enumeration Type Documentation
◆ sfMouseButton
| enum sfMouseButton |
Mouse buttons.
◆ sfMouseWheel
| enum sfMouseWheel |
Function Documentation
◆ sfMouse_getPosition()
| sfVector2i sfMouse_getPosition | ( | const sfWindow * | relativeTo | ) |
Get the current position of the mouse.
This function returns the current position of the mouse cursor relative to the given window, or desktop if NULL is passed.
- Parameters
-
relativeTo Reference window
- Returns
- Position of the mouse cursor, relative to the given window
◆ sfMouse_getPositionWindowBase()
| sfVector2i sfMouse_getPositionWindowBase | ( | const sfWindowBase * | relativeTo | ) |
Get the current position of the mouse relative to a window base.
This function returns the current position of the mouse cursor relative to the given window base, or desktop if NULL is passed.
- Parameters
-
relativeTo Reference window
- Returns
- Position of the mouse cursor, relative to the given window base
◆ sfMouse_isButtonPressed()
| sfBool sfMouse_isButtonPressed | ( | sfMouseButton | button | ) |
Check if a mouse button is pressed.
- Parameters
-
button Button to check
- Returns
- sfTrue if the button is pressed, sfFalse otherwise
◆ sfMouse_setPosition()
| void sfMouse_setPosition | ( | sfVector2i | position, |
| const sfWindow * | relativeTo ) |
Set the current position of the mouse.
This function sets the current position of the mouse cursor relative to the given window, or desktop if NULL is passed.
- Parameters
-
position New position of the mouse relativeTo Reference window
◆ sfMouse_setPositionWindowBase()
| void sfMouse_setPositionWindowBase | ( | sfVector2i | position, |
| const sfWindowBase * | relativeTo ) |
Set the current position of the mouse relative to a window base.
This function sets the current position of the mouse cursor relative to the given window base, or desktop if NULL is passed.
- Parameters
-
position New position of the mouse relativeTo Reference window