1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transistional//EN"><html><head><title>OpenLayer Offline Manual</title><style type="text/css" media="all">@import "CrystalStyle.css";</style><body bgcolor="FFFFFF" ><div align="center" style="pagestyle"><table width="60%"><tr><td><div class="parentLinks"><a href="index.html">OpenLayer</a> | <a href="Rgba.html">Rgba</a></div><br><div class="BigHeader">Rgba</div><br><div class="">The color structure which holds the 4 color components: Red, green, blue and alpha components.
<br>
<br><div class="Surrounded"><table><tr valign="top"><td align="right"><div class="FuncDef"><strong><a href="Rgba.html"><font color="#0000CC">Rgba</font></a>(</strong></div></td><td><div class="FuncDef"><strong><font color="#777733">float</font> r, <font color="#777733">float</font> g, <font color="#777733">float</font> b, <font color="#777733">float</font> a = <font color="#994400">1.0</font> );
<br></strong></div></td></tr></table>
<br>Construct the color from floating-point color components. The values should be between 0.0 and 1.0.
<br></div>
<br><div class="Surrounded"><table><tr valign="top"><td align="right"><div class="FuncDef"><strong><a href="Rgba.html"><font color="#0000CC">Rgba</font></a>(</strong></div></td><td><div class="FuncDef"><strong><font color="#777733">double</font> r, <font color="#777733">double</font> g, <font color="#777733">double</font> b, <font color="#777733">double</font> a = <font color="#994400">1.0</font> );
<br></strong></div></td></tr></table>
<br>Construct the color from double color components. The values should be between 0.0 and 1.0.
<br></div>
<br><div class="Surrounded"><table><tr valign="top"><td align="right"><div class="FuncDef"><strong><a href="Rgba.html"><font color="#0000CC">Rgba</font></a>(</strong></div></td><td><div class="FuncDef"><strong><font color="#777733">int</font> r, <font color="#777733">int</font> g, <font color="#777733">int</font> b, <font color="#777733">int</font> a = <font color="#994400">255</font> );
<br></strong></div></td></tr></table>
<br>Construct the color from integer color components. The values should be between 0 and 255.
<br></div>
<br><div class="Surrounded"><table><tr valign="top"><td align="right"><div class="FuncDef"><strong><a href="Rgba.html"><font color="#0000CC">Rgba</font></a>(</strong></div></td><td><div class="FuncDef"><strong><font color="#777733">int</font> col, <font color="#777733">int</font> a );
<br></strong></div></td></tr></table>
<br>Construct the color from a 24-bit packed color value and an integer alpha value. The alpha value should be between 0 and 255.
<br></div>
<br><div class="Surrounded"><table><tr valign="top"><td align="right"><div class="FuncDef"><strong>Public fields
<br></strong></div></td></tr></table>float r, g, b, a - The color components
<br></div>
<br>With the default blender the alpha value of the color tells the opacity of the color. This way you can have translucency where ever an Rgba color is needed. The higher the alpha value, the more visible the color is. With the maxium value the color is totally visible and with the minium value the color is totally transparent.
<br>
<br>Notice that in most constructors you don't have to pass the alpha value if you want the color to be totally opaque.
<br>
<br>There are several color constants to use:
<br><div class="Surrounded"><table><tr valign="top"><td align="right"><div class="FuncDef"><strong><font color="#777733">static</font> <a href="Rgba.html"><font color="#0000CC">Rgba</font></a> BLACK, WHITE, RED, YELLOW, GREEN, BLUE, INVISIBLE;
<br></strong></div></td></tr></table>
<br>The color constants.
<br></div>
<br>All constant colors are totally opaque except Rgba::INVISIBLE, which is totally transparent. The name INVISIBLE is used instead of TRANSPARENT because TRANSPARENT seems to be a reserved name. If you can think of a better name then let me know!</div><br><div class="MediumHeader">Examples</div><br><div class="Code"><font color="#999922">// Create a pure white color using float color components //</font>
<br><font color="#999922">// (same as Rgba::WHITE) //</font>
<br><a href="Rgba.html"><font color="#0000CC">Rgba</font></a> white( <font color="#994400">1.0</font>, <font color="#994400">1.0</font>, <font color="#994400">1.0</font> );
<br>
<br><font color="#999922">// Create a pure white color using integer color components //</font>
<br><font color="#999922">// (same as Rgba::WHITE) //</font>
<br><a href="Rgba.html"><font color="#0000CC">Rgba</font></a> white( <font color="#994400">255</font>, <font color="#994400">255</font>, <font color="#994400">255</font> );
<br>
<br><font color="#999922">// Create a pure black color (same as Rgba::BLACK) //</font>
<br><a href="Rgba.html"><font color="#0000CC">Rgba</font></a> black( <font color="#994400">0.0</font>, <font color="#994400">0.0</font>, <font color="#994400">0.0</font> );
<br>
<br><font color="#999922">// Create a medium gray color //</font>
<br><a href="Rgba.html"><font color="#0000CC">Rgba</font></a> gray( <font color="#994400">0.5</font>, <font color="#994400">0.5</font>, <font color="#994400">0.5</font> );
<br>
<br><font color="#999922">// Create a pure red color (same as Rgba::RED) //</font>
<br><a href="Rgba.html"><font color="#0000CC">Rgba</font></a> red( <font color="#994400">1.0</font>, <font color="#994400">0.0</font>, <font color="#994400">0.0</font> );
<br>
<br><font color="#999922">// Create a pure green color (same as Rgba::GREEN) //</font>
<br><a href="Rgba.html"><font color="#0000CC">Rgba</font></a> green( <font color="#994400">0.0</font>, <font color="#994400">1.0</font>, <font color="#994400">0.0</font> );
<br>
<br><font color="#999922">// Create a pure blue color (same as Rgba::BLUE) //</font>
<br><a href="Rgba.html"><font color="#0000CC">Rgba</font></a> blue( <font color="#994400">0.0</font>, <font color="#994400">0.0</font>, <font color="#994400">1.0</font> );
<br>
<br><font color="#999922">// Create a yellow color (same as Rgba::YELLOW) //</font>
<br><a href="Rgba.html"><font color="#0000CC">Rgba</font></a> yellow( <font color="#994400">1.0</font>, <font color="#994400">1.0</font>, <font color="#994400">0.0</font> );
<br>
<br><font color="#999922">// Create a dark yellow color //</font>
<br><a href="Rgba.html"><font color="#0000CC">Rgba</font></a> yellowDark( <font color="#994400">0.3</font>, <font color="#994400">0.3</font>, <font color="#994400">0.0</font> )
<br>
<br><font color="#999922">// Create a 50% opaque bright yellow color //</font>
<br><a href="Rgba.html"><font color="#0000CC">Rgba</font></a> yellowTranslucent( <font color="#994400">1.0</font>, <font color="#994400">1.0</font>, <font color="#994400">0.0</font>, <font color="#994400">0.50</font> );
<br>
<br><font color="#999922">// Create a 20% opaque (almost transparent) cyan color //</font>
<br><a href="Rgba.html"><font color="#0000CC">Rgba</font></a> cyanTranslucent( <font color="#994400">0.0</font>, <font color="#994400">1.0</font>, <font color="#994400">1.0</font>, <font color="#994400">0.20</font> );
<br>
<br><font color="#999922">// Create an transparent color (same as Rgba::INVISIBLE) //</font>
<br><font color="#999922">// It doesn't matter what you pass as the red, green and blue components //</font>
<br><font color="#999922">// as the color will be totally transparent anyways //</font>
<br><a href="Rgba.html"><font color="#0000CC">Rgba</font></a> transparentColor( <font color="#994400">1.0</font>, <font color="#994400">1.0</font>, <font color="#994400">1.0</font>, <font color="#994400">0.0</font> );</div><div class=""><br><br><div class="MediumHeader">Member functions</div><div class="Surrounded"><table size="100%" cellpadding="0" cellspacing="0"><tr><td halign="center" class="funclist"><a href="Rgba/MixWith.html">MixWith</a></td><td width="65%" halign="center"><div class="smalltext">Mixes two colors together with the given factor</div></td></tr><tr><td halign="center" class="funclist"><a href="Rgba/WithAlpha.html">WithAlpha</a></td><td width="65%" halign="center"><div class="smalltext">Creates a new color with the same color components but a different alpha value</div></td></tr><tr><td colspan="2"><br><div class="SmallHeader"><font color="#775500">Advanced functions</font></div><br></td></tr><tr><td halign="center" class="funclist"><a href="Rgba/Packed.html">Packed</a></td><td width="65%" halign="center"><div class="smalltext">Returns the color packed in an integer</div></td></tr><tr><td halign="center" class="funclist"><a href="Rgba/Select.html">Select</a></td><td width="65%" halign="center"><div class="smalltext">Selects the color as the active OpenGL color</div></td></tr></table></div><br><div class=""><a href="index.html">Back to the main page of the manual</a></div><br>Questions about Rgba? Click <a href="http://crystalstorm.ath.cx/index.php?lan=en&page=CreateFeedback&subject=Rgba">here.</a></div></td></tr></table></body></html>
|
