src/palette_func.h

   1 /*
   2  * This file is part of OpenTTD.
   3  * OpenTTD is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, version 2.
   4  * OpenTTD is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
   5  * See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with OpenTTD. If not, see <http://www.gnu.org/licenses/>.
   6  */
   7
   8 /** @file palette_func.h Functions related to palettes. */
   9
  10 #ifndef PALETTE_FUNC_H
  11 #define PALETTE_FUNC_H
  12
  13 #include "core/enum_type.hpp"
  14 #include "gfx_type.h"
  15 #include "strings_type.h"
  16 #include "string_type.h"
  17
  18 extern Palette _cur_palette; ///< Current palette
  19
  20 bool CopyPalette(Palette &local_palette, bool force_copy = false);
  21 void GfxInitPalettes();
  22
  23 uint8_t GetNearestColourIndex(uint8_t r, uint8_t g, uint8_t b);
  24
  25 inline uint8_t GetNearestColourIndex(const Colour colour)
  26 {
  27         return GetNearestColourIndex(colour.r, colour.g, colour.b);
  28 }
  29
  30 /**
  31  * Checks if a Colours value is valid.
  32  *
  33  * @param colours The value to check
  34  * @return true if the given value is a valid Colours.
  35  */
  36 inline bool IsValidColours(Colours colours)
  37 {
  38         return colours < COLOUR_END;
  39 }
  40
  41 TextColour GetContrastColour(uint8_t background, uint8_t threshold = 128);
  42
  43 enum ColourShade : uint8_t {
  44         SHADE_BEGIN = 0,
  45         SHADE_DARKEST = SHADE_BEGIN,
  46         SHADE_DARKER,
  47         SHADE_DARK,
  48         SHADE_NORMAL,
  49         SHADE_LIGHT,
  50         SHADE_LIGHTER,
  51         SHADE_LIGHTEST,
  52         SHADE_LIGHTEREST,
  53         SHADE_END,
  54 };
  55 DECLARE_POSTFIX_INCREMENT(ColourShade)
  56
  57 uint8_t GetColourGradient(Colours colour, ColourShade shade);
  58 void SetColourGradient(Colours colour, ColourShade shade, uint8_t palette_colour);
  59
  60 /**
  61  * Return the colour for a particular greyscale level.
  62  * @param level Intensity, 0 = black, 15 = white
  63  * @return colour
  64  */
  65 #define GREY_SCALE(level) (level)
  66
  67 static const uint8_t PC_BLACK              = GREY_SCALE(1);  ///< Black palette colour.
  68 static const uint8_t PC_DARK_GREY          = GREY_SCALE(6);  ///< Dark grey palette colour.
  69 static const uint8_t PC_GREY               = GREY_SCALE(10); ///< Grey palette colour.
  70 static const uint8_t PC_WHITE              = GREY_SCALE(15); ///< White palette colour.
  71
  72 static const uint8_t PC_VERY_DARK_RED      = 0xB2;           ///< Almost-black red palette colour.
  73 static const uint8_t PC_DARK_RED           = 0xB4;           ///< Dark red palette colour.
  74 static const uint8_t PC_RED                = 0xB8;           ///< Red palette colour.
  75
  76 static const uint8_t PC_VERY_DARK_BROWN    = 0x56;           ///< Almost-black brown palette colour.
  77
  78 static const uint8_t PC_ORANGE             = 0xC2;           ///< Orange palette colour.
  79
  80 static const uint8_t PC_YELLOW             = 0xBF;           ///< Yellow palette colour.
  81 static const uint8_t PC_LIGHT_YELLOW       = 0x44;           ///< Light yellow palette colour.
  82 static const uint8_t PC_VERY_LIGHT_YELLOW  = 0x45;           ///< Almost-white yellow palette colour.
  83
  84 static const uint8_t PC_GREEN              = 0xD0;           ///< Green palette colour.
  85
  86 static const uint8_t PC_VERY_DARK_BLUE     = 0x9A;           ///< Almost-black blue palette colour.
  87 static const uint8_t PC_DARK_BLUE          = 0x9D;           ///< Dark blue palette colour.
  88 static const uint8_t PC_LIGHT_BLUE         = 0x98;           ///< Light blue palette colour.
  89
  90 static const uint8_t PC_ROUGH_LAND         = 0x52;           ///< Dark green palette colour for rough land.
  91 static const uint8_t PC_GRASS_LAND         = 0x54;           ///< Dark green palette colour for grass land.
  92 static const uint8_t PC_BARE_LAND          = 0x37;           ///< Brown palette colour for bare land.
  93 static const uint8_t PC_RAINFOREST         = 0x5C;           ///< Pale green palette colour for rainforest.
  94 static const uint8_t PC_FIELDS             = 0x25;           ///< Light brown palette colour for fields.
  95 static const uint8_t PC_TREES              = 0x57;           ///< Green palette colour for trees.
  96 static const uint8_t PC_WATER              = 0xC9;           ///< Dark blue palette colour for water.
  97
  98 #endif /* PALETTE_FUNC_H */