doxygen/console__types_8h_source.html

/* BSD 3-Clause License

 *

 * Copyright © 2008-2025, Jice and the libtcod contributors.

 * All rights reserved.

 *

 * Redistribution and use in source and binary forms, with or without

 * modification, are permitted provided that the following conditions are met:

 *

 * 1. Redistributions of source code must retain the above copyright notice,

 *    this list of conditions and the following disclaimer.

 *

 * 2. Redistributions in binary form must reproduce the above copyright notice,

 *    this list of conditions and the following disclaimer in the documentation

 *    and/or other materials provided with the distribution.

 *

 * 3. Neither the name of the copyright holder nor the names of its

 *    contributors may be used to endorse or promote products derived from

 *    this software without specific prior written permission.

 *

 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"

 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE

 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE

 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE

 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR

 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF

 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS

 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN

 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)

 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE

 * POSSIBILITY OF SUCH DAMAGE.

 */

#pragma once

#ifndef TCOD_CONSOLE_TYPES_H_

#define TCOD_CONSOLE_TYPES_H_


#include "color.h"

#include "config.h"

#include "console.h"


typedef enum TCOD_keycode_t {

  TCODK_NONE,

  TCODK_ESCAPE,

  TCODK_BACKSPACE,

  TCODK_TAB,

  TCODK_ENTER,

  TCODK_SHIFT,

  TCODK_CONTROL,

  TCODK_ALT,

  TCODK_PAUSE,

  TCODK_CAPSLOCK,

  TCODK_PAGEUP,

  TCODK_PAGEDOWN,

  TCODK_END,

  TCODK_HOME,

  TCODK_UP,

  TCODK_LEFT,

  TCODK_RIGHT,

  TCODK_DOWN,

  TCODK_PRINTSCREEN,

  TCODK_INSERT,

  TCODK_DELETE,

  TCODK_LWIN,

  TCODK_RWIN,

  TCODK_APPS,

  TCODK_0,

  TCODK_1,

  TCODK_2,

  TCODK_3,

  TCODK_4,

  TCODK_5,

  TCODK_6,

  TCODK_7,

  TCODK_8,

  TCODK_9,

  TCODK_KP0,

  TCODK_KP1,

  TCODK_KP2,

  TCODK_KP3,

  TCODK_KP4,

  TCODK_KP5,

  TCODK_KP6,

  TCODK_KP7,

  TCODK_KP8,

  TCODK_KP9,

  TCODK_KPADD,

  TCODK_KPSUB,

  TCODK_KPDIV,

  TCODK_KPMUL,

  TCODK_KPDEC,

  TCODK_KPENTER,

  TCODK_F1,

  TCODK_F2,

  TCODK_F3,

  TCODK_F4,

  TCODK_F5,

  TCODK_F6,

  TCODK_F7,

  TCODK_F8,

  TCODK_F9,

  TCODK_F10,

  TCODK_F11,

  TCODK_F12,

  TCODK_NUMLOCK,

  TCODK_SCROLLLOCK,

  TCODK_SPACE,

  TCODK_CHAR,

  TCODK_TEXT

} TCOD_keycode_t;


#define TCOD_KEY_TEXT_SIZE 32


TCOD_DEPRECATED("The libtcod event API has been deprecated, switch to using SDL event types exclusively")


typedef struct TCOD_key_t {


  TCOD_keycode_t vk;


  char c;


  char text[TCOD_KEY_TEXT_SIZE];


  bool pressed;


  bool lalt;


  bool lctrl;


  bool lmeta;


  bool ralt;


  bool rctrl;


  bool rmeta;


  bool shift;

} TCOD_key_t;


