Modulesdl2-2.5.5.0Haskell2010

SDL.Input.Mouse

8 types
14 values

Packagesdl2-2.5.5.0
Exports22
LanguageHaskell2010
LicenceBSD-3-Clause
SourceMouse.hs

Relative Mouse Mode

3 declarations

datadata LocationMode

AbsoluteLocation RelativeLocation

Instances9Bounded, Enum, Eq, Data, Ord, Read, …

Bounded LocationModeDefined in sdl2-2.5.5.0 · SDL.Input.Mouse
Enum LocationModeDefined in sdl2-2.5.5.0 · SDL.Input.Mouse
Eq LocationModeDefined in sdl2-2.5.5.0 · SDL.Input.Mouse
Data LocationModeDefined in sdl2-2.5.5.0 · SDL.Input.Mouse
Ord LocationModeDefined in sdl2-2.5.5.0 · SDL.Input.Mouse
Read LocationModeDefined in sdl2-2.5.5.0 · SDL.Input.Mouse
Show LocationModeDefined in sdl2-2.5.5.0 · SDL.Input.Mouse
Generic LocationModeDefined in sdl2-2.5.5.0 · SDL.Input.Mouse
type Rep LocationMode = D1 ('MetaData "LocationMode" "SDL.Input.Mouse" "sdl2-2.5.5.0-3sH3mgPhw4837qWuaPOiH" 'False) (C1 ('MetaCons "AbsoluteLocation" 'PrefixI 'False) U1 :+: C1 ('MetaCons "RelativeLocation" 'PrefixI 'False) U1)Defined in sdl2-2.5.5.0 · SDL.Input.Mouse

valuesetMouseLocationMode

:: (Functor m, MonadIO m)
=> LocationMode
-> m LocationMode

Sets the current relative mouse mode.

When relative mouse mode is enabled, cursor is hidden and mouse position will not change. However, you will be delivered relative mouse position change events.

valuegetMouseLocationMode :: MonadIO m => m LocationMode

Check which mouse location mode is currently active.

Mouse and Touch Input

3 declarations

datadata MouseButton

Constructors

ButtonLeft
ButtonMiddle
ButtonRight
ButtonX1
ButtonX2
ButtonExtra !Int
An unknown mouse button.

Instances9Eq, Data, Ord, Read, Show, Generic, …

