Termbox.Bindings.Hs

This module provides a low-level wrapper around termbox, a simple C library for writing text-based user interfaces: https://github.com/termbox/termbox

You may prefer to use one of the following interfaces instead:

• termbox, a higher-level interface.
• termbox-banana, a reactive-banana FRP interface.
• termbox-tea, an Elm Architecture interface.

Functions

Initialize / shutdown

tb_init :: IO (Either Tb_init_error ())

Initialize the termbox library.

tb_init_fd :: Fd -> IO (Either Tb_init_error ())

Initialize the termbox library.

tb_init = tb_init_fd(0)

tb_init_file :: FilePath -> IO (Either Tb_init_error ())

Initialize the termbox library.

tb_init = tb_init_file("/dev/tty")

tb_shutdown :: IO ()

Shutdown the termbox library.

Get or set input mode

tb_get_input_mode :: IO Tb_input_mode

Get the input mode.

tb_select_input_mode :: Tb_input_mode -> IO ()

Set the input mode.

Get or set output mode

tb_get_output_mode :: IO Tb_output_mode

Get the output mode.

tb_select_output_mode :: Tb_output_mode -> IO ()

Set the output mode.

Get terminal dimensions

tb_width :: IO Int

Get the terminal width.

tb_height :: IO Int

Get the terminal height.

Poll for events

tb_peek_event :: Int -> IO (Either () (Maybe Tb_event))

Wait up to a number of milliseconds for an event.

tb_poll_event :: IO (Either () Tb_event)

Wait for an event.

Set a cell

tb_set_cursor

Arguments

:: Maybe (Int, Int)

x, y

-> IO ()

Set or hide the cursor location.

tb_put_cell

Arguments

:: Int

x

-> Int

y

-> Tb_cell

cell

-> IO ()

Set a cell value in the back buffer.

tb_change_cell

Arguments

:: Int

x

-> Int

y

-> Char

ch

-> Tb_attrs

fg

-> Tb_attrs

bg

-> IO ()

Set a cell value in the back buffer.

Clear and synchronize the back buffer

tb_clear :: IO ()

Clear the back buffer.

tb_set_clear_attributes

Arguments

:: Tb_attrs

fg

-> Tb_attrs

bg

-> IO ()

Set the foreground and background attributes that tb_clear clears the back buffer with.

tb_present :: IO ()

Synchronize the back buffer with the terminal.

Types

data Tb_cell

A cell.

Constructors

Tb_cell

Fields

• ch :: !Char

  A unicode character.

• fg :: !Tb_attrs

  Foreground attributes.

• bg :: !Tb_attrs

  Background attributes.

Instances

Generic Tb_cell

Defined in Termbox.Bindings.Hs.Internal.Cell

Associated Types

type Rep Tb_cell :: Type -> Type

Methods

from :: Tb_cell -> Rep Tb_cell x

to :: Rep Tb_cell x -> Tb_cell

Show Tb_cell

Defined in Termbox.Bindings.Hs.Internal.Cell

Methods

showsPrec :: Int -> Tb_cell -> ShowS

show :: Tb_cell -> String

showList :: [Tb_cell] -> ShowS

Eq Tb_cell

Defined in Termbox.Bindings.Hs.Internal.Cell

Methods

(==) :: Tb_cell -> Tb_cell -> Bool

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

type Rep Tb_cell

Defined in Termbox.Bindings.Hs.Internal.Cell

type Rep Tb_cell = D1 ('MetaData "Tb_cell" "Termbox.Bindings.Hs.Internal.Cell" "termbox-bindings-hs-1.0.0-inplace" 'False) (C1 ('MetaCons "Tb_cell" 'PrefixI 'True) (S1 ('MetaSel ('Just "ch") 'SourceUnpack 'SourceStrict 'DecidedStrict) (Rec0 Char) :*: (S1 ('MetaSel ('Just "fg") 'SourceUnpack 'SourceStrict 'DecidedStrict) (Rec0 Tb_attrs) :*: S1 ('MetaSel ('Just "bg") 'SourceUnpack 'SourceStrict 'DecidedStrict) (Rec0 Tb_attrs))))

