hg.stevelosh.com > docs.stevelosh.com

fd88490d871a 

cl-blt: Update site.
[view raw] [browse files]
author Steve Losh <steve@stevelosh.com>
date Fri, 24 Nov 2017 14:29:25 -0500
parents 39da848801bd
children 5249c61c0562
branches/tags (none)
files cl-blt/index.html cl-blt/reference/index.html

Changes

--- a/cl-blt/index.html	Fri Nov 03 23:48:28 2017 -0400
+++ b/cl-blt/index.html	Fri Nov 24 14:29:25 2017 -0500
@@ -17,7 +17,7 @@
 top of them.</p>
 <ul>
 <li><strong>License:</strong> MIT/X11</li>
-<li><strong>Documentation:</strong> <a href="http://sjl.bitbucket.org/cl-blt/">http://sjl.bitbucket.org/cl-blt/</a></li>
+<li><strong>Documentation:</strong> <a href="https://sjl.bitbucket.io/cl-blt/">https://sjl.bitbucket.io/cl-blt/</a></li>
 <li><strong>Mercurial:</strong> <a href="http://bitbucket.org/sjl/cl-blt/">http://bitbucket.org/sjl/cl-blt/</a></li>
 <li><strong>Git:</strong> <a href="http://github.com/sjl/cl-blt/">http://github.com/sjl/cl-blt/</a></li>
 </ul><h2>Table of Contents</h2><ol class="toc"><li><a href="installation/">Installation</a></li><li><a href="usage/">Usage</a></li><li><a href="reference/"> API Reference</a></li><li><a href="changelog/">Changelog</a></li></ol>
--- a/cl-blt/reference/index.html	Fri Nov 03 23:48:28 2017 -0400
+++ b/cl-blt/reference/index.html	Fri Nov 24 14:29:25 2017 -0500
@@ -19,7 +19,57 @@
 don't touch it.</p>
 <div class="toc">
 <ul>
-<li><a href="#package-bearlibterminalhigh-level">Package BEARLIBTERMINAL/HIGH-LEVEL</a></li>
+<li><a href="#package-bearlibterminalhigh-level">Package BEARLIBTERMINAL/HIGH-LEVEL</a><ul>
+<li><a href="#background-color-function">BACKGROUND-COLOR (function)</a></li>
+<li><a href="#black-function">BLACK (function)</a></li>
+<li><a href="#blue-function">BLUE (function)</a></li>
+<li><a href="#cell-background-color-function">CELL-BACKGROUND-COLOR (function)</a></li>
+<li><a href="#cell-char-function">CELL-CHAR (function)</a></li>
+<li><a href="#cell-code-function">CELL-CODE (function)</a></li>
+<li><a href="#cell-color-function">CELL-COLOR (function)</a></li>
+<li><a href="#character-input-function">CHARACTER-INPUT (function)</a></li>
+<li><a href="#chartreuse-function">CHARTREUSE (function)</a></li>
+<li><a href="#clear-function">CLEAR (function)</a></li>
+<li><a href="#clear-area-function">CLEAR-AREA (function)</a></li>
+<li><a href="#clear-layer-function">CLEAR-LAYER (function)</a></li>
+<li><a href="#close-function">CLOSE (function)</a></li>
+<li><a href="#color">COLOR</a></li>
+<li><a href="#color-name-function">COLOR-NAME (function)</a></li>
+<li><a href="#color-to-hsva-function">COLOR-TO-HSVA (function)</a></li>
+<li><a href="#color-to-rgba-function">COLOR-TO-RGBA (function)</a></li>
+<li><a href="#composition-function">COMPOSITION (function)</a></li>
+<li><a href="#crop-function">CROP (function)</a></li>
+<li><a href="#cyan-function">CYAN (function)</a></li>
+<li><a href="#draw-box-function">DRAW-BOX (function)</a></li>
+<li><a href="#font-function">FONT (function)</a></li>
+<li><a href="#gray-function">GRAY (function)</a></li>
+<li><a href="#green-function">GREEN (function)</a></li>
+<li><a href="#has-input-p-function">HAS-INPUT-P (function)</a></li>
+<li><a href="#height-function">HEIGHT (function)</a></li>
+<li><a href="#hsva-function">HSVA (function)</a></li>
+<li><a href="#key-case-macro">KEY-CASE (macro)</a></li>
+<li><a href="#layer-function">LAYER (function)</a></li>
+<li><a href="#magenta-function">MAGENTA (function)</a></li>
+<li><a href="#mouse-function">MOUSE (function)</a></li>
+<li><a href="#mouse-x-function">MOUSE-X (function)</a></li>
+<li><a href="#mouse-y-function">MOUSE-Y (function)</a></li>
+<li><a href="#open-function">OPEN (function)</a></li>
+<li><a href="#orange-function">ORANGE (function)</a></li>
+<li><a href="#peek-function">PEEK (function)</a></li>
+<li><a href="#print-function">PRINT (function)</a></li>
+<li><a href="#purple-function">PURPLE (function)</a></li>
+<li><a href="#read-function">READ (function)</a></li>
+<li><a href="#red-function">RED (function)</a></li>
+<li><a href="#refresh-function">REFRESH (function)</a></li>
+<li><a href="#rgba-function">RGBA (function)</a></li>
+<li><a href="#set-function">SET (function)</a></li>
+<li><a href="#sleep-function">SLEEP (function)</a></li>
+<li><a href="#white-function">WHITE (function)</a></li>
+<li><a href="#width-function">WIDTH (function)</a></li>
+<li><a href="#with-terminal-macro">WITH-TERMINAL (macro)</a></li>
+<li><a href="#yellow-function">YELLOW (function)</a></li>
+</ul>
+</li>
 <li><a href="#package-bearlibterminallow-level">Package BEARLIBTERMINAL/LOW-LEVEL</a><ul>
 <li><a href="#-sizeof-wchar-t-variable">+--SIZEOF-WCHAR-T--+ (variable)</a></li>
 <li><a href="#terminal-vsprintf-maximum-buffer-size-variable">+TERMINAL-VSPRINTF-MAXIMUM-BUFFER-SIZE+ (variable)</a></li>
