Safe Haskell	None
Language	Haskell2010

SDL.Input.Mouse

Contents

Relative Mouse Mode
Mouse and Touch Input
Mouse State
Warping the Mouse
Cursor Visibility
Cursor Shape

Synopsis

data LocationMode
- = AbsoluteLocation
- | RelativeLocation
setMouseLocationMode :: (Functor m, MonadIO m) => LocationMode -> m LocationMode
getMouseLocationMode :: MonadIO m => m LocationMode
data MouseButton
- = ButtonLeft
- | ButtonMiddle
- | ButtonRight
- | ButtonX1
- | ButtonX2
- | ButtonExtra !Int
data MouseDevice
- = Mouse !Int
- | Touch
data MouseScrollDirection
- = ScrollNormal
- | ScrollFlipped
data ModalLocation
- = AbsoluteModalLocation (Point V2 CInt)
- | RelativeModalLocation (V2 CInt)
getModalMouseLocation :: MonadIO m => m ModalLocation
getAbsoluteMouseLocation :: MonadIO m => m (Point V2 CInt)
getRelativeMouseLocation :: MonadIO m => m (V2 CInt)
getMouseButtons :: MonadIO m => m (MouseButton -> Bool)
data WarpMouseOrigin
- = WarpInWindow Window
- | WarpCurrentFocus
- | WarpGlobal
warpMouse :: MonadIO m => WarpMouseOrigin -> Point V2 CInt -> m ()
cursorVisible :: StateVar Bool
data Cursor
data SystemCursor
- = SystemCursorArrow
- | SystemCursorIBeam
- | SystemCursorWait
- | SystemCursorCrossHair
- | SystemCursorWaitArrow
- | SystemCursorSizeNWSE
- | SystemCursorSizeNESW
- | SystemCursorSizeWE
- | SystemCursorSizeNS
- | SystemCursorSizeAll
- | SystemCursorNo
- | SystemCursorHand
activeCursor :: StateVar Cursor
createCursor :: MonadIO m => Vector Word8 -> Vector Word8 -> V2 CInt -> Point V2 CInt -> m Cursor
createCursorFrom :: MonadIO m => Point V2 CInt -> [[Char]] -> m Cursor
freeCursor :: MonadIO m => Cursor -> m ()
createColorCursor :: MonadIO m => Surface -> Point V2 CInt -> m Cursor
createSystemCursor :: MonadIO m => SystemCursor -> m Cursor

Relative Mouse Mode

data LocationMode Source #

Constructors

AbsoluteLocation
RelativeLocation

Instances

Instances details

Data LocationMode Source #

Instance details

Defined in SDL.Input.Mouse

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> LocationMode -> c LocationMode

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c LocationMode

toConstr :: LocationMode -> Constr

dataTypeOf :: LocationMode -> DataType

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c LocationMode)

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c LocationMode)

gmapT :: (forall b. Data b => b -> b) -> LocationMode -> LocationMode

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> LocationMode -> r

gmapQr :: forall r r'. (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> LocationMode -> r

gmapQ :: (forall d. Data d => d -> u) -> LocationMode -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> LocationMode -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> LocationMode -> m LocationMode

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> LocationMode -> m LocationMode

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> LocationMode -> m LocationMode

Bounded LocationMode Source #

Instance details

Defined in SDL.Input.Mouse

Methods

minBound :: LocationMode

maxBound :: LocationMode

Enum LocationMode Source #

Instance details

Defined in SDL.Input.Mouse

Methods

succ :: LocationMode -> LocationMode

pred :: LocationMode -> LocationMode

toEnum :: Int -> LocationMode

fromEnum :: LocationMode -> Int

enumFrom :: LocationMode -> [LocationMode]

enumFromThen :: LocationMode -> LocationMode -> [LocationMode]

enumFromTo :: LocationMode -> LocationMode -> [LocationMode]

enumFromThenTo :: LocationMode -> LocationMode -> LocationMode -> [LocationMode]

Generic LocationMode Source #

Instance details

Defined in SDL.Input.Mouse

Associated Types