typedef enum TCOD_chars_t {

  /* single walls */

  TCOD_CHAR_HLINE TCOD_DEPRECATED_ENUM = 196,

  TCOD_CHAR_VLINE TCOD_DEPRECATED_ENUM = 179,

  TCOD_CHAR_NE TCOD_DEPRECATED_ENUM = 191,

  TCOD_CHAR_NW TCOD_DEPRECATED_ENUM = 218,

  TCOD_CHAR_SE TCOD_DEPRECATED_ENUM = 217,

  TCOD_CHAR_SW TCOD_DEPRECATED_ENUM = 192,

  TCOD_CHAR_TEEW TCOD_DEPRECATED_ENUM = 180,

  TCOD_CHAR_TEEE TCOD_DEPRECATED_ENUM = 195,

  TCOD_CHAR_TEEN TCOD_DEPRECATED_ENUM = 193,

  TCOD_CHAR_TEES TCOD_DEPRECATED_ENUM = 194,

  TCOD_CHAR_CROSS TCOD_DEPRECATED_ENUM = 197,

  /* double walls */

  TCOD_CHAR_DHLINE TCOD_DEPRECATED_ENUM = 205,

  TCOD_CHAR_DVLINE TCOD_DEPRECATED_ENUM = 186,

  TCOD_CHAR_DNE TCOD_DEPRECATED_ENUM = 187,

  TCOD_CHAR_DNW TCOD_DEPRECATED_ENUM = 201,

  TCOD_CHAR_DSE TCOD_DEPRECATED_ENUM = 188,

  TCOD_CHAR_DSW TCOD_DEPRECATED_ENUM = 200,

  TCOD_CHAR_DTEEW TCOD_DEPRECATED_ENUM = 185,

  TCOD_CHAR_DTEEE TCOD_DEPRECATED_ENUM = 204,

  TCOD_CHAR_DTEEN TCOD_DEPRECATED_ENUM = 202,

  TCOD_CHAR_DTEES TCOD_DEPRECATED_ENUM = 203,

  TCOD_CHAR_DCROSS TCOD_DEPRECATED_ENUM = 206,

  /* blocks */

  TCOD_CHAR_BLOCK1 TCOD_DEPRECATED_ENUM = 176,

  TCOD_CHAR_BLOCK2 TCOD_DEPRECATED_ENUM = 177,

  TCOD_CHAR_BLOCK3 TCOD_DEPRECATED_ENUM = 178,

  /* arrows */

  TCOD_CHAR_ARROW_N TCOD_DEPRECATED_ENUM = 24,

  TCOD_CHAR_ARROW_S TCOD_DEPRECATED_ENUM = 25,

  TCOD_CHAR_ARROW_E TCOD_DEPRECATED_ENUM = 26,

  TCOD_CHAR_ARROW_W TCOD_DEPRECATED_ENUM = 27,

  /* arrows without tail */

  TCOD_CHAR_ARROW2_N TCOD_DEPRECATED_ENUM = 30,

  TCOD_CHAR_ARROW2_S TCOD_DEPRECATED_ENUM = 31,

  TCOD_CHAR_ARROW2_E TCOD_DEPRECATED_ENUM = 16,

  TCOD_CHAR_ARROW2_W TCOD_DEPRECATED_ENUM = 17,

  /* double arrows */

  TCOD_CHAR_DARROW_H TCOD_DEPRECATED_ENUM = 29,

  TCOD_CHAR_DARROW_V TCOD_DEPRECATED_ENUM = 18,

  /* GUI stuff */

  TCOD_CHAR_CHECKBOX_UNSET TCOD_DEPRECATED_ENUM = 224,

  TCOD_CHAR_CHECKBOX_SET TCOD_DEPRECATED_ENUM = 225,

  TCOD_CHAR_RADIO_UNSET TCOD_DEPRECATED_ENUM = 9,

  TCOD_CHAR_RADIO_SET TCOD_DEPRECATED_ENUM = 10,

  /* sub-pixel resolution kit */

  TCOD_CHAR_SUBP_NW TCOD_DEPRECATED_ENUM = 226,

  TCOD_CHAR_SUBP_NE TCOD_DEPRECATED_ENUM = 227,

  TCOD_CHAR_SUBP_N TCOD_DEPRECATED_ENUM = 228,

  TCOD_CHAR_SUBP_SE TCOD_DEPRECATED_ENUM = 229,

  TCOD_CHAR_SUBP_DIAG TCOD_DEPRECATED_ENUM = 230,

  TCOD_CHAR_SUBP_E TCOD_DEPRECATED_ENUM = 231,

  TCOD_CHAR_SUBP_SW TCOD_DEPRECATED_ENUM = 232,

  /* miscellaneous */

  TCOD_CHAR_SMILIE TCOD_DEPRECATED_ENUM = 1,

  TCOD_CHAR_SMILIE_INV TCOD_DEPRECATED_ENUM = 2,

  TCOD_CHAR_HEART TCOD_DEPRECATED_ENUM = 3,

  TCOD_CHAR_DIAMOND TCOD_DEPRECATED_ENUM = 4,

  TCOD_CHAR_CLUB TCOD_DEPRECATED_ENUM = 5,

  TCOD_CHAR_SPADE TCOD_DEPRECATED_ENUM = 6,

  TCOD_CHAR_BULLET TCOD_DEPRECATED_ENUM = 7,

  TCOD_CHAR_BULLET_INV TCOD_DEPRECATED_ENUM = 8,

  TCOD_CHAR_MALE TCOD_DEPRECATED_ENUM = 11,

  TCOD_CHAR_FEMALE TCOD_DEPRECATED_ENUM = 12,

  TCOD_CHAR_NOTE TCOD_DEPRECATED_ENUM = 13,

  TCOD_CHAR_NOTE_DOUBLE TCOD_DEPRECATED_ENUM = 14,

  TCOD_CHAR_LIGHT TCOD_DEPRECATED_ENUM = 15,

  TCOD_CHAR_EXCLAM_DOUBLE TCOD_DEPRECATED_ENUM = 19,

  TCOD_CHAR_PILCROW TCOD_DEPRECATED_ENUM = 20,

  TCOD_CHAR_SECTION TCOD_DEPRECATED_ENUM = 21,

  TCOD_CHAR_POUND TCOD_DEPRECATED_ENUM = 156,

  TCOD_CHAR_MULTIPLICATION TCOD_DEPRECATED_ENUM = 158,

  TCOD_CHAR_FUNCTION TCOD_DEPRECATED_ENUM = 159,

  TCOD_CHAR_RESERVED TCOD_DEPRECATED_ENUM = 169,

  TCOD_CHAR_HALF TCOD_DEPRECATED_ENUM = 171,

  TCOD_CHAR_ONE_QUARTER TCOD_DEPRECATED_ENUM = 172,

  TCOD_CHAR_COPYRIGHT TCOD_DEPRECATED_ENUM = 184,

  TCOD_CHAR_CENT TCOD_DEPRECATED_ENUM = 189,

  TCOD_CHAR_YEN TCOD_DEPRECATED_ENUM = 190,

  TCOD_CHAR_CURRENCY TCOD_DEPRECATED_ENUM = 207,

  TCOD_CHAR_THREE_QUARTERS TCOD_DEPRECATED_ENUM = 243,

  TCOD_CHAR_DIVISION TCOD_DEPRECATED_ENUM = 246,

  TCOD_CHAR_GRADE TCOD_DEPRECATED_ENUM = 248,

  TCOD_CHAR_UMLAUT TCOD_DEPRECATED_ENUM = 249,

  TCOD_CHAR_POW1 TCOD_DEPRECATED_ENUM = 251,

  TCOD_CHAR_POW3 TCOD_DEPRECATED_ENUM = 252,

  TCOD_CHAR_POW2 TCOD_DEPRECATED_ENUM = 253,

  TCOD_CHAR_BULLET_SQUARE TCOD_DEPRECATED_ENUM = 254,

  /* diacritics */

} TCOD_chars_t TCOD_DEPRECATED_ENUM;


