Skip to content

Commit

Permalink
docs build
Browse files Browse the repository at this point in the history
  • Loading branch information
@matiasvlevi
matiasvlevi committed Apr 28, 2024
1 parent 9c527cd commit e9b9bfd
Show file tree
Hide file tree
Showing 6 changed files with 61 additions and 97 deletions.
12 changes: 4 additions & 8 deletions docs/events.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -12,12 +12,9 @@
<body>
<div class="wrapper">
<div class="nav">
<div class="search">
<img width="30px" src="assets/search.svg"/>
<input type="text" placeholder="search"/>
</div>
<br/>
<ul><li class="btn"><a class="light" href="./window.html"><h4>window</h4></a></li><li class="btn"><a class="light" href="./shapes.html"><h4>shapes</h4></a></li><li class="btn"><a class="light" href="./setting.html"><h4>setting</h4></a></li><li class="btn"><a class="light" href="./io.html"><h4>io</h4></a></li><li class="btn"><a class="light" href="./events.html"><h4>events</h4></a></li></ul>
<a class="backBtn light" href="./"><img width="40px" src="./assets/back.svg"/></a>
<a class="backBtn light" href="./"><img width="32px" src="./assets/back.svg"/></a>
</div>
<main>
<header>
Expand All @@ -26,9 +23,8 @@ <h1 class="module">events</h1>
</header>


<div class="method"><h3>isKeyDown</h3><p>
Check if a keyboard key is pressed</p><div class="params"><div class="param"><span class="name">k</span><span class="desc"> The keyboard key to check
</span></div></div><br/><code>int isKeyDown(lua_State *L);</code></div>
<div class="method"><code>isKeyDown(k);</code><p>Check if a keyboard key is pressed, returns true if key is down and returns false if it</p><div class="params"><div class="param"><code class="name">k</code><span class="desc">The keyboard key to check
</span></div></div><br/></div>
</main>
</div>
</body>
Expand Down
5 changes: 1 addition & 4 deletions docs/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -12,10 +12,7 @@
<body>
<div class="wrapper">
<div class="nav">
<div class="search">
<img width="30px" src="assets/search.svg"/>
<input type="text" placeholder="search"/>
</div>
<br/>
<ul><li class="btn"><a class="light" href="./window.html"><h4>window</h4></a></li><li class="btn"><a class="light" href="./shapes.html"><h4>shapes</h4></a></li><li class="btn"><a class="light" href="./setting.html"><h4>setting</h4></a></li><li class="btn"><a class="light" href="./io.html"><h4>io</h4></a></li><li class="btn"><a class="light" href="./events.html"><h4>events</h4></a></li></ul>

</div>
Expand Down
12 changes: 4 additions & 8 deletions docs/io.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -12,12 +12,9 @@
<body>
<div class="wrapper">
<div class="nav">
<div class="search">
<img width="30px" src="assets/search.svg"/>
<input type="text" placeholder="search"/>
</div>
<br/>
<ul><li class="btn"><a class="light" href="./window.html"><h4>window</h4></a></li><li class="btn"><a class="light" href="./shapes.html"><h4>shapes</h4></a></li><li class="btn"><a class="light" href="./setting.html"><h4>setting</h4></a></li><li class="btn"><a class="light" href="./io.html"><h4>io</h4></a></li><li class="btn"><a class="light" href="./events.html"><h4>events</h4></a></li></ul>
<a class="backBtn light" href="./"><img width="40px" src="./assets/back.svg"/></a>
<a class="backBtn light" href="./"><img width="32px" src="./assets/back.svg"/></a>
</div>
<main>
<header>
Expand All @@ -26,9 +23,8 @@ <h1 class="module">io</h1>
</header>


