Safe Haskell	None
Language	GHC2024

NanoUI.Input

Description

The per-frame Input record backends fill in: pointer state, keys and modifiers, typed characters, scroll, window size, and file drops.

Synopsis

data Key
- = KeyBackspace
- | KeyDelete
- | KeyEnter
- | KeyEscape
- | KeyTab
- | KeyLeft
- | KeyRight
- | KeyUp
- | KeyDown
- | KeyHome
- | KeyEnd
data Modifiers = Modifiers {
- modShift :: !Bool
- modCtrl :: !Bool
- modAlt :: !Bool
}
data Input = Input {
- inputMousePos :: !V2
- inputMouseDown :: !Bool
- inputMousePressed :: !Bool
- inputMouseReleased :: !Bool
- inputMouseRightDown :: !Bool
- inputMouseRightPressed :: !Bool
- inputMouseRightReleased :: !Bool
- inputMouseClicks :: !Int
- inputScroll :: !V2
- inputKeys :: SmallArray Key
- inputChars :: !Text
- inputModifiers :: !Modifiers
- inputWindowSize :: !Size
- inputDeltaTime :: !Float
- inputDrops :: SmallArray DropEvent
- inputWindowRedraw :: !Bool
}
data DropType
- = DropBegin
- | DropPosition
- | DropFile
- | DropText
- | DropComplete
data DropEvent = DropEvent {
- dropEventType :: !DropType
- dropEventPos :: !(Maybe V2)
- dropEventData :: !Text
}
emptyDropEvents :: SmallArray DropEvent
emptyInput :: Input
inputInteracted :: Input -> Input -> Bool
inputPointerHeld :: Input -> Bool
appendInputKey :: Key -> SmallArray Key -> SmallArray Key
appendDropEvent :: DropEvent -> SmallArray DropEvent -> SmallArray DropEvent
data MouseButton
- = MouseLeft
- | MouseRight
applyMouseButton :: MouseButton -> Bool -> Input -> Input
inputKeysNull :: SmallArray Key -> Bool
inputKeysElem :: Key -> SmallArray Key -> Bool
foldInputKeys :: (a -> Key -> a) -> a -> SmallArray Key -> a
inputKeysFromList :: [Key] -> SmallArray Key
emptyInputKeys :: SmallArray Key
stripInteractionInput :: Input -> Input
data UiCursorKind
- = UiCursorDefault
- | UiCursorPointer
- | UiCursorText
- | UiCursorGrab
- | UiCursorGrabbing
- | UiCursorNsResize
- | UiCursorEwResize
- | UiCursorNwseResize
- | UiCursorNeswResize
grabHoverKind :: Bool -> Input -> UiCursorKind
grabDragKind :: Bool -> Bool -> Input -> UiCursorKind
clearEphemeral :: Input -> Input
isHardQuitInput :: Input -> Bool
splitFrame :: (a -> Bool) -> [a] -> ([a], [a])

Documentation

data Key Source #

Constructors

KeyBackspace
KeyDelete
KeyEnter
KeyEscape
KeyTab
KeyLeft
KeyRight
KeyUp
KeyDown
KeyHome
KeyEnd

Instances

Instances details

Eq Key Source #
Instance details Defined in NanoUI.Input Methods (==) :: Key -> Key -> Bool # (/=) :: Key -> Key -> Bool #
Bounded Key Source #
Instance details Defined in NanoUI.Input Methods minBound :: Key # maxBound :: Key #
Enum Key Source #
Instance details Defined in NanoUI.Input Methods succ :: Key -> Key # pred :: Key -> Key # toEnum :: Int -> Key # fromEnum :: Key -> Int # enumFrom :: Key -> [Key] # enumFromThen :: Key -> Key -> [Key] # enumFromTo :: Key -> Key -> [Key] # enumFromThenTo :: Key -> Key -> Key -> [Key] #
Show Key Source #
Instance details Defined in NanoUI.Input Methods showsPrec :: Int -> Key -> ShowS # show :: Key -> String # showList :: [Key] -> ShowS #

data Modifiers Source #

Constructors

Modifiers
Fields modShift :: !Bool modCtrl :: !Bool modAlt :: !Bool

Instances

Instances details

Eq Modifiers Source #
Instance details Defined in NanoUI.Input Methods (==) :: Modifiers -> Modifiers -> Bool # (/=) :: Modifiers -> Modifiers -> Bool #
Show Modifiers Source #
Instance details Defined in NanoUI.Input Methods showsPrec :: Int -> Modifiers -> ShowS # show :: Modifiers -> String # showList :: [Modifiers] -> ShowS #

data Input Source #

Constructors

Input

Fields

