From e9b9bfddcc82c61e64eccd80d8d711048a4c1a6d Mon Sep 17 00:00:00 2001 From: matiasvlevi Date: Sun, 28 Apr 2024 21:53:41 +0000 Subject: [PATCH] docs build --- docs/events.html | 12 +++---- docs/index.html | 5 +-- docs/io.html | 12 +++---- docs/setting.html | 18 ++++------ docs/shapes.html | 86 +++++++++++++++++++---------------------------- docs/window.html | 25 ++++++-------- 6 files changed, 61 insertions(+), 97 deletions(-) diff --git a/docs/events.html b/docs/events.html index 7faed907..bed3e972 100644 --- a/docs/events.html +++ b/docs/events.html @@ -12,12 +12,9 @@
-
- - -
+
- +
@@ -26,9 +23,8 @@

events

-

isKeyDown

-Check if a keyboard key is pressed

k The keyboard key to check -

int isKeyDown(lua_State *L);
+
isKeyDown(k);

Check if a keyboard key is pressed, returns true if key is down and returns false if it

kThe keyboard key to check +

diff --git a/docs/index.html b/docs/index.html index a6f915ed..0a73f613 100644 --- a/docs/index.html +++ b/docs/index.html @@ -12,10 +12,7 @@
-
- - -
+
diff --git a/docs/io.html b/docs/io.html index 8f78c710..c0367676 100644 --- a/docs/io.html +++ b/docs/io.html @@ -12,12 +12,9 @@
-
- - -
+
- +
@@ -26,9 +23,8 @@

io

-

print

-Printing utility

value The value to print to stdout -

int print(lua_State *L);
+
print(value);

Printing utility, can take any lua type, and any number of arguments.

valueThe value to print to stdout +

diff --git a/docs/setting.html b/docs/setting.html index ccd7d9dd..dddb3fa2 100644 --- a/docs/setting.html +++ b/docs/setting.html @@ -12,12 +12,9 @@
-
- - -
+
- +
@@ -26,12 +23,11 @@

setting

-

fill

-Set the fill color for shapes

g The green byte -
b The blue byte -
a The alpha byte -
r The red byte -

int fill(lua_State *L);
+
fill(r, g, b, a);

Set the fill color for shapes

rThe red byte +
gThe green byte +
bThe blue byte +
aThe alpha byte +

diff --git a/docs/shapes.html b/docs/shapes.html index ddd355dc..d8052f42 100644 --- a/docs/shapes.html +++ b/docs/shapes.html @@ -12,12 +12,9 @@
-
- - -
+
- +
@@ -26,52 +23,39 @@

shapes

-

circle

-Draw a circle to the opengl context

y The y position of the circle's center -
d The diameter of the circle -
x The x position of the circle's center -

int circle(lua_State *L);
-

rect

-Draw a rectangle to the opengl context

y The y position of the reactangle's top left corner -
w The width -
h The height -
x The x position of the reactangle's top left corner -

int rect(lua_State *L);
-

square

-Draw a square to the opengl context

y The y position of the square's top left corner -
s The size of the square's sides -
x The x position of the square's top left corner -

int square(lua_State *L);
-

line

-Draw a line to the opengl context

y1 The y position of the first point -
x2 The x position of the second point -
y2 The y position of the second point -
x1 The x position of the first point -

int line(lua_State *L);
-

text

-Draw text on the opengl context

x position of the text -
y position of the text -
s Text string -

int text(lua_State *L);
-

point

-Draw a point on the screen


int point(lua_State *L);
-

arc

-Draw an arc on the screen


int arc(lua_State *L);
-

ellipse

- -Draw an ellipse on the screen


int ellipse(lua_State *L);
-

triangle

-Draw a triangle on the screen


int triangle(lua_State *L);
-

quad

-Draw a quad on the screen

y1 The y position of the first point -
x2 The x position of the second point -
y2 The y position of the second point -
x3 The x position of the third point -
y3 The y position of the third point -
x4 The x position of the fourth point -
y4 The y position of the fourth point -
x1 The x position of the first point -

int quad(lua_State *L);
+
circle(x, y, d);

Draw a circle to the opengl context

xThe x position of the circle's center +
yThe y position of the circle's center +
dThe diameter of the circle +

+
rect(x, y, w, h);

Draw a rectangle to the opengl context

xThe x position of the reactangle's top left corner +
yThe y position of the reactangle's top left corner +
wThe width +
hThe height +

+
square(x, y, s);

Draw a square to the opengl context

xThe x position of the square's top left corner +
yThe y position of the square's top left corner +
sThe size of the square's sides +

+
line(x1, y1, x2, y2);

Draw a line to the opengl context

x1The x position of the first point +
y1The y position of the first point +
x2The x position of the second point +
y2The y position of the second point +

+
quad(x1, y1, x2, y2, x3, y3, x4, y4);

Draw a quad on the screen

x1The x position of the first point +
y1The y position of the first point +
x2The x position of the second point +
y2The y position of the second point +
x3The x position of the third point +
y3The y position of the third point +
x4The x position of the fourth point +
y4The y position of the fourth point +

+
text();

Draw text on the screen


+
point();

Draw a point on the screen


+
arc();

Draw an arc on the screen


+
ellipse();

+Draw an ellipse on the screen


+
triangle();

Draw a triangle on the screen


diff --git a/docs/window.html b/docs/window.html index 2cc6160e..ae5ffe62 100644 --- a/docs/window.html +++ b/docs/window.html @@ -12,12 +12,9 @@
-
- - -
+
- +
@@ -26,16 +23,14 @@

window

-

createWindow

-Create an OpenGL context and a GLFW window

h Window height -
w Window width -

int createWindow(lua_State *L);
-

background

-Clear a background with a color

g The green byte -
b The blue byte -
a The alpha byte -
r The red byte -

int background(lua_State *L);
+
createWindow(w, h);

Create a GLFW window, if no window was created and a setup function was defined, a Warning is thrown

wWindow width +
hWindow height +

+
background(r, g, b, a);

Clear a background with a color

rThe red byte +
gThe green byte +
bThe blue byte +
aThe alpha byte +