<div class="method"><h3>print</h3><p>
Printing utility</p><div class="params"><div class="param"><span class="name">value</span><span class="desc"> The value to print to stdout
</span></div></div><br/><code>int print(lua_State *L);</code></div>
<div class="method"><code>print(value);</code><p>Printing utility, can take any lua type, and any number of arguments.</p><div class="params"><div class="param"><code class="name">value</code><span class="desc">The value to print to stdout
</span></div></div><br/></div>
</main>
</div>
</body>
Expand Down
18 changes: 7 additions & 11 deletions docs/setting.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -12,12 +12,9 @@
<body>
<div class="wrapper">
<div class="nav">
<div class="search">
<img width="30px" src="assets/search.svg"/>
<input type="text" placeholder="search"/>
</div>
<br/>
<ul><li class="btn"><a class="light" href="./window.html"><h4>window</h4></a></li><li class="btn"><a class="light" href="./shapes.html"><h4>shapes</h4></a></li><li class="btn"><a class="light" href="./setting.html"><h4>setting</h4></a></li><li class="btn"><a class="light" href="./io.html"><h4>io</h4></a></li><li class="btn"><a class="light" href="./events.html"><h4>events</h4></a></li></ul>
<a class="backBtn light" href="./"><img width="40px" src="./assets/back.svg"/></a>
<a class="backBtn light" href="./"><img width="32px" src="./assets/back.svg"/></a>
</div>
<main>
<header>
Expand All @@ -26,12 +23,11 @@ <h1 class="module">setting</h1>
</header>


<div class="method"><h3>fill</h3><p>
Set the fill color for shapes</p><div class="params"><div class="param"><span class="name">g</span><span class="desc"> The green byte
</span></div><div class="param"><span class="name">b</span><span class="desc"> The blue byte
</span></div><div class="param"><span class="name">a</span><span class="desc"> The alpha byte
</span></div><div class="param"><span class="name">r</span><span class="desc"> The red byte
</span></div></div><br/><code>int fill(lua_State *L);</code></div>
<div class="method"><code>fill(r, g, b, a);</code><p>Set the fill color for shapes</p><div class="params"><div class="param"><code class="name">r</code><span class="desc">The red byte
</span></div><div class="param"><code class="name">g</code><span class="desc">The green byte
</span></div><div class="param"><code class="name">b</code><span class="desc">The blue byte
</span></div><div class="param"><code class="name">a</code><span class="desc">The alpha byte
</span></div></div><br/></div>
</main>
</div>
</body>
Expand Down
86 changes: 35 additions & 51 deletions docs/shapes.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -12,12 +12,9 @@
<body>
<div class="wrapper">
<div class="nav">
<div class="search">
<img width="30px" src="assets/search.svg"/>
<input type="text" placeholder="search"/>
</div>
<br/>
<ul><li class="btn"><a class="light" href="./window.html"><h4>window</h4></a></li><li class="btn"><a class="light" href="./shapes.html"><h4>shapes</h4></a></li><li class="btn"><a class="light" href="./setting.html"><h4>setting</h4></a></li><li class="btn"><a class="light" href="./io.html"><h4>io</h4></a></li><li class="btn"><a class="light" href="./events.html"><h4>events</h4></a></li></ul>
<a class="backBtn light" href="./"><img width="40px" src="./assets/back.svg"/></a>
<a class="backBtn light" href="./"><img width="32px" src="./assets/back.svg"/></a>
</div>
<main>
<header>
Expand All @@ -26,52 +23,39 @@ <h1 class="module">shapes</h1>
</header>


