libtcod
Loading...
Searching...
No Matches
console_rexpaint.h
Go to the documentation of this file.
1/* BSD 3-Clause License
2 *
3 * Copyright © 2008-2025, 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 TCOD_CONSOLE_REXPAINT_H_
36#define TCOD_CONSOLE_REXPAINT_H_
37#ifndef TCOD_NO_ZLIB
38
39#ifdef __cplusplus
40#include <string>
41#include <vector>
42#endif // __cplusplus
43
44#include "config.h"
45#include "console_types.h"
46#include "list.h"
49#ifdef __cplusplus
50extern "C" {
51#endif // __cplusplus
61TCODLIB_API TCOD_Console* TCOD_console_from_xp(const char* filename);
71TCODLIB_API bool TCOD_console_load_xp(TCOD_Console* con, const char* filename);
84TCODLIB_API bool TCOD_console_save_xp(const TCOD_Console* con, const char* filename, int compress_level);
100TCOD_DEPRECATED("TCOD_list_t is deprecated, use TCOD_load_xp instead.")
101TCODLIB_API TCOD_list_t TCOD_console_list_from_xp(const char* filename);
122TCOD_DEPRECATED("TCOD_list_t is deprecated, use TCOD_save_xp instead.")
123TCODLIB_API bool TCOD_console_list_save_xp(TCOD_list_t console_list, const char* filename, int compress_level);
139TCODLIB_API int TCOD_load_xp_from_memory(int n_data, const unsigned char* data, int n_out, TCOD_Console** out);
159 int n_consoles, const TCOD_Console* const* consoles, int n_out, unsigned char* out, int compression_level);
172TCODLIB_API int TCOD_load_xp(const char* path, int n, TCOD_Console** out);
188TCODLIB_API TCOD_Error TCOD_save_xp(int n, const TCOD_Console* const* consoles, const char* path, int compress_level);
189#ifdef __cplusplus
190} // extern "C"
191#endif // __cplusplus
193#endif // TCOD_NO_ZLIB
194#endif // TCOD_CONSOLE_REXPAINT_H_
Libtcod config header.
C types for console functions.
TCOD_Error
An enum of libtcod error codes.
Definition error.h:48
int TCOD_load_xp(const char *path, int n, TCOD_Console **out)
Load an array of consoles from a REXPaint file.
TCOD_Console * TCOD_console_from_xp(const char *filename)
Return a new console loaded from a REXPaint .xp file.
TCOD_list_t TCOD_console_list_from_xp(const char *filename)
Return a list of consoles from a REXPaint file.
bool TCOD_console_load_xp(TCOD_Console *con, const char *filename)
Update a console from a REXPaint .xp file.
int TCOD_load_xp_from_memory(int n_data, const unsigned char *data, int n_out, TCOD_Console **out)
Load an array of consoles from a REXPaint file in memory.
bool TCOD_console_save_xp(const TCOD_Console *con, const char *filename, int compress_level)
Save a console as a REXPaint .xp file.
bool TCOD_console_list_save_xp(TCOD_list_t console_list, const char *filename, int compress_level)
Save a list of consoles to a REXPaint file.
int TCOD_save_xp_to_memory(int n_consoles, const TCOD_Console *const *consoles, int n_out, unsigned char *out, int compression_level)
Save an array of consoles to a REXPaint file in memory.
TCOD_Error TCOD_save_xp(int n, const TCOD_Console *const *consoles, const char *path, int compress_level)
Save an array of consoles to a REXPaint file.
Deprecated libtcod list module.
A libtcod console containing a grid of tiles with {ch, fg, bg} information.
Definition console.h:125