<?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::HlsaColor</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::HlsaColor</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="#M000063">[]</a>
<a href="#M000064">[]=</a>
<a href="#M000077">a</a>
<a href="#M000078">a=</a>
<a href="#M000079">alpha</a>
<a href="#M000080">alpha=</a>
<a href="#M000065">h</a>
<a href="#M000066">h=</a>
<a href="#M000067">hue</a>
<a href="#M000068">hue=</a>
<a href="#M000069">l</a>
<a href="#M000070">l=</a>
<a href="#M000071">lightness</a>
<a href="#M000072">lightness=</a>
<a href="#M000062">new</a>
<a href="#M000061">new</a>
<a href="#M000073">s</a>
<a href="#M000074">s=</a>
<a href="#M000075">saturation</a>
<a href="#M000076">saturation=</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-M000062" class="method-detail">
<a name="M000062"></a>
<div class="method-heading">
<a href="HlsaColor.src/M000062.html" target="Code" class="method-signature"
onclick="popupCode('HlsaColor.src/M000062.html');return false;">
<span class="method-name">new</span><span class="method-args">(...)</span>
</a>
</div>
<div class="method-description">
<p>
<a href="HlsaColor.html">Imlib2::Color::HlsaColor</a> constructor.
</p>
<p>
Parameters are identical to Imlib2::Color::HlsaColor::new.
</p>
</div>
</div>
<div id="method-M000061" class="method-detail">
<a name="M000061"></a>
<div class="method-heading">
<a href="HlsaColor.src/M000061.html" target="Code" class="method-signature"
onclick="popupCode('HlsaColor.src/M000061.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="HlsaColor.html">Imlib2::Color::HlsaColor</a>.
</p>
<p>
Examples:
</p>
<pre>
h, l, s, a = 255, 0, 0, 255
border = Imlib2::Color::HlsaColor.new h, l, s, a
values = [255, 0, 0, 255]
border = Imlib2::Color::HlsaColor.new values
</pre>
</div>
</div>
<h3 class="section-bar">Public Instance methods</h3>
<div id="method-M000063" class="method-detail">
<a name="M000063"></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-M000064" class="method-detail">
<a name="M000064"></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-M000077" class="method-detail">
<a name="M000077"></a>
<div class="method-heading">
<a href="HlsaColor.src/M000077.html" target="Code" class="method-signature"
onclick="popupCode('HlsaColor.src/M000077.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="HlsaColor.html">HlsaColor</a> object.
</p>
<p>
Examples:
</p>
<pre>
amount = color.alpha
amount = color.a
</pre>
</div>
</div>
<div id="method-M000078" class="method-detail">
<a name="M000078"></a>
<div class="method-heading">
<a href="HlsaColor.src/M000078.html" target="Code" class="method-signature"
onclick="popupCode('HlsaColor.src/M000078.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="HlsaColor.html">HlsaColor</a> object.
</p>
<p>
Examples:
</p>
<pre>
color.alpha = 255
color.a = 255
</pre>
</div>
</div>
<div id="method-M000079" class="method-detail">
<a name="M000079"></a>
<div class="method-heading">
<a href="HlsaColor.src/M000079.html" target="Code" class="method-signature"
onclick="popupCode('HlsaColor.src/M000079.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="HlsaColor.html">HlsaColor</a> object.
</p>
<p>
Examples:
</p>
<pre>
amount = color.alpha
amount = color.a
</pre>
</div>
</div>
<div id="method-M000080" class="method-detail">
<a name="M000080"></a>
<div class="method-heading">
<a href="HlsaColor.src/M000080.html" target="Code" class="method-signature"
onclick="popupCode('HlsaColor.src/M000080.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="HlsaColor.html">HlsaColor</a> object.
</p>
<p>
Examples:
</p>
<pre>
color.alpha = 255
color.a = 255
</pre>
</div>
</div>
<div id="method-M000065" class="method-detail">
<a name="M000065"></a>
<div class="method-heading">
<a href="HlsaColor.src/M000065.html" target="Code" class="method-signature"
onclick="popupCode('HlsaColor.src/M000065.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="HlsaColor.html">HlsaColor</a> object.
</p>
<p>
Examples:
</p>
<pre>
amount = color.hue
amount = color.h
</pre>
</div>
</div>
<div id="method-M000066" class="method-detail">
<a name="M000066"></a>
<div class="method-heading">
<a href="HlsaColor.src/M000066.html" target="Code" class="method-signature"
onclick="popupCode('HlsaColor.src/M000066.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="HlsaColor.html">HlsaColor</a> object.
</p>
<p>
Examples:
</p>
<pre>
color.hue = 255
color.h = 255
</pre>
</div>
</div>
<div id="method-M000067" class="method-detail">
<a name="M000067"></a>
<div class="method-heading">
<a href="HlsaColor.src/M000067.html" target="Code" class="method-signature"
onclick="popupCode('HlsaColor.src/M000067.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="HlsaColor.html">HlsaColor</a> object.
</p>
<p>
Examples:
</p>
<pre>
amount = color.hue
amount = color.h
</pre>
</div>
</div>
<div id="method-M000068" class="method-detail">
<a name="M000068"></a>
<div class="method-heading">
<a href="HlsaColor.src/M000068.html" target="Code" class="method-signature"
onclick="popupCode('HlsaColor.src/M000068.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="HlsaColor.html">HlsaColor</a> object.
</p>
<p>
Examples:
</p>
<pre>
color.hue = 255
color.h = 255
</pre>
</div>
</div>
<div id="method-M000069" class="method-detail">
<a name="M000069"></a>
<div class="method-heading">
<a href="HlsaColor.src/M000069.html" target="Code" class="method-signature"
onclick="popupCode('HlsaColor.src/M000069.html');return false;">
<span class="method-name">l</span><span class="method-args">()</span>
</a>
</div>
<div class="method-description">
<p>
Get the lightness element of a <a href="HlsaColor.html">HlsaColor</a>
object.
</p>
<p>
Examples:
</p>
<pre>
amount = color.lightness
amount = color.l
</pre>
</div>
</div>
<div id="method-M000070" class="method-detail">
<a name="M000070"></a>
<div class="method-heading">
<a href="HlsaColor.src/M000070.html" target="Code" class="method-signature"
onclick="popupCode('HlsaColor.src/M000070.html');return false;">
<span class="method-name">l=</span><span class="method-args">(p1)</span>
</a>
</div>
<div class="method-description">
<p>
Set the lightness element of a <a href="HlsaColor.html">HlsaColor</a>
object.
</p>
<p>
Examples:
</p>
<pre>
color.lightness = 255
color.l = 255
</pre>
</div>
</div>
<div id="method-M000071" class="method-detail">
<a name="M000071"></a>
<div class="method-heading">
<a href="HlsaColor.src/M000071.html" target="Code" class="method-signature"
onclick="popupCode('HlsaColor.src/M000071.html');return false;">
<span class="method-name">lightness</span><span class="method-args">()</span>
</a>
</div>
<div class="method-description">
<p>
Get the lightness element of a <a href="HlsaColor.html">HlsaColor</a>
object.
</p>
<p>
Examples:
</p>
<pre>
amount = color.lightness
amount = color.l
</pre>
</div>
</div>
<div id="method-M000072" class="method-detail">
<a name="M000072"></a>
<div class="method-heading">
<a href="HlsaColor.src/M000072.html" target="Code" class="method-signature"
onclick="popupCode('HlsaColor.src/M000072.html');return false;">
<span class="method-name">lightness=</span><span class="method-args">(p1)</span>
</a>
</div>
<div class="method-description">
<p>
Set the lightness element of a <a href="HlsaColor.html">HlsaColor</a>
object.
</p>
<p>
Examples:
</p>
<pre>
color.lightness = 255
color.l = 255
</pre>
</div>
</div>
<div id="method-M000073" class="method-detail">
<a name="M000073"></a>
<div class="method-heading">
<a href="HlsaColor.src/M000073.html" target="Code" class="method-signature"
onclick="popupCode('HlsaColor.src/M000073.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="HlsaColor.html">HlsaColor</a>
object.
</p>
<p>
Examples:
</p>
<pre>
amount = color.saturation
amount = color.s
</pre>
</div>
</div>
<div id="method-M000074" class="method-detail">
<a name="M000074"></a>
<div class="method-heading">
<a href="HlsaColor.src/M000074.html" target="Code" class="method-signature"
onclick="popupCode('HlsaColor.src/M000074.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="HlsaColor.html">HlsaColor</a>
object.
</p>
<p>
Examples:
</p>
<pre>
color.saturation = 255
color.h = 255
</pre>
</div>
</div>
<div id="method-M000075" class="method-detail">
<a name="M000075"></a>
<div class="method-heading">
<a href="HlsaColor.src/M000075.html" target="Code" class="method-signature"
onclick="popupCode('HlsaColor.src/M000075.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="HlsaColor.html">HlsaColor</a>
object.
</p>
<p>
Examples:
</p>
<pre>
amount = color.saturation
amount = color.s
</pre>
</div>
</div>
<div id="method-M000076" class="method-detail">
<a name="M000076"></a>
<div class="method-heading">
<a href="HlsaColor.src/M000076.html" target="Code" class="method-signature"
onclick="popupCode('HlsaColor.src/M000076.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="HlsaColor.html">HlsaColor</a>
object.
</p>
<p>
Examples:
</p>
<pre>
color.saturation = 255
color.h = 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>
