Files
StorytellersBestFriend/sbf-cpp/Colors.h
Tom Hicks 5501de76e2 Adds doxygen comments to SBF namespace.
Adds doxygen header to header files.
2023-04-16 04:08:33 -07:00

46 lines
1.5 KiB
C++

#ifndef COLORS_H__
#define COLORS_H__
/***************************************************************************************
* @file Colors.h
*
* @brief Defines constants and functions for working with screen colors.
* @copyright
* Copyright 2023 Tom Hicks
* Licensed under the MIT license see the LICENSE file for details.
***************************************************************************************/
#include <cstdint>
#include <vector>
/** \addtogroup Abilities
* @{
*/
namespace SBF {
const uint8_t kColorDarkBlack = 0;
const uint8_t kColorDarkBlue = 1;
const uint8_t kColorDarkGreen = 2;
const uint8_t kColorDarkCyan = 3;
const uint8_t kColorDarkRed = 4;
const uint8_t kColorDarkMagenta = 5;
const uint8_t kColorDarkOrange = 6;
const uint8_t kColorDarkYellow = 6;
const uint8_t kColorDarkWhite = 7;
const uint8_t kColorBrightBlack = 8;
const uint8_t kColorBrightBlue = 9;
const uint8_t kColorBrightGreen = 10;
const uint8_t kColorBrightCyan = 11;
const uint8_t kColorBrightRed = 12;
const uint8_t kColorBrightMagenta = 13;
const uint8_t kColorBrightOrange = 14;
const uint8_t kColorBrightYellow = 14;
const uint8_t kColorBrightWhite = 15;
void SetForegroundColor(uint8_t foregroundColor);
uint8_t GetForegroundColor();
// TODO: Make this an ncurses color pair
uint16_t GetColor();
void FillColors(std::vector<uint8_t> colors);
} // End namespace SBF
/** @}*/
#endif // End !defined COLORS_H__