This repository has been archived on 2023-07-11. You can view files and clone it, but cannot push or open issues or pull requests.
BWMirror-Generator/bwapi-master/Color.h
2014-08-05 10:43:14 +02:00

49 lines
1.3 KiB
C++

#pragma once
#include <string>
#include <set>
#include "Type.h"
namespace BWAPI
{
// TODO: Add color palette image and info about text color
/** StarCraft uses a 256 color palette to render everything, so the colors we can use to draw shapes using
* BWAPI is limited to the colors available in the Palette. */
class Color : public Type
{
public:
Color();
/** Create a color using the specified index from the Broodwar color palette. */
Color(int id);
/** Create a color using the color in the palette that is closest to the RGB color specified. */
Color(int red, int green, int blue);
/** Return the red component of the color. */
int red() const;
/** Return the green component of the color. */
int green() const;
/** Return the blue component of the color. */
int blue() const;
};
/** While any color from the palette can be used, the following colors are available as short cuts. */
namespace Colors
{
void init();
extern const Color Red;
extern const Color Blue;
extern const Color Teal;
extern const Color Purple;
extern const Color Orange;
extern const Color Brown;
extern const Color White;
extern const Color Yellow;
extern const Color Green;
extern const Color Cyan;
extern const Color Black;
extern const Color Grey;
}
}