#if defined(_MSC_VER) && !defined(__clang__)

#pragma deprecated(TCOD_CHAR_HLINE)

#pragma deprecated(TCOD_CHAR_VLINE)

#pragma deprecated(TCOD_CHAR_NE)

#pragma deprecated(TCOD_CHAR_NW)

#pragma deprecated(TCOD_CHAR_SE)

#pragma deprecated(TCOD_CHAR_SW)

#pragma deprecated(TCOD_CHAR_TEEW)

#pragma deprecated(TCOD_CHAR_TEEE)

#pragma deprecated(TCOD_CHAR_TEEN)

#pragma deprecated(TCOD_CHAR_TEES)

#pragma deprecated(TCOD_CHAR_CROSS)

#pragma deprecated(TCOD_CHAR_DHLINE)

#pragma deprecated(TCOD_CHAR_DVLINE)

#pragma deprecated(TCOD_CHAR_DNE)

#pragma deprecated(TCOD_CHAR_DNW)

#pragma deprecated(TCOD_CHAR_DSE)

#pragma deprecated(TCOD_CHAR_DSW)

#pragma deprecated(TCOD_CHAR_DTEEW)

#pragma deprecated(TCOD_CHAR_DTEEE)

#pragma deprecated(TCOD_CHAR_DTEEN)

#pragma deprecated(TCOD_CHAR_DTEES)

#pragma deprecated(TCOD_CHAR_DCROSS)

#pragma deprecated(TCOD_CHAR_BLOCK1)

#pragma deprecated(TCOD_CHAR_BLOCK2)

#pragma deprecated(TCOD_CHAR_BLOCK3)

#pragma deprecated(TCOD_CHAR_ARROW_N)

