Skip to content
Permalink
Browse files

Colour functions and en-US help files implemented.

  • Loading branch information
ccrook committed Apr 15, 2013
1 parent 4cb0ae5 commit 0e696a3befd894df281e23717ea616c79b1bc41b
@@ -0,0 +1,3 @@

<h3>Color Group</h3>
This group contains functions for manipulating colors
@@ -0,0 +1,16 @@

<h3>color_rgb() function</h3>
Returns a string representation of a color based on its red, green, and blue components

<p><h4>Syntax</h4>
color_rgb(<i>red, green, blue</i>)</p>

<p><h4>Arguments</h4>
<!-- List args for functions here-->
<i> red</i> &rarr; the red component as an integer value from 0 to 255.<br>
<i> green</i> &rarr; the green component as an integer value from 0 to 255.<br>
<i> blue</i> &rarr; the blue component as an integer value from 0 to 255.<br>

<p><h4>Example</h4>
<!-- Show example of function.-->
color_rgb(255,127,0) &rarr; '#ff7f00'</p>
@@ -0,0 +1,17 @@

<h3>color_rgba() function</h3>
Returns a string representation of a color based on its red, green, blue, and alpha (transparency) components

<p><h4>Syntax</h4>
color_rgba(<i>red, green, blue, alpha</i>)</p>

<p><h4>Arguments</h4>
<!-- List args for functions here-->
<i> red</i> &rarr; the red component as an integer value from 0 to 255.<br>
<i> green</i> &rarr; the green component as an integer value from 0 to 255.<br>
<i> blue</i> &rarr; the blue component as an integer value from 0 to 255.<br>
<i> alpha</i> &rarr; the alpha component as an integer value from 0 (completely transparent) to 255 (opaque).<br>

<p><h4>Example</h4>
<!-- Show example of function.-->
color_rgba(255,127,0,200) &rarr; '255,127,0,200'</p>
@@ -0,0 +1,15 @@

<h3>ramp_color() function</h3>
Returns a string representing a color from a color ramp.

<p><h4>Syntax</h4>
ramp_color(<i>ramp_name,value</i>)</p>

<p><h4>Arguments</h4>
<!-- List args for functions here-->
<i> ramp_name</i> &rarr; the name of the color ramp as a string, for example 'Spectral'.<br>
<i> value</i> &rarr; the position on the ramp to select the color from as a real number between 0 and 1.<br>

<p><h4>Example</h4>
<!-- Show example of function.-->
ramp_color('Spectral',0.3) &rarr; '#fdbe73'</p>

0 comments on commit 0e696a3

Please sign in to comment.
You can’t perform that action at this time.