@@ -174,6 +224,10 @@
 <li><a href="#terminal-composition-function">TERMINAL-COMPOSITION (function)</a></li>
 <li><a href="#terminal-crop-function">TERMINAL-CROP (function)</a></li>
 <li><a href="#terminal-delay-function">TERMINAL-DELAY (function)</a></li>
+<li><a href="#terminal-font-function">TERMINAL-FONT (function)</a></li>
+<li><a href="#terminal-font-16-function">TERMINAL-FONT-16 (function)</a></li>
+<li><a href="#terminal-font-32-function">TERMINAL-FONT-32 (function)</a></li>
+<li><a href="#terminal-font-8-function">TERMINAL-FONT-8 (function)</a></li>
 <li><a href="#terminal-get-function">TERMINAL-GET (function)</a></li>
 <li><a href="#terminal-get-16-function">TERMINAL-GET-16 (function)</a></li>
 <li><a href="#terminal-get-32-function">TERMINAL-GET-32 (function)</a></li>
@@ -216,6 +270,7 @@
 <li><a href="#terminal-state-function">TERMINAL-STATE (function)</a></li>
 <li><a href="#terminal-vsprintf-function">TERMINAL-VSPRINTF (function)</a></li>
 <li><a href="#terminal-vswprintf-function">TERMINAL-VSWPRINTF (function)</a></li>
+<li><a href="#terminal-wfont-function">TERMINAL-WFONT (function)</a></li>
 <li><a href="#terminal-wget-function">TERMINAL-WGET (function)</a></li>
 <li><a href="#terminal-wmeasure-function">TERMINAL-WMEASURE (function)</a></li>
 <li><a href="#terminal-wmeasure-ext-function">TERMINAL-WMEASURE-EXT (function)</a></li>
@@ -232,6 +287,260 @@
 </ul></div>
 <h2 id="package-bearlibterminalhigh-level">Package <code>BEARLIBTERMINAL/HIGH-LEVEL</code></h2>
 <p>This package contains a high-level, lispy interface to bearlibterminal.  It has the nickname <code>blt</code> for easy prefixing.</p>