#pragma deprecated(TCOD_CHAR_ARROW_S)

#pragma deprecated(TCOD_CHAR_ARROW_E)

#pragma deprecated(TCOD_CHAR_ARROW_W)

#pragma deprecated(TCOD_CHAR_ARROW2_N)

#pragma deprecated(TCOD_CHAR_ARROW2_S)

#pragma deprecated(TCOD_CHAR_ARROW2_E)

#pragma deprecated(TCOD_CHAR_ARROW2_W)

#pragma deprecated(TCOD_CHAR_DARROW_H)

#pragma deprecated(TCOD_CHAR_DARROW_V)

#pragma deprecated(TCOD_CHAR_CHECKBOX_UNSET)

#pragma deprecated(TCOD_CHAR_CHECKBOX_SET)

#pragma deprecated(TCOD_CHAR_RADIO_UNSET)

#pragma deprecated(TCOD_CHAR_RADIO_SET)

#pragma deprecated(TCOD_CHAR_SUBP_NW)

#pragma deprecated(TCOD_CHAR_SUBP_NE)

#pragma deprecated(TCOD_CHAR_SUBP_N)

#pragma deprecated(TCOD_CHAR_SUBP_SE)

#pragma deprecated(TCOD_CHAR_SUBP_DIAG)

#pragma deprecated(TCOD_CHAR_SUBP_E)

#pragma deprecated(TCOD_CHAR_SUBP_SW)

#pragma deprecated(TCOD_CHAR_SMILIE)

#pragma deprecated(TCOD_CHAR_SMILIE_INV)

#pragma deprecated(TCOD_CHAR_HEART)

#pragma deprecated(TCOD_CHAR_DIAMOND)

#pragma deprecated(TCOD_CHAR_CLUB)

#pragma deprecated(TCOD_CHAR_SPADE)

#pragma deprecated(TCOD_CHAR_BULLET)

#pragma deprecated(TCOD_CHAR_BULLET_INV)

#pragma deprecated(TCOD_CHAR_MALE)

#pragma deprecated(TCOD_CHAR_FEMALE)

#pragma deprecated(TCOD_CHAR_NOTE)

#pragma deprecated(TCOD_CHAR_NOTE_DOUBLE)

#pragma deprecated(TCOD_CHAR_LIGHT)

#pragma deprecated(TCOD_CHAR_EXCLAM_DOUBLE)

#pragma deprecated(TCOD_CHAR_PILCROW)

#pragma deprecated(TCOD_CHAR_SECTION)

#pragma deprecated(TCOD_CHAR_POUND)

#pragma deprecated(TCOD_CHAR_MULTIPLICATION)

#pragma deprecated(TCOD_CHAR_FUNCTION)

#pragma deprecated(TCOD_CHAR_RESERVED)

#pragma deprecated(TCOD_CHAR_HALF)

#pragma deprecated(TCOD_CHAR_ONE_QUARTER)

#pragma deprecated(TCOD_CHAR_COPYRIGHT)

#pragma deprecated(TCOD_CHAR_CENT)

#pragma deprecated(TCOD_CHAR_YEN)

#pragma deprecated(TCOD_CHAR_CURRENCY)

#pragma deprecated(TCOD_CHAR_THREE_QUARTERS)

#pragma deprecated(TCOD_CHAR_DIVISION)

#pragma deprecated(TCOD_CHAR_GRADE)

#pragma deprecated(TCOD_CHAR_UMLAUT)

#pragma deprecated(TCOD_CHAR_POW1)

#pragma deprecated(TCOD_CHAR_POW3)

#pragma deprecated(TCOD_CHAR_POW2)

#pragma deprecated(TCOD_CHAR_BULLET_SQUARE)

#endif  // _MSC_VER


typedef enum {

  TCOD_KEY_PRESSED = 1,

  TCOD_KEY_RELEASED = 2,

} TCOD_key_status_t;


typedef enum {

  TCOD_FONT_LAYOUT_ASCII_INCOL = 1,

  TCOD_FONT_LAYOUT_ASCII_INROW = 2,

  TCOD_FONT_TYPE_GREYSCALE = 4,

  TCOD_FONT_TYPE_GRAYSCALE = 4,

  TCOD_FONT_LAYOUT_TCOD = 8,

  TCOD_FONT_LAYOUT_CP437 = 16,

} TCOD_font_flags_t;


