Safe Haskell	None
Language	GHC2021

SDL3.Sys.Bindgen.Mouse

Description

Any GUI application has to deal with the mouse, and SDL provides functions to manage mouse input and the displayed cursor.

Most interactions with the mouse will come through the event subsystem. Moving a mouse generates an SDL_EVENT_MOUSE_MOTION event, pushing a button generates SDL_EVENT_MOUSE_BUTTON_DOWN, etc, but one can also query the current state of the mouse at any time with SDL_GetMouseState().

For certain games, it's useful to disassociate the mouse cursor from mouse input. An FPS, for example, would not want the player's motion to stop as the mouse hits the edge of the window. For these scenarios, use SDL_SetWindowRelativeMouseMode(), which hides the cursor, grabs mouse input to the window, and reads mouse input no matter how far it moves.

Games that want the system to track the mouse but want to draw their own cursor can use SDL_HideCursor() and SDL_ShowCursor(). It might be more efficient to let the system manage the cursor, if possible, using SDL_SetCursor() with a custom image made through SDL_CreateColorCursor(), or perhaps just a specific system cursor from SDL_CreateSystemCursor().

SDL can, on many platforms, differentiate between multiple connected mice, allowing for interesting input scenarios and multiplayer games. They can be enumerated with SDL_GetMice(), and SDL will send SDL_EVENT_MOUSE_ADDED and SDL_EVENT_MOUSE_REMOVED events as they are connected and unplugged.

Since many apps only care about basic mouse input, SDL offers a virtual mouse device for touch and pen input, which often can make a desktop application work on a touchscreen phone without any code changes. Apps that care about touch/pen separately from mouse input should filter out events with a which field of SDL_TOUCH_MOUSEID/SDL_PEN_MOUSEID. This is a unique ID for a mouse for the time it is connected to the system, and is never reused for the lifetime of the application.

If the mouse is disconnected and reconnected, it will get a new ID.

The value 0 is an invalid ID.

Since: 3.2.0

Synopsis

newtype SDL_MouseID = SDL_MouseID {
- unwrap :: Uint32
}
data SDL_Cursor
newtype SDL_SystemCursor = SDL_SystemCursor {
- unwrap :: CUInt
}
pattern SDL_SYSTEM_CURSOR_DEFAULT :: SDL_SystemCursor
pattern SDL_SYSTEM_CURSOR_TEXT :: SDL_SystemCursor
pattern SDL_SYSTEM_CURSOR_WAIT :: SDL_SystemCursor
pattern SDL_SYSTEM_CURSOR_CROSSHAIR :: SDL_SystemCursor
pattern SDL_SYSTEM_CURSOR_PROGRESS :: SDL_SystemCursor
pattern SDL_SYSTEM_CURSOR_NWSE_RESIZE :: SDL_SystemCursor
pattern SDL_SYSTEM_CURSOR_NESW_RESIZE :: SDL_SystemCursor
pattern SDL_SYSTEM_CURSOR_EW_RESIZE :: SDL_SystemCursor
pattern SDL_SYSTEM_CURSOR_NS_RESIZE :: SDL_SystemCursor
pattern SDL_SYSTEM_CURSOR_MOVE :: SDL_SystemCursor
pattern SDL_SYSTEM_CURSOR_NOT_ALLOWED :: SDL_SystemCursor
pattern SDL_SYSTEM_CURSOR_POINTER :: SDL_SystemCursor
pattern SDL_SYSTEM_CURSOR_NW_RESIZE :: SDL_SystemCursor
pattern SDL_SYSTEM_CURSOR_N_RESIZE :: SDL_SystemCursor
pattern SDL_SYSTEM_CURSOR_NE_RESIZE :: SDL_SystemCursor
pattern SDL_SYSTEM_CURSOR_E_RESIZE :: SDL_SystemCursor
pattern SDL_SYSTEM_CURSOR_SE_RESIZE :: SDL_SystemCursor
pattern SDL_SYSTEM_CURSOR_S_RESIZE :: SDL_SystemCursor
pattern SDL_SYSTEM_CURSOR_SW_RESIZE :: SDL_SystemCursor
pattern SDL_SYSTEM_CURSOR_W_RESIZE :: SDL_SystemCursor
pattern SDL_SYSTEM_CURSOR_COUNT :: SDL_SystemCursor
newtype SDL_MouseWheelDirection = SDL_MouseWheelDirection {
- unwrap :: CUInt
}
pattern SDL_MOUSEWHEEL_NORMAL :: SDL_MouseWheelDirection
pattern SDL_MOUSEWHEEL_FLIPPED :: SDL_MouseWheelDirection
data SDL_CursorFrameInfo = SDL_CursorFrameInfo {
- surface :: Ptr SDL_Surface
- duration :: Uint32
}
newtype SDL_MouseButtonFlags = SDL_MouseButtonFlags {
- unwrap :: Uint32
}
sDL_BUTTON_LEFT :: CInt
sDL_BUTTON_MIDDLE :: CInt
sDL_BUTTON_RIGHT :: CInt
sDL_BUTTON_X1 :: CInt
sDL_BUTTON_X2 :: CInt
sDL_BUTTON_MASK :: (Sub a0 CInt, Shift CUInt (SubRes a0 CInt)) => a0 -> CUInt
sDL_BUTTON_LMASK :: CUInt
sDL_BUTTON_MMASK :: CUInt
sDL_BUTTON_RMASK :: CUInt
sDL_BUTTON_X1MASK :: CUInt
sDL_BUTTON_X2MASK :: CUInt
newtype SDL_MouseMotionTransformCallback_Aux = SDL_MouseMotionTransformCallback_Aux {
- unwrap :: Ptr Void -> Uint64 -> Ptr SDL_Window -> SDL_MouseID -> Ptr CFloat -> Ptr CFloat -> IO ()
}
newtype SDL_MouseMotionTransformCallback = SDL_MouseMotionTransformCallback {
- unwrap :: FunPtr SDL_MouseMotionTransformCallback_Aux
}

Documentation

newtype SDL_MouseID Source #

C declaration: SDL_MouseID, defined at SDL3/SDL_mouse.h 81:16

Constructors

SDL_MouseID
Fields unwrap :: Uint32

Instances

Instances details

Bits SDL_MouseID Source #

Instance details

SDL_CursorFrameInfo
Fields surface :: Ptr SDL_Surface The surface data for this frame C declaration `surface`, defined at `SDL3/SDL_mouse.h 140:18` duration :: Uint32 The frame duration in milliseconds (a duration of 0 is infinite) C declaration `duration`, defined at `SDL3/SDL_mouse.h 141:12`

SDL_MouseMotionTransformCallback_Aux
Fields unwrap :: Ptr Void -> Uint64 -> Ptr SDL_Window -> SDL_MouseID -> Ptr CFloat -> Ptr CFloat -> IO ()

SDL_MouseMotionTransformCallback
Fields unwrap :: FunPtr SDL_MouseMotionTransformCallback_Aux