<div class="method"><h3>circle</h3><p>
Draw a circle to the opengl context</p><div class="params"><div class="param"><span class="name">y</span><span class="desc"> The y position of the circle's center
</span></div><div class="param"><span class="name">d</span><span class="desc"> The diameter of the circle
</span></div><div class="param"><span class="name">x</span><span class="desc"> The x position of the circle's center
</span></div></div><br/><code>int circle(lua_State *L);</code></div>
<div class="method"><h3>rect</h3><p>
Draw a rectangle to the opengl context</p><div class="params"><div class="param"><span class="name">y</span><span class="desc"> The y position of the reactangle's top left corner
</span></div><div class="param"><span class="name">w</span><span class="desc"> The width
</span></div><div class="param"><span class="name">h</span><span class="desc"> The height
</span></div><div class="param"><span class="name">x</span><span class="desc"> The x position of the reactangle's top left corner
</span></div></div><br/><code>int rect(lua_State *L);</code></div>
<div class="method"><h3>square</h3><p>
Draw a square to the opengl context</p><div class="params"><div class="param"><span class="name">y</span><span class="desc"> The y position of the square's top left corner
</span></div><div class="param"><span class="name">s</span><span class="desc"> The size of the square's sides
</span></div><div class="param"><span class="name">x</span><span class="desc"> The x position of the square's top left corner
</span></div></div><br/><code>int square(lua_State *L);</code></div>
<div class="method"><h3>line</h3><p>
Draw a line to the opengl context</p><div class="params"><div class="param"><span class="name">y1</span><span class="desc"> The y position of the first point
</span></div><div class="param"><span class="name">x2</span><span class="desc"> The x position of the second point
</span></div><div class="param"><span class="name">y2</span><span class="desc"> The y position of the second point
</span></div><div class="param"><span class="name">x1</span><span class="desc"> The x position of the first point
</span></div></div><br/><code>int line(lua_State *L);</code></div>
<div class="method"><h3>text</h3><p>
Draw text on the opengl context</p><div class="params"><div class="param"><span class="name">x</span><span class="desc"> position of the text
</span></div><div class="param"><span class="name">y</span><span class="desc"> position of the text
</span></div><div class="param"><span class="name">s</span><span class="desc"> Text string
</span></div></div><br/><code>int text(lua_State *L);</code></div>
<div class="method"><h3>point</h3><p>
Draw a point on the screen</p><div class="params"></div><br/><code>int point(lua_State *L);</code></div>
<div class="method"><h3>arc</h3><p>
Draw an arc on the screen</p><div class="params"></div><br/><code>int arc(lua_State *L);</code></div>
<div class="method"><h3>ellipse</h3><p>

Draw an ellipse on the screen</p><div class="params"></div><br/><code>int ellipse(lua_State *L);</code></div>
<div class="method"><h3>triangle</h3><p>
Draw a triangle on the screen</p><div class="params"></div><br/><code>int triangle(lua_State *L);</code></div>
<div class="method"><h3>quad</h3><p>
Draw a quad on the screen</p><div class="params"><div class="param"><span class="name">y1</span><span class="desc"> The y position of the first point
</span></div><div class="param"><span class="name">x2</span><span class="desc"> The x position of the second point
</span></div><div class="param"><span class="name">y2</span><span class="desc"> The y position of the second point
</span></div><div class="param"><span class="name">x3</span><span class="desc"> The x position of the third point
</span></div><div class="param"><span class="name">y3</span><span class="desc"> The y position of the third point
</span></div><div class="param"><span class="name">x4</span><span class="desc"> The x position of the fourth point
</span></div><div class="param"><span class="name">y4</span><span class="desc"> The y position of the fourth point
</span></div><div class="param"><span class="name">x1</span><span class="desc"> The x position of the first point
</span></div></div><br/><code>int quad(lua_State *L);</code></div>
<div class="method"><code>circle(x, y, d);</code><p>Draw a circle to the opengl context</p><div class="params"><div class="param"><code class="name">x</code><span class="desc">The x position of the circle's center
</span></div><div class="param"><code class="name">y</code><span class="desc">The y position of the circle's center
</span></div><div class="param"><code class="name">d</code><span class="desc">The diameter of the circle
</span></div></div><br/></div>
<div class="method"><code>rect(x, y, w, h);</code><p>Draw a rectangle to the opengl context</p><div class="params"><div class="param"><code class="name">x</code><span class="desc">The x position of the reactangle's top left corner
</span></div><div class="param"><code class="name">y</code><span class="desc">The y position of the reactangle's top left corner
</span></div><div class="param"><code class="name">w</code><span class="desc">The width
</span></div><div class="param"><code class="name">h</code><span class="desc">The height
</span></div></div><br/></div>
<div class="method"><code>square(x, y, s);</code><p>Draw a square to the opengl context</p><div class="params"><div class="param"><code class="name">x</code><span class="desc">The x position of the square's top left corner
</span></div><div class="param"><code class="name">y</code><span class="desc">The y position of the square's top left corner
</span></div><div class="param"><code class="name">s</code><span class="desc">The size of the square's sides
</span></div></div><br/></div>
<div class="method"><code>line(x1, y1, x2, y2);</code><p>Draw a line to the opengl context</p><div class="params"><div class="param"><code class="name">x1</code><span class="desc">The x position of the first point
</span></div><div class="param"><code class="name">y1</code><span class="desc">The y position of the first point
</span></div><div class="param"><code class="name">x2</code><span class="desc">The x position of the second point
</span></div><div class="param"><code class="name">y2</code><span class="desc">The y position of the second point
</span></div></div><br/></div>
<div class="method"><code>quad(x1, y1, x2, y2, x3, y3, x4, y4);</code><p>Draw a quad on the screen</p><div class="params"><div class="param"><code class="name">x1</code><span class="desc">The x position of the first point
</span></div><div class="param"><code class="name">y1</code><span class="desc">The y position of the first point
</span></div><div class="param"><code class="name">x2</code><span class="desc">The x position of the second point
</span></div><div class="param"><code class="name">y2</code><span class="desc">The y position of the second point
</span></div><div class="param"><code class="name">x3</code><span class="desc">The x position of the third point
</span></div><div class="param"><code class="name">y3</code><span class="desc">The y position of the third point
</span></div><div class="param"><code class="name">x4</code><span class="desc">The x position of the fourth point
</span></div><div class="param"><code class="name">y4</code><span class="desc">The y position of the fourth point
</span></div></div><br/></div>
<div class="method"><code>text();</code><p>Draw text on the screen</p><div class="params"></div><br/></div>
<div class="method"><code>point();</code><p>Draw a point on the screen</p><div class="params"></div><br/></div>
<div class="method"><code>arc();</code><p>Draw an arc on the screen</p><div class="params"></div><br/></div>
<div class="method"><code>ellipse();</code><p>
Draw an ellipse on the screen</p><div class="params"></div><br/></div>
<div class="method"><code>triangle();</code><p>Draw a triangle on the screen</p><div class="params"></div><br/></div>
</main>
</div>
</body>
Expand Down
25 changes: 10 additions & 15 deletions docs/window.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -12,12 +12,9 @@
<body>
<div class="wrapper">
<div class="nav">
<div class="search">
<img width="30px" src="assets/search.svg"/>
<input type="text" placeholder="search"/>
</div>
<br/>
<ul><li class="btn"><a class="light" href="./window.html"><h4>window</h4></a></li><li class="btn"><a class="light" href="./shapes.html"><h4>shapes</h4></a></li><li class="btn"><a class="light" href="./setting.html"><h4>setting</h4></a></li><li class="btn"><a class="light" href="./io.html"><h4>io</h4></a></li><li class="btn"><a class="light" href="./events.html"><h4>events</h4></a></li></ul>
<a class="backBtn light" href="./"><img width="40px" src="./assets/back.svg"/></a>
<a class="backBtn light" href="./"><img width="32px" src="./assets/back.svg"/></a>
</div>
<main>
<header>
Expand All @@ -26,16 +23,14 @@ <h1 class="module">window</h1>
</header>