Eq MouseButtonDefined in sdl2-2.5.5.0 · SDL.Input.Mouse
Data MouseButtonDefined in sdl2-2.5.5.0 · SDL.Input.Mouse
Ord MouseButtonDefined in sdl2-2.5.5.0 · SDL.Input.Mouse
Read MouseButtonDefined in sdl2-2.5.5.0 · SDL.Input.Mouse
Show MouseButtonDefined in sdl2-2.5.5.0 · SDL.Input.Mouse
Generic MouseButtonDefined in sdl2-2.5.5.0 · SDL.Input.Mouse
ToNumber MouseButton Word8Defined in sdl2-2.5.5.0 · SDL.Input.Mouse
FromNumber MouseButton Word8Defined in sdl2-2.5.5.0 · SDL.Input.Mouse
type Rep MouseButton = D1 ('MetaData "MouseButton" "SDL.Input.Mouse" "sdl2-2.5.5.0-3sH3mgPhw4837qWuaPOiH" 'False) ((C1 ('MetaCons "ButtonLeft" 'PrefixI 'False) U1 :+: (C1 ('MetaCons "ButtonMiddle" 'PrefixI 'False) U1 :+: C1 ('MetaCons "ButtonRight" 'PrefixI 'False) U1)) :+: (C1 ('MetaCons "ButtonX1" 'PrefixI 'False) U1 :+: (C1 ('MetaCons "ButtonX2" 'PrefixI 'False) U1 :+: C1 ('MetaCons "ButtonExtra" 'PrefixI 'False) (S1 ('MetaSel 'Nothing 'NoSourceUnpackedness 'SourceStrict 'DecidedUnpack) (Rec0 Int)))))Defined in sdl2-2.5.5.0 · SDL.Input.Mouse

datadata MouseDevice

Identifies what kind of mouse-like device this is.

Constructors

Mouse !Int
An actual mouse. The number identifies which mouse.
Touch
Some sort of touch device.

Instances8Eq, Data, Ord, Read, Show, Generic, …

Eq MouseDeviceDefined in sdl2-2.5.5.0 · SDL.Input.Mouse
Data MouseDeviceDefined in sdl2-2.5.5.0 · SDL.Input.Mouse
Ord MouseDeviceDefined in sdl2-2.5.5.0 · SDL.Input.Mouse
Read MouseDeviceDefined in sdl2-2.5.5.0 · SDL.Input.Mouse
Show MouseDeviceDefined in sdl2-2.5.5.0 · SDL.Input.Mouse
Generic MouseDeviceDefined in sdl2-2.5.5.0 · SDL.Input.Mouse
FromNumber MouseDevice Word32Defined in sdl2-2.5.5.0 · SDL.Input.Mouse
type Rep MouseDevice = D1 ('MetaData "MouseDevice" "SDL.Input.Mouse" "sdl2-2.5.5.0-3sH3mgPhw4837qWuaPOiH" 'False) (C1 ('MetaCons "Mouse" 'PrefixI 'False) (S1 ('MetaSel 'Nothing 'NoSourceUnpackedness 'SourceStrict 'DecidedUnpack) (Rec0 Int)) :+: C1 ('MetaCons "Touch" 'PrefixI 'False) U1)Defined in sdl2-2.5.5.0 · SDL.Input.Mouse

datadata MouseScrollDirection

Identifies mouse scroll direction.

ScrollNormal ScrollFlipped

Instances10Bounded, Enum, Eq, Data, Ord, Read, …

Bounded MouseScrollDirectionDefined in sdl2-2.5.5.0 · SDL.Input.Mouse
Enum MouseScrollDirectionDefined in sdl2-2.5.5.0 · SDL.Input.Mouse
Eq MouseScrollDirectionDefined in sdl2-2.5.5.0 · SDL.Input.Mouse
Data MouseScrollDirectionDefined in sdl2-2.5.5.0 · SDL.Input.Mouse
Ord MouseScrollDirectionDefined in sdl2-2.5.5.0 · SDL.Input.Mouse
Read MouseScrollDirectionDefined in sdl2-2.5.5.0 · SDL.Input.Mouse
Show MouseScrollDirectionDefined in sdl2-2.5.5.0 · SDL.Input.Mouse
Generic MouseScrollDirectionDefined in sdl2-2.5.5.0 · SDL.Input.Mouse
FromNumber MouseScrollDirection Word32Defined in sdl2-2.5.5.0 · SDL.Input.Mouse
type Rep MouseScrollDirection = D1 ('MetaData "MouseScrollDirection" "SDL.Input.Mouse" "sdl2-2.5.5.0-3sH3mgPhw4837qWuaPOiH" 'False) (C1 ('MetaCons "ScrollNormal" 'PrefixI 'False) U1 :+: C1 ('MetaCons "ScrollFlipped" 'PrefixI 'False) U1)Defined in sdl2-2.5.5.0 · SDL.Input.Mouse

Mouse State

5 declarations

datadata ModalLocation

Constructors

AbsoluteModalLocation (Point V2 CInt)
RelativeModalLocation (V2 CInt)

Instances6Eq, Ord, Read, Show, Generic, Rep

Eq ModalLocationDefined in sdl2-2.5.5.0 · SDL.Input.Mouse
Ord ModalLocationDefined in sdl2-2.5.5.0 · SDL.Input.Mouse
Read ModalLocationDefined in sdl2-2.5.5.0 · SDL.Input.Mouse
Show ModalLocationDefined in sdl2-2.5.5.0 · SDL.Input.Mouse
Generic ModalLocationDefined in sdl2-2.5.5.0 · SDL.Input.Mouse
type Rep ModalLocation = D1 ('MetaData "ModalLocation" "SDL.Input.Mouse" "sdl2-2.5.5.0-3sH3mgPhw4837qWuaPOiH" 'False) (C1 ('MetaCons "AbsoluteModalLocation" 'PrefixI 'False) (S1 ('MetaSel 'Nothing 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Point V2 CInt))) :+: C1 ('MetaCons "RelativeModalLocation" 'PrefixI 'False) (S1 ('MetaSel 'Nothing 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (V2 CInt))))Defined in sdl2-2.5.5.0 · SDL.Input.Mouse

valuegetModalMouseLocation :: MonadIO m => m ModalLocation

Return proper mouse location depending on mouse mode

valuegetAbsoluteMouseLocation :: MonadIO m => m (Point V2 CInt)

Retrieve the current location of the mouse, relative to the currently focused window.

valuegetRelativeMouseLocation :: MonadIO m => m (V2 CInt)

Retrieve mouse motion

valuegetMouseButtons :: MonadIO m => m (MouseButton -> Bool)

Retrieve a mapping of which buttons are currently held down.

Warping the Mouse

2 declarations

datadata WarpMouseOrigin

Constructors

WarpInWindow Window
Move the mouse pointer within a given Window.
WarpCurrentFocus
Move the mouse pointer within whichever Window currently has focus.
WarpGlobal
Move the mouse pointer in global screen space.

Instances6Eq, Data, Ord, Show, Generic, Rep

Eq WarpMouseOriginDefined in sdl2-2.5.5.0 · SDL.Input.Mouse
Data WarpMouseOriginDefined in sdl2-2.5.5.0 · SDL.Input.Mouse
Ord WarpMouseOriginDefined in sdl2-2.5.5.0 · SDL.Input.Mouse
Show WarpMouseOriginDefined in sdl2-2.5.5.0 · SDL.Input.Mouse
Generic WarpMouseOriginDefined in sdl2-2.5.5.0 · SDL.Input.Mouse
type Rep WarpMouseOrigin = D1 ('MetaData "WarpMouseOrigin" "SDL.Input.Mouse" "sdl2-2.5.5.0-3sH3mgPhw4837qWuaPOiH" 'False) (C1 ('MetaCons "WarpInWindow" 'PrefixI 'False) (S1 ('MetaSel 'Nothing 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Window)) :+: (C1 ('MetaCons "WarpCurrentFocus" 'PrefixI 'False) U1 :+: C1 ('MetaCons "WarpGlobal" 'PrefixI 'False) U1))Defined in sdl2-2.5.5.0 · SDL.Input.Mouse

valuewarpMouse :: MonadIO m => WarpMouseOrigin -> Point V2 CInt -> m ()

Move the current location of a mouse pointer. The WarpMouseOrigin specifies the origin for the given warp coordinates.

Cursor Visibility

1 declaration

valuecursorVisible :: StateVar Bool

Get or set whether the cursor is currently visible.

This StateVar can be modified using $= and the current value retrieved with get.

See SDL_ShowCursor and SDL_HideCursor for C documentation.

Cursor Shape

8 declarations

newtypenewtype Cursor

Instances1Eq

Eq CursorDefined in sdl2-2.5.5.0 · SDL.Input.Mouse

datadata SystemCursor

SystemCursorArrow SystemCursorIBeam SystemCursorWait SystemCursorCrossHair SystemCursorWaitArrow SystemCursorSizeNWSE SystemCursorSizeNESW SystemCursorSizeWE SystemCursorSizeNS SystemCursorSizeAll SystemCursorNo SystemCursorHand

Instances1ToNumber

ToNumber SystemCursor Word32Defined in sdl2-2.5.5.0 · SDL.Input.Mouse

valueactiveCursor :: StateVar Cursor

Get or set the currently active cursor. You can create new Cursors with createCursor.

This StateVar can be modified using $= and the current value retrieved with get.

See SDL_SetCursor and SDL_GetCursor for C documentation.

valuecreateCursor

:: MonadIO m
=> Vector Word8
Whether this part of the cursor is black. Use False for white and True for black.
-> Vector Word8
Whether or not pixels are visible. Use True for visible and False for transparent.
-> V2 CInt
The width and height of the cursor.
-> Point V2 CInt
The X- and Y-axis location of the upper left corner of the cursor relative to the actual mouse position
-> m Cursor

Create a cursor using the specified bitmap data and mask (in MSB format).

valuecreateCursorFrom

:: MonadIO m
=> Point V2 CInt
The X- and Y-axis location of the upper left corner of the cursor relative to the actual mouse position
-> [[Char]]
-> m Cursor

Create a cursor from a bit art painting of it.

The number of columns must be a multiple of 8.

Symbols used: (space) - transparent, . - visible black, # (or anything else) - visible white.

A minimal cursor template: source8x8 :: [[Char]] source8x8 = [ " " , " " , " " , " " , " " , " " , " " , " " ]

valuefreeCursor :: MonadIO m => Cursor -> m ()

Free a cursor created with createCursor, createColorCusor and createSystemCursor.

See SDL_FreeCursor for C documentation.

valuecreateColorCursor

:: MonadIO m
=> Surface
-> Point V2 CInt
The location of the cursor hot spot
-> m Cursor

Create a color cursor.

See SDL_CreateColorCursor for C documentation.

valuecreateSystemCursor :: MonadIO m => SystemCursor -> m Cursor

Create system cursor.

See SDL_CreateSystemCursor for C documentation.