documentation: Breaking the API Reference documentation ice
[sdk] / doc / ecere / ecere / gfx / Color.econ
1 {
2    name = "Color",
3    description = "A 32 bit bit class representing Red, Green and Blue from 0..255, with Blue stored in LSB.",
4    usage = "Used in the declaration section of code.",
5    example = "Color red = { r = 255 }; // High intensity red.\n"
6       "Color yellow = { 0xFFFF00 }; // High intensity yellow. r = 0xFF(255), g = 0xFF(255), b = 0x00(0)",
7    also = "Color444, Color555, Color565, ColorAlpha, ColorCMYK, ColorHSV, ColorKey, ColorLab, ColorRGB, ColorRGBA, DefinedColor, PixelFormat, SystemColor",
8    fields = [
9       {
10          "b",
11          {
12             description = "The green component of the color. A value between 0 and 255(0x0 and 0xFF)."
13          }
14       },
15       {
16          "g",
17          {
18             description = "The green component of the color. A value between 0 and 255(0x0 and 0xFF)."
19          }
20       },
21       {
22          "r",
23          {
24             description = "The red component of the color. A value between 0 and 255(0x0 and 0xFF)."
25          }
26       }
27    ],
28    conversions = [
29       {
30          "ColorRGB",
31          {
32             description = "Enables the conversion from the Color type, to the ColorRGB type where each color element is stored as a floating point number."
33          }
34       }
35    ]
36 }