type Rep LocationMode
Instance details Defined in SDL.Input.Mouse type Rep LocationMode = D1 ('MetaData "LocationMode" "SDL.Input.Mouse" "sdl2-2.5.5.1-AgF6e4ywebPJjPO67cQCnV" 'False) (C1 ('MetaCons "AbsoluteLocation" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "RelativeLocation" 'PrefixI 'False) (U1 :: Type -> Type))

Methods

from :: LocationMode -> Rep LocationMode x

to :: Rep LocationMode x -> LocationMode

Read LocationMode Source #

Instance details

Defined in SDL.Input.Mouse

Methods

readsPrec :: Int -> ReadS LocationMode

readList :: ReadS [LocationMode]

readPrec :: ReadPrec LocationMode

readListPrec :: ReadPrec [LocationMode]

Show LocationMode Source #

Instance details

Defined in SDL.Input.Mouse

Methods

showsPrec :: Int -> LocationMode -> ShowS

show :: LocationMode -> String

showList :: [LocationMode] -> ShowS

Eq LocationMode Source #

Instance details

Defined in SDL.Input.Mouse

Methods

(==) :: LocationMode -> LocationMode -> Bool

(/=) :: LocationMode -> LocationMode -> Bool

Ord LocationMode Source #

Instance details

Defined in SDL.Input.Mouse

Methods

compare :: LocationMode -> LocationMode -> Ordering

(<) :: LocationMode -> LocationMode -> Bool

(<=) :: LocationMode -> LocationMode -> Bool

(>) :: LocationMode -> LocationMode -> Bool

(>=) :: LocationMode -> LocationMode -> Bool

max :: LocationMode -> LocationMode -> LocationMode

min :: LocationMode -> LocationMode -> LocationMode

type Rep LocationMode Source #

Instance details

Defined in SDL.Input.Mouse

type Rep LocationMode = D1 ('MetaData "LocationMode" "SDL.Input.Mouse" "sdl2-2.5.5.1-AgF6e4ywebPJjPO67cQCnV" 'False) (C1 ('MetaCons "AbsoluteLocation" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "RelativeLocation" 'PrefixI 'False) (U1 :: Type -> Type))

setMouseLocationMode :: (Functor m, MonadIO m) => LocationMode -> m LocationMode Source #

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.

getMouseLocationMode :: MonadIO m => m LocationMode Source #

Check which mouse location mode is currently active.

Mouse and Touch Input

data MouseButton Source #

Constructors

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

Instances

Instances details

Data MouseButton Source #

Instance details

Defined in SDL.Input.Mouse

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> MouseButton -> c MouseButton

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c MouseButton

toConstr :: MouseButton -> Constr

dataTypeOf :: MouseButton -> DataType

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c MouseButton)

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c MouseButton)

gmapT :: (forall b. Data b => b -> b) -> MouseButton -> MouseButton

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> MouseButton -> r

gmapQr :: forall r r'. (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> MouseButton -> r

gmapQ :: (forall d. Data d => d -> u) -> MouseButton -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> MouseButton -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> MouseButton -> m MouseButton

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> MouseButton -> m MouseButton

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> MouseButton -> m MouseButton

Generic MouseButton Source #

Instance details

Defined in SDL.Input.Mouse

Associated Types

type Rep MouseButton

Instance details

Defined in SDL.Input.Mouse

type Rep MouseButton = D1 ('MetaData "MouseButton" "SDL.Input.Mouse" "sdl2-2.5.5.1-AgF6e4ywebPJjPO67cQCnV" 'False) ((C1 ('MetaCons "ButtonLeft" 'PrefixI 'False) (U1 :: Type -> Type) :+: (C1 ('MetaCons "ButtonMiddle" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "ButtonRight" 'PrefixI 'False) (U1 :: Type -> Type))) :+: (C1 ('MetaCons "ButtonX1" 'PrefixI 'False) (U1 :: Type -> Type) :+: (C1 ('MetaCons "ButtonX2" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "ButtonExtra" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Int)))))

Methods

from :: MouseButton -> Rep MouseButton x

to :: Rep MouseButton x -> MouseButton

Read MouseButton Source #

Instance details

Defined in SDL.Input.Mouse

Methods

readsPrec :: Int -> ReadS MouseButton

readList :: ReadS [MouseButton]

readPrec :: ReadPrec MouseButton

readListPrec :: ReadPrec [MouseButton]

Show MouseButton Source #

Instance details

Defined in SDL.Input.Mouse

Methods

showsPrec :: Int -> MouseButton -> ShowS

show :: MouseButton -> String

showList :: [MouseButton] -> ShowS

Eq MouseButton Source #

Instance details

Defined in SDL.Input.Mouse

Methods

(==) :: MouseButton -> MouseButton -> Bool

(/=) :: MouseButton -> MouseButton -> Bool

