-
Notifications
You must be signed in to change notification settings - Fork 1
/
color.html
221 lines (214 loc) · 7.86 KB
/
color.html
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
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
<!DOCTYPE html>
<html>
<head>
<meta charset='utf-8'>
<title> color - color computation </title>
<script src="jquery.js"></script>
<script src="jquery-cookie.js"></script>
<script src="jquery-tablesorter.js"></script>
<script src="strftime.js"></script>
<script src="mustache.js"></script>
<script src="config.js"></script>
<script src="main.js"></script>
<link rel="stylesheet" type="text/css" href="templates/reset.css" />
<link rel="stylesheet" type="text/css" href="templates/hack.css" />
<link rel="stylesheet" type="text/css" id="lights_css" />
<script>
var DOCNAME = 'color'
var PROJECT = 'color'
//set the lights before rendering starts
set_lights()
</script>
</head>
<body>
<header>
<div class="container">
<div class="btn-container btn-lights-container">
<a href="#" class="btn btn-lights" id="lights">lights</a>
</div>
<div class="btn-container btn-home-container">
<a href="/" class="btn btn-home">luapower</a>
</div>
<table id="header_table">
<tr>
<td style="vertical-align: middle;" width="100%">
<h1> color </h1>
<h2> color computation </h2>
</td>
<td style="vertical-align: middle;" align="right" style="height: 150px">
<table><tr><td>
<div class="doc" id="package_info_container">
<div id="package_info"> </div>
<div id="commit_log"> </div>
</div>
<a href="https://github.com/luapower/color" class="btn btn-rightside btn-github"><span class="icon"></span>View on GitHub</a>
</td></tr><tr><td>
<a href="https://github.com/luapower/color/tarball/master" class="btn btn-rightside">Download as .tar.gz</a>
</td></tr><tr><td>
<a href="https://github.com/luapower/color/zipball/master" class="btn btn-rightside">Download as .zip</a>
</td></tr></table>
</td>
</tr>
</table>
<div class="btn-container btn-discuss-container">
<a href="https://github.com/luapower/color/issues/new" target="_blank"
class="btn btn-rightside btn-discuss"><span class="icon"></span>Discuss</a>
</div>
</div>
</header>
<div class="bg-container">
<div class="bg-center-container">
<div class="bg bg-color" style="background-image: url('bg/color.png');"></div>
</div>
</div>
<div class="under-header">
<div class="container">
<div id="toc_container" class="toc_container doc"></div>
<button id=tab1_button class="tab_button hidden">Documentation</button>
<button id=tab2_button class="tab_button hidden">Package Info</button>
<div id="tabs_cointainer">
<div id="tab1_container">
<section class="doc">
<span id="module_info"></span>
<h2 id="local-color-requirecolor"><code>local color = require'color'</code></h2>
<p>Color computation in HSL space. Shamelessly ripped off and modified from <a href="http://sputnik.freewisdom.org/lib/colors/">Sputnik's colors lib</a>, by Yuri Takhteyev.</p>
<ul>
<li><code>r, g, b, s, L</code> are in 0..1 range.</li>
<li><code>h</code> is in 0..360 range.</li>
</ul>
<h2 id="direct-conversions">Direct conversions</h2>
<table>
<tbody>
<tr class="odd">
<td align="left"><code>color.hsl_to_rgb(h, s, L) -> r, g, b</code></td>
<td align="left">HSL -> RGB; h is modulo 360; s, L are clamped to range</td>
</tr>
<tr class="even">
<td align="left"><code>color.rgb_to_hsl(r, g, b) -> h, s, L</code></td>
<td align="left">RGB -> HSL; r, g, b are clamped to range</td>
</tr>
<tr class="odd">
<td align="left"><code>color.rgb_to_string(r, g, b) -> s</code></td>
<td align="left">generate '#rrggbb' hex color</td>
</tr>
<tr class="even">
<td align="left"><code>color.string_to_rgb(s) -> r, g, b | nil</code></td>
<td align="left">parse a '#rrggbb' hex color</td>
</tr>
<tr class="odd">
<td align="left"><code>color.rgba_to_string(r, g, b, a) -> s</code></td>
<td align="left">generate a '#rrggbbaa' hex color</td>
</tr>
<tr class="even">
<td align="left"><code>color.string_to_rgba(s) -> r, g, b, a | nil</code></td>
<td align="left">parse a '#rrggbbaa' hex color (the 'aa' part is optional)</td>
</tr>
</tbody>
</table>
<h2 id="color-objects">Color objects</h2>
<table>
<tbody>
<tr class="odd">
<td align="left"><code>color('#rrggbb') -> col</code></td>
<td align="left">create a new HSL color object from a RGB string</td>
</tr>
<tr class="even">
<td align="left"><code>color(h, s, L) -> col</code></td>
<td align="left">create a new HSL color object from HSL values</td>
</tr>
<tr class="odd">
<td align="left"><code>col.h, col.s, col.L</code></td>
<td align="left">color fields (for reading and writing)</td>
</tr>
<tr class="even">
<td align="left"><code>col:hsl() -> h, s, L</code> <br> <code>col() -> h, s, L</code></td>
<td align="left">color fields unpacked</td>
</tr>
<tr class="odd">
<td align="left"><code>col:rgb() -> r, g, b</code></td>
<td align="left">convert to RGB</td>
</tr>
<tr class="even">
<td align="left"><code>col:tostring() -> '#rrggbb'</code></td>
<td align="left">convert to RGB string</td>
</tr>
<tr class="odd">
<td align="left"><code>col:hue_offset(hue_delta) -> color</code></td>
<td align="left">create a new color with a different hue</td>
</tr>
<tr class="even">
<td align="left"><code>col:complementary() -> color</code></td>
<td align="left">create a complementary color</td>
</tr>
<tr class="odd">
<td align="left"><code>col:neighbors(angle) -> color1, color2</code></td>
<td align="left">create two neighboring colors (by hue), offset by "angle"</td>
</tr>
<tr class="even">
<td align="left"><code>col:triadic() -> color1, color2</code></td>
<td align="left">create two new colors to make a triadic color scheme</td>
</tr>
<tr class="odd">
<td align="left"><code>col:split_complementary(angle) -> color1, color2</code></td>
<td align="left">create two new colors, offset by angle from a color's complementary</td>
</tr>
<tr class="even">
<td align="left"><code>col:desaturate_to(saturation) -> color</code></td>
<td align="left">create a new color with saturation set to a new value</td>
</tr>
<tr class="odd">
<td align="left"><code>col:desaturate_by(r) -> color</code></td>
<td align="left">create a new color with saturation set to a old saturation times r</td>
</tr>
<tr class="even">
<td align="left"><code>col:lighten_to(lightness) -> color</code></td>
<td align="left">create a new color with lightness set to a new value</td>
</tr>
<tr class="odd">
<td align="left"><code>col:lighten_by(r) -> color</code></td>
<td align="left">create a new color with lightness set to its lightness times r</td>
</tr>
<tr class="even">
<td align="left"><code>col:variations(f, n) -> {color1, ...}</code></td>
<td align="left">create n variations of a color using supplied function and return them as a table</td>
</tr>
<tr class="odd">
<td align="left"><code>col:tints(n) -> {color1, ...}</code></td>
<td align="left">create n tints of a color and return them as a table</td>
</tr>
<tr class="even">
<td align="left"><code>col:shades(n) -> {color1, ...}</code></td>
<td align="left">create n shades of a color and return them as a table</td>
</tr>
<tr class="odd">
<td align="left"><code>col:tint(r) -> color</code></td>
<td align="left">create a color tint</td>
</tr>
<tr class="even">
<td align="left"><code>col:shade(r) -> color</code></td>
<td align="left">create a color shade</td>
</tr>
</tbody>
</table>
</section>
</div>
<div id="tab2_container" class="doc"></div>
</div>
</div>
<div class="container">
<footer>
<div id="disqus_thread"></div>
<div class="faint">[email protected] | <a href="http://unlicense.org/">public domain</a></div>
</footer>
</div>
</div>
<script type="text/x-mustache" id=info_tab_template>
<h3>Modules</h3>
<ul>
{{#module_array}}
<li>{{name}}</li>
{{/module_array}}
</ul>
</script>
</body>
</html>