<div class="method"><h3>createWindow</h3><p>
Create an OpenGL context and a GLFW window</p><div class="params"><div class="param"><span class="name">h</span><span class="desc"> Window height
</span></div><div class="param"><span class="name">w</span><span class="desc"> Window width
</span></div></div><br/><code>int createWindow(lua_State *L);</code></div>
<div class="method"><h3>background</h3><p>
Clear a background with a color</p><div class="params"><div class="param"><span class="name">g</span><span class="desc"> The green byte
</span></div><div class="param"><span class="name">b</span><span class="desc"> The blue byte
</span></div><div class="param"><span class="name">a</span><span class="desc"> The alpha byte
</span></div><div class="param"><span class="name">r</span><span class="desc"> The red byte
</span></div></div><br/><code>int background(lua_State *L);</code></div>
<div class="method"><code>createWindow(w, h);</code><p>Create a GLFW window, if no window was created and a setup function was defined, a Warning is thrown</p><div class="params"><div class="param"><code class="name">w</code><span class="desc">Window width
</span></div><div class="param"><code class="name">h</code><span class="desc">Window height
</span></div></div><br/></div>
<div class="method"><code>background(r, g, b, a);</code><p>Clear a background with a color</p><div class="params"><div class="param"><code class="name">r</code><span class="desc">The red byte
</span></div><div class="param"><code class="name">g</code><span class="desc">The green byte
</span></div><div class="param"><code class="name">b</code><span class="desc">The blue byte
</span></div><div class="param"><code class="name">a</code><span class="desc">The alpha byte
</span></div></div><br/></div>
</main>
</div>
</body>
Expand Down

0 comments on commit e9b9bfd

Please sign in to comment.