.. _program_listing_file_libtcod_console_drawing.h:

Program Listing for File console_drawing.h
==========================================

|exhale_lsh| :ref:`Return to documentation for file <file_libtcod_console_drawing.h>` (``libtcod/console_drawing.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 TCOD_CONSOLE_DRAWING_H_
   #define TCOD_CONSOLE_DRAWING_H_
   #ifdef __cplusplus
   #include <array>
   #include <optional>
   #endif  // __cplusplus
   #include "config.h"
   #include "console_types.h"
   #ifdef __cplusplus
   extern "C" {
   #endif  // __cplusplus
   TCOD_DEPRECATED("Use TCOD_console_draw_rect_rgb instead.")
   TCOD_PUBLIC void TCOD_console_rect(TCOD_Console* con, int x, int y, int rw, int rh, bool clear, TCOD_bkgnd_flag_t flag);
   TCOD_DEPRECATED("Use TCOD_console_draw_rect_rgb instead.")
   TCOD_PUBLIC void TCOD_console_hline(TCOD_Console* con, int x, int y, int l, TCOD_bkgnd_flag_t flag);
   TCOD_DEPRECATED("Use TCOD_console_draw_rect_rgb instead.")
   TCOD_PUBLIC void TCOD_console_vline(TCOD_Console* con, int x, int y, int l, TCOD_bkgnd_flag_t flag);
   // Next functions are provisional unless given an added version.
   TCOD_PUBLIC void TCOD_console_put_rgb(
       TCOD_Console* __restrict console,
       int x,
       int y,
       int ch,
       const TCOD_color_t* fg,
       const TCOD_color_t* bg,
       TCOD_bkgnd_flag_t flag);
   TCOD_PUBLIC TCOD_Error TCOD_console_draw_rect_rgb(
       TCOD_Console* __restrict console,
       int x,
       int y,
       int width,
       int height,
       int ch,
       const TCOD_color_t* fg,
       const TCOD_color_t* bg,
       TCOD_bkgnd_flag_t flag);
   TCOD_PUBLIC TCOD_Error TCOD_console_draw_frame_rgb(
       struct TCOD_Console* __restrict con,
       int x,
       int y,
       int width,
       int height,
       const int* __restrict decoration,
       const TCOD_ColorRGB* __restrict fg,
       const TCOD_ColorRGB* __restrict bg,
       TCOD_bkgnd_flag_t flag,
       bool clear);
   #ifdef __cplusplus
   }  // extern "C"
   namespace tcod {
   
   inline void draw_rect(
       TCOD_Console& console,
       const std::array<int, 4>& rect,
       int ch,
       std::optional<TCOD_ColorRGB> fg,
       std::optional<TCOD_ColorRGB> bg,
       TCOD_bkgnd_flag_t flag = TCOD_BKGND_SET) {
     const TCOD_ColorRGB* fg_ptr = fg ? &fg.value() : nullptr;
     const TCOD_ColorRGB* bg_ptr = bg ? &bg.value() : nullptr;
     tcod::check_throw_error(
         TCOD_console_draw_rect_rgb(&console, rect.at(0), rect.at(1), rect.at(2), rect.at(3), ch, fg_ptr, bg_ptr, flag));
   }
   
   inline void draw_frame(
       TCOD_Console& console,
       const std::array<int, 4>& rect,
       const std::array<int, 9>& decoration,
       std::optional<TCOD_ColorRGB> fg,
       std::optional<TCOD_ColorRGB> bg,
       TCOD_bkgnd_flag_t flag = TCOD_BKGND_SET,
       bool clear = true) {
     const TCOD_ColorRGB* fg_ptr = fg ? &fg.value() : nullptr;
     const TCOD_ColorRGB* bg_ptr = bg ? &bg.value() : nullptr;
     tcod::check_throw_error(TCOD_console_draw_frame_rgb(
         &console, rect.at(0), rect.at(1), rect.at(2), rect.at(3), decoration.data(), fg_ptr, bg_ptr, flag, clear));
   }
   }  // namespace tcod
   #endif  // __cplusplus
   #endif  // TCOD_CONSOLE_DRAWING_H_