+<h3 id="background-color-function"><code>BACKGROUND-COLOR</code> (function)</h3>
+<div class="codehilite"><pre><span/>(BACKGROUND-COLOR)
+</pre></div>
+
+
+<h3 id="black-function"><code>BLACK</code> (function)</h3>
+<div class="codehilite"><pre><span/>(BLACK &amp;KEY (VALUE 0.0) (ALPHA 1.0))
+</pre></div>
+
+
+<h3 id="blue-function"><code>BLUE</code> (function)</h3>
+<div class="codehilite"><pre><span/>(BLUE &amp;KEY (SATURATION 1.0) (VALUE 1.0) (ALPHA 1.0))
+</pre></div>
+
+
+<h3 id="cell-background-color-function"><code>CELL-BACKGROUND-COLOR</code> (function)</h3>
+<div class="codehilite"><pre><span/>(CELL-BACKGROUND-COLOR X Y)
+</pre></div>
+
+
+<h3 id="cell-char-function"><code>CELL-CHAR</code> (function)</h3>
+<div class="codehilite"><pre><span/>(CELL-CHAR X Y &amp;OPTIONAL (INDEX 0))
+</pre></div>
+
+
+<h3 id="cell-code-function"><code>CELL-CODE</code> (function)</h3>
+<div class="codehilite"><pre><span/>(CELL-CODE X Y &amp;OPTIONAL (INDEX 0))
+</pre></div>
+
+
+<h3 id="cell-color-function"><code>CELL-COLOR</code> (function)</h3>
+<div class="codehilite"><pre><span/>(CELL-COLOR X Y &amp;OPTIONAL (INDEX 0))
+</pre></div>
+
+
+<h3 id="character-input-function"><code>CHARACTER-INPUT</code> (function)</h3>
+<div class="codehilite"><pre><span/>(CHARACTER-INPUT)
+</pre></div>
+
+
+<h3 id="chartreuse-function"><code>CHARTREUSE</code> (function)</h3>
+<div class="codehilite"><pre><span/>(CHARTREUSE &amp;KEY (SATURATION 1.0) (VALUE 1.0) (ALPHA 1.0))
+</pre></div>
+
+
+<h3 id="clear-function"><code>CLEAR</code> (function)</h3>
+<div class="codehilite"><pre><span/>(CLEAR)
+</pre></div>
+
+
+<h3 id="clear-area-function"><code>CLEAR-AREA</code> (function)</h3>
+<div class="codehilite"><pre><span/>(CLEAR-AREA X Y WIDTH HEIGHT)
+</pre></div>
+
+
+<h3 id="clear-layer-function"><code>CLEAR-LAYER</code> (function)</h3>
+<div class="codehilite"><pre><span/>(CLEAR-LAYER &amp;OPTIONAL LAYER)
+</pre></div>
+
+
+<p>Clear <code>layer</code>, or the current layer if not given.</p>
+<h3 id="close-function"><code>CLOSE</code> (function)</h3>
+<div class="codehilite"><pre><span/>(CLOSE)
+</pre></div>
+
+
+<h3 id="color"><code>COLOR</code></h3>
+<p><code>#&lt;STANDARD-CLASS DOCPARSER:TYPE-NODE&gt;</code></p>
+<h3 id="color-name-function"><code>COLOR-NAME</code> (function)</h3>
+<div class="codehilite"><pre><span/>(COLOR-NAME COLOR-NAME)
+</pre></div>
+
+
+<h3 id="color-to-hsva-function"><code>COLOR-TO-HSVA</code> (function)</h3>
+<div class="codehilite"><pre><span/>(COLOR-TO-HSVA COLOR &amp;OPTIONAL FLOAT?)
+</pre></div>
+
+
+<h3 id="color-to-rgba-function"><code>COLOR-TO-RGBA</code> (function)</h3>
+<div class="codehilite"><pre><span/>(COLOR-TO-RGBA COLOR &amp;OPTIONAL FLOAT?)
+</pre></div>
+
+
+<h3 id="composition-function"><code>COMPOSITION</code> (function)</h3>
+<div class="codehilite"><pre><span/>(COMPOSITION)
+</pre></div>
+
+
+<h3 id="crop-function"><code>CROP</code> (function)</h3>
+<div class="codehilite"><pre><span/>(CROP X Y WIDTH HEIGHT)
+</pre></div>
+
+
+<h3 id="cyan-function"><code>CYAN</code> (function)</h3>
+<div class="codehilite"><pre><span/>(CYAN &amp;KEY (SATURATION 1.0) (VALUE 1.0) (ALPHA 1.0))
+</pre></div>
+
+
+<h3 id="draw-box-function"><code>DRAW-BOX</code> (function)</h3>
+<div class="codehilite"><pre><span/>(DRAW-BOX X Y WIDTH HEIGHT &amp;KEY (CONTENTS NIL) (BORDER :LIGHT)
+          (BACKGROUND-COLOR (RGBA 0 0 0)) (BORDER-COLOR (RGBA 255 255 255)))
+</pre></div>
+
+
+<p>Draw a box.</p>
+<p>The border of the box, if present, will be one cell wide/tall.</p>
+<p><code>border</code> specifies the type of border to draw, and can be one of <code>:light</code>,
+  <code>:heavy</code>, or <code>:double</code>, or <code>nil</code> for no border.</p>
+<p><code>background-color</code> and <code>border-color</code> specify the colors to use.  If <code>nil</code> is
+  given they will not be drawn.</p>
+<p>The <code>width</code> and <code>height</code> measurements include the two border cells, if
+  present.  For example: a <code>width</code> of <code>10</code> would have <code>8</code> cells of content
+  space with a border.</p>
+<p>If given, <code>contents</code> will be <code>print</code>ed inside the box with the appropriate
+  bounds.  The color, font, etc will all be whatever they are currently set to.</p>
+<p><strong>EXPERIMENTAL</strong>: This function is experimental and may change or be remove
+  entirely in the future.</p>
+<h3 id="font-function"><code>FONT</code> (function)</h3>
+<div class="codehilite"><pre><span/>(FONT NEW-VALUE)
+</pre></div>
+
+
+<h3 id="gray-function"><code>GRAY</code> (function)</h3>
+<div class="codehilite"><pre><span/>(GRAY &amp;KEY (VALUE 0.5) (ALPHA 1.0))
+</pre></div>
+
+
+<h3 id="green-function"><code>GREEN</code> (function)</h3>
+<div class="codehilite"><pre><span/>(GREEN &amp;KEY (SATURATION 1.0) (VALUE 1.0) (ALPHA 1.0))
+</pre></div>
+
+
+<h3 id="has-input-p-function"><code>HAS-INPUT-P</code> (function)</h3>
+<div class="codehilite"><pre><span/>(HAS-INPUT-P)
+</pre></div>
+
+
+<h3 id="height-function"><code>HEIGHT</code> (function)</h3>
+<div class="codehilite"><pre><span/>(HEIGHT)
+</pre></div>
+
+
+<h3 id="hsva-function"><code>HSVA</code> (function)</h3>
+<div class="codehilite"><pre><span/>(HSVA H S V &amp;OPTIONAL (A NIL))
+</pre></div>
+
+
+<h3 id="key-case-macro"><code>KEY-CASE</code> (macro)</h3>
+<div class="codehilite"><pre><span/>(KEY-CASE DATA &amp;REST CLAUSES)
+</pre></div>
+
+
+<h3 id="layer-function"><code>LAYER</code> (function)</h3>
+<div class="codehilite"><pre><span/>(LAYER)
+</pre></div>
+
+
+<h3 id="magenta-function"><code>MAGENTA</code> (function)</h3>
+<div class="codehilite"><pre><span/>(MAGENTA &amp;KEY (SATURATION 1.0) (VALUE 1.0) (ALPHA 1.0))
+</pre></div>
+
+
+<h3 id="mouse-function"><code>MOUSE</code> (function)</h3>
+<div class="codehilite"><pre><span/>(MOUSE)
+</pre></div>
+
+
+<h3 id="mouse-x-function"><code>MOUSE-X</code> (function)</h3>
+<div class="codehilite"><pre><span/>(MOUSE-X)
+</pre></div>
+
+
+<h3 id="mouse-y-function"><code>MOUSE-Y</code> (function)</h3>
+<div class="codehilite"><pre><span/>(MOUSE-Y)
+</pre></div>
+
+
+<h3 id="open-function"><code>OPEN</code> (function)</h3>
+<div class="codehilite"><pre><span/>(OPEN)
+</pre></div>
+
+
+<h3 id="orange-function"><code>ORANGE</code> (function)</h3>
+<div class="codehilite"><pre><span/>(ORANGE &amp;KEY (SATURATION 1.0) (VALUE 1.0) (ALPHA 1.0))
+</pre></div>
+
+
+<h3 id="peek-function"><code>PEEK</code> (function)</h3>
+<div class="codehilite"><pre><span/>(PEEK)
+</pre></div>
+
+
+<h3 id="print-function"><code>PRINT</code> (function)</h3>
+<div class="codehilite"><pre><span/>(PRINT X Y STRING &amp;KEY WIDTH HEIGHT (HALIGN :DEFAULT) (VALIGN :DEFAULT))
+</pre></div>
+
+
+<h3 id="purple-function"><code>PURPLE</code> (function)</h3>
+<div class="codehilite"><pre><span/>(PURPLE &amp;KEY (SATURATION 1.0) (VALUE 1.0) (ALPHA 1.0))
+</pre></div>
+
+
+<h3 id="read-function"><code>READ</code> (function)</h3>
+<div class="codehilite"><pre><span/>(READ)
+</pre></div>
+
+
+<h3 id="red-function"><code>RED</code> (function)</h3>
+<div class="codehilite"><pre><span/>(RED &amp;KEY (SATURATION 1.0) (VALUE 1.0) (ALPHA 1.0))
+</pre></div>
+
+
+<h3 id="refresh-function"><code>REFRESH</code> (function)</h3>
+<div class="codehilite"><pre><span/>(REFRESH)
+</pre></div>
+
+
+<h3 id="rgba-function"><code>RGBA</code> (function)</h3>
+<div class="codehilite"><pre><span/>(RGBA R G B &amp;OPTIONAL (A NIL))
+</pre></div>
+
+
+<h3 id="set-function"><code>SET</code> (function)</h3>
+<div class="codehilite"><pre><span/>(SET CONFIGURATION-STRING &amp;REST FORMAT-ARGUMENTS)
+</pre></div>
+
+
+<h3 id="sleep-function"><code>SLEEP</code> (function)</h3>
+<div class="codehilite"><pre><span/>(SLEEP SECONDS)
+</pre></div>
+
+
+<h3 id="white-function"><code>WHITE</code> (function)</h3>
+<div class="codehilite"><pre><span/>(WHITE &amp;KEY (VALUE 1.0) (ALPHA 1.0))
+</pre></div>
+
+
+<h3 id="width-function"><code>WIDTH</code> (function)</h3>
+<div class="codehilite"><pre><span/>(WIDTH)
+</pre></div>
+
+
+<h3 id="with-terminal-macro"><code>WITH-TERMINAL</code> (macro)</h3>
+<div class="codehilite"><pre><span/>(WITH-TERMINAL
+  &amp;BODY
+  BODY)
+</pre></div>
+
+
+<h3 id="yellow-function"><code>YELLOW</code> (function)</h3>
+<div class="codehilite"><pre><span/>(YELLOW &amp;KEY (SATURATION 1.0) (VALUE 1.0) (ALPHA 1.0))
+</pre></div>
+
+
 <h2 id="package-bearlibterminallow-level">Package <code>BEARLIBTERMINAL/LOW-LEVEL</code></h2>
 <p>This package contains the low-level, SWIG-generated wrapper functions for bearlibterminal.</p>
 <h3 id="-sizeof-wchar-t-variable"><code>+--SIZEOF-WCHAR-T--+</code> (variable)</h3>