typedef enum TCOD_renderer_t {


  TCOD_RENDERER_GLSL,


  TCOD_RENDERER_OPENGL,


  TCOD_RENDERER_SDL,


  TCOD_RENDERER_SDL2,


  TCOD_RENDERER_OPENGL2,


  TCOD_RENDERER_XTERM,

  TCOD_NB_RENDERERS,

} TCOD_renderer_t;


#endif  // TCOD_CONSOLE_TYPES_H_

color.h
Color handling module.

config.h
Libtcod config header.

console.h
Various console functions.

TCOD_keycode_t
TCOD_keycode_t
Libtcod specific codes representing keys on the keyboard.
Definition console_types.h:126

TCOD_key_status_t
TCOD_key_status_t
Bitwise flags used for functions such as TCOD_console_check_for_keypress() This was replaced by the e...
Definition console_types.h:452

TCOD_font_flags_t
TCOD_font_flags_t
These font flags can be OR'd together into a bit-field and passed to TCOD_console_set_custom_font.
Definition console_types.h:460

TCOD_FONT_LAYOUT_TCOD
@ TCOD_FONT_LAYOUT_TCOD
A unique layout used by some of libtcod's fonts.
Definition console_types.h:479

TCOD_FONT_LAYOUT_ASCII_INROW
@ TCOD_FONT_LAYOUT_ASCII_INROW
Tiles are arranged in row-major order.
Definition console_types.h:474

TCOD_FONT_LAYOUT_CP437
@ TCOD_FONT_LAYOUT_CP437
Decode a code page 437 tileset into Unicode code-points.
Definition console_types.h:486

TCOD_FONT_TYPE_GREYSCALE
@ TCOD_FONT_TYPE_GREYSCALE
Converts all tiles into a monochrome gradient.
Definition console_types.h:476

TCOD_FONT_LAYOUT_ASCII_INCOL
@ TCOD_FONT_LAYOUT_ASCII_INCOL
Tiles are arranged in column-major order.
Definition console_types.h:467

TCOD_chars_t
TCOD_chars_t
Non-standard special character codes.
Definition console_types.h:273

TCOD_renderer_t
TCOD_renderer_t
Libtcod rendering modes.
Definition console_types.h:491

TCOD_RENDERER_GLSL
@ TCOD_RENDERER_GLSL
Alias for TCOD_RENDERER_OPENGL2.
Definition console_types.h:495

TCOD_RENDERER_OPENGL2
@ TCOD_RENDERER_OPENGL2
A new OpenGL 2.0 core renderer.
Definition console_types.h:551

TCOD_RENDERER_OPENGL
@ TCOD_RENDERER_OPENGL
An OpenGL 1.1 implementation.
Definition console_types.h:506

TCOD_RENDERER_SDL
@ TCOD_RENDERER_SDL
A software based renderer.
Definition console_types.h:517

TCOD_RENDERER_SDL2
@ TCOD_RENDERER_SDL2
Libtcod's primary SDL renderer.
Definition console_types.h:530

TCOD_RENDERER_XTERM
@ TCOD_RENDERER_XTERM
A renderer targeting modern XTerm terminals with 24-bit color support.
Definition console_types.h:567

TCOD_key_t
Libtcod key event data, as a keycode or text character.
Definition console_types.h:207

TCOD_key_t::text
char text[TCOD_KEY_TEXT_SIZE]
The UTF-8 text of a key when vk == TCODK_TEXT.
Definition console_types.h:232

TCOD_key_t::lctrl
bool lctrl
True if left control was held during this event.
Definition console_types.h:244

TCOD_key_t::rmeta
bool rmeta
True if the right meta key was held during this event.
Definition console_types.h:260

TCOD_key_t::ralt
bool ralt
True if right alt was held during this event.
Definition console_types.h:252

TCOD_key_t::lalt
bool lalt
True if left alt was held during this event.
Definition console_types.h:240

TCOD_key_t::pressed
bool pressed
True if is this key was pressed.
Definition console_types.h:236

TCOD_key_t::rctrl
bool rctrl
True if right control was held during this event.
Definition console_types.h:256

TCOD_key_t::lmeta
bool lmeta
True if the left meta key was held during this event.
Definition console_types.h:248

TCOD_key_t::shift
bool shift
True if shift was held during this event.
Definition console_types.h:264

TCOD_key_t::c
char c
The printable character of a keycode if vk == TCODK_CHAR, else 0.
Definition console_types.h:226

TCOD_key_t::vk
TCOD_keycode_t vk
The TCOD_keycode_t enum of the current key.
Definition console_types.h:211