<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>
Class: Discorb::Color
— Documentation by YARD 0.9.26
</title>
<link rel="stylesheet" href="../css/style.css" type="text/css" />
<link rel="stylesheet" href="../css/common.css" type="text/css" />
<script type="text/javascript">
pathId = "Discorb::Color";
relpath = '../';
</script>
<script type="text/javascript" charset="utf-8" src="../js/jquery.js"></script>
<script type="text/javascript" charset="utf-8" src="../js/app.js"></script>
</head>
<body>
<div class="nav_wrap">
<iframe id="nav" src="../class_list.html?1"></iframe>
<div id="resizer"></div>
</div>
<div id="main" tabindex="-1">
<div id="header">
<div id="menu">
<a href="../a_index.html">Index (C)</a> »
<span class='title'><span class='object_link'><a href="../Discorb.html" title="Discorb (module)">Discorb</a></span></span>
»
<span class="title">Color</span>
</div>
<div id="search">
<a class="full_list_link" id="class_list_link"
href="../class_list.html">
<svg width="24" height="24">
<rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
<rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
<rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
</svg>
</a>
</div>
<div class="clear"></div>
</div>
<div id="content"><h1>Class: Discorb::Color
</h1>
<div class="box_info">
<dl>
<dt>Inherits:</dt>
<dd>
<span class="inheritName">Object</span>
<ul class="fullTree">
<li>Object</li>
<li class="next">Discorb::Color</li>
</ul>
<a href="#" class="inheritanceTree">show all</a>
</dd>
</dl>
<dl>
<dt>Defined in:</dt>
<dd>lib/discorb/color.rb</dd>
</dl>
</div>
<h2>Overview</h2><div class="docstring">
<div class="discussion">
<p>Represents RGB color.</p>
</div>
</div>
<div class="tags">
</div>
<h2>Instance Attribute Summary <small><a href="#" class="summary_toggle">collapse</a></small></h2>
<ul class="summary">
<li class="public ">
<span class="summary_signature">
<a href="#value-instance_method" title="#value (instance method)">#<strong>value</strong> ⇒ Object </a>
</span>
<span class="summary_desc"><div class='inline'><p>Returns the value of attribute value.</p>
</div></span>
</li>
</ul>
<h2>
Class Method Summary
<small><a href="#" class="summary_toggle">collapse</a></small>
</h2>
<ul class="summary">
<li class="public ">
<span class="summary_signature">
<a href="#[]-class_method" title="[] (class method)">.<strong>[]</strong>(color) ⇒ Discorb::Color </a>
</span>
<span class="summary_desc"><div class='inline'><p>Create a color from a Discord's color.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#from_hex-class_method" title="from_hex (class method)">.<strong>from_hex</strong>(hex) ⇒ Discorb::Color </a>
</span>
<span class="summary_desc"><div class='inline'><p>Create a color from a hexadecimal string.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#from_rgb-class_method" title="from_rgb (class method)">.<strong>from_rgb</strong>(red, green, blue) ⇒ Discorb::Color </a>
</span>
<span class="summary_desc"><div class='inline'><p>Create a color from a RGB array.</p>
</div></span>
</li>
</ul>
<h2>
Instance Method Summary
<small><a href="#" class="summary_toggle">collapse</a></small>
</h2>
<ul class="summary">
<li class="public ">
<span class="summary_signature">
<a href="#initialize-instance_method" title="#initialize (instance method)">#<strong>initialize</strong>(value) ⇒ Color </a>
</span>
<span class="note title constructor">constructor</span>
<span class="summary_desc"><div class='inline'><p>Create a color from a Integer.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#inspect-instance_method" title="#inspect (instance method)">#<strong>inspect</strong> ⇒ Object </a>
</span>
<span class="summary_desc"><div class='inline'></div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#to_hex-instance_method" title="#to_hex (instance method)">#<strong>to_hex</strong> ⇒ String </a>
</span>
<span class="summary_desc"><div class='inline'><p>Convert a color to a hexadecimal value.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#to_i-instance_method" title="#to_i (instance method)">#<strong>to_i</strong> ⇒ Integer </a>
</span>
<span class="summary_desc"><div class='inline'><p>Integerize a color.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#to_rgb-instance_method" title="#to_rgb (instance method)">#<strong>to_rgb</strong> ⇒ Array(Integer, Integer, Integer) </a>
(also: #to_a, #deconstruct)
</span>
<span class="summary_desc"><div class='inline'><p>Convert a color to RGB array.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#to_rgb_hash-instance_method" title="#to_rgb_hash (instance method)">#<strong>to_rgb_hash</strong> ⇒ Hash{:r, :g, :b => Integer} </a>
(also: #deconstruct_keys)
</span>
<span class="summary_desc"><div class='inline'><p>Convert a color to RGB hash.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#to_s-instance_method" title="#to_s (instance method)">#<strong>to_s</strong> ⇒ String </a>
</span>
<span class="summary_desc"><div class='inline'><p>Converts a color to a <code>#000000</code> string.</p>
</div></span>
</li>
</ul>
<div id="constructor_details" class="method_details_list">
<h2>Constructor Details</h2>
<div class="method_details first">
<h3 class="signature first" id="initialize-instance_method">
#<strong>initialize</strong>(value) ⇒ <tt><span class='object_link'><a href="" title="Discorb::Color (class)">Color</a></span></tt>
</h3><div class="docstring">
<div class="discussion">
<p>Create a color from a Integer.</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
<span class='name'>value</span>
<span class='type'>(<tt>Integer</tt>)</span>
—
<div class='inline'><p>A color value.</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
48
49
50</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/discorb/color.rb', line 48</span>
<span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span><span class='lparen'>(</span><span class='id identifier rubyid_value'>value</span><span class='rparen'>)</span>
<span class='ivar'>@value</span> <span class='op'>=</span> <span class='id identifier rubyid_value'>value</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
</div>
<div id="instance_attr_details" class="attr_details">
<h2>Instance Attribute Details</h2>
<span id="value=-instance_method"></span>
<div class="method_details first">
<h3 class="signature first" id="value-instance_method">
#<strong>value</strong> ⇒ <tt>Object</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Returns the value of attribute value.</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
8
9
10</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/discorb/color.rb', line 8</span>
<span class='kw'>def</span> <span class='id identifier rubyid_value'>value</span>
<span class='ivar'>@value</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
</div>
<div id="class_method_details" class="method_details_list">
<h2>Class Method Details</h2>
<div class="method_details first">
<h3 class="signature first" id="[]-class_method">
.<strong>[]</strong>(color) ⇒ <tt><span class='object_link'><a href="" title="Discorb::Color (class)">Discorb::Color</a></span></tt>
</h3><div class="docstring">
<div class="discussion">
<p>Create a color from a Discord's color.
Currently these colors are supported:</p>
<ul>
<li>teal (0x1abc9c)</li>
<li>dark_teal (0x11806a)</li>
<li>green (0x2ecc71)</li>
<li>dark_green (0x1f8b4c)</li>
<li>blue (0x3498db)</li>
<li>dark_blue (0x206694)</li>
<li>purple (0x9b59b6)</li>
<li>dark_purple (0x71368a)</li>
<li>magenta (0xe91e63)</li>
<li>dark_magenta (0xad1457)</li>
<li>gold (0xf1c40f)</li>
<li>dark_gold (0xc27c0e)</li>
<li>orange (0xe67e22)</li>
<li>dark_orange (0xa84300)</li>
<li>red (0xe74c3c)</li>
<li>dark_red (0x992d22)</li>
<li>lighter_grey (0x95a5a6)</li>
<li>lighter_gray (0x95a5a6)</li>
<li>dark_grey (0x607d8b)</li>
<li>dark_gray (0x607d8b)</li>
<li>light_grey (0x979c9f)</li>
<li>light_gray (0x979c9f)</li>
<li>darker_grey (0x546e7a)</li>
<li>darker_gray (0x546e7a)</li>
<li>og_blurple (0x7289da)</li>
<li>blurple (0x5865f2)</li>
<li>greyple (0x99aab5)</li>
<li>dark_theme (0x36393f)</li>
<li>fuchsia (0xeb459e)</li>
</ul>
</div>
</div>
<div class="tags">
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
<span class='name'>color</span>
<span class='type'>(<tt>Symbol</tt>)</span>
—
<div class='inline'><p>A Discord color name.</p>
</div>
</li>
</ul>
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt><span class='object_link'><a href="" title="Discorb::Color (class)">Discorb::Color</a></span></tt>)</span>
—
<div class='inline'><p>A color object.</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
167
168
169</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/discorb/color.rb', line 167</span>
<span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='op'>[]</span><span class='lparen'>(</span><span class='id identifier rubyid_color'>color</span><span class='rparen'>)</span>
<span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='ivar'>@discord_colors</span><span class='lbracket'>[</span><span class='id identifier rubyid_color'>color</span><span class='rbracket'>]</span><span class='rparen'>)</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="from_hex-class_method">
.<strong>from_hex</strong>(hex) ⇒ <tt><span class='object_link'><a href="" title="Discorb::Color (class)">Discorb::Color</a></span></tt>
</h3><div class="docstring">
<div class="discussion">
<p>Create a color from a hexadecimal string.</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
<span class='name'>hex</span>
<span class='type'>(<tt>String</tt>)</span>
—
<div class='inline'><p>A hexadecimal string.</p>
</div>
</li>
</ul>
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt><span class='object_link'><a href="" title="Discorb::Color (class)">Discorb::Color</a></span></tt>)</span>
—
<div class='inline'><p>A color object.</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
113
114
115</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/discorb/color.rb', line 113</span>
<span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_from_hex'>from_hex</span><span class='lparen'>(</span><span class='id identifier rubyid_hex'>hex</span><span class='rparen'>)</span>
<span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='id identifier rubyid_hex'>hex</span><span class='period'>.</span><span class='id identifier rubyid_to_i'>to_i</span><span class='lparen'>(</span><span class='int'>16</span><span class='rparen'>)</span><span class='rparen'>)</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="from_rgb-class_method">
.<strong>from_rgb</strong>(red, green, blue) ⇒ <tt><span class='object_link'><a href="" title="Discorb::Color (class)">Discorb::Color</a></span></tt>
</h3><div class="docstring">
<div class="discussion">
<p>Create a color from a RGB array.</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
<span class='name'>red</span>
<span class='type'>(<tt>Integer</tt>)</span>
—
<div class='inline'><p>A red value.</p>
</div>
</li>
<li>
<span class='name'>green</span>
<span class='type'>(<tt>Integer</tt>)</span>
—
<div class='inline'><p>A green value.</p>
</div>
</li>
<li>
<span class='name'>blue</span>
<span class='type'>(<tt>Integer</tt>)</span>
—
<div class='inline'><p>A blue value.</p>
</div>
</li>
</ul>
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt><span class='object_link'><a href="" title="Discorb::Color (class)">Discorb::Color</a></span></tt>)</span>
—
<div class='inline'><p>A color object.</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
126
127
128</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/discorb/color.rb', line 126</span>
<span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_from_rgb'>from_rgb</span><span class='lparen'>(</span><span class='id identifier rubyid_red'>red</span><span class='comma'>,</span> <span class='id identifier rubyid_green'>green</span><span class='comma'>,</span> <span class='id identifier rubyid_blue'>blue</span><span class='rparen'>)</span>
<span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='id identifier rubyid_red'>red</span> <span class='op'>*</span> <span class='int'>256</span> <span class='op'>*</span> <span class='int'>256</span> <span class='op'>+</span> <span class='id identifier rubyid_green'>green</span> <span class='op'>*</span> <span class='int'>256</span> <span class='op'>+</span> <span class='id identifier rubyid_blue'>blue</span><span class='rparen'>)</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
</div>
<div id="instance_method_details" class="method_details_list">
<h2>Instance Method Details</h2>
<div class="method_details first">
<h3 class="signature first" id="inspect-instance_method">
#<strong>inspect</strong> ⇒ <tt>Object</tt>
</h3><table class="source_code">
<tr>
<td>
<pre class="lines">
102
103
104</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/discorb/color.rb', line 102</span>
<span class='kw'>def</span> <span class='id identifier rubyid_inspect'>inspect</span>
<span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>#<</span><span class='embexpr_beg'>#{</span><span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_class'>class</span><span class='embexpr_end'>}</span><span class='tstring_content'> </span><span class='embexpr_beg'>#{</span><span class='ivar'>@value</span><span class='embexpr_end'>}</span><span class='tstring_content'>/</span><span class='embexpr_beg'>#{</span><span class='kw'>self</span><span class='embexpr_end'>}</span><span class='tstring_content'>></span><span class='tstring_end'>"</span></span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="to_hex-instance_method">
#<strong>to_hex</strong> ⇒ <tt>String</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Convert a color to a hexadecimal value.</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt>String</tt>)</span>
—
<div class='inline'><p>A hexadecimal value.</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
66
67
68</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/discorb/color.rb', line 66</span>
<span class='kw'>def</span> <span class='id identifier rubyid_to_hex'>to_hex</span>
<span class='ivar'>@value</span><span class='period'>.</span><span class='id identifier rubyid_to_s'>to_s</span><span class='lparen'>(</span><span class='int'>16</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_rjust'>rjust</span><span class='lparen'>(</span><span class='int'>6</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>0</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="to_i-instance_method">
#<strong>to_i</strong> ⇒ <tt>Integer</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Integerize a color.</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt>Integer</tt>)</span>
—
<div class='inline'><p>A color value.</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
57
58
59</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/discorb/color.rb', line 57</span>
<span class='kw'>def</span> <span class='id identifier rubyid_to_i'>to_i</span>
<span class='ivar'>@value</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="to_rgb-instance_method">
#<strong>to_rgb</strong> ⇒ <tt>Array(Integer, Integer, Integer)</tt>
<span class="aliases">Also known as:
<span class="names"><span id='to_a-instance_method'>to_a</span>, <span id='deconstruct-instance_method'>deconstruct</span></span>
</span>
</h3><div class="docstring">
<div class="discussion">
<p>Convert a color to RGB array.</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt>Array(Integer, Integer, Integer)</tt>)</span>
—
<div class='inline'><p>A RGB array.</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
75
76
77</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/discorb/color.rb', line 75</span>
<span class='kw'>def</span> <span class='id identifier rubyid_to_rgb'>to_rgb</span>
<span class='lbracket'>[</span><span class='ivar'>@value</span> <span class='op'>/</span> <span class='lparen'>(</span><span class='int'>256</span> <span class='op'>*</span> <span class='int'>256</span><span class='rparen'>)</span><span class='comma'>,</span> <span class='ivar'>@value</span> <span class='op'>/</span> <span class='int'>256</span> <span class='op'>%</span> <span class='int'>256</span><span class='comma'>,</span> <span class='ivar'>@value</span> <span class='op'>%</span> <span class='int'>256</span><span class='rbracket'>]</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="to_rgb_hash-instance_method">
#<strong>to_rgb_hash</strong> ⇒ <tt>Hash{:r, :g, :b => Integer}</tt>
<span class="aliases">Also known as:
<span class="names"><span id='deconstruct_keys-instance_method'>deconstruct_keys</span></span>
</span>
</h3><div class="docstring">
<div class="discussion">
<p>Convert a color to RGB hash.</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt>Hash{:r, :g, :b => Integer}</tt>)</span>
—
<div class='inline'><p>A RGB hash.</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
87
88
89</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/discorb/color.rb', line 87</span>
<span class='kw'>def</span> <span class='id identifier rubyid_to_rgb_hash'>to_rgb_hash</span>
<span class='lbracket'>[</span><span class='ivar'>@value</span> <span class='op'>/</span> <span class='lparen'>(</span><span class='int'>256</span> <span class='op'>*</span> <span class='int'>256</span><span class='rparen'>)</span><span class='comma'>,</span> <span class='ivar'>@value</span> <span class='op'>/</span> <span class='int'>256</span> <span class='op'>%</span> <span class='int'>256</span><span class='comma'>,</span> <span class='ivar'>@value</span> <span class='op'>%</span> <span class='int'>256</span><span class='rbracket'>]</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="to_s-instance_method">
#<strong>to_s</strong> ⇒ <tt>String</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Converts a color to a <code>#000000</code> string.</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt>String</tt>)</span>
—
<div class='inline'><p>Converted string.</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
98
99
100</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/discorb/color.rb', line 98</span>
<span class='kw'>def</span> <span class='id identifier rubyid_to_s'>to_s</span>
<span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>#</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_to_hex'>to_hex</span><span class='embexpr_end'>}</span><span class='tstring_end'>"</span></span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
</div>
</div>
<div id="footer">
Generated from <a href="https://github.com/discorb-lib/discorb/tree/b1dd9cf49ec5d42e3e3ed921f950a18a24c7a2b9"><code>b1dd9cf49ec5d42e3e3ed921f950a18a24c7a2b9</code></a>, version v0.0.7, with YARD 0.9.26.
</div>
</div>
</body>
</html>