newtype Tb_attrs

Cell attributes.

Constructors

Tb_attrs Word16

Instances

Monoid Tb_attrs

Defined in Termbox.Bindings.Hs.Internal.Attrs

Methods

mempty :: Tb_attrs

mappend :: Tb_attrs -> Tb_attrs -> Tb_attrs

mconcat :: [Tb_attrs] -> Tb_attrs

Semigroup Tb_attrs

Defined in Termbox.Bindings.Hs.Internal.Attrs

Methods

(<>) :: Tb_attrs -> Tb_attrs -> Tb_attrs

sconcat :: NonEmpty Tb_attrs -> Tb_attrs

stimes :: Integral b => b -> Tb_attrs -> Tb_attrs

Show Tb_attrs

Defined in Termbox.Bindings.Hs.Internal.Attrs

Methods

showsPrec :: Int -> Tb_attrs -> ShowS

show :: Tb_attrs -> String

showList :: [Tb_attrs] -> ShowS

Eq Tb_attrs

Defined in Termbox.Bindings.Hs.Internal.Attrs

Methods

(==) :: Tb_attrs -> Tb_attrs -> Bool

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

_TB_DEFAULT :: Tb_attrs

_TB_BLACK :: Tb_attrs

_TB_BLUE :: Tb_attrs

_TB_CYAN :: Tb_attrs

_TB_GREEN :: Tb_attrs

_TB_MAGENTA :: Tb_attrs

_TB_RED :: Tb_attrs

_TB_WHITE :: Tb_attrs

_TB_YELLOW :: Tb_attrs

_TB_BOLD :: Tb_attrs

_TB_REVERSE :: Tb_attrs

_TB_UNDERLINE :: Tb_attrs

data Tb_event

An event.

Constructors

Tb_event

Fields

• type_ :: !Tb_event_type
• mod :: !(Maybe Tb_event_mod)
• key :: !Tb_key
• ch :: !Char
• w :: !Int32
• h :: !Int32
• x :: !Int32
• y :: !Int32

Instances

Generic Tb_event

Defined in Termbox.Bindings.Hs.Internal.Event

Associated Types

type Rep Tb_event :: Type -> Type

Methods

from :: Tb_event -> Rep Tb_event x

to :: Rep Tb_event x -> Tb_event

Show Tb_event

Defined in Termbox.Bindings.Hs.Internal.Event

Methods

showsPrec :: Int -> Tb_event -> ShowS

show :: Tb_event -> String

showList :: [Tb_event] -> ShowS

Eq Tb_event

Defined in Termbox.Bindings.Hs.Internal.Event

Methods

(==) :: Tb_event -> Tb_event -> Bool

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

type Rep Tb_event

Defined in Termbox.Bindings.Hs.Internal.Event

type Rep Tb_event = D1 ('MetaData "Tb_event" "Termbox.Bindings.Hs.Internal.Event" "termbox-bindings-hs-1.0.0-inplace" 'False) (C1 ('MetaCons "Tb_event" 'PrefixI 'True) (((S1 ('MetaSel ('Just "type_") 'SourceUnpack 'SourceStrict 'DecidedStrict) (Rec0 Tb_event_type) :*: S1 ('MetaSel ('Just "mod") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (Maybe Tb_event_mod))) :*: (S1 ('MetaSel ('Just "key") 'SourceUnpack 'SourceStrict 'DecidedStrict) (Rec0 Tb_key) :*: S1 ('MetaSel ('Just "ch") 'SourceUnpack 'SourceStrict 'DecidedStrict) (Rec0 Char))) :*: ((S1 ('MetaSel ('Just "w") 'SourceUnpack 'SourceStrict 'DecidedStrict) (Rec0 Int32) :*: S1 ('MetaSel ('Just "h") 'SourceUnpack 'SourceStrict 'DecidedStrict) (Rec0 Int32)) :*: (S1 ('MetaSel ('Just "x") 'SourceUnpack 'SourceStrict 'DecidedStrict) (Rec0 Int32) :*: S1 ('MetaSel ('Just "y") 'SourceUnpack 'SourceStrict 'DecidedStrict) (Rec0 Int32)))))