Ord MouseButton Source #

Instance details

Defined in SDL.Input.Mouse

Methods

compare :: MouseButton -> MouseButton -> Ordering

(<) :: MouseButton -> MouseButton -> Bool

(<=) :: MouseButton -> MouseButton -> Bool

(>) :: MouseButton -> MouseButton -> Bool

(>=) :: MouseButton -> MouseButton -> Bool

max :: MouseButton -> MouseButton -> MouseButton

min :: MouseButton -> MouseButton -> MouseButton

FromNumber MouseButton Word8 Source #

Instance details

Defined in SDL.Input.Mouse

Methods

fromNumber :: Word8 -> MouseButton Source #

ToNumber MouseButton Word8 Source #

Instance details

Defined in SDL.Input.Mouse

Methods

toNumber :: MouseButton -> Word8 Source #

type Rep MouseButton Source #

Instance details

Defined in SDL.Input.Mouse

type Rep MouseButton = D1 ('MetaData "MouseButton" "SDL.Input.Mouse" "sdl2-2.5.5.1-AgF6e4ywebPJjPO67cQCnV" 'False) ((C1 ('MetaCons "ButtonLeft" 'PrefixI 'False) (U1 :: Type -> Type) :+: (C1 ('MetaCons "ButtonMiddle" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "ButtonRight" 'PrefixI 'False) (U1 :: Type -> Type))) :+: (C1 ('MetaCons "ButtonX1" 'PrefixI 'False) (U1 :: Type -> Type) :+: (C1 ('MetaCons "ButtonX2" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "ButtonExtra" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Int)))))

data MouseDevice Source #

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.

Instances

Instances details

Data MouseDevice Source #

Instance details

Defined in SDL.Input.Mouse

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> MouseDevice -> c MouseDevice

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c MouseDevice

toConstr :: MouseDevice -> Constr

dataTypeOf :: MouseDevice -> DataType

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c MouseDevice)

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c MouseDevice)

gmapT :: (forall b. Data b => b -> b) -> MouseDevice -> MouseDevice

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> MouseDevice -> r

gmapQr :: forall r r'. (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> MouseDevice -> r

gmapQ :: (forall d. Data d => d -> u) -> MouseDevice -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> MouseDevice -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> MouseDevice -> m MouseDevice

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> MouseDevice -> m MouseDevice

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> MouseDevice -> m MouseDevice

Generic MouseDevice Source #

Instance details

Defined in SDL.Input.Mouse

Associated Types

type Rep MouseDevice
Instance details Defined in SDL.Input.Mouse type Rep MouseDevice = D1 ('MetaData "MouseDevice" "SDL.Input.Mouse" "sdl2-2.5.5.1-AgF6e4ywebPJjPO67cQCnV" 'False) (C1 ('MetaCons "Mouse" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Int)) :+: C1 ('MetaCons "Touch" 'PrefixI 'False) (U1 :: Type -> Type))

Methods

from :: MouseDevice -> Rep MouseDevice x

to :: Rep MouseDevice x -> MouseDevice

Read MouseDevice Source #

Instance details

Defined in SDL.Input.Mouse

Methods

readsPrec :: Int -> ReadS MouseDevice

readList :: ReadS [MouseDevice]

readPrec :: ReadPrec MouseDevice

readListPrec :: ReadPrec [MouseDevice]

Show MouseDevice Source #

Instance details

Defined in SDL.Input.Mouse

Methods

showsPrec :: Int -> MouseDevice -> ShowS

show :: MouseDevice -> String

showList :: [MouseDevice] -> ShowS

Eq MouseDevice Source #

Instance details

Defined in SDL.Input.Mouse

Methods

(==) :: MouseDevice -> MouseDevice -> Bool

(/=) :: MouseDevice -> MouseDevice -> Bool

Ord MouseDevice Source #

Instance details

Defined in SDL.Input.Mouse

Methods

compare :: MouseDevice -> MouseDevice -> Ordering

(<) :: MouseDevice -> MouseDevice -> Bool

(<=) :: MouseDevice -> MouseDevice -> Bool

(>) :: MouseDevice -> MouseDevice -> Bool

(>=) :: MouseDevice -> MouseDevice -> Bool

max :: MouseDevice -> MouseDevice -> MouseDevice

min :: MouseDevice -> MouseDevice -> MouseDevice

FromNumber MouseDevice Word32 Source #

Instance details

Defined in SDL.Input.Mouse

Methods

