Skip to content

Commit

Permalink
docs build
Browse files Browse the repository at this point in the history
  • Loading branch information
@matiasvlevi
matiasvlevi committed May 4, 2024
1 parent 178159d commit 4168f77
Show file tree
Hide file tree
Showing 5 changed files with 21 additions and 7 deletions.
2 changes: 1 addition & 1 deletion docs/events.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ <h1 class="module">events</h1>
</header>


<div class="method" id="isKeyDown"><code>isKeyDown(k);</code><p>Check if a keyboard key is pressed, returns true if key is down and returns false if it's not</p><h4>Arguments</h4><div class="params"><div class="param"><code class="name">k</code><span class="text desc">The keyboard key to check
<div class="method" id="isKeyDown"><code>isKeyDown(k);</code><p>Check if a keyboard key is pressed, returns <code class="inline">true</code> if key is down and returns <code class="inline">false</code> if it's not</p><h4>Arguments</h4><div class="params"><div class="param"><code class="name">k</code><span class="text desc">The keyboard key to check
</span></div></div><h4>Returns</h4><div class="param"><code class="name">boolean</code><span class="text desc">Whether or not the key is down</span></div><p></p><br/></div>
</main>
</body>
Expand Down
2 changes: 1 addition & 1 deletion docs/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ <h1 class="module">Reference</h1>
<span class="text version">v0.0.2</span>
</header>

<div class="modules" id="reactive"><div class="summary"><h3>events</h3><ul><li class="index"><a class="dark index" href="./events.html#isKeyDown">isKeyDown</a></li></ul></div><div class="summary"><h3>shapes</h3><ul><li class="index"><a class="dark index" href="./shapes.html#circle">circle</a></li><li class="index"><a class="dark index" href="./shapes.html#rect">rect</a></li><li class="index"><a class="dark index" href="./shapes.html#square">square</a></li><li class="index"><a class="dark index" href="./shapes.html#line">line</a></li><li class="index"><a class="dark index" href="./shapes.html#quad">quad</a></li><li class="index"><a class="dark index" href="./shapes.html#text">text</a></li><li class="index"><a class="dark index" href="./shapes.html#point">point</a></li><li class="index"><a class="dark index" href="./shapes.html#arc">arc</a></li><li class="index"><a class="dark index" href="./shapes.html#ellipse">ellipse</a></li><li class="index"><a class="dark index" href="./shapes.html#triangle">triangle</a></li></ul></div><div class="summary"><h3>loaders</h3><ul><li class="index"><a class="dark index" href="./loaders.html#loadFont">loadFont</a></li></ul></div><div class="summary"><h3>window</h3><ul><li class="index"><a class="dark index" href="./window.html#createWindow">createWindow</a></li><li class="index"><a class="dark index" href="./window.html#background">background</a></li></ul></div><div class="summary"><h3>io</h3><ul><li class="index"><a class="dark index" href="./io.html#print">print</a></li></ul></div><div class="summary"><h3>setting</h3><ul><li class="index"><a class="dark index" href="./setting.html#fill">fill</a></li><li class="index"><a class="dark index" href="./setting.html#strokeWeight">strokeWeight</a></li><li class="index"><a class="dark index" href="./setting.html#noFill">noFill</a></li><li class="index"><a class="dark index" href="./setting.html#stroke">stroke</a></li><li class="index"><a class="dark index" href="./setting.html#noStroke">noStroke</a></li><li class="index"><a class="dark index" href="./setting.html#textSize">textSize</a></li></ul></div><div class="summary"><h3>math</h3><ul><li class="index"><a class="dark index" href="./math.html#round">round</a></li></ul></div></div>
<div class="modules" id="reactive"><div class="summary"><h3>setting</h3><ul><li class="index"><a class="dark index" href="./setting.html#fill">fill</a></li><li class="index"><a class="dark index" href="./setting.html#strokeWeight">strokeWeight</a></li><li class="index"><a class="dark index" href="./setting.html#noFill">noFill</a></li><li class="index"><a class="dark index" href="./setting.html#stroke">stroke</a></li><li class="index"><a class="dark index" href="./setting.html#noStroke">noStroke</a></li><li class="index"><a class="dark index" href="./setting.html#textSize">textSize</a></li><li class="index"><a class="dark index" href="./setting.html#textFont">textFont</a></li></ul></div><div class="summary"><h3>shapes</h3><ul><li class="index"><a class="dark index" href="./shapes.html#circle">circle</a></li><li class="index"><a class="dark index" href="./shapes.html#rect">rect</a></li><li class="index"><a class="dark index" href="./shapes.html#square">square</a></li><li class="index"><a class="dark index" href="./shapes.html#line">line</a></li><li class="index"><a class="dark index" href="./shapes.html#quad">quad</a></li><li class="index"><a class="dark index" href="./shapes.html#text">text</a></li><li class="index"><a class="dark index" href="./shapes.html#point">point</a></li><li class="index"><a class="dark index" href="./shapes.html#arc">arc</a></li><li class="index"><a class="dark index" href="./shapes.html#ellipse">ellipse</a></li><li class="index"><a class="dark index" href="./shapes.html#triangle">triangle</a></li></ul></div><div class="summary"><h3>math</h3><ul><li class="index"><a class="dark index" href="./math.html#round">round</a></li></ul></div><div class="summary"><h3>events</h3><ul><li class="index"><a class="dark index" href="./events.html#isKeyDown">isKeyDown</a></li></ul></div><div class="summary"><h3>window</h3><ul><li class="index"><a class="dark index" href="./window.html#createWindow">createWindow</a></li><li class="index"><a class="dark index" href="./window.html#background">background</a></li></ul></div><div class="summary"><h3>io</h3><ul><li class="index"><a class="dark index" href="./io.html#print">print</a></li></ul></div><div class="summary"><h3>loaders</h3><ul><li class="index"><a class="dark index" href="./loaders.html#loadFont">loadFont</a></li></ul></div></div>
</main>
</body>
</html>
2 changes: 1 addition & 1 deletion docs/io.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ <h1 class="module">io</h1>
</header>


