libtcod
Loading...
Searching...
No Matches
tileset.h
Go to the documentation of this file.
1/* BSD 3-Clause License
2 *
3 * Copyright © 2008-2026, Jice and the libtcod contributors.
4 * All rights reserved.
5 *
6 * Redistribution and use in source and binary forms, with or without
7 * modification, are permitted provided that the following conditions are met:
8 *
9 * 1. Redistributions of source code must retain the above copyright notice,
10 * this list of conditions and the following disclaimer.
11 *
12 * 2. Redistributions in binary form must reproduce the above copyright notice,
13 * this list of conditions and the following disclaimer in the documentation
14 * and/or other materials provided with the distribution.
15 *
16 * 3. Neither the name of the copyright holder nor the names of its
17 * contributors may be used to endorse or promote products derived from
18 * this software without specific prior written permission.
19 *
20 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
21 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
22 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
23 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
24 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
25 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
26 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
27 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
28 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
29 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
30 * POSSIBILITY OF SUCH DAMAGE.
31 */
34#pragma once
35#ifndef LIBTCOD_TILESET_H_
36#define LIBTCOD_TILESET_H_
37#include <stddef.h>
38
39#include "color.h"
40#include "config.h"
41#include "error.h"
42
46
47struct TCOD_Tileset;
48struct TCOD_TilesetObserver {
49 struct TCOD_Tileset* tileset;
50 struct TCOD_TilesetObserver* next;
51 void* userdata;
52 void (*on_observer_delete)(struct TCOD_TilesetObserver* observer);
53 int (*on_tile_changed)(struct TCOD_TilesetObserver* observer, int tile_id);
54};
55
60struct TCOD_Tileset {
61 int tile_width;
62 int tile_height;
63 int tile_length;
64 int tiles_capacity;
65 int tiles_count;
66 struct TCOD_ColorRGBA* __restrict pixels;
67 int character_map_length;
68 int* __restrict character_map;
69 struct TCOD_TilesetObserver* observer_list;
70 int virtual_columns;
71 volatile int ref_count;
72};
73typedef struct TCOD_Tileset TCOD_Tileset;
74// clang-format off
75// Character maps are defined in this way so that the C and C++ API don't duplicate them.
76#define TCOD_CHARMAP_CP437_ {\
77 0x0000, 0x263A, 0x263B, 0x2665, 0x2666, 0x2663, 0x2660, 0x2022,\
78 0x25D8, 0x25CB, 0x25D9, 0x2642, 0x2640, 0x266A, 0x266B, 0x263C,\
79 0x25BA, 0x25C4, 0x2195, 0x203C, 0x00B6, 0x00A7, 0x25AC, 0x21A8,\
80 0x2191, 0x2193, 0x2192, 0x2190, 0x221F, 0x2194, 0x25B2, 0x25BC,\
81 0x0020, 0x0021, 0x0022, 0x0023, 0x0024, 0x0025, 0x0026, 0x0027,\
82 0x0028, 0x0029, 0x002A, 0x002B, 0x002C, 0x002D, 0x002E, 0x002F,\
83 0x0030, 0x0031, 0x0032, 0x0033, 0x0034, 0x0035, 0x0036, 0x0037,\
84 0x0038, 0x0039, 0x003A, 0x003B, 0x003C, 0x003D, 0x003E, 0x003F,\
85 0x0040, 0x0041, 0x0042, 0x0043, 0x0044, 0x0045, 0x0046, 0x0047,\
86 0x0048, 0x0049, 0x004A, 0x004B, 0x004C, 0x004D, 0x004E, 0x004F,\
87 0x0050, 0x0051, 0x0052, 0x0053, 0x0054, 0x0055, 0x0056, 0x0057,\
88 0x0058, 0x0059, 0x005A, 0x005B, 0x005C, 0x005D, 0x005E, 0x005F,\
89 0x0060, 0x0061, 0x0062, 0x0063, 0x0064, 0x0065, 0x0066, 0x0067,\
90 0x0068, 0x0069, 0x006A, 0x006B, 0x006C, 0x006D, 0x006E, 0x006F,\
91 0x0070, 0x0071, 0x0072, 0x0073, 0x0074, 0x0075, 0x0076, 0x0077,\
92 0x0078, 0x0079, 0x007A, 0x007B, 0x007C, 0x007D, 0x007E, 0x2302,\
93 0x00C7, 0x00FC, 0x00E9, 0x00E2, 0x00E4, 0x00E0, 0x00E5, 0x00E7,\
94 0x00EA, 0x00EB, 0x00E8, 0x00EF, 0x00EE, 0x00EC, 0x00C4, 0x00C5,\
95 0x00C9, 0x00E6, 0x00C6, 0x00F4, 0x00F6, 0x00F2, 0x00FB, 0x00F9,\
96 0x00FF, 0x00D6, 0x00DC, 0x00A2, 0x00A3, 0x00A5, 0x20A7, 0x0192,\
97 0x00E1, 0x00ED, 0x00F3, 0x00FA, 0x00F1, 0x00D1, 0x00AA, 0x00BA,\
98 0x00BF, 0x2310, 0x00AC, 0x00BD, 0x00BC, 0x00A1, 0x00AB, 0x00BB,\
99 0x2591, 0x2592, 0x2593, 0x2502, 0x2524, 0x2561, 0x2562, 0x2556,\
100 0x2555, 0x2563, 0x2551, 0x2557, 0x255D, 0x255C, 0x255B, 0x2510,\
101 0x2514, 0x2534, 0x252C, 0x251C, 0x2500, 0x253C, 0x255E, 0x255F,\
102 0x255A, 0x2554, 0x2569, 0x2566, 0x2560, 0x2550, 0x256C, 0x2567,\
103 0x2568, 0x2564, 0x2565, 0x2559, 0x2558, 0x2552, 0x2553, 0x256B,\
104 0x256A, 0x2518, 0x250C, 0x2588, 0x2584, 0x258C, 0x2590, 0x2580,\
105 0x03B1, 0x00DF, 0x0393, 0x03C0, 0x03A3, 0x03C3, 0x00B5, 0x03C4,\
106 0x03A6, 0x0398, 0x03A9, 0x03B4, 0x221E, 0x03C6, 0x03B5, 0x2229,\
107 0x2261, 0x00B1, 0x2265, 0x2264, 0x2320, 0x2321, 0x00F7, 0x2248,\
108 0x00B0, 0x2219, 0x00B7, 0x221A, 0x207F, 0x00B2, 0x25A0, 0x00A0,\
109}
110#define TCOD_CHARMAP_TCOD_ {\
111 0x20, 0x21, 0x22, 0x23, 0x24, 0x25, 0x26, 0x27,\
112 0x28, 0x29, 0x2A, 0x2B, 0x2C, 0x2D, 0x2E, 0x2F,\
113 0x30, 0x31, 0x32, 0x33, 0x34, 0x35, 0x36, 0x37,\
114 0x38, 0x39, 0x3A, 0x3B, 0x3C, 0x3D, 0x3E, 0x3F,\
115 0x40, 0x5B, 0x5C, 0x5D, 0x5E, 0x5F, 0x60, 0x7B,\
116 0x7C, 0x7D, 0x7E, 0x2591, 0x2592, 0x2593, 0x2502, 0x2500,\
117 0x253C, 0x2524, 0x2534, 0x251C, 0x252C, 0x2514, 0x250C, 0x2510,\
118 0x2518, 0x2598, 0x259D, 0x2580, 0x2596, 0x259A, 0x2590, 0x2597,\
119 0x2191, 0x2193, 0x2190, 0x2192, 0x25B2, 0x25BC, 0x25C4, 0x25BA,\
120 0x2195, 0x2194, 0x2610, 0x2611, 0x25CB, 0x25C9, 0x2551, 0x2550,\
121 0x256C, 0x2563, 0x2569, 0x2560, 0x2566, 0x255A, 0x2554, 0x2557,\
122 0x255D, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,\
123 0x41, 0x42, 0x43, 0x44, 0x45, 0x46, 0x47, 0x48,\
124 0x49, 0x4A, 0x4B, 0x4C, 0x4D, 0x4E, 0x4F, 0x50,\
125 0x51, 0x52, 0x53, 0x54, 0x55, 0x56, 0x57, 0x58,\
126 0x59, 0x5A, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,\
127 0x61, 0x62, 0x63, 0x64, 0x65, 0x66, 0x67, 0x68,\
128 0x69, 0x6A, 0x6B, 0x6C, 0x6D, 0x6E, 0x6F, 0x70,\
129 0x71, 0x72, 0x73, 0x74, 0x75, 0x76, 0x77, 0x78,\
130 0x79, 0x7A, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,\
131 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,\
132 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,\
133 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,\
134 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,\
135 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,\
136 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,\
137 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,\
138 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,\
139 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,\
140 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,\
141 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,\
142 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,\
143}
144// clang-format on
149static const int TCOD_CHARMAP_CP437[256] = TCOD_CHARMAP_CP437_;
154static const int TCOD_CHARMAP_TCOD[256] = TCOD_CHARMAP_TCOD_;
155#ifdef __cplusplus
156extern "C" {
157#endif // __cplusplus
162TCOD_NODISCARD
163TCOD_PUBLIC TCOD_Tileset* TCOD_tileset_new(int tile_width, int tile_height);
168TCOD_PUBLIC void TCOD_tileset_delete(TCOD_Tileset* tileset);
174TCOD_NODISCARD
175TCOD_PUBLIC int TCOD_tileset_get_tile_width_(const TCOD_Tileset* tileset);
181TCOD_NODISCARD
182TCOD_PUBLIC int TCOD_tileset_get_tile_height_(const TCOD_Tileset* tileset);
197TCOD_NODISCARD
198TCOD_PUBLIC TCOD_Error
199TCOD_tileset_get_tile_(const TCOD_Tileset* __restrict tileset, int codepoint, struct TCOD_ColorRGBA* __restrict buffer);
210TCOD_NODISCARD
211TCOD_PUBLIC TCOD_Error
212TCOD_tileset_set_tile_(TCOD_Tileset* __restrict tileset, int codepoint, const struct TCOD_ColorRGBA* __restrict buffer);
213
214#ifndef TCOD_NO_PNG
229TCOD_NODISCARD
230TCOD_PUBLIC TCOD_Tileset* TCOD_tileset_load(
231 const char* filename, int columns, int rows, int n, const int* __restrict charmap);
232
242TCOD_NODISCARD
243TCOD_PUBLIC TCOD_Tileset* TCOD_tileset_load_mem(
244 size_t buffer_length, const unsigned char* buffer, int columns, int rows, int n, const int* __restrict charmap);
245#endif // TCOD_NO_PNG
246
256TCOD_NODISCARD
257TCOD_PUBLIC TCOD_Tileset* TCOD_tileset_load_raw(
258 int width,
259 int height,
260 const struct TCOD_ColorRGBA* __restrict pixels,
261 int columns,
262 int rows,
263 int n,
264 const int* __restrict charmap);
265
273TCOD_NODISCARD
274TCOD_PUBLIC int TCOD_tileset_assign_tile(struct TCOD_Tileset* tileset, int tile_id, int codepoint);
280TCOD_NODISCARD
281TCOD_PUBLIC const struct TCOD_ColorRGBA* TCOD_tileset_get_tile(const TCOD_Tileset* tileset, int codepoint);
287TCOD_NODISCARD
288struct TCOD_TilesetObserver* TCOD_tileset_observer_new(struct TCOD_Tileset* tileset);
296void TCOD_tileset_observer_delete(struct TCOD_TilesetObserver* observer);
303void TCOD_tileset_notify_tile_changed(TCOD_Tileset* tileset, int tile_id);
309TCOD_NODISCARD
310TCOD_Error TCOD_tileset_reserve(TCOD_Tileset* tileset, int desired);
311#ifdef __cplusplus
312} // extern "C"
313#endif // __cplusplus
315#endif // LIBTCOD_TILESET_H_
color.h
Color handling module.
config.h
Libtcod config header.
error.h
Error handling module.
TCOD_Error
TCOD_Error
An enum of libtcod error codes.
Definition error.h:48
TCOD_tileset_delete
void TCOD_tileset_delete(TCOD_Tileset *tileset)
Delete a tile-set.
TCOD_CHARMAP_TCOD
static const int TCOD_CHARMAP_TCOD[256]
A character mapping of a deprecated TCOD tileset to Unicode.
Definition tileset.h:154
TCOD_tileset_load_mem
TCOD_Tileset * TCOD_tileset_load_mem(size_t buffer_length, const unsigned char *buffer, int columns, int rows, int n, const int *charmap)
Load a PNG font from memory and return a TCOD_Tileset.
TCOD_tileset_notify_tile_changed
void TCOD_tileset_notify_tile_changed(TCOD_Tileset *tileset, int tile_id)
Called to notify any observers that a tile has been changed.
TCOD_CHARMAP_CP437
static const int TCOD_CHARMAP_CP437[256]
A character mapping of a Code Page 437 tileset to Unicode.
Definition tileset.h:149
TCOD_tileset_observer_delete
void TCOD_tileset_observer_delete(struct TCOD_TilesetObserver *observer)
Delete an existing observer.
TCOD_tileset_observer_new
struct TCOD_TilesetObserver * TCOD_tileset_observer_new(struct TCOD_Tileset *tileset)
Return a new observer to this tileset.
TCOD_tileset_assign_tile
int TCOD_tileset_assign_tile(struct TCOD_Tileset *tileset, int tile_id, int codepoint)
Assign a codepoint to an existing tile based on its tile ID.
TCOD_tileset_load_raw
TCOD_Tileset * TCOD_tileset_load_raw(int width, int height, const struct TCOD_ColorRGBA *pixels, int columns, int rows, int n, const int *charmap)
Load raw RGBA data and return a TCOD_Tileset.
TCOD_tileset_reserve
TCOD_Error TCOD_tileset_reserve(TCOD_Tileset *tileset, int desired)
Reserve memory for a specific amount of tiles.
TCOD_tileset_new
TCOD_Tileset * TCOD_tileset_new(int tile_width, int tile_height)
Create a new tile-set with the given tile size.
TCOD_tileset_get_tile
const struct TCOD_ColorRGBA * TCOD_tileset_get_tile(const TCOD_Tileset *tileset, int codepoint)
Return a pointer to the tile for codepoint.
TCOD_tileset_load
TCOD_Tileset * TCOD_tileset_load(const char *filename, int columns, int rows, int n, const int *charmap)
Load a PNG font as a tilesheet and return a TCOD_Tileset.
TCOD_ColorRGBA
A 4-channel RGBA color struct.
Definition color.h:89
TCOD_Tileset
A container for libtcod tileset graphics.
Definition tileset.h:60
TCOD_TilesetObserver
Definition tileset.h:48