palette_func.h

Go to the documentation of this file.

/*
 * This file is part of OpenTTD.
 * 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.
 * 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.
 * 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/>.
 */
 
#ifndef PALETTE_FUNC_H
#define PALETTE_FUNC_H
 
#include "core/enum_type.hpp"
#include "gfx_type.h"
#include "strings_type.h"
#include "string_type.h"
 
extern Palette _cur_palette; 
 
bool CopyPalette(Palette &local_palette, bool force_copy = false);
void GfxInitPalettes();
 
uint8_t GetNearestColourIndex(uint8_t r, uint8_t g, uint8_t b);
uint8_t GetNearestColourReshadeIndex(uint8_t b);
 
inline uint8_t GetNearestColourIndex(const Colour colour)
{
  return GetNearestColourIndex(colour.r, colour.g, colour.b);
}
 
static constexpr int DEFAULT_BRIGHTNESS = 128;
 
Colour ReallyAdjustBrightness(Colour colour, int brightness);
 
static inline Colour AdjustBrightness(Colour colour, uint8_t brightness)
{
  /* Shortcut for normal brightness */
  if (brightness == DEFAULT_BRIGHTNESS) return colour;
 
  return ReallyAdjustBrightness(colour, brightness);
}
 
static inline uint8_t GetColourBrightness(Colour colour)
{
  uint8_t rgb_max = std::max(colour.r, std::max(colour.g, colour.b));
 
  /* Black pixel (8bpp or old 32bpp image), so use default value */
  if (rgb_max == 0) rgb_max = DEFAULT_BRIGHTNESS;
 
  return rgb_max;
}
 
inline bool IsValidColours(Colours colours)
{
  return colours < COLOUR_END;
}
 
TextColour GetContrastColour(uint8_t background, uint8_t threshold = 128);
 
enum ColourShade : uint8_t {
  SHADE_BEGIN = 0,
  SHADE_DARKEST = SHADE_BEGIN,
  SHADE_DARKER,
  SHADE_DARK,
  SHADE_NORMAL,
  SHADE_LIGHT,
  SHADE_LIGHTER,
  SHADE_LIGHTEST,
  SHADE_LIGHTEREST,
  SHADE_END,
};
DECLARE_INCREMENT_DECREMENT_OPERATORS(ColourShade)
 
uint8_t GetColourGradient(Colours colour, ColourShade shade);
void SetColourGradient(Colours colour, ColourShade shade, uint8_t palette_colour);
 
#define GREY_SCALE(level) (level)
 
static const uint8_t PC_BLACK              = GREY_SCALE(1);  
static const uint8_t PC_DARK_GREY          = GREY_SCALE(6);  
static const uint8_t PC_GREY               = GREY_SCALE(10); 
static const uint8_t PC_WHITE              = GREY_SCALE(15); 
 
static const uint8_t PC_VERY_DARK_RED      = 0xB2;           
static const uint8_t PC_DARK_RED           = 0xB4;           
static const uint8_t PC_RED                = 0xB8;           
 
static const uint8_t PC_VERY_DARK_BROWN    = 0x56;           
 
static const uint8_t PC_ORANGE             = 0xC2;           
 
static const uint8_t PC_YELLOW             = 0xBF;           
static const uint8_t PC_LIGHT_YELLOW       = 0x44;           
static const uint8_t PC_VERY_LIGHT_YELLOW  = 0x45;           
 
static const uint8_t PC_GREEN              = 0xD0;           
 
static const uint8_t PC_VERY_DARK_BLUE     = 0x9A;           
static const uint8_t PC_DARK_BLUE          = 0x9D;           
static const uint8_t PC_LIGHT_BLUE         = 0x98;           
 
static const uint8_t PC_ROUGH_LAND         = 0x52;           
static const uint8_t PC_GRASS_LAND         = 0x54;           
static const uint8_t PC_BARE_LAND          = 0x37;           
static const uint8_t PC_RAINFOREST         = 0x5C;           
static const uint8_t PC_FIELDS             = 0x25;           
static const uint8_t PC_TREES              = 0x57;           
static const uint8_t PC_WATER              = 0xC9;           
 
#endif /* PALETTE_FUNC_H */