data Tb_event_mod where

An event modifier.

Bundled Patterns

pattern TB_MOD_ALT :: Tb_event_mod

pattern TB_MOD_MOTION :: Tb_event_mod

Instances

Show Tb_event_mod

Defined in Termbox.Bindings.Hs.Internal.EventMod

Methods

showsPrec :: Int -> Tb_event_mod -> ShowS

show :: Tb_event_mod -> String

showList :: [Tb_event_mod] -> ShowS

Eq Tb_event_mod

Defined in Termbox.Bindings.Hs.Internal.EventMod

Methods

(==) :: Tb_event_mod -> Tb_event_mod -> Bool

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

data Tb_event_type where

An event type.

Bundled Patterns

pattern TB_EVENT_KEY :: Tb_event_type

pattern TB_EVENT_MOUSE :: Tb_event_type

pattern TB_EVENT_RESIZE :: Tb_event_type

Instances

Show Tb_event_type

Defined in Termbox.Bindings.Hs.Internal.EventType

Methods

showsPrec :: Int -> Tb_event_type -> ShowS

show :: Tb_event_type -> String

showList :: [Tb_event_type] -> ShowS

Eq Tb_event_type

Defined in Termbox.Bindings.Hs.Internal.EventType

Methods

(==) :: Tb_event_type -> Tb_event_type -> Bool

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

data Tb_init_error where

A tb_init error.

Bundled Patterns

pattern TB_EFAILED_TO_OPEN_TTY :: Tb_init_error

pattern TB_EPIPE_TRAP_ERROR :: Tb_init_error

pattern TB_EUNSUPPORTED_TERMINAL :: Tb_init_error

Instances

Exception Tb_init_error

Defined in Termbox.Bindings.Hs.Internal.InitError

Methods

toException :: Tb_init_error -> SomeException

fromException :: SomeException -> Maybe Tb_init_error

displayException :: Tb_init_error -> String

Show Tb_init_error

Defined in Termbox.Bindings.Hs.Internal.InitError

Methods

showsPrec :: Int -> Tb_init_error -> ShowS

show :: Tb_init_error -> String

showList :: [Tb_init_error] -> ShowS

Eq Tb_init_error

Defined in Termbox.Bindings.Hs.Internal.InitError

Methods

(==) :: Tb_init_error -> Tb_init_error -> Bool

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

newtype Tb_input_mode

The input mode.

Constructors

Tb_input_mode CInt

Instances

Semigroup Tb_input_mode

Defined in Termbox.Bindings.Hs.Internal.InputMode

Methods

(<>) :: Tb_input_mode -> Tb_input_mode -> Tb_input_mode

sconcat :: NonEmpty Tb_input_mode -> Tb_input_mode

stimes :: Integral b => b -> Tb_input_mode -> Tb_input_mode

Bits Tb_input_mode

Defined in Termbox.Bindings.Hs.Internal.InputMode

Methods

(.&.) :: Tb_input_mode -> Tb_input_mode -> Tb_input_mode

(.|.) :: Tb_input_mode -> Tb_input_mode -> Tb_input_mode

xor :: Tb_input_mode -> Tb_input_mode -> Tb_input_mode

complement :: Tb_input_mode -> Tb_input_mode

shift :: Tb_input_mode -> Int -> Tb_input_mode

rotate :: Tb_input_mode -> Int -> Tb_input_mode

zeroBits :: Tb_input_mode

bit :: Int -> Tb_input_mode