fromNumber :: Word32 -> MouseDevice Source #

type Rep MouseDevice Source #

Instance details

Defined in SDL.Input.Mouse

type Rep MouseDevice = D1 ('MetaData "MouseDevice" "SDL.Input.Mouse" "sdl2-2.5.5.1-AgF6e4ywebPJjPO67cQCnV" 'False) (C1 ('MetaCons "Mouse" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Int)) :+: C1 ('MetaCons "Touch" 'PrefixI 'False) (U1 :: Type -> Type))

data MouseScrollDirection Source #

Identifies mouse scroll direction.

Constructors

ScrollNormal
ScrollFlipped

Instances

Instances details

Data MouseScrollDirection Source #

Instance details

Defined in SDL.Input.Mouse

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> MouseScrollDirection -> c MouseScrollDirection

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c MouseScrollDirection

toConstr :: MouseScrollDirection -> Constr

dataTypeOf :: MouseScrollDirection -> DataType

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c MouseScrollDirection)

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c MouseScrollDirection)

gmapT :: (forall b. Data b => b -> b) -> MouseScrollDirection -> MouseScrollDirection

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> MouseScrollDirection -> r

gmapQr :: forall r r'. (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> MouseScrollDirection -> r

gmapQ :: (forall d. Data d => d -> u) -> MouseScrollDirection -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> MouseScrollDirection -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> MouseScrollDirection -> m MouseScrollDirection

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> MouseScrollDirection -> m MouseScrollDirection

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> MouseScrollDirection -> m MouseScrollDirection

Bounded MouseScrollDirection Source #

Instance details

Defined in SDL.Input.Mouse

Methods

minBound :: MouseScrollDirection

maxBound :: MouseScrollDirection

Enum MouseScrollDirection Source #

Instance details

Defined in SDL.Input.Mouse

Methods

succ :: MouseScrollDirection -> MouseScrollDirection

pred :: MouseScrollDirection -> MouseScrollDirection

toEnum :: Int -> MouseScrollDirection

fromEnum :: MouseScrollDirection -> Int

enumFrom :: MouseScrollDirection -> [MouseScrollDirection]

enumFromThen :: MouseScrollDirection -> MouseScrollDirection -> [MouseScrollDirection]

enumFromTo :: MouseScrollDirection -> MouseScrollDirection -> [MouseScrollDirection]

enumFromThenTo :: MouseScrollDirection -> MouseScrollDirection -> MouseScrollDirection -> [MouseScrollDirection]

Generic MouseScrollDirection Source #

Instance details

Defined in SDL.Input.Mouse

Associated Types

