<?xml version="1.0" encoding="iso-8859-1"?> <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en"> <head> <title>Class: Imlib2::Color::HsvaColor</title> <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" /> <meta http-equiv="Content-Script-Type" content="text/javascript" /> <link rel="stylesheet" href="../../.././rdoc-style.css" type="text/css" media="screen" /> <script type="text/javascript"> // <![CDATA[ function popupCode( url ) { window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=150,width=400") } function toggleCode( id ) { if ( document.getElementById ) elem = document.getElementById( id ); else if ( document.all ) elem = eval( "document.all." + id ); else return false; elemStyle = elem.style; if ( elemStyle.display != "block" ) { elemStyle.display = "block" } else { elemStyle.display = "none" } return true; } // Make codeblocks hidden by default document.writeln( "<style type=\"text/css\">div.method-source-code { display: none }</style>" ) // ]]> </script> </head> <body> <div id="classHeader"> <table class="header-table"> <tr class="top-aligned-row"> <td><strong>Class</strong></td> <td class="class-name-in-header">Imlib2::Color::HsvaColor</td> </tr> <tr class="top-aligned-row"> <td><strong>In:</strong></td> <td> <a href="../../../files/imlib2_c.html"> imlib2.c </a> (<a href="http://cvs.pablotron.org/cgi-bin/viewcvs.cgi/imlib2-ruby/imlib2.c">CVS</a>) <br /> </td> </tr> <tr class="top-aligned-row"> <td><strong>Parent:</strong></td> <td> Object </td> </tr> </table> </div> <!-- banner header --> <div id="bodyContent"> <div id="contextContent"> </div> <div id="method-list"> <h3 class="section-bar">Methods</h3> <div class="name-list"> <a href="#M000023">[]</a> <a href="#M000024">[]=</a> <a href="#M000037">a</a> <a href="#M000038">a=</a> <a href="#M000039">alpha</a> <a href="#M000040">alpha=</a> <a href="#M000025">h</a> <a href="#M000026">h=</a> <a href="#M000027">hue</a> <a href="#M000028">hue=</a> <a href="#M000022">new</a> <a href="#M000021">new</a> <a href="#M000029">s</a> <a href="#M000030">s=</a> <a href="#M000031">saturation</a> <a href="#M000032">saturation=</a> <a href="#M000033">v</a> <a href="#M000034">v=</a> <a href="#M000035">value</a> <a href="#M000036">value=</a> </div> </div> </div> <!-- if includes --> <div id="section"> <!-- if method_list --> <div id="methods"> <h3 class="section-bar">Public Class methods</h3> <div id="method-M000022" class="method-detail"> <a name="M000022"></a> <div class="method-heading"> <a href="HsvaColor.src/M000022.html" target="Code" class="method-signature" onclick="popupCode('HsvaColor.src/M000022.html');return false;"> <span class="method-name">new</span><span class="method-args">(...)</span> </a> </div> <div class="method-description"> <p> <a href="HsvaColor.html">Imlib2::Color::HsvaColor</a> constructor. </p> <p> Parameters are identical to Imlib2::Color::HsvaColor::new. </p> </div> </div> <div id="method-M000021" class="method-detail"> <a name="M000021"></a> <div class="method-heading"> <a href="HsvaColor.src/M000021.html" target="Code" class="method-signature" onclick="popupCode('HsvaColor.src/M000021.html');return false;"> <span class="method-name">new</span><span class="method-args">(...)</span> </a> </div> <div class="method-description"> <p> Returns a new <a href="HsvaColor.html">Imlib2::Color::HsvaColor</a>. </p> <p> Examples: </p> <pre> h, s, v, a = 255, 0, 0, 255 border = Imlib2::Color::HsvaColor.new h, s, v, a values = [255, 0, 0, 255] border = Imlib2::Color::HsvaColor.new values </pre> </div> </div> <h3 class="section-bar">Public Instance methods</h3> <div id="method-M000023" class="method-detail"> <a name="M000023"></a> <div class="method-heading"> <span class="method-name">[]</span><span class="method-args">()</span> </div> <div class="method-description"> </div> </div> <div id="method-M000024" class="method-detail"> <a name="M000024"></a> <div class="method-heading"> <span class="method-name">[]=</span><span class="method-args">(p1, p2)</span> </div> <div class="method-description"> </div> </div> <div id="method-M000037" class="method-detail"> <a name="M000037"></a> <div class="method-heading"> <a href="HsvaColor.src/M000037.html" target="Code" class="method-signature" onclick="popupCode('HsvaColor.src/M000037.html');return false;"> <span class="method-name">a</span><span class="method-args">()</span> </a> </div> <div class="method-description"> <p> Get the alpha element of a <a href="HsvaColor.html">HsvaColor</a> object. </p> <p> Examples: </p> <pre> amount = color.alpha amount = color.a </pre> </div> </div> <div id="method-M000038" class="method-detail"> <a name="M000038"></a> <div class="method-heading"> <a href="HsvaColor.src/M000038.html" target="Code" class="method-signature" onclick="popupCode('HsvaColor.src/M000038.html');return false;"> <span class="method-name">a=</span><span class="method-args">(p1)</span> </a> </div> <div class="method-description"> <p> Set the alpha element of a <a href="HsvaColor.html">HsvaColor</a> object. </p> <p> Examples: </p> <pre> color.alpha = 255 color.a = 255 </pre> </div> </div> <div id="method-M000039" class="method-detail"> <a name="M000039"></a> <div class="method-heading"> <a href="HsvaColor.src/M000039.html" target="Code" class="method-signature" onclick="popupCode('HsvaColor.src/M000039.html');return false;"> <span class="method-name">alpha</span><span class="method-args">()</span> </a> </div> <div class="method-description"> <p> Get the alpha element of a <a href="HsvaColor.html">HsvaColor</a> object. </p> <p> Examples: </p> <pre> amount = color.alpha amount = color.a </pre> </div> </div> <div id="method-M000040" class="method-detail"> <a name="M000040"></a> <div class="method-heading"> <a href="HsvaColor.src/M000040.html" target="Code" class="method-signature" onclick="popupCode('HsvaColor.src/M000040.html');return false;"> <span class="method-name">alpha=</span><span class="method-args">(p1)</span> </a> </div> <div class="method-description"> <p> Set the alpha element of a <a href="HsvaColor.html">HsvaColor</a> object. </p> <p> Examples: </p> <pre> color.alpha = 255 color.a = 255 </pre> </div> </div> <div id="method-M000025" class="method-detail"> <a name="M000025"></a> <div class="method-heading"> <a href="HsvaColor.src/M000025.html" target="Code" class="method-signature" onclick="popupCode('HsvaColor.src/M000025.html');return false;"> <span class="method-name">h</span><span class="method-args">()</span> </a> </div> <div class="method-description"> <p> Get the hue element of a <a href="HsvaColor.html">HsvaColor</a> object. </p> <p> Examples: </p> <pre> amount = color.hue amount = color.h </pre> </div> </div> <div id="method-M000026" class="method-detail"> <a name="M000026"></a> <div class="method-heading"> <a href="HsvaColor.src/M000026.html" target="Code" class="method-signature" onclick="popupCode('HsvaColor.src/M000026.html');return false;"> <span class="method-name">h=</span><span class="method-args">(p1)</span> </a> </div> <div class="method-description"> <p> Set the hue element of a <a href="HsvaColor.html">HsvaColor</a> object. </p> <p> Examples: </p> <pre> color.hue = 255 color.h = 255 </pre> </div> </div> <div id="method-M000027" class="method-detail"> <a name="M000027"></a> <div class="method-heading"> <a href="HsvaColor.src/M000027.html" target="Code" class="method-signature" onclick="popupCode('HsvaColor.src/M000027.html');return false;"> <span class="method-name">hue</span><span class="method-args">()</span> </a> </div> <div class="method-description"> <p> Get the hue element of a <a href="HsvaColor.html">HsvaColor</a> object. </p> <p> Examples: </p> <pre> amount = color.hue amount = color.h </pre> </div> </div> <div id="method-M000028" class="method-detail"> <a name="M000028"></a> <div class="method-heading"> <a href="HsvaColor.src/M000028.html" target="Code" class="method-signature" onclick="popupCode('HsvaColor.src/M000028.html');return false;"> <span class="method-name">hue=</span><span class="method-args">(p1)</span> </a> </div> <div class="method-description"> <p> Set the hue element of a <a href="HsvaColor.html">HsvaColor</a> object. </p> <p> Examples: </p> <pre> color.hue = 255 color.h = 255 </pre> </div> </div> <div id="method-M000029" class="method-detail"> <a name="M000029"></a> <div class="method-heading"> <a href="HsvaColor.src/M000029.html" target="Code" class="method-signature" onclick="popupCode('HsvaColor.src/M000029.html');return false;"> <span class="method-name">s</span><span class="method-args">()</span> </a> </div> <div class="method-description"> <p> Get the saturation element of a <a href="HsvaColor.html">HsvaColor</a> object. </p> <p> Examples: </p> <pre> amount = color.saturation amount = color.s </pre> </div> </div> <div id="method-M000030" class="method-detail"> <a name="M000030"></a> <div class="method-heading"> <a href="HsvaColor.src/M000030.html" target="Code" class="method-signature" onclick="popupCode('HsvaColor.src/M000030.html');return false;"> <span class="method-name">s=</span><span class="method-args">(p1)</span> </a> </div> <div class="method-description"> <p> Set the saturation element of a <a href="HsvaColor.html">HsvaColor</a> object. </p> <p> Examples: </p> <pre> color.saturation = 255 color.s = 255 </pre> </div> </div> <div id="method-M000031" class="method-detail"> <a name="M000031"></a> <div class="method-heading"> <a href="HsvaColor.src/M000031.html" target="Code" class="method-signature" onclick="popupCode('HsvaColor.src/M000031.html');return false;"> <span class="method-name">saturation</span><span class="method-args">()</span> </a> </div> <div class="method-description"> <p> Get the saturation element of a <a href="HsvaColor.html">HsvaColor</a> object. </p> <p> Examples: </p> <pre> amount = color.saturation amount = color.s </pre> </div> </div> <div id="method-M000032" class="method-detail"> <a name="M000032"></a> <div class="method-heading"> <a href="HsvaColor.src/M000032.html" target="Code" class="method-signature" onclick="popupCode('HsvaColor.src/M000032.html');return false;"> <span class="method-name">saturation=</span><span class="method-args">(p1)</span> </a> </div> <div class="method-description"> <p> Set the saturation element of a <a href="HsvaColor.html">HsvaColor</a> object. </p> <p> Examples: </p> <pre> color.saturation = 255 color.s = 255 </pre> </div> </div> <div id="method-M000033" class="method-detail"> <a name="M000033"></a> <div class="method-heading"> <a href="HsvaColor.src/M000033.html" target="Code" class="method-signature" onclick="popupCode('HsvaColor.src/M000033.html');return false;"> <span class="method-name">v</span><span class="method-args">()</span> </a> </div> <div class="method-description"> <p> Get the value element of a <a href="HsvaColor.html">HsvaColor</a> object. </p> <p> Examples: </p> <pre> amount = color.value amount = color.v </pre> </div> </div> <div id="method-M000034" class="method-detail"> <a name="M000034"></a> <div class="method-heading"> <a href="HsvaColor.src/M000034.html" target="Code" class="method-signature" onclick="popupCode('HsvaColor.src/M000034.html');return false;"> <span class="method-name">v=</span><span class="method-args">(p1)</span> </a> </div> <div class="method-description"> <p> Set the value element of a <a href="HsvaColor.html">HsvaColor</a> object. </p> <p> Examples: </p> <pre> color.value = 255 color.v = 255 </pre> </div> </div> <div id="method-M000035" class="method-detail"> <a name="M000035"></a> <div class="method-heading"> <a href="HsvaColor.src/M000035.html" target="Code" class="method-signature" onclick="popupCode('HsvaColor.src/M000035.html');return false;"> <span class="method-name">value</span><span class="method-args">()</span> </a> </div> <div class="method-description"> <p> Get the value element of a <a href="HsvaColor.html">HsvaColor</a> object. </p> <p> Examples: </p> <pre> amount = color.value amount = color.v </pre> </div> </div> <div id="method-M000036" class="method-detail"> <a name="M000036"></a> <div class="method-heading"> <a href="HsvaColor.src/M000036.html" target="Code" class="method-signature" onclick="popupCode('HsvaColor.src/M000036.html');return false;"> <span class="method-name">value=</span><span class="method-args">(p1)</span> </a> </div> <div class="method-description"> <p> Set the value element of a <a href="HsvaColor.html">HsvaColor</a> object. </p> <p> Examples: </p> <pre> color.value = 255 color.v = 255 </pre> </div> </div> </div> </div> <div id="validator-badges"> <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p> </div> </body> </html>