(index ("style" 0) ("create-cell" 210) ("create-cells" 778) ("init" 983) ("shutdown" 983) ("width" 1267) ("height" 1267) ("clear" 1675) ("present" 1850) ("cursor-set!" 1961) ("hide-cursor!" 2093) ("put-cell!" 2287) ("blit" 2427) ("bprintf" 2702) ("input-mode" 2909) ("output-mode" 3395) ("poll" 4512) ("key-f1" 4850) ("key-f2" 4850) ("key-f3" 4850) ("key-f4" 4850) ("key-f5" 4850) ("key-f6" 4850) ("key-f7" 4850) ("key-f8" 4850) ("key-f9" 4850) ("key-f10" 4850) ("key-f11" 4850) ("key-f12" 4850) ("key-insert" 4850) ("key-delete" 4850) ("key-home" 4850) ("key-end" 4850) ("key-pgup" 4850) ("key-pgdn" 4850) ("key-arrow-up" 4850) ("key-arrow-down" 4850) ("key-arrow-left" 4850) ("key-arrow-right" 4850) ("key-ctrl-tilde" 4850) ("key-ctrl-2" 4850) ("key-ctrl-a" 4850) ("key-ctrl-b" 4850) ("key-ctrl-c" 4850) ("key-ctrl-d" 4850) ("key-ctrl-e" 4850) ("key-ctrl-f" 4850) ("key-ctrl-g" 4850) ("key-backspace" 4850) ("key-ctrl-h" 4850) ("key-tab" 4850) ("key-ctrl-i" 4850) ("key-ctrl-j" 4850) ("key-ctrl-k" 4850) ("key-ctrl-l" 4850) ("key-enter" 4850) ("key-ctrl-m" 4850) ("key-ctrl-n" 4850) ("key-ctrl-o" 4850) ("key-ctrl-p" 4850) ("key-ctrl-q" 4850) ("key-ctrl-r" 4850) ("key-ctrl-s" 4850) ("key-ctrl-t" 4850) ("key-ctrl-u" 4850) ("key-ctrl-v" 4850) ("key-ctrl-w" 4850) ("key-ctrl-x" 4850) ("key-ctrl-y" 4850) ("key-ctrl-z" 4850) ("key-esc" 4850) ("key-ctrl-lsq-bracket" 4850) ("key-ctrl-3" 4850) ("key-ctrl-4" 4850) ("key-ctrl-backslash" 4850) ("key-ctrl-5" 4850) ("key-ctrl-rsq-bracket" 4850) ("key-ctrl-6" 4850) ("key-ctrl-7" 4850) ("key-ctrl-slash" 4850) ("key-ctrl-underscore" 4850) ("key-space" 4850) ("key-backspace2" 4850) ("key-ctrl-8" 4850) ("mod-alt" 7552) ("black" 7598) ("red" 7598) ("green" 7598) ("yellow" 7598) ("blue" 7598) ("magenta" 7598) ("cyan" 7598) ("white" 7598) ("bold" 7848) ("underline" 7848) ("reversed" 7848))
(def (sig (procedure "(style colour attributes ...)" (id style))) (p "Creates a style, combining a " (i "colour") " with zero or more attributes: " (i "underline") ", " (i "bold") ", and " (i "reversed") "."))
(def (sig (procedure "(create-cell char fg-style bg-style)" (id create-cell))) (p "Creates a cell containing a character with specific foreground and background colours/attributes. These can then be put on screen with the functions " (i "(put-cell!)") " or " (i "(blit)") ".") (p "Example:") (highlight scheme "\t; Create a letter ''H'' with black text and a white background.\n\t(create-cell #\\H (style black) (style white))\n\t; Create a letter ''H'' with black underlines text and a white background.\n\t(create-cell #\\H (style black underline) (style white))"))
(def (sig (procedure "(create-cells string fg-style bg-style)" (id create-cells))) (p "Create a list of cells of all characters in " (i "string") " all sharing the same foreground and background style."))
(def (sig (procedure "(init)" (id init)) (procedure "(shutdown)" (id shutdown))) (p "Initializes the termbox library. This function should be called before any other functions. After successful initialization, the library must be finalized using the " (i "(shutdown)") " function."))
(def (sig (procedure "(width)" (id width)) (procedure "(height)" (id height))) (p "Returns the size of the internal back buffer (which is the same as terminal's window size in characters). The internal buffer can be resized after " (i "(clear)") " or " (i "(present)") " function calls. Both dimensions have an unspecified negative value when called before " (i "(init)") " or after " (i "(shutdown)") "."))
(def (sig (procedure "(clear [fg bg])" (id clear))) (p "Clears the interbal back buffer to specific foreground and background colour which default to " (i "colour-default")))
(def (sig (procedure "(present)" (id present))) (p "Syncronizes the internal back buffer with the terminal."))
(def (sig (procedure "(cursor-set! x y)" (id cursor-set!))) (p "Sets the position of the cursor. Upper-left character is (0, 0)."))
(def (sig (procedure "(hide-cursor!)" (id hide-cursor!))) (p "Hides the cursor. If " (i "(cursor-set!)") " is called after this the cursor will be visible again. Cursor is hidden by default."))
(def (sig (procedure "(put-cell!)" (id put-cell!))) (p "Changes cell's parameters in the internal back buffer at the specified position."))
(def (sig (procedure "(blit x y w h cells)" (id blit))) (p "Copies the buffer from 'cells' at the specified position, assuming the buffer is a two-dimensional list of size ('w' x 'h'), represented as a one-dimensional list containing lines of cells starting from the top."))
(def (sig (procedure "(bprintf x y fg-style bg-style formatstring ... args)" (id bprintf))) (p "Prints a formated string (like printf) at position (x y). Using a specific foreground and background style."))
(def (sig (procedure "(input-mode [mode])" (id input-mode))) (p "Sets the termbox input mode. Termbox has two input modes:<br/>") (ul (li (i "esc") " input mode: When ESC sequence is in the buffer and it doesn't match any known ESC sequence.") (li (i "alt") " input mode: When ESC sequence is in the buffer and it doesn't match any known sequence => ESC enables " (i "mod-alt") " modifier for the next keyboard event.")) (p "Returns the current mode if node " (i "mode") " is given."))
(def (sig (procedure "(output-mode [mode])" (id output-mode))) (p "Sets the termbox output mode. Termbox has three output options:") (ul (li (i "normal") " [1..8]:  This mode provides 8 different colours: black, red, green, yellow, blue, magenta, cyan, white. Attributes: bold, underline, reversed")) (p "Example usage:") (pre "      (change_cell! x y #\\@ (style black bold) red)") (ul (li (i "256") " [0..256]:  In this mode you can leverage the 256 terminal mode:" (ul (li "0x00 - 0x07: the 8 colours as in " (i "normal")) (li "0x08 - 0x0f: (style red bold)") (li "0x10 - 0xe7: 216 different colours") (li "0xe8 - 0xff: 24 different shades of grey")))) (p "Example usage:") (pre "      (change_cell! x y #\\@ (style 184) (style 240))\n      (change_cell! x y #\\@ (style #xb8) (style #xf0))") (ul (li (i "216") " [0..216]: This mode supports the 3rd range of the 256 mode only. But you dont need to provide an offset.") (li (i "grayscale") " [0..23]: This mode supports the 4th range of the 256 mode only. But you dont need to provide an offset.")) (p "Returns the current mode if node " (i "mode") " is given."))
(def (sig (procedure "(poll on-keypress on-resize)" (id poll))) (p "Waits until there is an event availiable. If there is it will call, if it is a key event, " (i "on-keypress") " which must be of form (lambda (mod key ch) ...). If the event is a resize event it will kall " (i "on-resize") " which must be of form (lambda (w h) ...)."))
(def (sig (constant "key-f1" (id key-f1)) (constant "key-f2" (id key-f2)) (constant "key-f3" (id key-f3)) (constant "key-f4" (id key-f4)) (constant "key-f5" (id key-f5)) (constant "key-f6" (id key-f6)) (constant "key-f7" (id key-f7)) (constant "key-f8" (id key-f8)) (constant "key-f9" (id key-f9)) (constant "key-f10" (id key-f10)) (constant "key-f11" (id key-f11)) (constant "key-f12" (id key-f12)) (constant "key-insert" (id key-insert)) (constant "key-delete" (id key-delete)) (constant "key-home" (id key-home)) (constant "key-end" (id key-end)) (constant "key-pgup" (id key-pgup)) (constant "key-pgdn" (id key-pgdn)) (constant "key-arrow-up" (id key-arrow-up)) (constant "key-arrow-down" (id key-arrow-down)) (constant "key-arrow-left" (id key-arrow-left)) (constant "key-arrow-right" (id key-arrow-right)) (constant "key-ctrl-tilde" (id key-ctrl-tilde)) (constant "key-ctrl-2" (id key-ctrl-2)) (constant "key-ctrl-a" (id key-ctrl-a)) (constant "key-ctrl-b" (id key-ctrl-b)) (constant "key-ctrl-c" (id key-ctrl-c)) (constant "key-ctrl-d" (id key-ctrl-d)) (constant "key-ctrl-e" (id key-ctrl-e)) (constant "key-ctrl-f" (id key-ctrl-f)) (constant "key-ctrl-g" (id key-ctrl-g)) (constant "key-backspace" (id key-backspace)) (constant "key-ctrl-h" (id key-ctrl-h)) (constant "key-tab" (id key-tab)) (constant "key-ctrl-i" (id key-ctrl-i)) (constant "key-ctrl-j" (id key-ctrl-j)) (constant "key-ctrl-k" (id key-ctrl-k)) (constant "key-ctrl-l" (id key-ctrl-l)) (constant "key-enter" (id key-enter)) (constant "key-ctrl-m" (id key-ctrl-m)) (constant "key-ctrl-n" (id key-ctrl-n)) (constant "key-ctrl-o" (id key-ctrl-o)) (constant "key-ctrl-p" (id key-ctrl-p)) (constant "key-ctrl-q" (id key-ctrl-q)) (constant "key-ctrl-r" (id key-ctrl-r)) (constant "key-ctrl-s" (id key-ctrl-s)) (constant "key-ctrl-t" (id key-ctrl-t)) (constant "key-ctrl-u" (id key-ctrl-u)) (constant "key-ctrl-v" (id key-ctrl-v)) (constant "key-ctrl-w" (id key-ctrl-w)) (constant "key-ctrl-x" (id key-ctrl-x)) (constant "key-ctrl-y" (id key-ctrl-y)) (constant "key-ctrl-z" (id key-ctrl-z)) (constant "key-esc" (id key-esc)) (constant "key-ctrl-lsq-bracket" (id key-ctrl-lsq-bracket)) (constant "key-ctrl-3" (id key-ctrl-3)) (constant "key-ctrl-4" (id key-ctrl-4)) (constant "key-ctrl-backslash" (id key-ctrl-backslash)) (constant "key-ctrl-5" (id key-ctrl-5)) (constant "key-ctrl-rsq-bracket" (id key-ctrl-rsq-bracket)) (constant "key-ctrl-6" (id key-ctrl-6)) (constant "key-ctrl-7" (id key-ctrl-7)) (constant "key-ctrl-slash" (id key-ctrl-slash)) (constant "key-ctrl-underscore" (id key-ctrl-underscore)) (constant "key-space" (id key-space)) (constant "key-backspace2" (id key-backspace2)) (constant "key-ctrl-8" (id key-ctrl-8))))
(def (sig (constant "mod-alt" (id mod-alt))))
(def (sig (constant "black" (id black)) (constant "red" (id red)) (constant "green" (id green)) (constant "yellow" (id yellow)) (constant "blue" (id blue)) (constant "magenta" (id magenta)) (constant "cyan" (id cyan)) (constant "white" (id white))))
(def (sig (constant "bold" (id bold)) (constant "underline" (id underline)) (constant "reversed" (id reversed))))
