224 lines
8.5 KiB
C++
224 lines
8.5 KiB
C++
/* BSD 3-Clause License
|
|
*
|
|
* Copyright © 2008-2022, 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.
|
|
*/
|
|
#ifndef LIBTCOD_CONSOLE_INIT_H_
|
|
#define LIBTCOD_CONSOLE_INIT_H_
|
|
|
|
#include "config.h"
|
|
#include "console.h"
|
|
#include "console_types.h"
|
|
#include "context.h"
|
|
#include "error.h"
|
|
#include "tileset.h"
|
|
|
|
#ifdef __cplusplus
|
|
extern "C" {
|
|
#endif // __cplusplus
|
|
struct SDL_Rect;
|
|
struct SDL_Window;
|
|
struct SDL_Renderer;
|
|
#ifndef NO_SDL
|
|
/**
|
|
* \brief Initialize the libtcod graphical engine.
|
|
*
|
|
* \param w The width in tiles.
|
|
* \param h The height in tiles.
|
|
* \param title The title for the window.
|
|
* \param fullscreen Fullscreen option.
|
|
* \param renderer Which renderer to use when rendering the console.
|
|
*
|
|
* You may want to call TCOD_console_set_custom_font BEFORE calling this
|
|
* function. By default this function loads libtcod's `terminal.png` image
|
|
* from the working directory.
|
|
*
|
|
* Afterwards TCOD_quit must be called before the program exits.
|
|
*
|
|
* Returns 0 on success, or -1 on an error, you can check the error with
|
|
* TCOD_sys_get_error()
|
|
*
|
|
* `renderer` and vsync settings can be overridden by the `TCOD_RENDERER` or
|
|
* `TCOD_VSYNC` environment variables.
|
|
*
|
|
* Valid case-sensitive options for `TCOD_RENDERER` are:
|
|
* - sdl
|
|
* - opengl
|
|
* - glsl
|
|
* - sdl2
|
|
* - opengl2
|
|
*
|
|
* Valid options for `TCOD_VSYNC` are `0` or `1`.
|
|
*
|
|
* \rst
|
|
* .. versionchanged:: 1.12
|
|
* Now returns -1 on error instead of crashing.
|
|
*
|
|
* .. versionchanged:: 1.13
|
|
* Added the `TCOD_RENDERER` and `TCOD_VSYNC` overrides.
|
|
* \endrst
|
|
*/
|
|
TCOD_DEPRECATED(
|
|
"This way of initializing libtcod is deprecated. See the documentation for how to use TCOD_context_new.")
|
|
TCOD_PUBLIC TCOD_NODISCARD TCOD_Error
|
|
TCOD_console_init_root(int w, int h, const char* title, bool fullscreen, TCOD_renderer_t renderer);
|
|
TCOD_DEPRECATED(
|
|
"This way of initializing libtcod is deprecated. See the documentation for how to use TCOD_context_new.")
|
|
TCOD_PUBLIC TCOD_NODISCARD TCOD_Error
|
|
TCOD_console_init_root_(int w, int h, const char* title, bool fullscreen, TCOD_renderer_t renderer, bool vsync);
|
|
/**
|
|
* Change the title string of the active window.
|
|
*
|
|
* \param title A utf8 string.
|
|
*/
|
|
TCOD_DEPRECATED("This function is not compatible with contexts. Use SDL_SetWindowTitle to change the window title.")
|
|
TCOD_PUBLIC void TCOD_console_set_window_title(const char* title);
|
|
/**
|
|
* Set the display to be full-screen or windowed.
|
|
*
|
|
* \param fullscreen If true the display will go full-screen.
|
|
*/
|
|
TCOD_DEPRECATED(
|
|
"This function is not compatible with contexts. Use SDL_SetWindowFullscreen to set the fullscreen state.")
|
|
TCOD_PUBLIC void TCOD_console_set_fullscreen(bool fullscreen);
|
|
/**
|
|
* Return true if the display is full-screen.
|
|
*/
|
|
TCOD_DEPRECATED("This function is not compatible with contexts. Use SDL_GetWindowFlags to check this.")
|
|
TCOD_PUBLIC bool TCOD_console_is_fullscreen(void);
|
|
/**
|
|
* Return true if the window has mouse focus.
|
|
*/
|
|
TCOD_DEPRECATED("This function is not compatible with contexts. Use SDL_GetWindowFlags to check this.")
|
|
TCOD_PUBLIC bool TCOD_console_has_mouse_focus(void);
|
|
/**
|
|
* Return true if the window has keyboard focus.
|
|
*
|
|
* \verbatim embed:rst:leading-asterisk
|
|
* .. versionchanged: 1.7
|
|
* This function was previously broken. It now keeps track of keyboard
|
|
* focus.
|
|
* \endverbatim
|
|
*/
|
|
TCOD_DEPRECATED("This function is not compatible with contexts. Use SDL_GetWindowFlags to check this.")
|
|
TCOD_PUBLIC bool TCOD_console_is_active(void);
|
|
/**
|
|
* Return true if the window is closing.
|
|
*/
|
|
TCOD_DEPRECATED("This function is not compatible with contexts. Use SDL for events and check for SDL_QUIT.")
|
|
TCOD_PUBLIC bool TCOD_console_is_window_closed(void);
|
|
/**
|
|
* Return an SDL_Window pointer if one is in use, returns NULL otherwise.
|
|
* \rst
|
|
* .. versionadded:: 1.11
|
|
* \endrst
|
|
*/
|
|
TCOD_DEPRECATED("This function is not compatible with contexts.")
|
|
TCOD_PUBLIC struct SDL_Window* TCOD_sys_get_sdl_window(void);
|
|
/**
|
|
* Return an SDL_Renderer pointer if one is in use, returns NULL otherwise.
|
|
* \rst
|
|
* .. versionadded:: 1.11
|
|
* \endrst
|
|
*/
|
|
TCOD_DEPRECATED("This function is not compatible with contexts.")
|
|
TCOD_PUBLIC struct SDL_Renderer* TCOD_sys_get_sdl_renderer(void);
|
|
/**
|
|
* Render a console over the display.
|
|
* \rst
|
|
* `console` can be any size, the active render will try to scale it to fit
|
|
* the screen.
|
|
*
|
|
* The function will only work for the SDL2/OPENGL2 renderers.
|
|
*
|
|
* Unlike :any:`TCOD_console_flush` this will not present the display.
|
|
* You will need to do that manually, likely with the SDL API.
|
|
*
|
|
* Returns 0 on success, or a negative number on a failure such as the
|
|
* incorrect renderer being active.
|
|
*
|
|
* .. versionadded:: 1.11
|
|
*
|
|
* .. seealso::
|
|
* :any:`TCOD_sys_get_sdl_window` :any:`TCOD_sys_get_sdl_renderer`
|
|
* \endrst
|
|
*/
|
|
#endif // NO_SDL
|
|
TCOD_DEPRECATED("This function is not compatible with contexts.")
|
|
TCOD_PUBLIC int TCOD_sys_accumulate_console(const TCOD_Console* console);
|
|
TCOD_DEPRECATED("This function is not compatible with contexts.")
|
|
TCOD_PUBLIC int TCOD_sys_accumulate_console_(const TCOD_Console* console, const struct SDL_Rect* viewport);
|
|
/***************************************************************************
|
|
@brief Return the context being used internally by the old API.
|
|
|
|
@return A TCOD_Context pointer, or NULL if the global internals were not initialzed.
|
|
|
|
This function can be useful to progressively upgrade older code to use the newer API.
|
|
\rst
|
|
.. versionadded:: 1.19
|
|
\endrst
|
|
*/
|
|
TCOD_PUBLIC TCOD_Context* TCOD_sys_get_internal_context(void);
|
|
/***************************************************************************
|
|
@brief Return a pointer to the "root console" used internally by the old API.
|
|
|
|
This is useful for functions which take a console parameter but won't accept NULL.
|
|
|
|
@return A pointer to TCOD_Console, or NULL if it doesn't exist.
|
|
|
|
\rst
|
|
.. versionadded:: 1.19
|
|
\endrst
|
|
*/
|
|
TCOD_PUBLIC TCOD_Console* TCOD_sys_get_internal_console(void);
|
|
/***************************************************************************
|
|
@brief Shutdown libtcod. This must be called before your program exits.
|
|
|
|
\rst
|
|
.. versionadded:: 1.8
|
|
\endrst
|
|
*/
|
|
TCOD_PUBLIC void TCOD_quit(void);
|
|
#ifdef __cplusplus
|
|
} // extern "C"
|
|
namespace tcod {
|
|
namespace console {
|
|
[[deprecated(
|
|
"This way of initializing libtcod is deprecated. See the documentation for how to use "
|
|
"tcod::new_context.")]] TCOD_PUBLIC void
|
|
init_root(int w, int h, const std::string& title, bool fullscreen, TCOD_renderer_t renderer);
|
|
[[deprecated(
|
|
"This way of initializing libtcod is deprecated. See the documentation for how to use "
|
|
"tcod::new_context.")]] TCOD_PUBLIC void
|
|
init_root(int w, int h, const std::string& title, bool fullscreen, TCOD_renderer_t renderer, bool vsync);
|
|
} // namespace console
|
|
} // namespace tcod
|
|
#endif // __cplusplus
|
|
#endif // LIBTCOD_CONSOLE_INIT_H_
|