type Rep MouseScrollDirection
Instance details Defined in SDL.Input.Mouse type Rep MouseScrollDirection = D1 ('MetaData "MouseScrollDirection" "SDL.Input.Mouse" "sdl2-2.5.5.1-AgF6e4ywebPJjPO67cQCnV" 'False) (C1 ('MetaCons "ScrollNormal" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "ScrollFlipped" 'PrefixI 'False) (U1 :: Type -> Type))

Methods

from :: MouseScrollDirection -> Rep MouseScrollDirection x

to :: Rep MouseScrollDirection x -> MouseScrollDirection

Read MouseScrollDirection Source #

Instance details

Defined in SDL.Input.Mouse

Methods

readsPrec :: Int -> ReadS MouseScrollDirection

readList :: ReadS [MouseScrollDirection]

readPrec :: ReadPrec MouseScrollDirection

readListPrec :: ReadPrec [MouseScrollDirection]

Show MouseScrollDirection Source #

Instance details

Defined in SDL.Input.Mouse

Methods

showsPrec :: Int -> MouseScrollDirection -> ShowS

show :: MouseScrollDirection -> String

showList :: [MouseScrollDirection] -> ShowS

Eq MouseScrollDirection Source #

Instance details

Defined in SDL.Input.Mouse

Methods

(==) :: MouseScrollDirection -> MouseScrollDirection -> Bool

(/=) :: MouseScrollDirection -> MouseScrollDirection -> Bool

Ord MouseScrollDirection Source #

Instance details

Defined in SDL.Input.Mouse

Methods

compare :: MouseScrollDirection -> MouseScrollDirection -> Ordering

(<) :: MouseScrollDirection -> MouseScrollDirection -> Bool

(<=) :: MouseScrollDirection -> MouseScrollDirection -> Bool

(>) :: MouseScrollDirection -> MouseScrollDirection -> Bool

(>=) :: MouseScrollDirection -> MouseScrollDirection -> Bool

max :: MouseScrollDirection -> MouseScrollDirection -> MouseScrollDirection

min :: MouseScrollDirection -> MouseScrollDirection -> MouseScrollDirection

FromNumber MouseScrollDirection Word32 Source #

Instance details

Defined in SDL.Input.Mouse

Methods

fromNumber :: Word32 -> MouseScrollDirection Source #

type Rep MouseScrollDirection Source #

Instance details

Defined in SDL.Input.Mouse

type Rep MouseScrollDirection = D1 ('MetaData "MouseScrollDirection" "SDL.Input.Mouse" "sdl2-2.5.5.1-AgF6e4ywebPJjPO67cQCnV" 'False) (C1 ('MetaCons "ScrollNormal" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "ScrollFlipped" 'PrefixI 'False) (U1 :: Type -> Type))

Mouse State

data ModalLocation Source #

Constructors

AbsoluteModalLocation (Point V2 CInt)
RelativeModalLocation (V2 CInt)

Instances

Instances details

Generic ModalLocation Source #

Instance details

Defined in SDL.Input.Mouse

Associated Types

type Rep ModalLocation

Instance details

Defined in SDL.Input.Mouse

type Rep ModalLocation = D1 ('MetaData "ModalLocation" "SDL.Input.Mouse" "sdl2-2.5.5.1-AgF6e4ywebPJjPO67cQCnV" 'False) (C1 ('MetaCons "AbsoluteModalLocation" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Point V2 CInt))) :+: C1 ('MetaCons "RelativeModalLocation" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (V2 CInt))))

Methods

from :: ModalLocation -> Rep ModalLocation x

to :: Rep ModalLocation x -> ModalLocation

Read ModalLocation Source #

Instance details

Defined in SDL.Input.Mouse

Methods

readsPrec :: Int -> ReadS ModalLocation

readList :: ReadS [ModalLocation]

readPrec :: ReadPrec ModalLocation

readListPrec :: ReadPrec [ModalLocation]

Show ModalLocation Source #

Instance details

Defined in SDL.Input.Mouse

Methods

showsPrec :: Int -> ModalLocation -> ShowS

show :: ModalLocation -> String

showList :: [ModalLocation] -> ShowS

Eq ModalLocation Source #

Instance details

Defined in SDL.Input.Mouse

Methods

(==) :: ModalLocation -> ModalLocation -> Bool

(/=) :: ModalLocation -> ModalLocation -> Bool

Ord ModalLocation Source #

Instance details

Defined in SDL.Input.Mouse

Methods

compare :: ModalLocation -> ModalLocation -> Ordering

(<) :: ModalLocation -> ModalLocation -> Bool

(<=) :: ModalLocation -> ModalLocation -> Bool

(>) :: ModalLocation -> ModalLocation -> Bool

(>=) :: ModalLocation -> ModalLocation -> Bool

max :: ModalLocation -> ModalLocation -> ModalLocation

min :: ModalLocation -> ModalLocation -> ModalLocation

type Rep ModalLocation Source #

Instance details

Defined in SDL.Input.Mouse

type Rep ModalLocation = D1 ('MetaData "ModalLocation" "SDL.Input.Mouse" "sdl2-2.5.5.1-AgF6e4ywebPJjPO67cQCnV" 'False) (C1 ('MetaCons "AbsoluteModalLocation" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Point V2 CInt))) :+: C1 ('MetaCons "RelativeModalLocation" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (V2 CInt))))

getModalMouseLocation :: MonadIO m => m ModalLocation Source #

Return proper mouse location depending on mouse mode

getAbsoluteMouseLocation :: MonadIO m => m (Point V2 CInt) Source #

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

getRelativeMouseLocation :: MonadIO m => m (V2 CInt) Source #

Retrieve mouse motion

getMouseButtons :: MonadIO m => m (MouseButton -> Bool) Source #

Retrieve a mapping of which buttons are currently held down.

Warping the Mouse

data WarpMouseOrigin Source #

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.

Instances

Instances details

Data WarpMouseOrigin Source #

Instance details

Defined in SDL.Input.Mouse

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> WarpMouseOrigin -> c WarpMouseOrigin

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c WarpMouseOrigin

toConstr :: WarpMouseOrigin -> Constr

dataTypeOf :: WarpMouseOrigin -> DataType

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c WarpMouseOrigin)

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c WarpMouseOrigin)