setBit :: Tb_input_mode -> Int -> Tb_input_mode

clearBit :: Tb_input_mode -> Int -> Tb_input_mode

complementBit :: Tb_input_mode -> Int -> Tb_input_mode

testBit :: Tb_input_mode -> Int -> Bool

bitSizeMaybe :: Tb_input_mode -> Maybe Int

bitSize :: Tb_input_mode -> Int

isSigned :: Tb_input_mode -> Bool

shiftL :: Tb_input_mode -> Int -> Tb_input_mode

unsafeShiftL :: Tb_input_mode -> Int -> Tb_input_mode

shiftR :: Tb_input_mode -> Int -> Tb_input_mode

unsafeShiftR :: Tb_input_mode -> Int -> Tb_input_mode

rotateL :: Tb_input_mode -> Int -> Tb_input_mode

rotateR :: Tb_input_mode -> Int -> Tb_input_mode

popCount :: Tb_input_mode -> Int

Show Tb_input_mode

Defined in Termbox.Bindings.Hs.Internal.InputMode

Methods

showsPrec :: Int -> Tb_input_mode -> ShowS

show :: Tb_input_mode -> String

showList :: [Tb_input_mode] -> ShowS

Eq Tb_input_mode

Defined in Termbox.Bindings.Hs.Internal.InputMode

Methods

(==) :: Tb_input_mode -> Tb_input_mode -> Bool

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

_TB_INPUT_ALT :: Tb_input_mode

_TB_INPUT_ESC :: Tb_input_mode

_TB_INPUT_MOUSE :: Tb_input_mode

data Tb_key where

A key.

Bundled Patterns

pattern TB_KEY_ARROW_DOWN :: Tb_key

pattern TB_KEY_ARROW_LEFT :: Tb_key

pattern TB_KEY_ARROW_RIGHT :: Tb_key

pattern TB_KEY_ARROW_UP :: Tb_key

pattern TB_KEY_BACKSPACE :: Tb_key

pattern TB_KEY_BACKSPACE2 :: Tb_key

pattern TB_KEY_CTRL_2 :: Tb_key

pattern TB_KEY_CTRL_3 :: Tb_key

pattern TB_KEY_CTRL_4 :: Tb_key

pattern TB_KEY_CTRL_5 :: Tb_key

pattern TB_KEY_CTRL_6 :: Tb_key

pattern TB_KEY_CTRL_7 :: Tb_key

pattern TB_KEY_CTRL_8 :: Tb_key

pattern TB_KEY_CTRL_A :: Tb_key

pattern TB_KEY_CTRL_B :: Tb_key

pattern TB_KEY_CTRL_BACKSLASH :: Tb_key

pattern TB_KEY_CTRL_C :: Tb_key

pattern TB_KEY_CTRL_D :: Tb_key

pattern TB_KEY_CTRL_E :: Tb_key

pattern TB_KEY_CTRL_F :: Tb_key

pattern TB_KEY_CTRL_G :: Tb_key

pattern TB_KEY_CTRL_H :: Tb_key

pattern TB_KEY_CTRL_I :: Tb_key

pattern TB_KEY_CTRL_J :: Tb_key

pattern TB_KEY_CTRL_K :: Tb_key

pattern TB_KEY_CTRL_L :: Tb_key

pattern TB_KEY_CTRL_LSQ_BRACKET :: Tb_key

pattern TB_KEY_CTRL_M :: Tb_key

pattern TB_KEY_CTRL_N :: Tb_key

pattern TB_KEY_CTRL_O :: Tb_key

pattern TB_KEY_CTRL_P :: Tb_key

pattern TB_KEY_CTRL_Q :: Tb_key

pattern TB_KEY_CTRL_R :: Tb_key

pattern TB_KEY_CTRL_RSQ_BRACKET :: Tb_key

pattern TB_KEY_CTRL_S :: Tb_key