inputMousePos :: !V2
inputMouseDown :: !Bool
inputMousePressed :: !Bool
inputMouseReleased :: !Bool
inputMouseRightDown :: !Bool
inputMouseRightPressed :: !Bool
inputMouseRightReleased :: !Bool
inputMouseClicks :: !Int
inputScroll :: !V2
inputKeys :: SmallArray Key
inputChars :: !Text
inputModifiers :: !Modifiers
inputWindowSize :: !Size
inputDeltaTime :: !Float
inputDrops :: SmallArray DropEvent
inputWindowRedraw :: !Bool

Instances

Instances details

Eq Input Source #
Instance details Defined in NanoUI.Input Methods (==) :: Input -> Input -> Bool # (/=) :: Input -> Input -> Bool #
Show Input Source #
Instance details Defined in NanoUI.Input Methods showsPrec :: Int -> Input -> ShowS # show :: Input -> String # showList :: [Input] -> ShowS #

data DropType Source #

OS-level drag-and-drop event kind, mirroring SDL_EventType drop codes.

Constructors

DropBegin	A drag enters the window; no position or payload yet.
DropPosition	The drag pointer moved over the window; position available.
DropFile	A file path was dropped; `dropEventData` holds the path.
DropText	Text was dropped; `dropEventData` holds the text.
DropComplete	The OS drag operation finished.

Instances

Instances details

Eq DropType Source #
Instance details Defined in NanoUI.Input Methods (==) :: DropType -> DropType -> Bool # (/=) :: DropType -> DropType -> Bool #
Show DropType Source #
Instance details Defined in NanoUI.Input Methods showsPrec :: Int -> DropType -> ShowS # show :: DropType -> String # showList :: [DropType] -> ShowS #

data DropEvent Source #

A single normalized drop payload surfaced to widgets.

Constructors

DropEvent
Fields dropEventType :: !DropType dropEventPos :: !(Maybe V2) dropEventData :: !Text

Instances

Instances details

Eq DropEvent Source #
Instance details Defined in NanoUI.Input Methods (==) :: DropEvent -> DropEvent -> Bool # (/=) :: DropEvent -> DropEvent -> Bool #
Show DropEvent Source #
Instance details Defined in NanoUI.Input Methods showsPrec :: Int -> DropEvent -> ShowS # show :: DropEvent -> String # showList :: [DropEvent] -> ShowS #

emptyDropEvents :: SmallArray DropEvent Source #

emptyInput :: Input Source #

inputInteracted :: Input -> Input -> Bool Source #

inputPointerHeld :: Input -> Bool Source #

appendInputKey :: Key -> SmallArray Key -> SmallArray Key Source #

appendDropEvent :: DropEvent -> SmallArray DropEvent -> SmallArray DropEvent Source #

The drops with one more at the end.

data MouseButton Source #

Mouse buttons tracked by Input.

Constructors

MouseLeft
MouseRight

Instances

Instances details

Eq MouseButton Source #
Instance details Defined in NanoUI.Input Methods (==) :: MouseButton -> MouseButton -> Bool # (/=) :: MouseButton -> MouseButton -> Bool #
Show MouseButton Source #
Instance details Defined in NanoUI.Input Methods showsPrec :: Int -> MouseButton -> ShowS # show :: MouseButton -> String # showList :: [MouseButton] -> ShowS #

applyMouseButton :: MouseButton -> Bool -> Input -> Input Source #

Apply a button transition: the held state plus that frame's one-shot pressed or released flag.

inputKeysNull :: SmallArray Key -> Bool Source #

inputKeysElem :: Key -> SmallArray Key -> Bool Source #

foldInputKeys :: (a -> Key -> a) -> a -> SmallArray Key -> a Source #

inputKeysFromList :: [Key] -> SmallArray Key Source #

emptyInputKeys :: SmallArray Key Source #

stripInteractionInput :: Input -> Input Source #

data UiCursorKind Source #

Constructors

UiCursorDefault
UiCursorPointer
UiCursorText
UiCursorGrab
UiCursorGrabbing
UiCursorNsResize
UiCursorEwResize
UiCursorNwseResize
UiCursorNeswResize

Instances

Instances details

Eq UiCursorKind Source #
Instance details Defined in NanoUI.Input Methods (==) :: UiCursorKind -> UiCursorKind -> Bool # (/=) :: UiCursorKind -> UiCursorKind -> Bool #
Show UiCursorKind Source #
Instance details Defined in NanoUI.Input Methods showsPrec :: Int -> UiCursorKind -> ShowS # show :: UiCursorKind -> String # showList :: [UiCursorKind] -> ShowS #

grabHoverKind :: Bool -> Input -> UiCursorKind Source #

grabDragKind :: Bool -> Bool -> Input -> UiCursorKind Source #

clearEphemeral :: Input -> Input Source #

isHardQuitInput :: Input -> Bool Source #

splitFrame :: (a -> Bool) -> [a] -> ([a], [a]) Source #