.. _program_listing_file_libtcod_renderer_sdl2.h:

Program Listing for File renderer_sdl2.h
========================================

|exhale_lsh| :ref:`Return to documentation for file <file_libtcod_renderer_sdl2.h>` (``libtcod/renderer_sdl2.h``)

.. |exhale_lsh| unicode:: U+021B0 .. UPWARDS ARROW WITH TIP LEFTWARDS

.. code-block:: cpp

   /* 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 LIBTCOD_RENDERER_SDL2_H_
   #define LIBTCOD_RENDERER_SDL2_H_
   #ifndef NO_SDL
   
   #include <SDL3/SDL_properties.h>
   #include <stdbool.h>
   
   #include "config.h"
   #include "console.h"
   #include "context.h"
   #include "error.h"
   #include "mouse.h"
   #include "tileset.h"
   
   struct SDL_Window;
   struct SDL_Renderer;
   struct SDL_Texture;
   typedef struct TCOD_TilesetAtlasSDL2 {
     struct SDL_Renderer* renderer;
     struct SDL_Texture* texture;
     struct TCOD_Tileset* tileset;
     struct TCOD_TilesetObserver* observer;
     int texture_columns;
   } TCOD_TilesetAtlasSDL2;
   struct TCOD_RendererSDL2 {
     struct SDL_Window* window;  // Owning power to an SDL2 window.
     struct SDL_Renderer* renderer;  // Owning pointer to an SDL2 renderer.
     struct TCOD_TilesetAtlasSDL2* __restrict atlas;  // Owning atlas pointer.
     struct TCOD_Console* __restrict cache_console;  // Tracks the data from the last console presented.
     struct SDL_Texture* __restrict cache_texture;  // Cached console rendering output.
     uint32_t sdl_subsystems;  // Which subsystems where initialzed by this context.
     // Mouse cursor transform values of the last viewport used.
     TCOD_MouseTransform cursor_transform;
   };
   #ifdef __cplusplus
   extern "C" {
   #endif  // __cplusplus
   
   TCOD_PUBLIC TCOD_NODISCARD struct TCOD_Context* TCOD_renderer_init_sdl2(
       int x, int y, int width, int height, const char* title, int window_flags, int vsync, struct TCOD_Tileset* tileset);
   
   TCOD_PUBLIC TCOD_NODISCARD TCOD_Context* TCOD_renderer_init_sdl3(
       SDL_PropertiesID window_props, SDL_PropertiesID renderer_props, struct TCOD_Tileset* tileset);
   TCOD_PUBLIC TCOD_NODISCARD struct TCOD_TilesetAtlasSDL2* TCOD_sdl2_atlas_new(
       struct SDL_Renderer* renderer, struct TCOD_Tileset* tileset);
   TCOD_PUBLIC void TCOD_sdl2_atlas_delete(struct TCOD_TilesetAtlasSDL2* atlas);
   TCOD_PUBLIC TCOD_Error TCOD_sdl2_render_texture_setup(
       const struct TCOD_TilesetAtlasSDL2* __restrict atlas,
       const struct TCOD_Console* __restrict console,
       struct TCOD_Console* __restrict* cache,
       struct SDL_Texture* __restrict* target);
   TCOD_PUBLIC TCOD_Error TCOD_sdl2_render_texture(
       const struct TCOD_TilesetAtlasSDL2* __restrict atlas,
       const struct TCOD_Console* __restrict console,
       struct TCOD_Console* __restrict cache,
       struct SDL_Texture* __restrict target);
   #ifdef __cplusplus
   }  // extern "C"
   #endif  // __cplusplus
   #endif  // NO_SDL
   #endif  // LIBTCOD_RENDERER_SDL2_H_