pattern TB_KEY_CTRL_SLASH :: Tb_key

pattern TB_KEY_CTRL_T :: Tb_key

pattern TB_KEY_CTRL_TILDE :: Tb_key

pattern TB_KEY_CTRL_U :: Tb_key

pattern TB_KEY_CTRL_UNDERSCORE :: Tb_key

pattern TB_KEY_CTRL_V :: Tb_key

pattern TB_KEY_CTRL_W :: Tb_key

pattern TB_KEY_CTRL_X :: Tb_key

pattern TB_KEY_CTRL_Y :: Tb_key

pattern TB_KEY_CTRL_Z :: Tb_key

pattern TB_KEY_DELETE :: Tb_key

pattern TB_KEY_END :: Tb_key

pattern TB_KEY_ENTER :: Tb_key

pattern TB_KEY_ESC :: Tb_key

pattern TB_KEY_F1 :: Tb_key

pattern TB_KEY_F10 :: Tb_key

pattern TB_KEY_F11 :: Tb_key

pattern TB_KEY_F12 :: Tb_key

pattern TB_KEY_F2 :: Tb_key

pattern TB_KEY_F3 :: Tb_key

pattern TB_KEY_F4 :: Tb_key

pattern TB_KEY_F5 :: Tb_key

pattern TB_KEY_F6 :: Tb_key

pattern TB_KEY_F7 :: Tb_key

pattern TB_KEY_F8 :: Tb_key

pattern TB_KEY_F9 :: Tb_key

pattern TB_KEY_HOME :: Tb_key

pattern TB_KEY_INSERT :: Tb_key

pattern TB_KEY_MOUSE_LEFT :: Tb_key

pattern TB_KEY_MOUSE_MIDDLE :: Tb_key

pattern TB_KEY_MOUSE_RELEASE :: Tb_key

pattern TB_KEY_MOUSE_RIGHT :: Tb_key

pattern TB_KEY_MOUSE_WHEEL_DOWN :: Tb_key

pattern TB_KEY_MOUSE_WHEEL_UP :: Tb_key

pattern TB_KEY_PGDN :: Tb_key

pattern TB_KEY_PGUP :: Tb_key

pattern TB_KEY_SPACE :: Tb_key

pattern TB_KEY_TAB :: Tb_key

Instances

Show Tb_key

Defined in Termbox.Bindings.Hs.Internal.Key

Methods

showsPrec :: Int -> Tb_key -> ShowS

show :: Tb_key -> String

showList :: [Tb_key] -> ShowS

Eq Tb_key

Defined in Termbox.Bindings.Hs.Internal.Key

Methods

(==) :: Tb_key -> Tb_key -> Bool

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

Ord Tb_key

Defined in Termbox.Bindings.Hs.Internal.Key

Methods

compare :: Tb_key -> Tb_key -> Ordering

(<) :: Tb_key -> Tb_key -> Bool

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

(>) :: Tb_key -> Tb_key -> Bool

(>=) :: Tb_key -> Tb_key -> Bool

max :: Tb_key -> Tb_key -> Tb_key

min :: Tb_key -> Tb_key -> Tb_key

data Tb_output_mode where

The output mode.

Bundled Patterns

pattern TB_OUTPUT_216 :: Tb_output_mode

pattern TB_OUTPUT_256 :: Tb_output_mode

pattern TB_OUTPUT_GRAYSCALE :: Tb_output_mode

pattern TB_OUTPUT_NORMAL :: Tb_output_mode

Instances

Show Tb_output_mode

Defined in Termbox.Bindings.Hs.Internal.OutputMode

Methods

showsPrec :: Int -> Tb_output_mode -> ShowS

show :: Tb_output_mode -> String

showList :: [Tb_output_mode] -> ShowS

Eq Tb_output_mode

Defined in Termbox.Bindings.Hs.Internal.OutputMode

Methods

(==) :: Tb_output_mode -> Tb_output_mode -> Bool

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