@@ -448,6 +757,26 @@
 </pre></div>
 
 
+<h3 id="terminal-font-function"><code>TERMINAL-FONT</code> (function)</h3>
+<div class="codehilite"><pre><span/>(TERMINAL-FONT)
+</pre></div>
+
+
+<h3 id="terminal-font-16-function"><code>TERMINAL-FONT-16</code> (function)</h3>
+<div class="codehilite"><pre><span/>(TERMINAL-FONT-16)
+</pre></div>
+
+
+<h3 id="terminal-font-32-function"><code>TERMINAL-FONT-32</code> (function)</h3>
+<div class="codehilite"><pre><span/>(TERMINAL-FONT-32)
+</pre></div>
+
+
+<h3 id="terminal-font-8-function"><code>TERMINAL-FONT-8</code> (function)</h3>
+<div class="codehilite"><pre><span/>(TERMINAL-FONT-8)
+</pre></div>
+
+
 <h3 id="terminal-get-function"><code>TERMINAL-GET</code> (function)</h3>
 <div class="codehilite"><pre><span/>(TERMINAL-GET)
 </pre></div>
@@ -658,6 +987,11 @@
 </pre></div>
 
 
+<h3 id="terminal-wfont-function"><code>TERMINAL-WFONT</code> (function)</h3>
+<div class="codehilite"><pre><span/>(TERMINAL-WFONT)
+</pre></div>
+
+
 <h3 id="terminal-wget-function"><code>TERMINAL-WGET</code> (function)</h3>
 <div class="codehilite"><pre><span/>(TERMINAL-WGET)
 </pre></div>