Skip to content

Commit 64ab676

Browse files
committed
update docs
1 parent d654048 commit 64ab676

File tree

6 files changed

+45
-6
lines changed

6 files changed

+45
-6
lines changed

docs/classes/Color.html

Lines changed: 40 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -225,6 +225,10 @@ <h2><a href="#Methods">Methods</a></h2>
225225
<td class="summary">Get string representation of color.</td>
226226
</tr>
227227
<tr>
228+
<td class="name" nowrap><a href="#Color:band">Color:band (a, b)</a></td>
229+
<td class="summary">Apply rgb mask to color, providing backwards compatibility for Lua 5.1 and LuaJIT 2.1.0-beta3 (e.g.</td>
230+
</tr>
231+
<tr>
228232
<td class="name" nowrap><a href="#Color:isColor">Color:isColor (color)</a></td>
229233
<td class="summary">Check whether <code>color</code> is a Color.</td>
230234
</tr>
@@ -1343,6 +1347,41 @@ <h3>See also:</h3>
13431347
</ul>
13441348

13451349

1350+
</dd>
1351+
<dt>
1352+
<a name = "Color:band"></a>
1353+
<strong>Color:band (a, b)</strong>
1354+
</dt>
1355+
<dd>
1356+
Apply rgb mask to color, providing backwards compatibility for Lua 5.1 and LuaJIT 2.1.0-beta3 (e.g. inside Neovim), which don't provide native support for bitwise operators.
1357+
1358+
1359+
<h3>Parameters:</h3>
1360+
<ul>
1361+
<li><span class="parameter">a</span>
1362+
<span class="types"><a class="type" href="../classes/Color.html#">Color</a> or <span class="type">number</span></span>
1363+
color or mask
1364+
</li>
1365+
<li><span class="parameter">b</span>
1366+
<span class="types"><a class="type" href="../classes/Color.html#">Color</a> or <span class="type">number</span></span>
1367+
color or mask (if a and b are colors b is used as mask)
1368+
</li>
1369+
</ul>
1370+
1371+
<h3>Returns:</h3>
1372+
<ol>
1373+
1374+
<span class="types"><a class="type" href="../classes/Color.html#">Color</a></span>
1375+
new color
1376+
</ol>
1377+
1378+
1379+
1380+
<h3>Usage:</h3>
1381+
<ul>
1382+
<pre class="example"><span class="keyword">local</span> new_col = Color.band(color, <span class="number">0xff00ff</span>) <span class="comment">-- get new color without the green channel</span></pre>
1383+
</ul>
1384+
13461385
</dd>
13471386
<dt>
13481387
<a name = "Color:isColor"></a>
@@ -1383,7 +1422,7 @@ <h3>Usage:</h3>
13831422
</div> <!-- id="main" -->
13841423
<div id="about">
13851424
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a></i>
1386-
<i style="float:right;">Last updated 2022-02-05 10:49:30 </i>
1425+
<i style="float:right;">Last updated 2022-06-08 20:37:27 </i>
13871426
</div> <!-- id="about" -->
13881427
</div> <!-- id="container" -->
13891428
</body>

docs/index.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -84,7 +84,7 @@ <h2>Topics</h2>
8484
</div> <!-- id="main" -->
8585
<div id="about">
8686
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a></i>
87-
<i style="float:right;">Last updated 2022-02-05 10:49:30 </i>
87+
<i style="float:right;">Last updated 2022-06-08 20:37:27 </i>
8888
</div> <!-- id="about" -->
8989
</div> <!-- id="container" -->
9090
</body>

docs/modules/lua-color.colors.X11.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -76,7 +76,7 @@ <h3>Usage:</h3>
7676
</div> <!-- id="main" -->
7777
<div id="about">
7878
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a></i>
79-
<i style="float:right;">Last updated 2022-02-05 10:49:30 </i>
79+
<i style="float:right;">Last updated 2022-06-08 20:37:27 </i>
8080
</div> <!-- id="about" -->
8181
</div> <!-- id="container" -->
8282
</body>

docs/modules/lua-color.colors.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -197,7 +197,7 @@ <h3>Usage:</h3>
197197
</div> <!-- id="main" -->
198198
<div id="about">
199199
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a></i>
200-
<i style="float:right;">Last updated 2022-02-05 10:49:30 </i>
200+
<i style="float:right;">Last updated 2022-06-08 20:37:27 </i>
201201
</div> <!-- id="about" -->
202202
</div> <!-- id="container" -->
203203
</body>

docs/modules/lua-color.terminal.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -260,7 +260,7 @@ <h2 class="section-header "><a name="Fields"></a>Fields</h2>
260260
</div> <!-- id="main" -->
261261
<div id="about">
262262
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a></i>
263-
<i style="float:right;">Last updated 2022-02-05 10:49:30 </i>
263+
<i style="float:right;">Last updated 2022-06-08 20:37:27 </i>
264264
</div> <!-- id="about" -->
265265
</div> <!-- id="container" -->
266266
</body>

docs/topics/README.md.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -269,7 +269,7 @@ <h3>Terminal colors</h3>
269269
</div> <!-- id="main" -->
270270
<div id="about">
271271
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a></i>
272-
<i style="float:right;">Last updated 2022-02-05 10:49:30 </i>
272+
<i style="float:right;">Last updated 2022-06-08 20:37:27 </i>
273273
</div> <!-- id="about" -->
274274
</div> <!-- id="container" -->
275275
</body>

0 commit comments

Comments
 (0)