<div class="method" id="print"><code>print(value);</code><p>Printing utility, can take any lua type, and any number of arguments.</p><h4>Arguments</h4><div class="params"><div class="param"><code class="name">value</code><span class="text desc">The value to print to stdout
<div class="method" id="print"><code>print(value);</code><p>Printing utility, can take any lua type (except objects).</p><h4>Arguments</h4><div class="params"><div class="param"><code class="name">value</code><span class="text desc">The value to print to stdout
</span></div></div><p></p><br/></div>
</main>
</body>
Expand Down
3 changes: 2 additions & 1 deletion docs/loaders.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -35,12 +35,13 @@ <h1 class="module">loaders</h1>
<div class="method" id="loadFont"><code>loadFont(path);</code><p>Load a font face</p><h4>Arguments</h4><div class="params"><div class="param"><code class="name">path</code><span class="text desc">The font path on the local system
</span></div></div><p></p><pre><code class="language-lua"> function setup()
createWindow(600, 600);
loadFont('/path/to/your/font.ttf');
myfont = loadFont('/path/to/myfont.ttf');
end

function draw()
background(51);

textFont(myfont);
text('Hello from lu5!', 30, 50);
end </code></pre><br/></div>
</main>
Expand Down
19 changes: 16 additions & 3 deletions docs/setting.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -46,11 +46,24 @@ <h1 class="module">setting</h1>
</span></div><div class="param"><code class="name">g</code><span class="text desc">The green byte
</span></div><div class="param"><code class="name">b</code><span class="text desc">The blue byte
</span></div><div class="param"><code class="name">a</code><span class="text desc">The alpha byte
</span></div></div><p>Only implemented with for `line` and `circle`</p><br/></div>
<div class="method" id="noStroke"><code>noStroke();</code><p>Only implemented with for `line` and `circle`
</span></div></div><p>Only implemented for <code class="inline">line</code> and <code class="inline">circle</code></p><br/></div>
<div class="method" id="noStroke"><code>noStroke();</code><p>Only implemented for <code class="inline">line</code> and <code class="inline">circle</code>
Disable stroke</p><h4>Arguments</h4><div class="params"></div><p></p><br/></div>
<div class="method" id="textSize"><code>textSize(size);</code><p>Set the font size</p><h4>Arguments</h4><div class="params"><div class="param"><code class="name">size</code><span class="text desc">The size of the font in pixels
</span></div></div><p></p><br/></div>
</span></div></div><p>If this is called using fonts, make sure to call <code class="inline">textSize</code> after calling <code class="inline">textFont</code></p><br/></div>
<div class="method" id="textFont"><code>textFont(font);</code><p>Set the font family</p><h4>Arguments</h4><div class="params"><div class="param"><code class="name">font</code><span class="text desc">The font value returned when using loadFont
</span></div></div><p></p><pre><code class="language-lua"> function setup()
createWindow(600, 600);

myfont = loadFont('path/to/myfont.ttf');
end

function draw()
background(51);

textFont(myfont);
text('Hello world!', 100, 200);
end</code></pre><br/></div>
</main>
</body>
</html>

0 comments on commit 4168f77

Please sign in to comment.