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 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181
|
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<reference xml:id="class.ui-draw-color" role="class" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:xi="http://www.w3.org/2001/XInclude">
<title>Color Representation</title>
<titleabbrev>UI\Draw\Color</titleabbrev>
<partintro>
<!-- {{{ UI\Draw\Color intro -->
<section xml:id="ui-draw-color.intro">
&reftitle.intro;
<para>
Represents RGBA colours, individual channels are accessible via public properties.
</para>
</section>
<!-- }}} -->
<section xml:id="ui-draw-color.synopsis">
&reftitle.classsynopsis;
<!-- {{{ Synopsis -->
<classsynopsis>
<ooclass><classname>UI\Draw\Color</classname></ooclass>
<!-- {{{ Class synopsis -->
<classsynopsisinfo>
<ooclass>
<classname>UI\Draw\Color</classname>
</ooclass>
</classsynopsisinfo>
<!-- }}} -->
<classsynopsisinfo role="comment">&Constants;</classsynopsisinfo>
<fieldsynopsis>
<modifier>const</modifier>
<type>int</type>
<varname linkend="ui-draw-color.constants.red">UI\Draw\Color::Red</varname>
</fieldsynopsis>
<fieldsynopsis>
<modifier>const</modifier>
<type>int</type>
<varname linkend="ui-draw-color.constants.green">UI\Draw\Color::Green</varname>
</fieldsynopsis>
<fieldsynopsis>
<modifier>const</modifier>
<type>int</type>
<varname linkend="ui-draw-color.constants.blue">UI\Draw\Color::Blue</varname>
</fieldsynopsis>
<fieldsynopsis>
<modifier>const</modifier>
<type>int</type>
<varname linkend="ui-draw-color.constants.alpha">UI\Draw\Color::Alpha</varname>
</fieldsynopsis>
<classsynopsisinfo role="comment">&Properties;</classsynopsisinfo>
<fieldsynopsis>
<modifier>public</modifier>
<varname linkend="ui-draw-color.props.r">r</varname>
</fieldsynopsis>
<fieldsynopsis>
<modifier>public</modifier>
<varname linkend="ui-draw-color.props.g">g</varname>
</fieldsynopsis>
<fieldsynopsis>
<modifier>public</modifier>
<varname linkend="ui-draw-color.props.b">b</varname>
</fieldsynopsis>
<fieldsynopsis>
<modifier>public</modifier>
<varname linkend="ui-draw-color.props.a">a</varname>
</fieldsynopsis>
<classsynopsisinfo role="comment">Constructor</classsynopsisinfo>
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.ui-draw-color')/db:refentry/db:refsect1[@role='description']/descendant::db:constructorsynopsis[not(@role='procedural')])" />
<classsynopsisinfo role="comment">&Methods;</classsynopsisinfo>
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.ui-draw-color')/db:refentry/db:refsect1[@role='description']/descendant::db:methodsynopsis[not(@role='procedural')])" />
</classsynopsis>
<!-- }}} -->
</section>
<!-- {{{ UI\Draw\Color properties -->
<section xml:id="ui-draw-color.props">
&reftitle.properties;
<variablelist>
<varlistentry xml:id="ui-draw-color.props.r">
<term><varname>r</varname></term>
<listitem>
<para>Provides access to the red channel</para>
</listitem>
</varlistentry>
<varlistentry xml:id="ui-draw-color.props.g">
<term><varname>g</varname></term>
<listitem>
<para>Provides access to the green channel</para>
</listitem>
</varlistentry>
<varlistentry xml:id="ui-draw-color.props.b">
<term><varname>b</varname></term>
<listitem>
<para>Provides access to the blue channel</para>
</listitem>
</varlistentry>
<varlistentry xml:id="ui-draw-color.props.a">
<term><varname>a</varname></term>
<listitem>
<para>Provides access to the alpha channel</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<!-- }}} -->
<!-- {{{ UI\Draw\Color constants -->
<section xml:id="ui-draw-color.constants">
&reftitle.constants;
<variablelist>
<varlistentry xml:id="ui-draw-color.constants.red">
<term><constant>UI\Draw\Color::Red</constant></term>
<listitem>
<para>Identifies the red channel</para>
</listitem>
</varlistentry>
<varlistentry xml:id="ui-draw-color.constants.green">
<term><constant>UI\Draw\Color::Green</constant></term>
<listitem>
<para>Identifies the green channel</para>
</listitem>
</varlistentry>
<varlistentry xml:id="ui-draw-color.constants.blue">
<term><constant>UI\Draw\Color::Blue</constant></term>
<listitem>
<para>Identifies the blue channel</para>
</listitem>
</varlistentry>
<varlistentry xml:id="ui-draw-color.constants.alpha">
<term><constant>UI\Draw\Color::Alpha</constant></term>
<listitem>
<para>Identifies the alpha channel</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<!-- }}} -->
</partintro>
&reference.ui.ui.draw.entities.color;
</reference>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"~/.phpdoc/manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->
|