gmapT :: (forall b. Data b => b -> b) -> WarpMouseOrigin -> WarpMouseOrigin

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> WarpMouseOrigin -> r

gmapQr :: forall r r'. (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> WarpMouseOrigin -> r

gmapQ :: (forall d. Data d => d -> u) -> WarpMouseOrigin -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> WarpMouseOrigin -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> WarpMouseOrigin -> m WarpMouseOrigin

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> WarpMouseOrigin -> m WarpMouseOrigin

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> WarpMouseOrigin -> m WarpMouseOrigin

Generic WarpMouseOrigin Source #

Instance details

Defined in SDL.Input.Mouse

Associated Types

type Rep WarpMouseOrigin

Instance details

Defined in SDL.Input.Mouse

type Rep WarpMouseOrigin = D1 ('MetaData "WarpMouseOrigin" "SDL.Input.Mouse" "sdl2-2.5.5.1-AgF6e4ywebPJjPO67cQCnV" 'False) (C1 ('MetaCons "WarpInWindow" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Window)) :+: (C1 ('MetaCons "WarpCurrentFocus" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "WarpGlobal" 'PrefixI 'False) (U1 :: Type -> Type)))

Methods

from :: WarpMouseOrigin -> Rep WarpMouseOrigin x

to :: Rep WarpMouseOrigin x -> WarpMouseOrigin

Show WarpMouseOrigin Source #

Instance details

Defined in SDL.Input.Mouse

Methods

showsPrec :: Int -> WarpMouseOrigin -> ShowS

show :: WarpMouseOrigin -> String

showList :: [WarpMouseOrigin] -> ShowS

Eq WarpMouseOrigin Source #

Instance details

Defined in SDL.Input.Mouse

Methods

(==) :: WarpMouseOrigin -> WarpMouseOrigin -> Bool

(/=) :: WarpMouseOrigin -> WarpMouseOrigin -> Bool

Ord WarpMouseOrigin Source #

Instance details

Defined in SDL.Input.Mouse

Methods

compare :: WarpMouseOrigin -> WarpMouseOrigin -> Ordering

(<) :: WarpMouseOrigin -> WarpMouseOrigin -> Bool

(<=) :: WarpMouseOrigin -> WarpMouseOrigin -> Bool

(>) :: WarpMouseOrigin -> WarpMouseOrigin -> Bool

(>=) :: WarpMouseOrigin -> WarpMouseOrigin -> Bool

max :: WarpMouseOrigin -> WarpMouseOrigin -> WarpMouseOrigin

min :: WarpMouseOrigin -> WarpMouseOrigin -> WarpMouseOrigin

type Rep WarpMouseOrigin Source #

Instance details

Defined in SDL.Input.Mouse

type Rep WarpMouseOrigin = D1 ('MetaData "WarpMouseOrigin" "SDL.Input.Mouse" "sdl2-2.5.5.1-AgF6e4ywebPJjPO67cQCnV" 'False) (C1 ('MetaCons "WarpInWindow" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Window)) :+: (C1 ('MetaCons "WarpCurrentFocus" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "WarpGlobal" 'PrefixI 'False) (U1 :: Type -> Type)))

warpMouse :: MonadIO m => WarpMouseOrigin -> Point V2 CInt -> m () Source #

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

Cursor Visibility

cursorVisible :: StateVar Bool Source #

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

data Cursor Source #

Instances

Instances details

Eq Cursor Source #
Instance details Defined in SDL.Input.Mouse Methods (==) :: Cursor -> Cursor -> Bool (/=) :: Cursor -> Cursor -> Bool

data SystemCursor Source #

Constructors

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

Instances

Instances details

ToNumber SystemCursor Word32 Source #
Instance details Defined in SDL.Input.Mouse Methods toNumber :: SystemCursor -> Word32 Source #

activeCursor :: StateVar Cursor Source #

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.

createCursor Source #

Arguments

:: 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).

createCursorFrom Source #

Arguments

:: 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 = [ " " , " " , " " , " " , " " , " " , " " , " " ]

freeCursor :: MonadIO m => Cursor -> m () Source #

Free a cursor created with createCursor, createColorCusor and createSystemCursor.

See SDL_FreeCursor for C documentation.

createColorCursor Source #

Arguments

:: 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.

createSystemCursor :: MonadIO m => SystemCursor -> m Cursor Source #

Create system cursor.

See SDL_CreateSystemCursor for C documentation.