diff --git a/docs/assets/style.css b/docs/assets/style.css index 5a85675..1b14e2d 100644 --- a/docs/assets/style.css +++ b/docs/assets/style.css @@ -1 +1 @@ -:root{--dark:#461164;--primary:#AA36EF;--lighter:#d49af7;--white:#efefef;--grey:#4f4f4f;--black:#181021}::-webkit-scrollbar{width:10px}::-webkit-scrollbar-track{background:rgba(0,0,0,0)}::-webkit-scrollbar-thumb{background:var(--primary)}::-webkit-scrollbar-thumb:hover{background:var(--dark)}code.inline{border-radius:4px;background-color:#dfd4ff;padding:0.1em}html,body{width:100%;height:100%;margin:0px;background-color:var(--white)}.smaller{font-size:0.7rem}.small{font-size:0.85rem}.dark{color:var(--dark)}.lighter{color:var(--lighter)}.flex{display:flex}.items-center{align-items:center}.flex-col{display:flex;flex-direction:column}.space-between{justify-content:space-between}.justify-start{justify-content:flex-start}.justify-between{justify-content:space-between}.underline{text-decoration:underline}.flex-grow{flex-grow:1}button{background-color:var(--primary);color:var(--white);cursor:pointer;border:none;border-radius:0.5rem;font-weight:bold;scale:1}button:hover{background-color:var(--dark);transition:0.2s;scale:1.05}button:active{background-color:var(--primary);transition:0.2s;scale:0.975}button.download{padding:0.95rem;margin:0 1rem;display:flex;gap:0.5rem;align-items:center}.gap-1{gap:0.25rem}.gap-2{gap:0.5rem}.gap-3{gap:0.75rem}.gap-4{gap:1rem}.gap-5{gap:1.25rem}.gap-6{gap:1.5rem}.gap-7{gap:1.75rem}.gap-8{gap:2rem}.gap-9{gap:2.25rem}.gap-10{gap:2.5rem}.gap-11{gap:2.75rem}.gap-12{gap:3rem}footer{margin-top:3rem;padding:2rem 4rem;min-height:6rem;background-color:var(--primary);width:100%;width:-moz-available;width:-webkit-fill-available;width:fill-available}body{min-height:100%;height:fit-content;display:flex;flex-direction:column;align-items:flex-end}a,p,span.text,span.small,span.smaller,span.decorator,h1,h2,h3,h4,h5,h6{font-family:"Trebuchet MS",Tahoma,sans-serif}h1,h2,h3,h4,h5,h6{color:var(--black)}.light > h1,.light > h2,.light > h3,.light > h4,.light > h5,.light > h6{color:var(--white) !important}.decorator{font-size:12pt;border-radius:6px;color:var(--white);font-weight:bold;background-color:var(--primary);margin:auto 1.5rem;padding:0.2em 0.35em}ul{list-style-type:none;margin:0px;padding:0px}li:not(:last-child){padding-bottom:12px}.method{padding-top:2rem}.btn{padding-left:0.5rem}.light{color:var(--white)}.btn.light > a > h4{color:var(--white)}.btn:hover > a > h4,.btn:active > a > h4{color:var(--dark);transition:0.1s}code,pre{font-family:inconsolata,lucida console,monospace;white-space:pre-wrap}header{display:flex;justify-content:space-between;flex-direction:column;align-items:baseline;width:100%}header > .wrap,header:not(:has(.wrap)){width:100%;display:flex;flex-direction:row;align-items:baseline;gap:0.9rem;flex-wrap:wrap;justify-content:flex-start}.modules{display:flex;flex-wrap:wrap;gap:3.5rem}.container{width:80%;margin:0 auto}.flex{display:flex}.flex-col{flex-direction:column}a{text-decoration:none}a:visited{text-decoration:none}.underline{text-decoration:underline}.method > p > a{text-decoration:underline;text-underline-offset:0.2rem}.version{color:var(--dark);position:relative;top:-0.25em;left:-0.25em}main{padding:1.8em;height:fit-content;width:100%;display:flex;flex-direction:column;gap:0rem}.summary{min-width:8em}h1.module{position:relative;top:-0.25em;color:var(--primary);font-weight:bold}pre code.hljs{padding:1em;max-width:100%;font-size:10pt}.modules{margin-right:auto;margin-left:auto}.modules.open{margin-right:10.2rem;margin-left:2em}.builds{display:flex;flex-direction:column}.tags{display:none}.home-section{display:flex;justify-content:space-between;flex-direction:column-reverse;gap:2rem}.mosaic{display:flex;flex-wrap:wrap;gap:1rem;max-width:420px;align-content:flex-start}img.demo{width:auto}.search-section{margin-bottom:1rem;margin-right:2rem;color:var(--lighter)}@media (min-width:900px){body{align-items:flex-start;width:100%}body > div{width:100%}header{flex-direction:row}.search-section{margin-bottom:1rem;margin-right:18%;color:var(--lighter)}.tags{display:block}.modules{margin-right:auto;margin-left:auto}.modules.open{margin-right:auto;margin-left:auto}main > .method{padding-left:10%}h1.module{font-size:32pt}pre code.hljs{padding:1em 6em 1em 1em;max-width:38em;width:fit-content;font-size:13pt}.builds{display:flex;flex-direction:row;align-items:flex-end}.home-section{display:flex;justify-content:space-between;flex-direction:row}}input{padding:0.5rem;border:none;border-radius:0.5rem;background-color:var(--lighter);color:var(--dark);outline:none}.search-wrap{min-width:20rem;max-width:32rem}.search-box{background-color:var(--lighter);color:var(--dark);width:100%;top:2rem;border-radius:0.5rem}.search-box > p#cursor{margin:0rem 0.5rem;padding:0.25rem 0.5rem;background-color:var(--dark);color:var(--lighter);border-radius:0.5rem}.search-box > p{margin:0.25rem 1rem}.param{display:flex;gap:1rem;margin:0.2rem;vertical-align:middle;align-items:flex-start}.method{max-width:87.5%;margin-bottom:3rem}.method > div.methodDeclaration > code{font-size:16pt;white-space:nowrap}.menuBtn{position:fixed;top:45dvh;right:-3.5em;width:7em;border-radius:49%;height:7em;border:none;outline:none;background-color:var(--primary)}.menuBtn > img{position:relative;left:-1.5em}.nav{background-color:var(--primary);position:fixed;min-width:10em;min-height:100%;position:fixed;padding:1.6rem;display:flex;flex-direction:column;right:calc(-100%);z-index:10}.nav.open{right:0px}#download-Windows,#download-Linux,#download-Mac,#download-fallback{display:none} \ No newline at end of file +:root{--dark:#461164;--primary:#AA36EF;--lighter:#d49af7;--white:#efefef;--grey:#4f4f4f;--black:#181021}::-webkit-scrollbar{width:10px}::-webkit-scrollbar-track{background:rgba(0,0,0,0)}::-webkit-scrollbar-thumb{background:var(--primary)}::-webkit-scrollbar-thumb:hover{background:var(--dark)}code.inline{border-radius:4px;background-color:#dfd4ff;padding:0.1em}html,body{width:100%;height:100%;margin:0px;background-color:var(--white)}.smaller{font-size:0.7rem}.small{font-size:0.85rem}.dark{color:var(--dark)}.lighter{color:var(--lighter)}.flex{display:flex}.items-center{align-items:center}.flex-col{display:flex;flex-direction:column}.space-between{justify-content:space-between}.justify-start{justify-content:flex-start}.justify-between{justify-content:space-between}.underline{text-decoration:underline}.flex-grow{flex-grow:1}button{background-color:var(--primary);color:var(--white);cursor:pointer;border:none;border-radius:0.5rem;font-weight:bold;scale:1}button:hover{background-color:var(--dark);transition:0.2s;scale:1.05}button:active{background-color:var(--primary);transition:0.2s;scale:0.975}button.download{padding:0.95rem;margin:0 1rem;display:flex;gap:0.5rem;align-items:center}.gap-1{gap:0.25rem}.gap-2{gap:0.5rem}.gap-3{gap:0.75rem}.gap-4{gap:1rem}.gap-5{gap:1.25rem}.gap-6{gap:1.5rem}.gap-7{gap:1.75rem}.gap-8{gap:2rem}.gap-9{gap:2.25rem}.gap-10{gap:2.5rem}.gap-11{gap:2.75rem}.gap-12{gap:3rem}footer{margin-top:3rem;padding:2rem 4rem;min-height:6rem;background-color:var(--primary);width:100%;width:-moz-available;width:-webkit-fill-available;width:fill-available}body{min-height:100%;height:fit-content;display:flex;flex-direction:column;align-items:center}a,p,span.text,span.small,span.smaller,span.decorator,h1,h2,h3,h4,h5,h6{font-family:"Trebuchet MS",Tahoma,sans-serif}h1,h2,h3,h4,h5,h6{color:var(--black)}.light > h1,.light > h2,.light > h3,.light > h4,.light > h5,.light > h6{color:var(--white) !important}.decorator{font-size:12pt;border-radius:6px;color:var(--white);font-weight:bold;background-color:var(--primary);margin:auto 1.5rem;padding:0.2em 0.35em}ul{list-style-type:none;margin:0px;padding:0px}li:not(:last-child){padding-bottom:12px}.method{padding-top:2rem}.btn{padding-left:0.5rem}.light{color:var(--white)}.btn.light > a > h4{color:var(--white)}.btn:hover > a > h4,.btn:active > a > h4{color:var(--dark);transition:0.1s}code,pre{font-family:inconsolata,lucida console,monospace;white-space:pre-wrap}header{display:flex;justify-content:space-between;flex-direction:column;align-items:baseline;width:100%}header > .wrap,header:not(:has(.wrap)){width:100%;display:flex;flex-direction:row;align-items:baseline;gap:0.9rem;flex-wrap:wrap;justify-content:flex-start}.modules{display:flex;flex-wrap:wrap;gap:3.5rem}.container{width:80%;margin:0 auto}.flex{display:flex}.flex-col{flex-direction:column}a{text-decoration:none}a:visited{text-decoration:none}.underline{text-decoration:underline}.method > p > a{text-decoration:underline;text-underline-offset:0.2rem}.version{color:var(--dark);position:relative;top:-0.25em;left:-0.25em}main{padding:1.8em;height:fit-content;width:100%;display:flex;flex-direction:column;gap:0rem}.summary{min-width:8em}h1.module{position:relative;top:-0.25em;color:var(--primary);font-weight:bold}pre code.hljs{padding:1em;max-width:100%;font-size:10pt}.modules{margin-right:auto;margin-left:auto}.modules.open{margin-right:10.2rem;margin-left:2em}.builds{display:flex;flex-direction:column}.tags{display:none}.home-section{display:flex;justify-content:space-between;flex-direction:column-reverse;gap:2rem}.mosaic{display:flex;flex-wrap:wrap;gap:1rem;max-width:420px;align-content:flex-start}img.demo{width:auto}.search-section{margin-bottom:1rem;margin-right:2rem;color:var(--lighter)}@media (min-width:900px){body{align-items:flex-start;width:100%}body > div{width:100%}header{flex-direction:row}.search-section{margin-bottom:1rem;margin-right:18%;color:var(--lighter)}.tags{display:block}.modules{margin-right:auto;margin-left:auto}.modules.open{margin-right:auto;margin-left:auto}main > .method{padding-left:10%}h1.module{font-size:32pt}pre code.hljs{padding:1em 6em 1em 1em;max-width:38em;width:fit-content;font-size:13pt}.builds{display:flex;flex-direction:row;align-items:flex-end}.home-section{display:flex;justify-content:space-between;flex-direction:row}}input{padding:0.5rem;border:none;border-radius:0.5rem;background-color:var(--lighter);color:var(--dark);outline:none}.search-wrap{min-width:20rem;max-width:32rem}.search-box{background-color:var(--lighter);color:var(--dark);width:100%;top:2rem;border-radius:0.5rem}.search-box > p#cursor{margin:0rem 0.5rem;padding:0.25rem 0.5rem;background-color:var(--dark);color:var(--lighter);border-radius:0.5rem}.search-box > p{margin:0.25rem 1rem}.param{display:flex;gap:1rem;margin:0.2rem;vertical-align:middle;align-items:flex-start}.method{max-width:87.5%;margin-bottom:3rem}.method > div.methodDeclaration > code{font-size:16pt;white-space:nowrap}.menuBtn{position:fixed;top:45dvh;right:-3.5em;width:7em;border-radius:49%;height:7em;border:none;outline:none;background-color:var(--primary)}.menuBtn > img{position:relative;left:-1.5em}.nav{background-color:var(--primary);position:fixed;min-width:10em;min-height:100%;position:fixed;padding:1.6rem;display:flex;flex-direction:column;right:calc(-100%);z-index:10}.nav.open{right:0px}#download-Windows,#download-Linux,#download-Mac,#download-fallback{display:none} \ No newline at end of file diff --git a/docs/index.html b/docs/index.html index 53cf5e0..e76a100 100644 --- a/docs/index.html +++ b/docs/index.html @@ -1,4 +1,4 @@ -lu5 | Interpreter for Creative Coding

Interpreter for Creative Coding

Lu5 is a free and open-source Lua interpreter for Creative Coding.

Download

On arch based systems, you can install lu5 from the AUR.
yay -S lu5

For any other linux distribution, you can build from source
git clone https://github.com/matiasvlevi/lu5 --branch v0.1.6
+lu5 | Interpreter for Creative Coding

Interpreter for Creative Coding

Lu5 is a free and open-source Lua interpreter for Creative Coding.

Download

On arch based systems, you can install lu5 from the AUR.
yay -S lu5

For any other linux distribution, you can build from source
git clone https://github.com/matiasvlevi/lu5 --branch v0.1.6
 cd lu5
 make
-
lu5 is not available on Mac OS :(
lu5 is not available on mobile devices :(

This project is licensed under the MIT License.
It also includes the FreeType font engine, which is licensed under the FreeType License (FTL).
\ No newline at end of file +
lu5 is not available on Mac OS :(
lu5 is not available on mobile devices :(

Releases


\ No newline at end of file diff --git a/docs/v0.1.7/camera/index.html b/docs/v0.1.7/camera/index.html index 22dc027..01a0c82 100644 --- a/docs/v0.1.7/camera/index.html +++ b/docs/v0.1.7/camera/index.html @@ -1,4 +1,4 @@ -lu5 | camera

camera

v0.1.7
orbitControl();

Helpful utility for controlling the camera around the origin.
Enables quick camera controls without much of an implementation.

function setup()
+lu5 | camera

camera

v0.1.7
orbitControl();

Helpful utility for controlling the camera around the origin.
Enables quick camera controls without much of an implementation.

function setup()
     createWindow(800, 800, GL3D);
 end
 
@@ -13,4 +13,4 @@
     strokeWeight(4);
 
     box(60);
-end
See orbitControl in camera.h
This project is licensed under the MIT License.
It also includes the FreeType font engine, which is licensed under the FreeType License (FTL).
\ No newline at end of file +end
See orbitControl in camera.h
\ No newline at end of file diff --git a/docs/v0.1.7/camera/orbitControl/index.html b/docs/v0.1.7/camera/orbitControl/index.html index 0e0912d..4703817 100644 --- a/docs/v0.1.7/camera/orbitControl/index.html +++ b/docs/v0.1.7/camera/orbitControl/index.html @@ -1,4 +1,4 @@ -lu5 | orbitControl

orbitControl

v0.1.7
orbitControl();

Helpful utility for controlling the camera around the origin.
Enables quick camera controls without much of an implementation.

function setup()
+lu5 | orbitControl

orbitControl

v0.1.7
orbitControl();

Helpful utility for controlling the camera around the origin.
Enables quick camera controls without much of an implementation.

function setup()
     createWindow(800, 800, GL3D);
 end
 
@@ -13,4 +13,4 @@
     strokeWeight(4);
 
     box(60);
-end
See orbitControl in camera.h
This project is licensed under the MIT License.
It also includes the FreeType font engine, which is licensed under the FreeType License (FTL).
\ No newline at end of file +end
See orbitControl in camera.h
\ No newline at end of file diff --git a/docs/v0.1.7/camera/orbitControl/meta.json b/docs/v0.1.7/camera/orbitControl/meta.json index b53d5aa..8f4aa89 100644 --- a/docs/v0.1.7/camera/orbitControl/meta.json +++ b/docs/v0.1.7/camera/orbitControl/meta.json @@ -1 +1 @@ -{"doc":{"bottom_description":"","name":"orbitControl","description":"Helpful utility for controlling the camera around the origin.
Enables quick camera controls without much of an implementation.","calls":[{"arguments":{}}],"_type":"method","examples":["function setup()\n createWindow(800, 800, GL3D);\nend\n\nfunction draw() \n background(51);\n\n -- Allows us to control the camera\n orbitControl();\n\n noFill();\n stroke(80, 255, 50);\n strokeWeight(4);\n\n box(60);\nend"]},"source":{"end_line":46,"start_line":22,"header":"camera.h"}} \ No newline at end of file +{"doc":{"description":"Helpful utility for controlling the camera around the origin.
Enables quick camera controls without much of an implementation.","bottom_description":"","examples":["function setup()\n createWindow(800, 800, GL3D);\nend\n\nfunction draw() \n background(51);\n\n -- Allows us to control the camera\n orbitControl();\n\n noFill();\n stroke(80, 255, 50);\n strokeWeight(4);\n\n box(60);\nend"],"name":"orbitControl","calls":[{"arguments":{}}],"_type":"method"},"source":{"header":"camera.h","start_line":22,"end_line":46}} \ No newline at end of file diff --git a/docs/v0.1.7/classes/class/index.html b/docs/v0.1.7/classes/class/index.html index 0465009..a1128f1 100644 --- a/docs/v0.1.7/classes/class/index.html +++ b/docs/v0.1.7/classes/class/index.html @@ -1,4 +1,4 @@ -lu5 | class

class

v0.1.7
class(name);

Create a class.
if a class implements a print method, it can be used in the print function.

Arguments

nameThe class name

local Player = class('Player');
+lu5 | class

class

v0.1.7
class(name);

Create a class.
if a class implements a print method, it can be used in the print function.

Arguments

nameThe class name

local Player = class('Player');
 
 function Player:init(x, y)
   self.x = x;
@@ -24,4 +24,4 @@
 
   p1:draw();
   p2:draw();
-end
See class in classes.h
This project is licensed under the MIT License.
It also includes the FreeType font engine, which is licensed under the FreeType License (FTL).
\ No newline at end of file +end
See class in classes.h
\ No newline at end of file diff --git a/docs/v0.1.7/classes/class/meta.json b/docs/v0.1.7/classes/class/meta.json index b2a6793..cd41724 100644 --- a/docs/v0.1.7/classes/class/meta.json +++ b/docs/v0.1.7/classes/class/meta.json @@ -1 +1 @@ -{"doc":{"bottom_description":"","name":"class","description":"Create a class.
if a class implements a print method, it can be used in the print function.","calls":[{"arguments":[{"name":"name","description":"The class name"}]}],"_type":"method","examples":["local Player = class('Player');\n\nfunction Player:init(x, y)\n self.x = x;\n self.y = y;\n return self;\nend\n\nfunction Player:draw()\n circle(self.x, self.y, 16);\nend\n\n\n-- Create 2 players and draw them\nlocal p1 = Player:new(100, 200);\nlocal p2 = Player:new(300, 200);\n\nfunction setup()\n createWindow(400, 400);\nend\n\nfunction draw()\n background(51);\n\n p1:draw();\n p2:draw();\nend"]},"source":{"end_line":40,"start_line":4,"header":"classes.h"}} \ No newline at end of file +{"doc":{"description":"Create a class.
if a class implements a print method, it can be used in the print function.","bottom_description":"","examples":["local Player = class('Player');\n\nfunction Player:init(x, y)\n self.x = x;\n self.y = y;\n return self;\nend\n\nfunction Player:draw()\n circle(self.x, self.y, 16);\nend\n\n\n-- Create 2 players and draw them\nlocal p1 = Player:new(100, 200);\nlocal p2 = Player:new(300, 200);\n\nfunction setup()\n createWindow(400, 400);\nend\n\nfunction draw()\n background(51);\n\n p1:draw();\n p2:draw();\nend"],"name":"class","calls":[{"arguments":[{"name":"name","description":"The class name"}]}],"_type":"method"},"source":{"header":"classes.h","start_line":4,"end_line":40}} \ No newline at end of file diff --git a/docs/v0.1.7/classes/index.html b/docs/v0.1.7/classes/index.html index 5bc337f..65592b3 100644 --- a/docs/v0.1.7/classes/index.html +++ b/docs/v0.1.7/classes/index.html @@ -1,4 +1,4 @@ -lu5 | classes

classes

v0.1.7
class(name);

Create a class.
if a class implements a print method, it can be used in the print function.

Arguments

nameThe class name

local Player = class('Player');
+lu5 | classes

classes

v0.1.7
class(name);

Create a class.
if a class implements a print method, it can be used in the print function.

Arguments

nameThe class name

local Player = class('Player');
 
 function Player:init(x, y)
   self.x = x;
@@ -24,4 +24,4 @@
 
   p1:draw();
   p2:draw();
-end
See class in classes.h
This project is licensed under the MIT License.
It also includes the FreeType font engine, which is licensed under the FreeType License (FTL).
\ No newline at end of file +end
See class in classes.h
\ No newline at end of file diff --git a/docs/v0.1.7/image/Image.crop/index.html b/docs/v0.1.7/image/Image.crop/index.html index 53ed4d5..a56ede5 100644 --- a/docs/v0.1.7/image/Image.crop/index.html +++ b/docs/v0.1.7/image/Image.crop/index.html @@ -1,4 +1,4 @@ -lu5 | Image.crop

Image.crop

v0.1.7
Image.crop(x, y, w, h);

Crop an Image into an other Image.

Arguments

xThe x position of the image
yThe y position of the image
wThe width of the new cropped image
hThe height of the new cropped image

Returns

Imagethe cropped image

function setup()
+lu5 | Image.crop

Image.crop

v0.1.7
Image.crop(x, y, w, h);

Crop an Image into an other Image.

Arguments

xThe x position of the image
yThe y position of the image
wThe width of the new cropped image
hThe height of the new cropped image

Returns

Imagethe cropped image

function setup()
     createWindow(400, 400);
 
     img = loadImage('examples/images/cat.jpg');
@@ -13,4 +13,4 @@
 
     image(img, 0, 0);
     image(cropped, x, y);
-end
See Image.crop in image.h
This project is licensed under the MIT License.
It also includes the FreeType font engine, which is licensed under the FreeType License (FTL).
\ No newline at end of file +end
See Image.crop in image.h
\ No newline at end of file diff --git a/docs/v0.1.7/image/Image.crop/meta.json b/docs/v0.1.7/image/Image.crop/meta.json index f683f96..aee2dba 100644 --- a/docs/v0.1.7/image/Image.crop/meta.json +++ b/docs/v0.1.7/image/Image.crop/meta.json @@ -1 +1 @@ -{"doc":{"bottom_description":"","_return":{"description":"the cropped image","var":"Image"},"name":"Image.crop","description":"Crop an Image into an other Image.","calls":[{"arguments":[{"name":"x","description":"The x position of the image"},{"name":"y","description":"The y position of the image"},{"name":"w","description":"The width of the new cropped image"},{"name":"h","description":"The height of the new cropped image"}]}],"_type":"method","examples":["function setup()\n createWindow(400, 400);\n\n img = loadImage('examples/images/cat.jpg');\n\n cropped = img:crop(150, 150, 125, 200);\n -- -- or\n -- cropped = Image.crop(img, 150, 150, 125, 200);\nend\n\nfunction draw() \n background(51);\n\n image(img, 0, 0);\n image(cropped, x, y);\nend"]},"source":{"end_line":70,"start_line":39,"header":"image.h"}} \ No newline at end of file +{"doc":{"description":"Crop an Image into an other Image.","bottom_description":"","examples":["function setup()\n createWindow(400, 400);\n\n img = loadImage('examples/images/cat.jpg');\n\n cropped = img:crop(150, 150, 125, 200);\n -- -- or\n -- cropped = Image.crop(img, 150, 150, 125, 200);\nend\n\nfunction draw() \n background(51);\n\n image(img, 0, 0);\n image(cropped, x, y);\nend"],"name":"Image.crop","_type":"method","calls":[{"arguments":[{"name":"x","description":"The x position of the image"},{"name":"y","description":"The y position of the image"},{"name":"w","description":"The width of the new cropped image"},{"name":"h","description":"The height of the new cropped image"}]}],"_return":{"var":"Image","description":"the cropped image"}},"source":{"header":"image.h","start_line":39,"end_line":70}} \ No newline at end of file diff --git a/docs/v0.1.7/image/image/index.html b/docs/v0.1.7/image/image/index.html index 492c509..1e158b2 100644 --- a/docs/v0.1.7/image/image/index.html +++ b/docs/v0.1.7/image/image/index.html @@ -1 +1 @@ -lu5 | image

image

v0.1.7
image(img, x, y, [w], [h]);

Draw an image to the screen

Arguments

imgThe Image instance
xThe x position of the image
yThe y position of the image
[w]The width of the image, if not specified, using source width
[h]The height of the image, if not specified, using source height

See image in image.h
\ No newline at end of file +lu5 | image

image

v0.1.7
image(img, x, y, [w], [h]);

Draw an image to the screen

Arguments

imgThe Image instance
xThe x position of the image
yThe y position of the image
[w]The width of the image, if not specified, using source width
[h]The height of the image, if not specified, using source height

See image in image.h
\ No newline at end of file diff --git a/docs/v0.1.7/image/image/meta.json b/docs/v0.1.7/image/image/meta.json index e18494f..98d3652 100644 --- a/docs/v0.1.7/image/image/meta.json +++ b/docs/v0.1.7/image/image/meta.json @@ -1 +1 @@ -{"doc":{"bottom_description":"","name":"image","description":"Draw an image to the screen","calls":[{"arguments":[{"name":"img","description":"The Image instance"},{"name":"x","description":"The x position of the image"},{"name":"y","description":"The y position of the image"},{"name":"[w]","description":"The width of the image, if not specified, using source width"},{"name":"[h]","description":"The height of the image, if not specified, using source height"}]}],"_type":"method","examples":{}},"source":{"end_line":37,"start_line":28,"header":"image.h"}} \ No newline at end of file +{"doc":{"description":"Draw an image to the screen","bottom_description":"","examples":{},"name":"image","calls":[{"arguments":[{"name":"img","description":"The Image instance"},{"name":"x","description":"The x position of the image"},{"name":"y","description":"The y position of the image"},{"name":"[w]","description":"The width of the image, if not specified, using source width"},{"name":"[h]","description":"The height of the image, if not specified, using source height"}]}],"_type":"method"},"source":{"header":"image.h","start_line":28,"end_line":37}} \ No newline at end of file diff --git a/docs/v0.1.7/image/index.html b/docs/v0.1.7/image/index.html index e3c3641..721a31b 100644 --- a/docs/v0.1.7/image/index.html +++ b/docs/v0.1.7/image/index.html @@ -1,4 +1,4 @@ -lu5 | image

image

v0.1.7
loadImage(path);

Load a png or jpeg image

Arguments

pathThe local image path

Returns

ImageThe image instance

function setup()
+lu5 | image

image

v0.1.7
loadImage(path);

Load a png or jpeg image

Arguments

pathThe local image path

Returns

ImageThe image instance

function setup()
   createWindow(600, 600);
   img = loadImage('/path/to/mypic.png');
 end
@@ -7,7 +7,7 @@
   background(51);
 
   image(img, 0, 0);
-end   
See loadImage in image.h
image(img, x, y, [w], [h]);

Draw an image to the screen

Arguments

imgThe Image instance
xThe x position of the image
yThe y position of the image
[w]The width of the image, if not specified, using source width
[h]The height of the image, if not specified, using source height

See image in image.h
Image.crop(x, y, w, h);

Crop an Image into an other Image.

Arguments

xThe x position of the image
yThe y position of the image
wThe width of the new cropped image
hThe height of the new cropped image

Returns

Imagethe cropped image

function setup()
+end   
See loadImage in image.h
image(img, x, y, [w], [h]);

Draw an image to the screen

Arguments

imgThe Image instance
xThe x position of the image
yThe y position of the image
[w]The width of the image, if not specified, using source width
[h]The height of the image, if not specified, using source height

See image in image.h
Image.crop(x, y, w, h);

Crop an Image into an other Image.

Arguments

xThe x position of the image
yThe y position of the image
wThe width of the new cropped image
hThe height of the new cropped image

Returns

Imagethe cropped image

function setup()
     createWindow(400, 400);
 
     img = loadImage('examples/images/cat.jpg');
@@ -22,4 +22,4 @@
 
     image(img, 0, 0);
     image(cropped, x, y);
-end
See Image.crop in image.h
This project is licensed under the MIT License.
It also includes the FreeType font engine, which is licensed under the FreeType License (FTL).
\ No newline at end of file +end
See Image.crop in image.h
\ No newline at end of file diff --git a/docs/v0.1.7/image/loadImage/index.html b/docs/v0.1.7/image/loadImage/index.html index 51cfa35..976588b 100644 --- a/docs/v0.1.7/image/loadImage/index.html +++ b/docs/v0.1.7/image/loadImage/index.html @@ -1,4 +1,4 @@ -lu5 | loadImage

loadImage

v0.1.7
loadImage(path);

Load a png or jpeg image

Arguments

pathThe local image path

Returns

ImageThe image instance

function setup()
+lu5 | loadImage

loadImage

v0.1.7
loadImage(path);

Load a png or jpeg image

Arguments

pathThe local image path

Returns

ImageThe image instance

function setup()
   createWindow(600, 600);
   img = loadImage('/path/to/mypic.png');
 end
@@ -7,4 +7,4 @@
   background(51);
 
   image(img, 0, 0);
-end   
See loadImage in image.h
This project is licensed under the MIT License.
It also includes the FreeType font engine, which is licensed under the FreeType License (FTL).
\ No newline at end of file +end
See loadImage in image.h
\ No newline at end of file diff --git a/docs/v0.1.7/image/loadImage/meta.json b/docs/v0.1.7/image/loadImage/meta.json index 5b369dc..35153b3 100644 --- a/docs/v0.1.7/image/loadImage/meta.json +++ b/docs/v0.1.7/image/loadImage/meta.json @@ -1 +1 @@ -{"doc":{"bottom_description":"","_return":{"description":"The image instance","var":"Image"},"name":"loadImage","description":"Load a png or jpeg image ","calls":[{"arguments":[{"name":"path","description":"The local image path"}]}],"_type":"method","examples":["function setup()\n createWindow(600, 600);\n img = loadImage('/path/to/mypic.png');\nend\n\nfunction draw()\n background(51);\n\n image(img, 0, 0);\nend "]},"source":{"end_line":26,"start_line":6,"header":"image.h"}} \ No newline at end of file +{"doc":{"description":"Load a png or jpeg image ","bottom_description":"","examples":["function setup()\n createWindow(600, 600);\n img = loadImage('/path/to/mypic.png');\nend\n\nfunction draw()\n background(51);\n\n image(img, 0, 0);\nend "],"name":"loadImage","_type":"method","calls":[{"arguments":[{"name":"path","description":"The local image path"}]}],"_return":{"var":"Image","description":"The image instance"}},"source":{"header":"image.h","start_line":6,"end_line":26}} \ No newline at end of file diff --git a/docs/v0.1.7/index.html b/docs/v0.1.7/index.html index 94440c4..7243d76 100644 --- a/docs/v0.1.7/index.html +++ b/docs/v0.1.7/index.html @@ -1 +1 @@ -lu5 | Reference

Reference

v0.1.7
\ No newline at end of file +lu5 | Reference

Reference

v0.1.7
\ No newline at end of file diff --git a/docs/v0.1.7/io/index.html b/docs/v0.1.7/io/index.html index 9db9b4e..9b95df6 100644 --- a/docs/v0.1.7/io/index.html +++ b/docs/v0.1.7/io/index.html @@ -1,9 +1,9 @@ -lu5 | io

io

v0.1.7
print(value);

Printing utility, can take any lua type.

Arguments

valueThe value to print to stdout

print(42);
+lu5 | io

io

v0.1.7
print(value);

Printing utility, can take any lua type.

Arguments

valueThe value to print to stdout

print(42);
 
 print(1, 2, 3);
 
 print('Hello world');
 
-print({ 3, 8, 1 });
See print in io.h
loadText(file_path);

Read a file as a string.

Arguments

file_pathThe path of the file

file = loadText("./your-file.txt");
-print(file);
See loadText in io.h
loadStrings(file_path);

Read a file as an array of strings split by line.

Arguments

file_pathThe path of the file

file = loadStrings("./your-file.txt");
-print(file);
See loadStrings in io.h
This project is licensed under the MIT License.
It also includes the FreeType font engine, which is licensed under the FreeType License (FTL).
\ No newline at end of file +print({ 3, 8, 1 });
See print in io.h
loadText(file_path);

Read a file as a string.

Arguments

file_pathThe path of the file

file = loadText("./your-file.txt");
+print(file);
See loadText in io.h
loadStrings(file_path);

Read a file as an array of strings split by line.

Arguments

file_pathThe path of the file

file = loadStrings("./your-file.txt");
+print(file);
See loadStrings in io.h
\ No newline at end of file diff --git a/docs/v0.1.7/io/loadStrings/index.html b/docs/v0.1.7/io/loadStrings/index.html index 9ed368b..e92af90 100644 --- a/docs/v0.1.7/io/loadStrings/index.html +++ b/docs/v0.1.7/io/loadStrings/index.html @@ -1,2 +1,2 @@ -lu5 | loadStrings

loadStrings

v0.1.7
loadStrings(file_path);

Read a file as an array of strings split by line.

Arguments

file_pathThe path of the file

file = loadStrings("./your-file.txt");
-print(file);
See loadStrings in io.h
\ No newline at end of file +lu5 | loadStrings

loadStrings

v0.1.7
loadStrings(file_path);

Read a file as an array of strings split by line.

Arguments

file_pathThe path of the file

file = loadStrings("./your-file.txt");
+print(file);
See loadStrings in io.h
\ No newline at end of file diff --git a/docs/v0.1.7/io/loadStrings/meta.json b/docs/v0.1.7/io/loadStrings/meta.json index e78b885..84e25e7 100644 --- a/docs/v0.1.7/io/loadStrings/meta.json +++ b/docs/v0.1.7/io/loadStrings/meta.json @@ -1 +1 @@ -{"doc":{"bottom_description":"","name":"loadStrings","description":"Read a file as an array of strings split by line.","calls":[{"arguments":[{"name":"file_path","description":"The path of the file"}]}],"_type":"method","examples":["file = loadStrings(\"./your-file.txt\");\nprint(file);"]},"source":{"end_line":47,"start_line":37,"header":"io.h"}} \ No newline at end of file +{"doc":{"description":"Read a file as an array of strings split by line.","bottom_description":"","examples":["file = loadStrings(\"./your-file.txt\");\nprint(file);"],"name":"loadStrings","calls":[{"arguments":[{"name":"file_path","description":"The path of the file"}]}],"_type":"method"},"source":{"header":"io.h","start_line":37,"end_line":47}} \ No newline at end of file diff --git a/docs/v0.1.7/io/loadText/index.html b/docs/v0.1.7/io/loadText/index.html index 5a65711..0137928 100644 --- a/docs/v0.1.7/io/loadText/index.html +++ b/docs/v0.1.7/io/loadText/index.html @@ -1,2 +1,2 @@ -lu5 | loadText

loadText

v0.1.7
loadText(file_path);

Read a file as a string.

Arguments

file_pathThe path of the file

file = loadText("./your-file.txt");
-print(file);
See loadText in io.h
\ No newline at end of file +lu5 | loadText

loadText

v0.1.7
loadText(file_path);

Read a file as a string.

Arguments

file_pathThe path of the file

file = loadText("./your-file.txt");
+print(file);
See loadText in io.h
\ No newline at end of file diff --git a/docs/v0.1.7/io/loadText/meta.json b/docs/v0.1.7/io/loadText/meta.json index e489761..f5fa371 100644 --- a/docs/v0.1.7/io/loadText/meta.json +++ b/docs/v0.1.7/io/loadText/meta.json @@ -1 +1 @@ -{"doc":{"bottom_description":"","name":"loadText","description":"Read a file as a string.","calls":[{"arguments":[{"name":"file_path","description":"The path of the file"}]}],"_type":"method","examples":["file = loadText(\"./your-file.txt\");\nprint(file);"]},"source":{"end_line":35,"start_line":25,"header":"io.h"}} \ No newline at end of file +{"doc":{"description":"Read a file as a string.","bottom_description":"","examples":["file = loadText(\"./your-file.txt\");\nprint(file);"],"name":"loadText","calls":[{"arguments":[{"name":"file_path","description":"The path of the file"}]}],"_type":"method"},"source":{"header":"io.h","start_line":25,"end_line":35}} \ No newline at end of file diff --git a/docs/v0.1.7/io/print/index.html b/docs/v0.1.7/io/print/index.html index 70bef8d..8ed260f 100644 --- a/docs/v0.1.7/io/print/index.html +++ b/docs/v0.1.7/io/print/index.html @@ -1,7 +1,7 @@ -lu5 | print

print

v0.1.7
print(value);

Printing utility, can take any lua type.

Arguments

valueThe value to print to stdout

print(42);
+lu5 | print

print

v0.1.7
print(value);

Printing utility, can take any lua type.

Arguments

valueThe value to print to stdout

print(42);
 
 print(1, 2, 3);
 
 print('Hello world');
 
-print({ 3, 8, 1 });
See print in io.h
This project is licensed under the MIT License.
It also includes the FreeType font engine, which is licensed under the FreeType License (FTL).
\ No newline at end of file +print({ 3, 8, 1 });
See print in io.h
\ No newline at end of file diff --git a/docs/v0.1.7/io/print/meta.json b/docs/v0.1.7/io/print/meta.json index e006def..6b7f71f 100644 --- a/docs/v0.1.7/io/print/meta.json +++ b/docs/v0.1.7/io/print/meta.json @@ -1 +1 @@ -{"doc":{"bottom_description":"","name":"print","description":"Printing utility, can take any lua type.","calls":[{"arguments":[{"name":"value","description":"The value to print to stdout"}]}],"_type":"method","examples":["print(42);\n\nprint(1, 2, 3);\n\nprint('Hello world');\n\nprint({ 3, 8, 1 });"]},"source":{"end_line":21,"start_line":6,"header":"io.h"}} \ No newline at end of file +{"doc":{"description":"Printing utility, can take any lua type.","bottom_description":"","examples":["print(42);\n\nprint(1, 2, 3);\n\nprint('Hello world');\n\nprint({ 3, 8, 1 });"],"name":"print","calls":[{"arguments":[{"name":"value","description":"The value to print to stdout"}]}],"_type":"method"},"source":{"header":"io.h","start_line":6,"end_line":21}} \ No newline at end of file diff --git a/docs/v0.1.7/keyboard/index.html b/docs/v0.1.7/keyboard/index.html index 118b013..813f9a6 100644 --- a/docs/v0.1.7/keyboard/index.html +++ b/docs/v0.1.7/keyboard/index.html @@ -1,4 +1,4 @@ -lu5 | keyboard

keyboard

v0.1.7
keyIsDown(k);

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

Arguments

kThe keyboard key to check as a key global, or a string

Returns

booleanWhether or not the key is down

-- Use a string 
+lu5 | keyboard

keyboard

v0.1.7
keyIsDown(k);

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

Arguments

kThe keyboard key to check as a key global, or a string

Returns

booleanWhether or not the key is down

-- Use a string 
 if (keyIsDown('a')) then
   -- key 'a' is down
 end
@@ -6,7 +6,7 @@
 -- use a global
 if (keyIsDown(LEFT_ARROW)) then
   -- left arrow is down
-end
See keyIsDown in keyboard.h
keyPressed(key, keyCode);Event

Called whenever a key is pressed.

Arguments

keyThe pressed key as a string, is nil if glfw cannot find a name for the key
keyCodeThe pressed key as a key code

function setup()
+end
See keyIsDown in keyboard.h
keyPressed(key, keyCode);Event

Called whenever a key is pressed.

Arguments

keyThe pressed key as a string, is nil if glfw cannot find a name for the key
keyCodeThe pressed key as a key code

function setup()
    createWindow(600, 600);
 end
 
@@ -16,7 +16,7 @@
 
 function keyPressed(key, keyCode)
    print(key, keyCode)
-end
See keyPressed in keyboard.h
keyReleased(key, keyCode);Event

Called whenever a key is released.

Arguments

keyThe released key as a string, is nil if glfw cannot find a name for the key
keyCodeThe released key as a key code

function setup()
+end
See keyPressed in keyboard.h
keyReleased(key, keyCode);Event

Called whenever a key is released.

Arguments

keyThe released key as a string, is nil if glfw cannot find a name for the key
keyCodeThe released key as a key code

function setup()
    createWindow(600, 600);
 end
 
@@ -26,7 +26,7 @@
 
 function keyReleased(key, keyCode)
    print(key, keyCode);
-end
See keyReleased in keyboard.h
keyHeld(key, keyCode);Event

Called whenever a key is held down.

Arguments

keyThe held key as a string, is nil if glfw cannot find a name for the key
keyCodeThe held key as a key code

function setup()
+end
See keyReleased in keyboard.h
keyHeld(key, keyCode);Event

Called whenever a key is held down.

Arguments

keyThe held key as a string, is nil if glfw cannot find a name for the key
keyCodeThe held key as a key code

function setup()
    createWindow(600, 600);
 end
 
@@ -36,4 +36,4 @@
 
 function keyHeld(key, keyCode)
    print(key, keyCode);
-end
See keyHeld in keyboard.h
UP_ARROWConstant

No description

See UP_ARROW in keyboard.h
DOWN_ARROWConstant

No description

See DOWN_ARROW in keyboard.h
LEFT_ARROWConstant

No description

See LEFT_ARROW in keyboard.h
RIGHT_ARROWConstant

No description

See RIGHT_ARROW in keyboard.h
KEY_ENTERConstant

No description

See KEY_ENTER in keyboard.h
KEY_BACKSPACEConstant

No description

See KEY_BACKSPACE in keyboard.h
KEY_AConstant

No description

See KEY_A in keyboard.h
KEY_BConstant

No description

See KEY_B in keyboard.h
KEY_CConstant

No description

See KEY_C in keyboard.h
KEY_DConstant

No description

See KEY_D in keyboard.h
KEY_EConstant

No description

See KEY_E in keyboard.h
KEY_FConstant

No description

See KEY_F in keyboard.h
KEY_GConstant

No description

See KEY_G in keyboard.h
KEY_HConstant

No description

See KEY_H in keyboard.h
KEY_IConstant

No description

See KEY_I in keyboard.h
KEY_JConstant

No description

See KEY_J in keyboard.h
KEY_KConstant

No description

See KEY_K in keyboard.h
KEY_LConstant

No description

See KEY_L in keyboard.h
KEY_MConstant

No description

See KEY_M in keyboard.h
KEY_NConstant

No description

See KEY_N in keyboard.h
KEY_OConstant

No description

See KEY_O in keyboard.h
KEY_PConstant

No description

See KEY_P in keyboard.h
KEY_QConstant

No description

See KEY_Q in keyboard.h
KEY_RConstant

No description

See KEY_R in keyboard.h
KEY_SConstant

No description

See KEY_S in keyboard.h
KEY_TConstant

No description

See KEY_T in keyboard.h
KEY_UConstant

No description

See KEY_U in keyboard.h
KEY_VConstant

No description

See KEY_V in keyboard.h
KEY_WConstant

No description

See KEY_W in keyboard.h
KEY_XConstant

No description

See KEY_X in keyboard.h
KEY_YConstant

No description

See KEY_Y in keyboard.h
KEY_ZConstant

No description

See KEY_Z in keyboard.h
This project is licensed under the MIT License.
It also includes the FreeType font engine, which is licensed under the FreeType License (FTL).
\ No newline at end of file +end
See keyHeld in keyboard.h
UP_ARROWConstant

No description

See UP_ARROW in keyboard.h
DOWN_ARROWConstant

No description

See DOWN_ARROW in keyboard.h
LEFT_ARROWConstant

No description

See LEFT_ARROW in keyboard.h
RIGHT_ARROWConstant

No description

See RIGHT_ARROW in keyboard.h
KEY_ENTERConstant

No description

See KEY_ENTER in keyboard.h
KEY_BACKSPACEConstant

No description

See KEY_BACKSPACE in keyboard.h
KEY_AConstant

No description

See KEY_A in keyboard.h
KEY_BConstant

No description

See KEY_B in keyboard.h
KEY_CConstant

No description

See KEY_C in keyboard.h
KEY_DConstant

No description

See KEY_D in keyboard.h
KEY_EConstant

No description

See KEY_E in keyboard.h
KEY_FConstant

No description

See KEY_F in keyboard.h
KEY_GConstant

No description

See KEY_G in keyboard.h
KEY_HConstant

No description

See KEY_H in keyboard.h
KEY_IConstant

No description

See KEY_I in keyboard.h
KEY_JConstant

No description

See KEY_J in keyboard.h
KEY_KConstant

No description

See KEY_K in keyboard.h
KEY_LConstant

No description

See KEY_L in keyboard.h
KEY_MConstant

No description

See KEY_M in keyboard.h
KEY_NConstant

No description

See KEY_N in keyboard.h
KEY_OConstant

No description

See KEY_O in keyboard.h
KEY_PConstant

No description

See KEY_P in keyboard.h
KEY_QConstant

No description

See KEY_Q in keyboard.h
KEY_RConstant

No description

See KEY_R in keyboard.h
KEY_SConstant

No description

See KEY_S in keyboard.h
KEY_TConstant

No description

See KEY_T in keyboard.h
KEY_UConstant

No description

See KEY_U in keyboard.h
KEY_VConstant

No description

See KEY_V in keyboard.h
KEY_WConstant

No description

See KEY_W in keyboard.h
KEY_XConstant

No description

See KEY_X in keyboard.h
KEY_YConstant

No description

See KEY_Y in keyboard.h
KEY_ZConstant

No description

See KEY_Z in keyboard.h
\ No newline at end of file diff --git a/docs/v0.1.7/keyboard/keyHeld/index.html b/docs/v0.1.7/keyboard/keyHeld/index.html index 138e3da..c2e13a5 100644 --- a/docs/v0.1.7/keyboard/keyHeld/index.html +++ b/docs/v0.1.7/keyboard/keyHeld/index.html @@ -1,4 +1,4 @@ -lu5 | keyHeld

keyHeld

v0.1.7
keyHeld(key, keyCode);Event

Called whenever a key is held down.

Arguments

keyThe held key as a string, is nil if glfw cannot find a name for the key
keyCodeThe held key as a key code

function setup()
+lu5 | keyHeld

keyHeld

v0.1.7
keyHeld(key, keyCode);Event

Called whenever a key is held down.

Arguments

keyThe held key as a string, is nil if glfw cannot find a name for the key
keyCodeThe held key as a key code

function setup()
    createWindow(600, 600);
 end
 
@@ -8,4 +8,4 @@
 
 function keyHeld(key, keyCode)
    print(key, keyCode);
-end
See keyHeld in keyboard.h
This project is licensed under the MIT License.
It also includes the FreeType font engine, which is licensed under the FreeType License (FTL).
\ No newline at end of file +end
See keyHeld in keyboard.h
\ No newline at end of file diff --git a/docs/v0.1.7/keyboard/keyHeld/meta.json b/docs/v0.1.7/keyboard/keyHeld/meta.json index 2afa1f9..d9ba327 100644 --- a/docs/v0.1.7/keyboard/keyHeld/meta.json +++ b/docs/v0.1.7/keyboard/keyHeld/meta.json @@ -1 +1 @@ -{"doc":{"bottom_description":"","name":"keyHeld","description":"Called whenever a key is held down.","calls":[{"arguments":[{"name":"key","description":"The held key as a string, is nil if glfw cannot find a name for the key"},{"name":"keyCode","description":"The held key as a key code"}]}],"_type":"event","examples":["function setup()\n createWindow(600, 600);\nend\n\nfunction draw()\n background(51);\nend\n\nfunction keyHeld(key, keyCode)\n print(key, keyCode);\nend"]},"source":{"end_line":97,"start_line":76,"header":"keyboard.h"}} \ No newline at end of file +{"doc":{"description":"Called whenever a key is held down.","bottom_description":"","examples":["function setup()\n createWindow(600, 600);\nend\n\nfunction draw()\n background(51);\nend\n\nfunction keyHeld(key, keyCode)\n print(key, keyCode);\nend"],"name":"keyHeld","calls":[{"arguments":[{"name":"key","description":"The held key as a string, is nil if glfw cannot find a name for the key"},{"name":"keyCode","description":"The held key as a key code"}]}],"_type":"event"},"source":{"header":"keyboard.h","start_line":76,"end_line":97}} \ No newline at end of file diff --git a/docs/v0.1.7/keyboard/keyIsDown/index.html b/docs/v0.1.7/keyboard/keyIsDown/index.html index cbc195c..bca2d06 100644 --- a/docs/v0.1.7/keyboard/keyIsDown/index.html +++ b/docs/v0.1.7/keyboard/keyIsDown/index.html @@ -1,4 +1,4 @@ -lu5 | keyIsDown

keyIsDown

v0.1.7
keyIsDown(k);

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

Arguments

kThe keyboard key to check as a key global, or a string

Returns

booleanWhether or not the key is down

-- Use a string 
+lu5 | keyIsDown

keyIsDown

v0.1.7
keyIsDown(k);

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

Arguments

kThe keyboard key to check as a key global, or a string

Returns

booleanWhether or not the key is down

-- Use a string 
 if (keyIsDown('a')) then
   -- key 'a' is down
 end
@@ -6,4 +6,4 @@
 -- use a global
 if (keyIsDown(LEFT_ARROW)) then
   -- left arrow is down
-end
See keyIsDown in keyboard.h
This project is licensed under the MIT License.
It also includes the FreeType font engine, which is licensed under the FreeType License (FTL).
\ No newline at end of file +end
See keyIsDown in keyboard.h
\ No newline at end of file diff --git a/docs/v0.1.7/keyboard/keyIsDown/meta.json b/docs/v0.1.7/keyboard/keyIsDown/meta.json index 7ce20c7..de9e259 100644 --- a/docs/v0.1.7/keyboard/keyIsDown/meta.json +++ b/docs/v0.1.7/keyboard/keyIsDown/meta.json @@ -1 +1 @@ -{"doc":{"bottom_description":"","_return":{"description":"Whether or not the key is down","var":"boolean"},"name":"keyIsDown","description":"Check if a keyboard key is pressed, returns true if key is down and returns false if it's not","calls":[{"arguments":[{"name":"k","description":"The keyboard key to check as a key global, or a string"}]}],"_type":"method","examples":["-- Use a string \nif (keyIsDown('a')) then\n -- key 'a' is down\nend\n\n-- use a global\nif (keyIsDown(LEFT_ARROW)) then\n -- left arrow is down\nend"]},"source":{"end_line":25,"start_line":6,"header":"keyboard.h"}} \ No newline at end of file +{"doc":{"description":"Check if a keyboard key is pressed, returns true if key is down and returns false if it's not","bottom_description":"","examples":["-- Use a string \nif (keyIsDown('a')) then\n -- key 'a' is down\nend\n\n-- use a global\nif (keyIsDown(LEFT_ARROW)) then\n -- left arrow is down\nend"],"name":"keyIsDown","_type":"method","calls":[{"arguments":[{"name":"k","description":"The keyboard key to check as a key global, or a string"}]}],"_return":{"var":"boolean","description":"Whether or not the key is down"}},"source":{"header":"keyboard.h","start_line":6,"end_line":25}} \ No newline at end of file diff --git a/docs/v0.1.7/keyboard/keyPressed/index.html b/docs/v0.1.7/keyboard/keyPressed/index.html index 2141800..e638822 100644 --- a/docs/v0.1.7/keyboard/keyPressed/index.html +++ b/docs/v0.1.7/keyboard/keyPressed/index.html @@ -1,4 +1,4 @@ -lu5 | keyPressed

keyPressed

v0.1.7
keyPressed(key, keyCode);Event

Called whenever a key is pressed.

Arguments

keyThe pressed key as a string, is nil if glfw cannot find a name for the key
keyCodeThe pressed key as a key code

function setup()
+lu5 | keyPressed

keyPressed

v0.1.7
keyPressed(key, keyCode);Event

Called whenever a key is pressed.

Arguments

keyThe pressed key as a string, is nil if glfw cannot find a name for the key
keyCodeThe pressed key as a key code

function setup()
    createWindow(600, 600);
 end
 
@@ -8,4 +8,4 @@
 
 function keyPressed(key, keyCode)
    print(key, keyCode)
-end
See keyPressed in keyboard.h
This project is licensed under the MIT License.
It also includes the FreeType font engine, which is licensed under the FreeType License (FTL).
\ No newline at end of file +end
See keyPressed in keyboard.h
\ No newline at end of file diff --git a/docs/v0.1.7/keyboard/keyPressed/meta.json b/docs/v0.1.7/keyboard/keyPressed/meta.json index cf5b56e..f4ccbcf 100644 --- a/docs/v0.1.7/keyboard/keyPressed/meta.json +++ b/docs/v0.1.7/keyboard/keyPressed/meta.json @@ -1 +1 @@ -{"doc":{"bottom_description":"","name":"keyPressed","description":"Called whenever a key is pressed.","calls":[{"arguments":[{"name":"key","description":"The pressed key as a string, is nil if glfw cannot find a name for the key"},{"name":"keyCode","description":"The pressed key as a key code"}]}],"_type":"event","examples":["function setup()\n createWindow(600, 600);\nend\n\nfunction draw()\n background(51);\nend\n\nfunction keyPressed(key, keyCode)\n print(key, keyCode)\nend"]},"source":{"end_line":49,"start_line":27,"header":"keyboard.h"}} \ No newline at end of file +{"doc":{"description":"Called whenever a key is pressed.","bottom_description":"","examples":["function setup()\n createWindow(600, 600);\nend\n\nfunction draw()\n background(51);\nend\n\nfunction keyPressed(key, keyCode)\n print(key, keyCode)\nend"],"name":"keyPressed","calls":[{"arguments":[{"name":"key","description":"The pressed key as a string, is nil if glfw cannot find a name for the key"},{"name":"keyCode","description":"The pressed key as a key code"}]}],"_type":"event"},"source":{"header":"keyboard.h","start_line":27,"end_line":49}} \ No newline at end of file diff --git a/docs/v0.1.7/keyboard/keyReleased/index.html b/docs/v0.1.7/keyboard/keyReleased/index.html index 9de5b8b..ef360ec 100644 --- a/docs/v0.1.7/keyboard/keyReleased/index.html +++ b/docs/v0.1.7/keyboard/keyReleased/index.html @@ -1,4 +1,4 @@ -lu5 | keyReleased

keyReleased

v0.1.7
keyReleased(key, keyCode);Event

Called whenever a key is released.

Arguments

keyThe released key as a string, is nil if glfw cannot find a name for the key
keyCodeThe released key as a key code

function setup()
+lu5 | keyReleased

keyReleased

v0.1.7
keyReleased(key, keyCode);Event

Called whenever a key is released.

Arguments

keyThe released key as a string, is nil if glfw cannot find a name for the key
keyCodeThe released key as a key code

function setup()
    createWindow(600, 600);
 end
 
@@ -8,4 +8,4 @@
 
 function keyReleased(key, keyCode)
    print(key, keyCode);
-end
See keyReleased in keyboard.h
This project is licensed under the MIT License.
It also includes the FreeType font engine, which is licensed under the FreeType License (FTL).
\ No newline at end of file +end
See keyReleased in keyboard.h
\ No newline at end of file diff --git a/docs/v0.1.7/keyboard/keyReleased/meta.json b/docs/v0.1.7/keyboard/keyReleased/meta.json index 3fe4f54..502d077 100644 --- a/docs/v0.1.7/keyboard/keyReleased/meta.json +++ b/docs/v0.1.7/keyboard/keyReleased/meta.json @@ -1 +1 @@ -{"doc":{"bottom_description":"","name":"keyReleased","description":"Called whenever a key is released.","calls":[{"arguments":[{"name":"key","description":"The released key as a string, is nil if glfw cannot find a name for the key"},{"name":"keyCode","description":"The released key as a key code"}]}],"_type":"event","examples":["function setup()\n createWindow(600, 600);\nend\n\nfunction draw()\n background(51);\nend\n\nfunction keyReleased(key, keyCode)\n print(key, keyCode);\nend"]},"source":{"end_line":73,"start_line":52,"header":"keyboard.h"}} \ No newline at end of file +{"doc":{"description":"Called whenever a key is released.","bottom_description":"","examples":["function setup()\n createWindow(600, 600);\nend\n\nfunction draw()\n background(51);\nend\n\nfunction keyReleased(key, keyCode)\n print(key, keyCode);\nend"],"name":"keyReleased","calls":[{"arguments":[{"name":"key","description":"The released key as a string, is nil if glfw cannot find a name for the key"},{"name":"keyCode","description":"The released key as a key code"}]}],"_type":"event"},"source":{"header":"keyboard.h","start_line":52,"end_line":73}} \ No newline at end of file diff --git a/docs/v0.1.7/math/abs/index.html b/docs/v0.1.7/math/abs/index.html index ba34160..677cb17 100644 --- a/docs/v0.1.7/math/abs/index.html +++ b/docs/v0.1.7/math/abs/index.html @@ -1 +1 @@ -lu5 | abs

abs

v0.1.7
abs(x);

Returns the absolute value of x.

Arguments

xThe input value

Returns

numberThe absolote value of the input

See abs in lu5_math.h
\ No newline at end of file +lu5 | abs

abs

v0.1.7
abs(x);

Returns the absolute value of x.

Arguments

xThe input value

Returns

numberThe absolote value of the input

See abs in lu5_math.h
\ No newline at end of file diff --git a/docs/v0.1.7/math/abs/meta.json b/docs/v0.1.7/math/abs/meta.json index 520ba43..e4d6d24 100644 --- a/docs/v0.1.7/math/abs/meta.json +++ b/docs/v0.1.7/math/abs/meta.json @@ -1 +1 @@ -{"doc":{"bottom_description":"","_return":{"description":"The absolote value of the input","var":"number"},"name":"abs","description":"Returns the absolute value of x.","calls":[{"arguments":[{"name":"x","description":"The input value"}]}],"_type":"method","examples":{}},"source":{"end_line":120,"start_line":113,"header":"lu5_math.h"}} \ No newline at end of file +{"doc":{"description":"Returns the absolute value of x.","bottom_description":"","examples":{},"name":"abs","_type":"method","calls":[{"arguments":[{"name":"x","description":"The input value"}]}],"_return":{"var":"number","description":"The absolote value of the input"}},"source":{"header":"lu5_math.h","start_line":113,"end_line":120}} \ No newline at end of file diff --git a/docs/v0.1.7/math/ceil/index.html b/docs/v0.1.7/math/ceil/index.html index 320d4b8..8ad807e 100644 --- a/docs/v0.1.7/math/ceil/index.html +++ b/docs/v0.1.7/math/ceil/index.html @@ -1 +1 @@ -lu5 | ceil

ceil

v0.1.7
ceil(x);

ceil is a function that takes in a number, and returns the smallest integer greater or equal to x.

Arguments

xThe value to floor

Returns

intThe floored value

See ceil in lu5_math.h
\ No newline at end of file +lu5 | ceil

ceil

v0.1.7
ceil(x);

ceil is a function that takes in a number, and returns the smallest integer greater or equal to x.

Arguments

xThe value to floor

Returns

intThe floored value

See ceil in lu5_math.h
\ No newline at end of file diff --git a/docs/v0.1.7/math/ceil/meta.json b/docs/v0.1.7/math/ceil/meta.json index 8a97658..f4a7e1e 100644 --- a/docs/v0.1.7/math/ceil/meta.json +++ b/docs/v0.1.7/math/ceil/meta.json @@ -1 +1 @@ -{"doc":{"bottom_description":"","_return":{"description":"The floored value","var":"int"},"name":"ceil","description":"ceil is a function that takes in a number, and returns the smallest integer greater or equal to x.","calls":[{"arguments":[{"name":"x","description":"The value to floor"}]}],"_type":"method","examples":{}},"source":{"end_line":73,"start_line":66,"header":"lu5_math.h"}} \ No newline at end of file +{"doc":{"description":"ceil is a function that takes in a number, and returns the smallest integer greater or equal to x.","bottom_description":"","examples":{},"name":"ceil","_type":"method","calls":[{"arguments":[{"name":"x","description":"The value to floor"}]}],"_return":{"var":"int","description":"The floored value"}},"source":{"header":"lu5_math.h","start_line":66,"end_line":73}} \ No newline at end of file diff --git a/docs/v0.1.7/math/constrain/index.html b/docs/v0.1.7/math/constrain/index.html index 7bd3fdb..cd051ac 100644 --- a/docs/v0.1.7/math/constrain/index.html +++ b/docs/v0.1.7/math/constrain/index.html @@ -1 +1 @@ -lu5 | constrain

constrain

v0.1.7
constrain(x, min, max);

Limits x to a minimum and maximum value.

Arguments

xThe input value
minThe minimum value
maxThe maximum value

Returns

numberThe constrained value

See constrain in lu5_math.h
\ No newline at end of file +lu5 | constrain

constrain

v0.1.7
constrain(x, min, max);

Limits x to a minimum and maximum value.

Arguments

xThe input value
minThe minimum value
maxThe maximum value

Returns

numberThe constrained value

See constrain in lu5_math.h
\ No newline at end of file diff --git a/docs/v0.1.7/math/constrain/meta.json b/docs/v0.1.7/math/constrain/meta.json index 92169ed..d6cfddc 100644 --- a/docs/v0.1.7/math/constrain/meta.json +++ b/docs/v0.1.7/math/constrain/meta.json @@ -1 +1 @@ -{"doc":{"bottom_description":"","_return":{"description":"The constrained value","var":"number"},"name":"constrain","description":"Limits x to a minimum and maximum value.","calls":[{"arguments":[{"name":"x","description":"The input value"},{"name":"min","description":"The minimum value"},{"name":"max","description":"The maximum value"}]}],"_type":"method","examples":{}},"source":{"end_line":192,"start_line":183,"header":"lu5_math.h"}} \ No newline at end of file +{"doc":{"description":"Limits x to a minimum and maximum value.","bottom_description":"","examples":{},"name":"constrain","_type":"method","calls":[{"arguments":[{"name":"x","description":"The input value"},{"name":"min","description":"The minimum value"},{"name":"max","description":"The maximum value"}]}],"_return":{"var":"number","description":"The constrained value"}},"source":{"header":"lu5_math.h","start_line":183,"end_line":192}} \ No newline at end of file diff --git a/docs/v0.1.7/math/cos/index.html b/docs/v0.1.7/math/cos/index.html index 747bb3b..64a7046 100644 --- a/docs/v0.1.7/math/cos/index.html +++ b/docs/v0.1.7/math/cos/index.html @@ -1 +1 @@ -lu5 | cos

cos

v0.1.7
cos(x);

Cosine function (Trigonometry).

Arguments

xThe input value

Returns

numberThe output value

See cos in lu5_math.h
\ No newline at end of file +lu5 | cos

cos

v0.1.7
cos(x);

Cosine function (Trigonometry).

Arguments

xThe input value

Returns

numberThe output value

See cos in lu5_math.h
\ No newline at end of file diff --git a/docs/v0.1.7/math/cos/meta.json b/docs/v0.1.7/math/cos/meta.json index 616a016..e1a1a74 100644 --- a/docs/v0.1.7/math/cos/meta.json +++ b/docs/v0.1.7/math/cos/meta.json @@ -1 +1 @@ -{"doc":{"bottom_description":"","_return":{"description":"The output value","var":"number"},"name":"cos","description":"Cosine function (Trigonometry).","calls":[{"arguments":[{"name":"x","description":"The input value"}]}],"_type":"method","examples":{}},"source":{"end_line":210,"start_line":203,"header":"lu5_math.h"}} \ No newline at end of file +{"doc":{"description":"Cosine function (Trigonometry).","bottom_description":"","examples":{},"name":"cos","_type":"method","calls":[{"arguments":[{"name":"x","description":"The input value"}]}],"_return":{"var":"number","description":"The output value"}},"source":{"header":"lu5_math.h","start_line":203,"end_line":210}} \ No newline at end of file diff --git a/docs/v0.1.7/math/dist/index.html b/docs/v0.1.7/math/dist/index.html index cee2b87..e822cec 100644 --- a/docs/v0.1.7/math/dist/index.html +++ b/docs/v0.1.7/math/dist/index.html @@ -1,7 +1,7 @@ -lu5 | dist

dist

v0.1.7
dist

Calculates the distance between 2 points in 2D or 3D space.

Arguments

x1The x coordinate of the first point
y1The y coordinate of the first point
x2The x coordinate of the second point
y2The y coordinate of the second point
local d = dist(0, 0, 3, 4);
+lu5 | dist

dist

v0.1.7
dist

Calculates the distance between 2 points in 2D or 3D space.

Arguments

x1The x coordinate of the first point
y1The y coordinate of the first point
x2The x coordinate of the second point
y2The y coordinate of the second point
local d = dist(0, 0, 3, 4);
 print(d) -- 5

Arguments

x1The x coordinate of the first point
y1The y coordinate of the first point
z1The z coordinate of the first point
x2The x coordinate of the second point
y2The y coordinate of the second point
z2The z coordinate of the second point
local d = dist(0, 0, 0, 2, 3, 6);
 print(d) -- 7

Arguments

v1The first vector
v2The second vector
local a = createVector(-1, -1);
 local b = createVector( 2,  3);
 
 local d = dist(a, b);
-print(d) -- 5

Returns

numberThe distance between the points

See dist in lu5_math.h
This project is licensed under the MIT License.
It also includes the FreeType font engine, which is licensed under the FreeType License (FTL).
\ No newline at end of file +print(d) -- 5

Returns

numberThe distance between the points

See dist in lu5_math.h
\ No newline at end of file diff --git a/docs/v0.1.7/math/dist/meta.json b/docs/v0.1.7/math/dist/meta.json index fc79d55..edbd4f5 100644 --- a/docs/v0.1.7/math/dist/meta.json +++ b/docs/v0.1.7/math/dist/meta.json @@ -1 +1 @@ -{"doc":{"bottom_description":"","_return":{"description":"The distance between the points","var":"number"},"name":"dist","description":"Calculates the distance between 2 points in 2D or 3D space.","calls":[{"example":"local d = dist(0, 0, 3, 4);\nprint(d) -- 5","arguments":[{"name":"x1","description":"The x coordinate of the first point"},{"name":"y1","description":"The y coordinate of the first point"},{"name":"x2","description":"The x coordinate of the second point"},{"name":"y2","description":"The y coordinate of the second point"}]},{"example":"local d = dist(0, 0, 0, 2, 3, 6);\nprint(d) -- 7","arguments":[{"name":"x1","description":"The x coordinate of the first point"},{"name":"y1","description":"The y coordinate of the first point"},{"name":"z1","description":"The z coordinate of the first point"},{"name":"x2","description":"The x coordinate of the second point"},{"name":"y2","description":"The y coordinate of the second point"},{"name":"z2","description":"The z coordinate of the second point"}]},{"example":"local a = createVector(-1, -1);\nlocal b = createVector( 2, 3);\n\nlocal d = dist(a, b);\nprint(d) -- 5","arguments":[{"name":"v1","description":"The first vector"},{"name":"v2","description":"The second vector"}]}],"_type":"method","examples":{}},"source":{"end_line":181,"start_line":141,"header":"lu5_math.h"}} \ No newline at end of file +{"doc":{"description":"Calculates the distance between 2 points in 2D or 3D space.","bottom_description":"","examples":{},"name":"dist","_type":"method","calls":[{"example":"local d = dist(0, 0, 3, 4);\nprint(d) -- 5","arguments":[{"name":"x1","description":"The x coordinate of the first point"},{"name":"y1","description":"The y coordinate of the first point"},{"name":"x2","description":"The x coordinate of the second point"},{"name":"y2","description":"The y coordinate of the second point"}]},{"example":"local d = dist(0, 0, 0, 2, 3, 6);\nprint(d) -- 7","arguments":[{"name":"x1","description":"The x coordinate of the first point"},{"name":"y1","description":"The y coordinate of the first point"},{"name":"z1","description":"The z coordinate of the first point"},{"name":"x2","description":"The x coordinate of the second point"},{"name":"y2","description":"The y coordinate of the second point"},{"name":"z2","description":"The z coordinate of the second point"}]},{"example":"local a = createVector(-1, -1);\nlocal b = createVector( 2, 3);\n\nlocal d = dist(a, b);\nprint(d) -- 5","arguments":[{"name":"v1","description":"The first vector"},{"name":"v2","description":"The second vector"}]}],"_return":{"var":"number","description":"The distance between the points"}},"source":{"header":"lu5_math.h","start_line":141,"end_line":181}} \ No newline at end of file diff --git a/docs/v0.1.7/math/floor/index.html b/docs/v0.1.7/math/floor/index.html index 7b5ae5f..df9ada8 100644 --- a/docs/v0.1.7/math/floor/index.html +++ b/docs/v0.1.7/math/floor/index.html @@ -1 +1 @@ -lu5 | floor

floor

v0.1.7
floor(x);

floor is a function that takes in a number, and returns the greatest integer less or equal to x.

Arguments

xThe value to floor

Returns

intgreatest integer less than or equals to x

See floor in lu5_math.h
\ No newline at end of file +lu5 | floor

floor

v0.1.7
floor(x);

floor is a function that takes in a number, and returns the greatest integer less or equal to x.

Arguments

xThe value to floor

Returns

intgreatest integer less than or equals to x

See floor in lu5_math.h
\ No newline at end of file diff --git a/docs/v0.1.7/math/floor/meta.json b/docs/v0.1.7/math/floor/meta.json index 72c7dbb..2a748eb 100644 --- a/docs/v0.1.7/math/floor/meta.json +++ b/docs/v0.1.7/math/floor/meta.json @@ -1 +1 @@ -{"doc":{"bottom_description":"","_return":{"description":"greatest integer less than or equals to x","var":"int"},"name":"floor","description":"floor is a function that takes in a number, and returns the greatest integer less or equal to x.","calls":[{"arguments":[{"name":"x","description":"The value to floor"}]}],"_type":"method","examples":{}},"source":{"end_line":64,"start_line":57,"header":"lu5_math.h"}} \ No newline at end of file +{"doc":{"description":"floor is a function that takes in a number, and returns the greatest integer less or equal to x.","bottom_description":"","examples":{},"name":"floor","_type":"method","calls":[{"arguments":[{"name":"x","description":"The value to floor"}]}],"_return":{"var":"int","description":"greatest integer less than or equals to x"}},"source":{"header":"lu5_math.h","start_line":57,"end_line":64}} \ No newline at end of file diff --git a/docs/v0.1.7/math/index.html b/docs/v0.1.7/math/index.html index 8e9b5a7..ea18d3e 100644 --- a/docs/v0.1.7/math/index.html +++ b/docs/v0.1.7/math/index.html @@ -1,17 +1,17 @@ -lu5 | math

math

v0.1.7
randomSeed(seed);

Set a random seed.

Arguments

seedThe seed value

Returns

numberThe random value

See randomSeed in lu5_math.h
random

Get a random number.

Arguments

maxThe maximum of the range
random()      -- random number between 0 and 1
-random(3)     -- random number between 0 and 3

Arguments

minThe minimum of the range
maxThe maximum of the range
random(3, 12) -- random number between 3 and 12

Arguments

arrThe array to randomly select an item from
random({ 'A', 'B', 'C' }) -- random element in table

Returns

numberThe random value

See random in lu5_math.h
round(x);

Round a number to the nearest integer.

Arguments

xThe value to round

Returns

intThe rounded value

See round in lu5_math.h
floor(x);

floor is a function that takes in a number, and returns the greatest integer less or equal to x.

Arguments

xThe value to floor

Returns

intgreatest integer less than or equals to x

See floor in lu5_math.h
ceil(x);

ceil is a function that takes in a number, and returns the smallest integer greater or equal to x.

Arguments

xThe value to floor

Returns

intThe floored value

See ceil in lu5_math.h
min(a, b);

Return the smallest value.
Can also take any number of arguments, or a table.

Arguments

aThe first value
bThe second value

Returns

numberThe smallest value

min(6, 7); -- returns 6
+lu5 | math

math

v0.1.7
randomSeed(seed);

Set a random seed.

Arguments

seedThe seed value

Returns

numberThe random value

See randomSeed in lu5_math.h
random

Get a random number.

Arguments

maxThe maximum of the range
random()      -- random number between 0 and 1
+random(3)     -- random number between 0 and 3

Arguments

minThe minimum of the range
maxThe maximum of the range
random(3, 12) -- random number between 3 and 12

Arguments

arrThe array to randomly select an item from
random({ 'A', 'B', 'C' }) -- random element in table

Returns

numberThe random value

See random in lu5_math.h
round(x);

Round a number to the nearest integer.

Arguments

xThe value to round

Returns

intThe rounded value

See round in lu5_math.h
floor(x);

floor is a function that takes in a number, and returns the greatest integer less or equal to x.

Arguments

xThe value to floor

Returns

intgreatest integer less than or equals to x

See floor in lu5_math.h
ceil(x);

ceil is a function that takes in a number, and returns the smallest integer greater or equal to x.

Arguments

xThe value to floor

Returns

intThe floored value

See ceil in lu5_math.h
min(a, b);

Return the smallest value.
Can also take any number of arguments, or a table.

Arguments

aThe first value
bThe second value

Returns

numberThe smallest value

min(6, 7); -- returns 6
 
 min(6, 7, 4); -- returns 4
 
-min({ 6, 7, 4 }); -- returns 4
See min in lu5_math.h
max(a, b);

Return the largest value.
Can also take any number of arguments, or a table.

Arguments

aThe first value
bThe second value

Returns

numberThe largest value

max(2, 5); -- returns 5
+min({ 6, 7, 4 }); -- returns 4
See min in lu5_math.h
max(a, b);

Return the largest value.
Can also take any number of arguments, or a table.

Arguments

aThe first value
bThe second value

Returns

numberThe largest value

max(2, 5); -- returns 5
 
 max(2, 5, 7); -- returns 7
 
-max({ 2, 5, 7 }); -- returns 7
See max in lu5_math.h
abs(x);

Returns the absolute value of x.

Arguments

xThe input value

Returns

numberThe absolote value of the input

See abs in lu5_math.h
map(value, start, end, target_start, target_end);

Maps x from an original range to a target range.

Arguments

valueThe value to map
startThe start of the initial range
endThe end of the initial range
target_startThe start of the target range
target_endThe end of the target range

Returns

numberThe mapped value

local mouseX_mapped = map(mouseX, 0, width, 0, 100);
--- mapped mouseX between 0 and 100
See map in lu5_math.h
dist

Calculates the distance between 2 points in 2D or 3D space.

Arguments

x1The x coordinate of the first point
y1The y coordinate of the first point
x2The x coordinate of the second point
y2The y coordinate of the second point
local d = dist(0, 0, 3, 4);
+max({ 2, 5, 7 }); -- returns 7
See max in lu5_math.h
abs(x);

Returns the absolute value of x.

Arguments

xThe input value

Returns

numberThe absolote value of the input

See abs in lu5_math.h
map(value, start, end, target_start, target_end);

Maps x from an original range to a target range.

Arguments

valueThe value to map
startThe start of the initial range
endThe end of the initial range
target_startThe start of the target range
target_endThe end of the target range

Returns

numberThe mapped value

local mouseX_mapped = map(mouseX, 0, width, 0, 100);
+-- mapped mouseX between 0 and 100
See map in lu5_math.h
dist

Calculates the distance between 2 points in 2D or 3D space.

Arguments

x1The x coordinate of the first point
y1The y coordinate of the first point
x2The x coordinate of the second point
y2The y coordinate of the second point
local d = dist(0, 0, 3, 4);
 print(d) -- 5

Arguments

x1The x coordinate of the first point
y1The y coordinate of the first point
z1The z coordinate of the first point
x2The x coordinate of the second point
y2The y coordinate of the second point
z2The z coordinate of the second point
local d = dist(0, 0, 0, 2, 3, 6);
 print(d) -- 7

Arguments

v1The first vector
v2The second vector
local a = createVector(-1, -1);
 local b = createVector( 2,  3);
 
 local d = dist(a, b);
-print(d) -- 5

Returns

numberThe distance between the points

See dist in lu5_math.h
constrain(x, min, max);

Limits x to a minimum and maximum value.

Arguments

xThe input value
minThe minimum value
maxThe maximum value

Returns

numberThe constrained value

See constrain in lu5_math.h
sin(x);

Sine function (Trigonometry).

Arguments

xThe input value

Returns

numberThe output value

See sin in lu5_math.h
cos(x);

Cosine function (Trigonometry).

Arguments

xThe input value

Returns

numberThe output value

See cos in lu5_math.h
tan(x);

Tangent function (Trigonometry).

Arguments

xThe input value

Returns

numberThe output value

See tan in lu5_math.h
PIConstant

No description

See PI in lu5_math.h
TWO_PIConstant

No description

See TWO_PI in lu5_math.h
HALF_PIConstant

No description

See HALF_PI in lu5_math.h
QUARTER_PIConstant

No description

See QUARTER_PI in lu5_math.h
This project is licensed under the MIT License.
It also includes the FreeType font engine, which is licensed under the FreeType License (FTL).
\ No newline at end of file +print(d) -- 5

Returns

numberThe distance between the points

See dist in lu5_math.h
constrain(x, min, max);

Limits x to a minimum and maximum value.

Arguments

xThe input value
minThe minimum value
maxThe maximum value

Returns

numberThe constrained value

See constrain in lu5_math.h
sin(x);

Sine function (Trigonometry).

Arguments

xThe input value

Returns

numberThe output value

See sin in lu5_math.h
cos(x);

Cosine function (Trigonometry).

Arguments

xThe input value

Returns

numberThe output value

See cos in lu5_math.h
tan(x);

Tangent function (Trigonometry).

Arguments

xThe input value

Returns

numberThe output value

See tan in lu5_math.h
PIConstant

No description

See PI in lu5_math.h
TWO_PIConstant

No description

See TWO_PI in lu5_math.h
HALF_PIConstant

No description

See HALF_PI in lu5_math.h
QUARTER_PIConstant

No description

See QUARTER_PI in lu5_math.h
\ No newline at end of file diff --git a/docs/v0.1.7/math/map/index.html b/docs/v0.1.7/math/map/index.html index dd3467b..0556305 100644 --- a/docs/v0.1.7/math/map/index.html +++ b/docs/v0.1.7/math/map/index.html @@ -1,2 +1,2 @@ -lu5 | map

map

v0.1.7
map(value, start, end, target_start, target_end);

Maps x from an original range to a target range.

Arguments

valueThe value to map
startThe start of the initial range
endThe end of the initial range
target_startThe start of the target range
target_endThe end of the target range

Returns

numberThe mapped value

local mouseX_mapped = map(mouseX, 0, width, 0, 100);
--- mapped mouseX between 0 and 100
See map in lu5_math.h
\ No newline at end of file +lu5 | map

map

v0.1.7
map(value, start, end, target_start, target_end);

Maps x from an original range to a target range.

Arguments

valueThe value to map
startThe start of the initial range
endThe end of the initial range
target_startThe start of the target range
target_endThe end of the target range

Returns

numberThe mapped value

local mouseX_mapped = map(mouseX, 0, width, 0, 100);
+-- mapped mouseX between 0 and 100
See map in lu5_math.h
\ No newline at end of file diff --git a/docs/v0.1.7/math/map/meta.json b/docs/v0.1.7/math/map/meta.json index dbfbe46..d1cce22 100644 --- a/docs/v0.1.7/math/map/meta.json +++ b/docs/v0.1.7/math/map/meta.json @@ -1 +1 @@ -{"doc":{"bottom_description":"","_return":{"description":"The mapped value","var":"number"},"name":"map","description":"Maps x from an original range to a target range.","calls":[{"arguments":[{"name":"value","description":"The value to map"},{"name":"start","description":"The start of the initial range"},{"name":"end","description":"The end of the initial range"},{"name":"target_start","description":"The start of the target range"},{"name":"target_end","description":"The end of the target range"}]}],"_type":"method","examples":["local mouseX_mapped = map(mouseX, 0, width, 0, 100);\n-- mapped mouseX between 0 and 100"]},"source":{"end_line":138,"start_line":122,"header":"lu5_math.h"}} \ No newline at end of file +{"doc":{"description":"Maps x from an original range to a target range.","bottom_description":"","examples":["local mouseX_mapped = map(mouseX, 0, width, 0, 100);\n-- mapped mouseX between 0 and 100"],"name":"map","_type":"method","calls":[{"arguments":[{"name":"value","description":"The value to map"},{"name":"start","description":"The start of the initial range"},{"name":"end","description":"The end of the initial range"},{"name":"target_start","description":"The start of the target range"},{"name":"target_end","description":"The end of the target range"}]}],"_return":{"var":"number","description":"The mapped value"}},"source":{"header":"lu5_math.h","start_line":122,"end_line":138}} \ No newline at end of file diff --git a/docs/v0.1.7/math/max/index.html b/docs/v0.1.7/math/max/index.html index 16d1dbc..dbb1c8e 100644 --- a/docs/v0.1.7/math/max/index.html +++ b/docs/v0.1.7/math/max/index.html @@ -1,5 +1,5 @@ -lu5 | max

max

v0.1.7
max(a, b);

Return the largest value.
Can also take any number of arguments, or a table.

Arguments

aThe first value
bThe second value

Returns

numberThe largest value

max(2, 5); -- returns 5
+lu5 | max

max

v0.1.7
max(a, b);

Return the largest value.
Can also take any number of arguments, or a table.

Arguments

aThe first value
bThe second value

Returns

numberThe largest value

max(2, 5); -- returns 5
 
 max(2, 5, 7); -- returns 7
 
-max({ 2, 5, 7 }); -- returns 7
See max in lu5_math.h
This project is licensed under the MIT License.
It also includes the FreeType font engine, which is licensed under the FreeType License (FTL).
\ No newline at end of file +max({ 2, 5, 7 }); -- returns 7
See max in lu5_math.h
\ No newline at end of file diff --git a/docs/v0.1.7/math/max/meta.json b/docs/v0.1.7/math/max/meta.json index 61aa469..ba814dd 100644 --- a/docs/v0.1.7/math/max/meta.json +++ b/docs/v0.1.7/math/max/meta.json @@ -1 +1 @@ -{"doc":{"bottom_description":"","_return":{"description":"The largest value","var":"number"},"name":"max","description":"Return the largest value.
Can also take any number of arguments, or a table.","calls":[{"arguments":[{"name":"a","description":"The first value"},{"name":"b","description":"The second value"}]}],"_type":"method","examples":["max(2, 5); -- returns 5\n\nmax(2, 5, 7); -- returns 7\n\nmax({ 2, 5, 7 }); -- returns 7"]},"source":{"end_line":111,"start_line":94,"header":"lu5_math.h"}} \ No newline at end of file +{"doc":{"description":"Return the largest value.
Can also take any number of arguments, or a table.","bottom_description":"","examples":["max(2, 5); -- returns 5\n\nmax(2, 5, 7); -- returns 7\n\nmax({ 2, 5, 7 }); -- returns 7"],"name":"max","_type":"method","calls":[{"arguments":[{"name":"a","description":"The first value"},{"name":"b","description":"The second value"}]}],"_return":{"var":"number","description":"The largest value"}},"source":{"header":"lu5_math.h","start_line":94,"end_line":111}} \ No newline at end of file diff --git a/docs/v0.1.7/math/min/index.html b/docs/v0.1.7/math/min/index.html index 4240109..18e241c 100644 --- a/docs/v0.1.7/math/min/index.html +++ b/docs/v0.1.7/math/min/index.html @@ -1,5 +1,5 @@ -lu5 | min

min

v0.1.7
min(a, b);

Return the smallest value.
Can also take any number of arguments, or a table.

Arguments

aThe first value
bThe second value

Returns

numberThe smallest value

min(6, 7); -- returns 6
+lu5 | min

min

v0.1.7
min(a, b);

Return the smallest value.
Can also take any number of arguments, or a table.

Arguments

aThe first value
bThe second value

Returns

numberThe smallest value

min(6, 7); -- returns 6
 
 min(6, 7, 4); -- returns 4
 
-min({ 6, 7, 4 }); -- returns 4
See min in lu5_math.h
This project is licensed under the MIT License.
It also includes the FreeType font engine, which is licensed under the FreeType License (FTL).
\ No newline at end of file +min({ 6, 7, 4 }); -- returns 4
See min in lu5_math.h
\ No newline at end of file diff --git a/docs/v0.1.7/math/min/meta.json b/docs/v0.1.7/math/min/meta.json index fe251d9..1bb745f 100644 --- a/docs/v0.1.7/math/min/meta.json +++ b/docs/v0.1.7/math/min/meta.json @@ -1 +1 @@ -{"doc":{"bottom_description":"","_return":{"description":"The smallest value","var":"number"},"name":"min","description":"Return the smallest value.
Can also take any number of arguments, or a table.","calls":[{"arguments":[{"name":"a","description":"The first value"},{"name":"b","description":"The second value"}]}],"_type":"method","examples":["min(6, 7); -- returns 6\n\nmin(6, 7, 4); -- returns 4\n\nmin({ 6, 7, 4 }); -- returns 4"]},"source":{"end_line":92,"start_line":75,"header":"lu5_math.h"}} \ No newline at end of file +{"doc":{"description":"Return the smallest value.
Can also take any number of arguments, or a table.","bottom_description":"","examples":["min(6, 7); -- returns 6\n\nmin(6, 7, 4); -- returns 4\n\nmin({ 6, 7, 4 }); -- returns 4"],"name":"min","_type":"method","calls":[{"arguments":[{"name":"a","description":"The first value"},{"name":"b","description":"The second value"}]}],"_return":{"var":"number","description":"The smallest value"}},"source":{"header":"lu5_math.h","start_line":75,"end_line":92}} \ No newline at end of file diff --git a/docs/v0.1.7/math/random/index.html b/docs/v0.1.7/math/random/index.html index 0b7ca9b..88613fe 100644 --- a/docs/v0.1.7/math/random/index.html +++ b/docs/v0.1.7/math/random/index.html @@ -1,2 +1,2 @@ -lu5 | random

random

v0.1.7
random

Get a random number.

Arguments

maxThe maximum of the range
random()      -- random number between 0 and 1
-random(3)     -- random number between 0 and 3

Arguments

minThe minimum of the range
maxThe maximum of the range
random(3, 12) -- random number between 3 and 12

Arguments

arrThe array to randomly select an item from
random({ 'A', 'B', 'C' }) -- random element in table

Returns

numberThe random value

See random in lu5_math.h
\ No newline at end of file +lu5 | random

random

v0.1.7
random

Get a random number.

Arguments

maxThe maximum of the range
random()      -- random number between 0 and 1
+random(3)     -- random number between 0 and 3

Arguments

minThe minimum of the range
maxThe maximum of the range
random(3, 12) -- random number between 3 and 12

Arguments

arrThe array to randomly select an item from
random({ 'A', 'B', 'C' }) -- random element in table

Returns

numberThe random value

See random in lu5_math.h
\ No newline at end of file diff --git a/docs/v0.1.7/math/random/meta.json b/docs/v0.1.7/math/random/meta.json index abe69f4..8d5314e 100644 --- a/docs/v0.1.7/math/random/meta.json +++ b/docs/v0.1.7/math/random/meta.json @@ -1 +1 @@ -{"doc":{"bottom_description":"","_return":{"description":"The random value","var":"number"},"name":"random","description":"Get a random number.","calls":[{"example":"random() -- random number between 0 and 1\nrandom(3) -- random number between 0 and 3","arguments":[{"name":"max","description":"The maximum of the range"}]},{"example":"random(3, 12) -- random number between 3 and 12","arguments":[{"name":"min","description":"The minimum of the range"},{"name":"max","description":"The maximum of the range"}]},{"example":"random({ 'A', 'B', 'C' }) -- random element in table","arguments":[{"name":"arr","description":"The array to randomly select an item from"}]}],"_type":"method","examples":{}},"source":{"end_line":45,"start_line":18,"header":"lu5_math.h"}} \ No newline at end of file +{"doc":{"description":"Get a random number.","bottom_description":"","examples":{},"name":"random","_type":"method","calls":[{"example":"random() -- random number between 0 and 1\nrandom(3) -- random number between 0 and 3","arguments":[{"name":"max","description":"The maximum of the range"}]},{"example":"random(3, 12) -- random number between 3 and 12","arguments":[{"name":"min","description":"The minimum of the range"},{"name":"max","description":"The maximum of the range"}]},{"example":"random({ 'A', 'B', 'C' }) -- random element in table","arguments":[{"name":"arr","description":"The array to randomly select an item from"}]}],"_return":{"var":"number","description":"The random value"}},"source":{"header":"lu5_math.h","start_line":18,"end_line":45}} \ No newline at end of file diff --git a/docs/v0.1.7/math/randomSeed/index.html b/docs/v0.1.7/math/randomSeed/index.html index 000b4a7..21ee27d 100644 --- a/docs/v0.1.7/math/randomSeed/index.html +++ b/docs/v0.1.7/math/randomSeed/index.html @@ -1 +1 @@ -lu5 | randomSeed

randomSeed

v0.1.7
randomSeed(seed);

Set a random seed.

Arguments

seedThe seed value

Returns

numberThe random value

See randomSeed in lu5_math.h
\ No newline at end of file +lu5 | randomSeed

randomSeed

v0.1.7
randomSeed(seed);

Set a random seed.

Arguments

seedThe seed value

Returns

numberThe random value

See randomSeed in lu5_math.h
\ No newline at end of file diff --git a/docs/v0.1.7/math/randomSeed/meta.json b/docs/v0.1.7/math/randomSeed/meta.json index a726307..69835f6 100644 --- a/docs/v0.1.7/math/randomSeed/meta.json +++ b/docs/v0.1.7/math/randomSeed/meta.json @@ -1 +1 @@ -{"doc":{"bottom_description":"","_return":{"description":"The random value","var":"number"},"name":"randomSeed","description":"Set a random seed.","calls":[{"arguments":[{"name":"seed","description":"The seed value"}]}],"_type":"method","examples":{}},"source":{"end_line":16,"start_line":7,"header":"lu5_math.h"}} \ No newline at end of file +{"doc":{"description":"Set a random seed.","bottom_description":"","examples":{},"name":"randomSeed","_type":"method","calls":[{"arguments":[{"name":"seed","description":"The seed value"}]}],"_return":{"var":"number","description":"The random value"}},"source":{"header":"lu5_math.h","start_line":7,"end_line":16}} \ No newline at end of file diff --git a/docs/v0.1.7/math/round/index.html b/docs/v0.1.7/math/round/index.html index 009686e..5111971 100644 --- a/docs/v0.1.7/math/round/index.html +++ b/docs/v0.1.7/math/round/index.html @@ -1 +1 @@ -lu5 | round

round

v0.1.7
round(x);

Round a number to the nearest integer.

Arguments

xThe value to round

Returns

intThe rounded value

See round in lu5_math.h
\ No newline at end of file +lu5 | round

round

v0.1.7
round(x);

Round a number to the nearest integer.

Arguments

xThe value to round

Returns

intThe rounded value

See round in lu5_math.h
\ No newline at end of file diff --git a/docs/v0.1.7/math/round/meta.json b/docs/v0.1.7/math/round/meta.json index 1a8636b..b0cbb22 100644 --- a/docs/v0.1.7/math/round/meta.json +++ b/docs/v0.1.7/math/round/meta.json @@ -1 +1 @@ -{"doc":{"bottom_description":"","_return":{"description":"The rounded value","var":"int"},"name":"round","description":"Round a number to the nearest integer.","calls":[{"arguments":[{"name":"x","description":"The value to round"}]}],"_type":"method","examples":{}},"source":{"end_line":55,"start_line":47,"header":"lu5_math.h"}} \ No newline at end of file +{"doc":{"description":"Round a number to the nearest integer.","bottom_description":"","examples":{},"name":"round","_type":"method","calls":[{"arguments":[{"name":"x","description":"The value to round"}]}],"_return":{"var":"int","description":"The rounded value"}},"source":{"header":"lu5_math.h","start_line":47,"end_line":55}} \ No newline at end of file diff --git a/docs/v0.1.7/math/sin/index.html b/docs/v0.1.7/math/sin/index.html index bb20896..9926224 100644 --- a/docs/v0.1.7/math/sin/index.html +++ b/docs/v0.1.7/math/sin/index.html @@ -1 +1 @@ -lu5 | sin

sin

v0.1.7
sin(x);

Sine function (Trigonometry).

Arguments

xThe input value

Returns

numberThe output value

See sin in lu5_math.h
\ No newline at end of file +lu5 | sin

sin

v0.1.7
sin(x);

Sine function (Trigonometry).

Arguments

xThe input value

Returns

numberThe output value

See sin in lu5_math.h
\ No newline at end of file diff --git a/docs/v0.1.7/math/sin/meta.json b/docs/v0.1.7/math/sin/meta.json index 57e5b13..78aefe7 100644 --- a/docs/v0.1.7/math/sin/meta.json +++ b/docs/v0.1.7/math/sin/meta.json @@ -1 +1 @@ -{"doc":{"bottom_description":"","_return":{"description":"The output value","var":"number"},"name":"sin","description":"Sine function (Trigonometry).","calls":[{"arguments":[{"name":"x","description":"The input value"}]}],"_type":"method","examples":{}},"source":{"end_line":201,"start_line":194,"header":"lu5_math.h"}} \ No newline at end of file +{"doc":{"description":"Sine function (Trigonometry).","bottom_description":"","examples":{},"name":"sin","_type":"method","calls":[{"arguments":[{"name":"x","description":"The input value"}]}],"_return":{"var":"number","description":"The output value"}},"source":{"header":"lu5_math.h","start_line":194,"end_line":201}} \ No newline at end of file diff --git a/docs/v0.1.7/math/tan/index.html b/docs/v0.1.7/math/tan/index.html index 97b86da..0067104 100644 --- a/docs/v0.1.7/math/tan/index.html +++ b/docs/v0.1.7/math/tan/index.html @@ -1 +1 @@ -lu5 | tan

tan

v0.1.7
tan(x);

Tangent function (Trigonometry).

Arguments

xThe input value

Returns

numberThe output value

See tan in lu5_math.h
\ No newline at end of file +lu5 | tan

tan

v0.1.7
tan(x);

Tangent function (Trigonometry).

Arguments

xThe input value

Returns

numberThe output value

See tan in lu5_math.h
\ No newline at end of file diff --git a/docs/v0.1.7/math/tan/meta.json b/docs/v0.1.7/math/tan/meta.json index 954fad3..d6ebcde 100644 --- a/docs/v0.1.7/math/tan/meta.json +++ b/docs/v0.1.7/math/tan/meta.json @@ -1 +1 @@ -{"doc":{"bottom_description":"","_return":{"description":"The output value","var":"number"},"name":"tan","description":"Tangent function (Trigonometry).","calls":[{"arguments":[{"name":"x","description":"The input value"}]}],"_type":"method","examples":{}},"source":{"end_line":219,"start_line":212,"header":"lu5_math.h"}} \ No newline at end of file +{"doc":{"description":"Tangent function (Trigonometry).","bottom_description":"","examples":{},"name":"tan","_type":"method","calls":[{"arguments":[{"name":"x","description":"The input value"}]}],"_return":{"var":"number","description":"The output value"}},"source":{"header":"lu5_math.h","start_line":212,"end_line":219}} \ No newline at end of file diff --git a/docs/v0.1.7/models/index.html b/docs/v0.1.7/models/index.html index 77dcc7b..923d693 100644 --- a/docs/v0.1.7/models/index.html +++ b/docs/v0.1.7/models/index.html @@ -1,4 +1,4 @@ -lu5 | models

models

v0.1.7
loadModel(model);

Load a 3D model.

Arguments

modelThe 3D model

function setup()
+lu5 | models

models

v0.1.7
loadModel(model);

Load a 3D model.

Arguments

modelThe 3D model

function setup()
   createWindow(600, 600, GL3D);
   
   ship = loadModel('path/to/your/ship.obj');
@@ -8,7 +8,7 @@
   background(51);
 
   model(ship);
-end
See loadModel in models.h
model(obj);

Render a 3D model.

Arguments

objThe 3D model

function setup()
+end
See loadModel in models.h
model(obj);

Render a 3D model.

Arguments

objThe 3D model

function setup()
   createWindow(600, 600, GL3D);
   
   ship = loadModel('path/to/your/ship.obj');
@@ -18,4 +18,4 @@
   background(51);
 
   model(ship);
-end
See model in models.h
This project is licensed under the MIT License.
It also includes the FreeType font engine, which is licensed under the FreeType License (FTL).
\ No newline at end of file +end
See model in models.h
\ No newline at end of file diff --git a/docs/v0.1.7/models/loadModel/index.html b/docs/v0.1.7/models/loadModel/index.html index 5c4cd35..efd6ed0 100644 --- a/docs/v0.1.7/models/loadModel/index.html +++ b/docs/v0.1.7/models/loadModel/index.html @@ -1,4 +1,4 @@ -lu5 | loadModel

loadModel

v0.1.7
loadModel(model);

Load a 3D model.

Arguments

modelThe 3D model

function setup()
+lu5 | loadModel

loadModel

v0.1.7
loadModel(model);

Load a 3D model.

Arguments

modelThe 3D model

function setup()
   createWindow(600, 600, GL3D);
   
   ship = loadModel('path/to/your/ship.obj');
@@ -8,4 +8,4 @@
   background(51);
 
   model(ship);
-end
See loadModel in models.h
This project is licensed under the MIT License.
It also includes the FreeType font engine, which is licensed under the FreeType License (FTL).
\ No newline at end of file +end
See loadModel in models.h
\ No newline at end of file diff --git a/docs/v0.1.7/models/loadModel/meta.json b/docs/v0.1.7/models/loadModel/meta.json index 0727719..4eb5082 100644 --- a/docs/v0.1.7/models/loadModel/meta.json +++ b/docs/v0.1.7/models/loadModel/meta.json @@ -1 +1 @@ -{"doc":{"bottom_description":"","name":"loadModel","description":"Load a 3D model.","calls":[{"arguments":[{"name":"model","description":"The 3D model"}]}],"_type":"method","examples":["function setup()\n createWindow(600, 600, GL3D);\n \n ship = loadModel('path/to/your/ship.obj');\nend\n\nfunction draw()\n background(51);\n\n model(ship);\nend"]},"source":{"end_line":25,"start_line":6,"header":"models.h"}} \ No newline at end of file +{"doc":{"description":"Load a 3D model.","bottom_description":"","examples":["function setup()\n createWindow(600, 600, GL3D);\n \n ship = loadModel('path/to/your/ship.obj');\nend\n\nfunction draw()\n background(51);\n\n model(ship);\nend"],"name":"loadModel","calls":[{"arguments":[{"name":"model","description":"The 3D model"}]}],"_type":"method"},"source":{"header":"models.h","start_line":6,"end_line":25}} \ No newline at end of file diff --git a/docs/v0.1.7/models/model/index.html b/docs/v0.1.7/models/model/index.html index 42bf4b3..d810cf9 100644 --- a/docs/v0.1.7/models/model/index.html +++ b/docs/v0.1.7/models/model/index.html @@ -1,4 +1,4 @@ -lu5 | model

model

v0.1.7
model(obj);

Render a 3D model.

Arguments

objThe 3D model

function setup()
+lu5 | model

model

v0.1.7
model(obj);

Render a 3D model.

Arguments

objThe 3D model

function setup()
   createWindow(600, 600, GL3D);
   
   ship = loadModel('path/to/your/ship.obj');
@@ -8,4 +8,4 @@
   background(51);
 
   model(ship);
-end
See model in models.h
This project is licensed under the MIT License.
It also includes the FreeType font engine, which is licensed under the FreeType License (FTL).
\ No newline at end of file +end
See model in models.h
\ No newline at end of file diff --git a/docs/v0.1.7/models/model/meta.json b/docs/v0.1.7/models/model/meta.json index 1f65048..81014d9 100644 --- a/docs/v0.1.7/models/model/meta.json +++ b/docs/v0.1.7/models/model/meta.json @@ -1 +1 @@ -{"doc":{"bottom_description":"","name":"model","description":"Render a 3D model.","calls":[{"arguments":[{"name":"obj","description":"The 3D model"}]}],"_type":"method","examples":["function setup()\n createWindow(600, 600, GL3D);\n \n ship = loadModel('path/to/your/ship.obj');\nend\n\nfunction draw()\n background(51);\n\n model(ship);\nend"]},"source":{"end_line":47,"start_line":27,"header":"models.h"}} \ No newline at end of file +{"doc":{"description":"Render a 3D model.","bottom_description":"","examples":["function setup()\n createWindow(600, 600, GL3D);\n \n ship = loadModel('path/to/your/ship.obj');\nend\n\nfunction draw()\n background(51);\n\n model(ship);\nend"],"name":"model","calls":[{"arguments":[{"name":"obj","description":"The 3D model"}]}],"_type":"method"},"source":{"header":"models.h","start_line":27,"end_line":47}} \ No newline at end of file diff --git a/docs/v0.1.7/mouse/index.html b/docs/v0.1.7/mouse/index.html index a49a1d1..d3cadeb 100644 --- a/docs/v0.1.7/mouse/index.html +++ b/docs/v0.1.7/mouse/index.html @@ -1,16 +1,16 @@ -lu5 | mouse

mouse

v0.1.7
mouseYGlobal

The y mouse coordinate.

createWindow(400, 400);
+lu5 | mouse

mouse

v0.1.7
mouseYGlobal

The y mouse coordinate.

createWindow(400, 400);
 
 function draw()
   background(51);
   
   line(0, mouseY, width, mouseY);
-end
See mouseY in mouse.h
mouseXGlobal

The x mouse coordinate.

createWindow(400, 400);
+end
See mouseY in mouse.h
mouseXGlobal

The x mouse coordinate.

createWindow(400, 400);
 
 function draw()
   background(51);
   
   line(mouseX, 0, mouseX, height);
-end
See mouseX in mouse.h
pmouseYGlobal

The y mouse coordinate from the previous draw call.

See pmouseY in mouse.h
pmouseXGlobal

The x mouse coordinate from the previous draw call.

See pmouseX in mouse.h
mouseIsPressedGlobal

Is true when the mouse is pressed, is false when it's not.

See mouseIsPressed in mouse.h
mousePressed(button);Event

Called when a mouse button is pressed.

Arguments

buttonThe pressed mouse button


+end

See mouseX in mouse.h
pmouseYGlobal

The y mouse coordinate from the previous draw call.

See pmouseY in mouse.h
pmouseXGlobal

The x mouse coordinate from the previous draw call.

See pmouseX in mouse.h
mouseIsPressedGlobal

Is true when the mouse is pressed, is false when it's not.

See mouseIsPressed in mouse.h
mousePressed(button);Event

Called when a mouse button is pressed.

Arguments

buttonThe pressed mouse button


In the following example, the circle's size increases when the user clicks the mouse.

size = 0;
 
 function setup()
@@ -26,7 +26,7 @@
 -- Increase circle size when mouse pressed
 function mousePressed()
   size = size + 1;
-end
See mousePressed in mouse.h
mouseReleased(button);Event

Called when a mouse button is released.

Arguments

buttonThe released mouse button


+endSee mousePressed in mouse.h

mouseReleased(button);Event

Called when a mouse button is released.

Arguments

buttonThe released mouse button


In the following example, the circle's size increases when the user clicks the mouse.

size = 32;
 
 function setup()
@@ -47,7 +47,7 @@
 -- Reset size
 function mouseReleased()
   size = 64;
-end
See mouseReleased in mouse.h
mouseWheel(button);Event

Called when a mouse wheel is used.

Arguments

buttonThe pressed mouse button


+endSee mouseReleased in mouse.h

mouseWheel(button);Event

Called when a mouse wheel is used.

Arguments

buttonThe pressed mouse button


In the following example, the circle's size changes when the user scrolls.

size = 0;
 
 function setup()
@@ -63,4 +63,4 @@
 -- Change circle size when mouse is scrolled
 function mouseWheel(delta)
   size = size + delta;
-end
See mouseWheel in mouse.h
\ No newline at end of file +endSee mouseWheel in mouse.h \ No newline at end of file diff --git a/docs/v0.1.7/mouse/mouseIsPressed/index.html b/docs/v0.1.7/mouse/mouseIsPressed/index.html index b408460..8e73807 100644 --- a/docs/v0.1.7/mouse/mouseIsPressed/index.html +++ b/docs/v0.1.7/mouse/mouseIsPressed/index.html @@ -1 +1 @@ -lu5 | mouseIsPressed

mouseIsPressed

v0.1.7
mouseIsPressedGlobal

Is true when the mouse is pressed, is false when it's not.

See mouseIsPressed in mouse.h
\ No newline at end of file +lu5 | mouseIsPressed

mouseIsPressed

v0.1.7
mouseIsPressedGlobal

Is true when the mouse is pressed, is false when it's not.

See mouseIsPressed in mouse.h
\ No newline at end of file diff --git a/docs/v0.1.7/mouse/mouseIsPressed/meta.json b/docs/v0.1.7/mouse/mouseIsPressed/meta.json index f8d4e60..d4904e8 100644 --- a/docs/v0.1.7/mouse/mouseIsPressed/meta.json +++ b/docs/v0.1.7/mouse/mouseIsPressed/meta.json @@ -1 +1 @@ -{"doc":{"bottom_description":"","name":"mouseIsPressed","description":"Is true when the mouse is pressed, is false when it's not.","calls":[{"arguments":{}}],"_type":"global","examples":{}},"source":{"end_line":62,"start_line":57,"header":"mouse.h"}} \ No newline at end of file +{"doc":{"description":"Is true when the mouse is pressed, is false when it's not.","bottom_description":"","examples":{},"name":"mouseIsPressed","calls":[{"arguments":{}}],"_type":"global"},"source":{"header":"mouse.h","start_line":57,"end_line":62}} \ No newline at end of file diff --git a/docs/v0.1.7/mouse/mousePressed/index.html b/docs/v0.1.7/mouse/mousePressed/index.html index 92d3e3b..7921444 100644 --- a/docs/v0.1.7/mouse/mousePressed/index.html +++ b/docs/v0.1.7/mouse/mousePressed/index.html @@ -1,4 +1,4 @@ -lu5 | mousePressed

mousePressed

v0.1.7
mousePressed(button);Event

Called when a mouse button is pressed.

Arguments

buttonThe pressed mouse button


+lu5 | mousePressed

mousePressed

v0.1.7
mousePressed(button);Event

Called when a mouse button is pressed.

Arguments

buttonThe pressed mouse button


In the following example, the circle's size increases when the user clicks the mouse.

size = 0;
 
 function setup()
@@ -14,4 +14,4 @@
 -- Increase circle size when mouse pressed
 function mousePressed()
   size = size + 1;
-end
See mousePressed in mouse.h
This project is licensed under the MIT License.
It also includes the FreeType font engine, which is licensed under the FreeType License (FTL).
\ No newline at end of file +endSee mousePressed in mouse.h
\ No newline at end of file diff --git a/docs/v0.1.7/mouse/mousePressed/meta.json b/docs/v0.1.7/mouse/mousePressed/meta.json index 72acba7..95c455d 100644 --- a/docs/v0.1.7/mouse/mousePressed/meta.json +++ b/docs/v0.1.7/mouse/mousePressed/meta.json @@ -1 +1 @@ -{"doc":{"bottom_description":"
\nIn the following example, the circle's size increases when the user clicks the mouse.","name":"mousePressed","description":"Called when a mouse button is pressed.","calls":[{"arguments":[{"name":"button","description":"The pressed mouse button"}]}],"_type":"event","examples":["size = 0;\n\nfunction setup()\n createWindow(400, 400);\nend\n\nfunction draw()\n background(51);\n\n circle(mouseX, mouseY, size);\nend\n\n-- Increase circle size when mouse pressed\nfunction mousePressed()\n size = size + 1;\nend"]},"source":{"end_line":93,"start_line":65,"header":"mouse.h"}} \ No newline at end of file +{"doc":{"description":"Called when a mouse button is pressed.","bottom_description":"
\nIn the following example, the circle's size increases when the user clicks the mouse.","examples":["size = 0;\n\nfunction setup()\n createWindow(400, 400);\nend\n\nfunction draw()\n background(51);\n\n circle(mouseX, mouseY, size);\nend\n\n-- Increase circle size when mouse pressed\nfunction mousePressed()\n size = size + 1;\nend"],"name":"mousePressed","calls":[{"arguments":[{"name":"button","description":"The pressed mouse button"}]}],"_type":"event"},"source":{"header":"mouse.h","start_line":65,"end_line":93}} \ No newline at end of file diff --git a/docs/v0.1.7/mouse/mouseReleased/index.html b/docs/v0.1.7/mouse/mouseReleased/index.html index 30ca566..ccc7f54 100644 --- a/docs/v0.1.7/mouse/mouseReleased/index.html +++ b/docs/v0.1.7/mouse/mouseReleased/index.html @@ -1,4 +1,4 @@ -lu5 | mouseReleased

mouseReleased

v0.1.7
mouseReleased(button);Event

Called when a mouse button is released.

Arguments

buttonThe released mouse button


+lu5 | mouseReleased

mouseReleased

v0.1.7
mouseReleased(button);Event

Called when a mouse button is released.

Arguments

buttonThe released mouse button


In the following example, the circle's size increases when the user clicks the mouse.

size = 32;
 
 function setup()
@@ -19,4 +19,4 @@
 -- Reset size
 function mouseReleased()
   size = 64;
-end
See mouseReleased in mouse.h
This project is licensed under the MIT License.
It also includes the FreeType font engine, which is licensed under the FreeType License (FTL).
\ No newline at end of file +endSee mouseReleased in mouse.h
\ No newline at end of file diff --git a/docs/v0.1.7/mouse/mouseReleased/meta.json b/docs/v0.1.7/mouse/mouseReleased/meta.json index 9b5a8cb..6d3a91e 100644 --- a/docs/v0.1.7/mouse/mouseReleased/meta.json +++ b/docs/v0.1.7/mouse/mouseReleased/meta.json @@ -1 +1 @@ -{"doc":{"bottom_description":"
\nIn the following example, the circle's size increases when the user clicks the mouse.","name":"mouseReleased","description":"Called when a mouse button is released.","calls":[{"arguments":[{"name":"button","description":"The released mouse button"}]}],"_type":"event","examples":["size = 32;\n\nfunction setup()\n createWindow(400, 400);\nend\n\nfunction draw()\n background(51);\n\n circle(mouseX, mouseY, size);\nend\n\n-- Increment circle size\nfunction mousePressed()\n size = size + 6;\nend\n\n-- Reset size\nfunction mouseReleased()\n size = 64;\nend"]},"source":{"end_line":129,"start_line":96,"header":"mouse.h"}} \ No newline at end of file +{"doc":{"description":"Called when a mouse button is released.","bottom_description":"
\nIn the following example, the circle's size increases when the user clicks the mouse.","examples":["size = 32;\n\nfunction setup()\n createWindow(400, 400);\nend\n\nfunction draw()\n background(51);\n\n circle(mouseX, mouseY, size);\nend\n\n-- Increment circle size\nfunction mousePressed()\n size = size + 6;\nend\n\n-- Reset size\nfunction mouseReleased()\n size = 64;\nend"],"name":"mouseReleased","calls":[{"arguments":[{"name":"button","description":"The released mouse button"}]}],"_type":"event"},"source":{"header":"mouse.h","start_line":96,"end_line":129}} \ No newline at end of file diff --git a/docs/v0.1.7/mouse/mouseWheel/index.html b/docs/v0.1.7/mouse/mouseWheel/index.html index c3ff332..83f3318 100644 --- a/docs/v0.1.7/mouse/mouseWheel/index.html +++ b/docs/v0.1.7/mouse/mouseWheel/index.html @@ -1,4 +1,4 @@ -lu5 | mouseWheel

mouseWheel

v0.1.7
mouseWheel(button);Event

Called when a mouse wheel is used.

Arguments

buttonThe pressed mouse button


+lu5 | mouseWheel

mouseWheel

v0.1.7
mouseWheel(button);Event

Called when a mouse wheel is used.

Arguments

buttonThe pressed mouse button


In the following example, the circle's size changes when the user scrolls.

size = 0;
 
 function setup()
@@ -14,4 +14,4 @@
 -- Change circle size when mouse is scrolled
 function mouseWheel(delta)
   size = size + delta;
-end
See mouseWheel in mouse.h
This project is licensed under the MIT License.
It also includes the FreeType font engine, which is licensed under the FreeType License (FTL).
\ No newline at end of file +endSee mouseWheel in mouse.h
\ No newline at end of file diff --git a/docs/v0.1.7/mouse/mouseWheel/meta.json b/docs/v0.1.7/mouse/mouseWheel/meta.json index 40258f9..0a87d32 100644 --- a/docs/v0.1.7/mouse/mouseWheel/meta.json +++ b/docs/v0.1.7/mouse/mouseWheel/meta.json @@ -1 +1 @@ -{"doc":{"bottom_description":"
\nIn the following example, the circle's size changes when the user scrolls.","name":"mouseWheel","description":"Called when a mouse wheel is used.","calls":[{"arguments":[{"name":"button","description":"The pressed mouse button"}]}],"_type":"event","examples":["size = 0;\n\nfunction setup()\n createWindow(400, 400);\nend\n\nfunction draw()\n background(51);\n\n circle(mouseX, mouseY, size);\nend\n\n-- Change circle size when mouse is scrolled\nfunction mouseWheel(delta)\n size = size + delta;\nend"]},"source":{"end_line":160,"start_line":132,"header":"mouse.h"}} \ No newline at end of file +{"doc":{"description":"Called when a mouse wheel is used.","bottom_description":"
\nIn the following example, the circle's size changes when the user scrolls.","examples":["size = 0;\n\nfunction setup()\n createWindow(400, 400);\nend\n\nfunction draw()\n background(51);\n\n circle(mouseX, mouseY, size);\nend\n\n-- Change circle size when mouse is scrolled\nfunction mouseWheel(delta)\n size = size + delta;\nend"],"name":"mouseWheel","calls":[{"arguments":[{"name":"button","description":"The pressed mouse button"}]}],"_type":"event"},"source":{"header":"mouse.h","start_line":132,"end_line":160}} \ No newline at end of file diff --git a/docs/v0.1.7/mouse/mouseX/index.html b/docs/v0.1.7/mouse/mouseX/index.html index 59be8d5..53449c3 100644 --- a/docs/v0.1.7/mouse/mouseX/index.html +++ b/docs/v0.1.7/mouse/mouseX/index.html @@ -1,7 +1,7 @@ -lu5 | mouseX

mouseX

v0.1.7
mouseXGlobal

The x mouse coordinate.

createWindow(400, 400);
+lu5 | mouseX

mouseX

v0.1.7
mouseXGlobal

The x mouse coordinate.

createWindow(400, 400);
 
 function draw()
   background(51);
   
   line(mouseX, 0, mouseX, height);
-end
See mouseX in mouse.h
This project is licensed under the MIT License.
It also includes the FreeType font engine, which is licensed under the FreeType License (FTL).
\ No newline at end of file +end
See mouseX in mouse.h
\ No newline at end of file diff --git a/docs/v0.1.7/mouse/mouseX/meta.json b/docs/v0.1.7/mouse/mouseX/meta.json index 92b3da8..d86d387 100644 --- a/docs/v0.1.7/mouse/mouseX/meta.json +++ b/docs/v0.1.7/mouse/mouseX/meta.json @@ -1 +1 @@ -{"doc":{"bottom_description":"","name":"mouseX","description":"The x mouse coordinate.","calls":[{"arguments":{}}],"_type":"global","examples":["createWindow(400, 400);\n\nfunction draw()\n background(51);\n \n line(mouseX, 0, mouseX, height);\nend"]},"source":{"end_line":37,"start_line":22,"header":"mouse.h"}} \ No newline at end of file +{"doc":{"description":"The x mouse coordinate.","bottom_description":"","examples":["createWindow(400, 400);\n\nfunction draw()\n background(51);\n \n line(mouseX, 0, mouseX, height);\nend"],"name":"mouseX","calls":[{"arguments":{}}],"_type":"global"},"source":{"header":"mouse.h","start_line":22,"end_line":37}} \ No newline at end of file diff --git a/docs/v0.1.7/mouse/mouseY/index.html b/docs/v0.1.7/mouse/mouseY/index.html index 072313d..9f1d337 100644 --- a/docs/v0.1.7/mouse/mouseY/index.html +++ b/docs/v0.1.7/mouse/mouseY/index.html @@ -1,7 +1,7 @@ -lu5 | mouseY

mouseY

v0.1.7
mouseYGlobal

The y mouse coordinate.

createWindow(400, 400);
+lu5 | mouseY

mouseY

v0.1.7
mouseYGlobal

The y mouse coordinate.

createWindow(400, 400);
 
 function draw()
   background(51);
   
   line(0, mouseY, width, mouseY);
-end
See mouseY in mouse.h
This project is licensed under the MIT License.
It also includes the FreeType font engine, which is licensed under the FreeType License (FTL).
\ No newline at end of file +end
See mouseY in mouse.h
\ No newline at end of file diff --git a/docs/v0.1.7/mouse/mouseY/meta.json b/docs/v0.1.7/mouse/mouseY/meta.json index b765602..2e0cc14 100644 --- a/docs/v0.1.7/mouse/mouseY/meta.json +++ b/docs/v0.1.7/mouse/mouseY/meta.json @@ -1 +1 @@ -{"doc":{"bottom_description":"","name":"mouseY","description":"The y mouse coordinate.","calls":[{"arguments":{}}],"_type":"global","examples":["createWindow(400, 400);\n\nfunction draw()\n background(51);\n \n line(0, mouseY, width, mouseY);\nend"]},"source":{"end_line":19,"start_line":4,"header":"mouse.h"}} \ No newline at end of file +{"doc":{"description":"The y mouse coordinate.","bottom_description":"","examples":["createWindow(400, 400);\n\nfunction draw()\n background(51);\n \n line(0, mouseY, width, mouseY);\nend"],"name":"mouseY","calls":[{"arguments":{}}],"_type":"global"},"source":{"header":"mouse.h","start_line":4,"end_line":19}} \ No newline at end of file diff --git a/docs/v0.1.7/mouse/pmouseX/index.html b/docs/v0.1.7/mouse/pmouseX/index.html index 5060d6b..10a09cc 100644 --- a/docs/v0.1.7/mouse/pmouseX/index.html +++ b/docs/v0.1.7/mouse/pmouseX/index.html @@ -1 +1 @@ -lu5 | pmouseX

pmouseX

v0.1.7
pmouseXGlobal

The x mouse coordinate from the previous draw call.

See pmouseX in mouse.h
\ No newline at end of file +lu5 | pmouseX

pmouseX

v0.1.7
pmouseXGlobal

The x mouse coordinate from the previous draw call.

See pmouseX in mouse.h
\ No newline at end of file diff --git a/docs/v0.1.7/mouse/pmouseX/meta.json b/docs/v0.1.7/mouse/pmouseX/meta.json index ec2ea5c..79bb312 100644 --- a/docs/v0.1.7/mouse/pmouseX/meta.json +++ b/docs/v0.1.7/mouse/pmouseX/meta.json @@ -1 +1 @@ -{"doc":{"bottom_description":"","name":"pmouseX","description":"The x mouse coordinate from the previous draw call.","calls":[{"arguments":{}}],"_type":"global","examples":{}},"source":{"end_line":53,"start_line":48,"header":"mouse.h"}} \ No newline at end of file +{"doc":{"description":"The x mouse coordinate from the previous draw call.","bottom_description":"","examples":{},"name":"pmouseX","calls":[{"arguments":{}}],"_type":"global"},"source":{"header":"mouse.h","start_line":48,"end_line":53}} \ No newline at end of file diff --git a/docs/v0.1.7/mouse/pmouseY/index.html b/docs/v0.1.7/mouse/pmouseY/index.html index 310327c..8bd296f 100644 --- a/docs/v0.1.7/mouse/pmouseY/index.html +++ b/docs/v0.1.7/mouse/pmouseY/index.html @@ -1 +1 @@ -lu5 | pmouseY

pmouseY

v0.1.7
pmouseYGlobal

The y mouse coordinate from the previous draw call.

See pmouseY in mouse.h
\ No newline at end of file +lu5 | pmouseY

pmouseY

v0.1.7
pmouseYGlobal

The y mouse coordinate from the previous draw call.

See pmouseY in mouse.h
\ No newline at end of file diff --git a/docs/v0.1.7/mouse/pmouseY/meta.json b/docs/v0.1.7/mouse/pmouseY/meta.json index 5d23092..081e395 100644 --- a/docs/v0.1.7/mouse/pmouseY/meta.json +++ b/docs/v0.1.7/mouse/pmouseY/meta.json @@ -1 +1 @@ -{"doc":{"bottom_description":"","name":"pmouseY","description":"The y mouse coordinate from the previous draw call.","calls":[{"arguments":{}}],"_type":"global","examples":{}},"source":{"end_line":45,"start_line":40,"header":"mouse.h"}} \ No newline at end of file +{"doc":{"description":"The y mouse coordinate from the previous draw call.","bottom_description":"","examples":{},"name":"pmouseY","calls":[{"arguments":{}}],"_type":"global"},"source":{"header":"mouse.h","start_line":40,"end_line":45}} \ No newline at end of file diff --git a/docs/v0.1.7/setting/background/index.html b/docs/v0.1.7/setting/background/index.html index 98d7b27..0fb62de 100644 --- a/docs/v0.1.7/setting/background/index.html +++ b/docs/v0.1.7/setting/background/index.html @@ -1 +1 @@ -lu5 | background

background

v0.1.7
background

Clear a background with a color.

Arguments

rThe red byte
gThe green byte
bThe blue byte
 background(100, 255, 100);

Arguments

rThe red byte
gThe green byte
bThe blue byte
aThe alpha byte
 background(100, 255, 100, 150);

Arguments

vThe grayscale value
 background(100);

Arguments

color_nameThe color name
 background('yellow');

Arguments

hexThe hex color string
 background('#88EE66');

See background in setting.h
\ No newline at end of file +lu5 | background

background

v0.1.7
background

Clear a background with a color.

Arguments

rThe red byte
gThe green byte
bThe blue byte
 background(100, 255, 100);

Arguments

rThe red byte
gThe green byte
bThe blue byte
aThe alpha byte
 background(100, 255, 100, 150);

Arguments

vThe grayscale value
 background(100);

Arguments

color_nameThe color name
 background('yellow');

Arguments

hexThe hex color string
 background('#88EE66');

See background in setting.h
\ No newline at end of file diff --git a/docs/v0.1.7/setting/background/meta.json b/docs/v0.1.7/setting/background/meta.json index 8f55244..9b63149 100644 --- a/docs/v0.1.7/setting/background/meta.json +++ b/docs/v0.1.7/setting/background/meta.json @@ -1 +1 @@ -{"doc":{"bottom_description":"","name":"background","description":"Clear a background with a color. ","calls":[{"example":" background(100, 255, 100);","arguments":[{"name":"r","description":"The red byte"},{"name":"g","description":"The green byte"},{"name":"b","description":"The blue byte"}]},{"example":" background(100, 255, 100, 150);","arguments":[{"name":"r","description":"The red byte"},{"name":"g","description":"The green byte"},{"name":"b","description":"The blue byte"},{"name":"a","description":"The alpha byte"}]},{"example":" background(100);","arguments":[{"name":"v","description":"The grayscale value"}]},{"example":" background('yellow');","arguments":[{"name":"color_name","description":"The color name"}]},{"example":" background('#88EE66');","arguments":[{"name":"hex","description":"The hex color string"}]}],"_type":"method","examples":{}},"source":{"end_line":48,"start_line":6,"header":"setting.h"}} \ No newline at end of file +{"doc":{"description":"Clear a background with a color. ","bottom_description":"","examples":{},"name":"background","calls":[{"example":" background(100, 255, 100);","arguments":[{"name":"r","description":"The red byte"},{"name":"g","description":"The green byte"},{"name":"b","description":"The blue byte"}]},{"example":" background(100, 255, 100, 150);","arguments":[{"name":"r","description":"The red byte"},{"name":"g","description":"The green byte"},{"name":"b","description":"The blue byte"},{"name":"a","description":"The alpha byte"}]},{"example":" background(100);","arguments":[{"name":"v","description":"The grayscale value"}]},{"example":" background('yellow');","arguments":[{"name":"color_name","description":"The color name"}]},{"example":" background('#88EE66');","arguments":[{"name":"hex","description":"The hex color string"}]}],"_type":"method"},"source":{"header":"setting.h","start_line":6,"end_line":48}} \ No newline at end of file diff --git a/docs/v0.1.7/setting/debugMode/index.html b/docs/v0.1.7/setting/debugMode/index.html index d4d1627..b6a87af 100644 --- a/docs/v0.1.7/setting/debugMode/index.html +++ b/docs/v0.1.7/setting/debugMode/index.html @@ -1,4 +1,4 @@ -lu5 | debugMode

debugMode

v0.1.7
debugMode([enable]);

Toggle a helpful mode with 3D Graphics.

Arguments

[enable]Whether or not to enable the debug mode, if not provided, it defaults to true

function setup()
+lu5 | debugMode

debugMode

v0.1.7
debugMode([enable]);

Toggle a helpful mode with 3D Graphics.

Arguments

[enable]Whether or not to enable the debug mode, if not provided, it defaults to true

function setup()
   createWindow(800, 800, GL3D);
 
   debugMode();
@@ -23,4 +23,4 @@
   end
 
   box(100);
-end
See debugMode in setting.h
This project is licensed under the MIT License.
It also includes the FreeType font engine, which is licensed under the FreeType License (FTL).
\ No newline at end of file +end
See debugMode in setting.h
\ No newline at end of file diff --git a/docs/v0.1.7/setting/debugMode/meta.json b/docs/v0.1.7/setting/debugMode/meta.json index 6a61843..6e814ca 100644 --- a/docs/v0.1.7/setting/debugMode/meta.json +++ b/docs/v0.1.7/setting/debugMode/meta.json @@ -1 +1 @@ -{"doc":{"bottom_description":"","name":"debugMode","description":"Toggle a helpful mode with 3D Graphics.","calls":[{"arguments":[{"name":"[enable]","description":"Whether or not to enable the debug mode, if not provided, it defaults to `true`"}]}],"_type":"method","examples":["function setup()\n createWindow(800, 800, GL3D);\n\n debugMode();\nend\n\nfunction draw()\n background(51);\n \n box(100);\nend","function setup()\n createWindow(800, 800, GL3D);\nend\n\nfunction draw()\n background(51);\n \n -- When the d key is down, show debug graphics\n if (keyIsDown('d')) then\n debugMode(true);\n else\n debugMode(false);\n end\n\n box(100);\nend"]},"source":{"end_line":275,"start_line":237,"header":"setting.h"}} \ No newline at end of file +{"doc":{"description":"Toggle a helpful mode with 3D Graphics.","bottom_description":"","examples":["function setup()\n createWindow(800, 800, GL3D);\n\n debugMode();\nend\n\nfunction draw()\n background(51);\n \n box(100);\nend","function setup()\n createWindow(800, 800, GL3D);\nend\n\nfunction draw()\n background(51);\n \n -- When the d key is down, show debug graphics\n if (keyIsDown('d')) then\n debugMode(true);\n else\n debugMode(false);\n end\n\n box(100);\nend"],"name":"debugMode","calls":[{"arguments":[{"name":"[enable]","description":"Whether or not to enable the debug mode, if not provided, it defaults to `true`"}]}],"_type":"method"},"source":{"header":"setting.h","start_line":237,"end_line":275}} \ No newline at end of file diff --git a/docs/v0.1.7/setting/fill/index.html b/docs/v0.1.7/setting/fill/index.html index 57fd452..d06f694 100644 --- a/docs/v0.1.7/setting/fill/index.html +++ b/docs/v0.1.7/setting/fill/index.html @@ -1 +1 @@ -lu5 | fill

fill

v0.1.7
fill

Set the fill color for shapes.

Arguments

rThe red byte
gThe green byte
bThe blue byte
 fill(100, 255, 100);

Arguments

rThe red byte
gThe green byte
bThe blue byte
aThe alpha byte
 fill(100, 255, 100, 150);

Arguments

vThe grayscale value
 fill(100);

Arguments

color_nameThe color name
 fill('yellow');

Arguments

hexThe hex color string
 fill('#88EE66');

See fill in setting.h
\ No newline at end of file +lu5 | fill

fill

v0.1.7
fill

Set the fill color for shapes.

Arguments

rThe red byte
gThe green byte
bThe blue byte
 fill(100, 255, 100);

Arguments

rThe red byte
gThe green byte
bThe blue byte
aThe alpha byte
 fill(100, 255, 100, 150);

Arguments

vThe grayscale value
 fill(100);

Arguments

color_nameThe color name
 fill('yellow');

Arguments

hexThe hex color string
 fill('#88EE66');

See fill in setting.h
\ No newline at end of file diff --git a/docs/v0.1.7/setting/fill/meta.json b/docs/v0.1.7/setting/fill/meta.json index 9a97d06..9697a75 100644 --- a/docs/v0.1.7/setting/fill/meta.json +++ b/docs/v0.1.7/setting/fill/meta.json @@ -1 +1 @@ -{"doc":{"bottom_description":"","name":"fill","description":"Set the fill color for shapes. ","calls":[{"example":" fill(100, 255, 100);","arguments":[{"name":"r","description":"The red byte"},{"name":"g","description":"The green byte"},{"name":"b","description":"The blue byte"}]},{"example":" fill(100, 255, 100, 150);","arguments":[{"name":"r","description":"The red byte"},{"name":"g","description":"The green byte"},{"name":"b","description":"The blue byte"},{"name":"a","description":"The alpha byte"}]},{"example":" fill(100);","arguments":[{"name":"v","description":"The grayscale value"}]},{"example":" fill('yellow');","arguments":[{"name":"color_name","description":"The color name"}]},{"example":" fill('#88EE66');","arguments":[{"name":"hex","description":"The hex color string"}]}],"_type":"method","examples":{}},"source":{"end_line":92,"start_line":50,"header":"setting.h"}} \ No newline at end of file +{"doc":{"description":"Set the fill color for shapes. ","bottom_description":"","examples":{},"name":"fill","calls":[{"example":" fill(100, 255, 100);","arguments":[{"name":"r","description":"The red byte"},{"name":"g","description":"The green byte"},{"name":"b","description":"The blue byte"}]},{"example":" fill(100, 255, 100, 150);","arguments":[{"name":"r","description":"The red byte"},{"name":"g","description":"The green byte"},{"name":"b","description":"The blue byte"},{"name":"a","description":"The alpha byte"}]},{"example":" fill(100);","arguments":[{"name":"v","description":"The grayscale value"}]},{"example":" fill('yellow');","arguments":[{"name":"color_name","description":"The color name"}]},{"example":" fill('#88EE66');","arguments":[{"name":"hex","description":"The hex color string"}]}],"_type":"method"},"source":{"header":"setting.h","start_line":50,"end_line":92}} \ No newline at end of file diff --git a/docs/v0.1.7/setting/index.html b/docs/v0.1.7/setting/index.html index 06ed7e5..4f849d8 100644 --- a/docs/v0.1.7/setting/index.html +++ b/docs/v0.1.7/setting/index.html @@ -1,6 +1,6 @@ -lu5 | setting

setting

v0.1.7
background

Clear a background with a color.

Arguments

rThe red byte
gThe green byte
bThe blue byte
 background(100, 255, 100);

Arguments

rThe red byte
gThe green byte
bThe blue byte
aThe alpha byte
 background(100, 255, 100, 150);

Arguments

vThe grayscale value
 background(100);

Arguments

color_nameThe color name
 background('yellow');

Arguments

hexThe hex color string
 background('#88EE66');

See background in setting.h
fill

Set the fill color for shapes.

Arguments

rThe red byte
gThe green byte
bThe blue byte
 fill(100, 255, 100);

Arguments

rThe red byte
gThe green byte
bThe blue byte
aThe alpha byte
 fill(100, 255, 100, 150);

Arguments

vThe grayscale value
 fill(100);

Arguments

color_nameThe color name
 fill('yellow');

Arguments

hexThe hex color string
 fill('#88EE66');

See fill in setting.h
strokeWeight(weight);

Set the line width.

Arguments

weightThe line width in pixels

strokeWeight(8);
-line(200, 200, mouseX, mouseY);
See strokeWeight in setting.h
noFill();

Disable fill.

noFill();
-circle(200, 200, 32);
See noFill in setting.h
stroke

Set the stroke color for shapes

Arguments

rThe red byte
gThe green byte
bThe blue byte
 stroke(255, 255, 100);

Arguments

rThe red byte
gThe green byte
bThe blue byte
aThe alpha byte
 stroke(255, 255, 100, 150);

Arguments

vThe grayscale value
 stroke(255);

Arguments

color_nameThe color name
 stroke('red');

See stroke in setting.h
noStroke();

Disable stroke.

See noStroke in setting.h
push();

Save the style and transformation settings.

Pushes the lu5 style settings off the stack.
Pushes the OpenGL transformation matrix off the stack.

function setup()
+lu5 | setting

setting

v0.1.7
background

Clear a background with a color.

Arguments

rThe red byte
gThe green byte
bThe blue byte
 background(100, 255, 100);

Arguments

rThe red byte
gThe green byte
bThe blue byte
aThe alpha byte
 background(100, 255, 100, 150);

Arguments

vThe grayscale value
 background(100);

Arguments

color_nameThe color name
 background('yellow');

Arguments

hexThe hex color string
 background('#88EE66');

See background in setting.h
fill

Set the fill color for shapes.

Arguments

rThe red byte
gThe green byte
bThe blue byte
 fill(100, 255, 100);

Arguments

rThe red byte
gThe green byte
bThe blue byte
aThe alpha byte
 fill(100, 255, 100, 150);

Arguments

vThe grayscale value
 fill(100);

Arguments

color_nameThe color name
 fill('yellow');

Arguments

hexThe hex color string
 fill('#88EE66');

See fill in setting.h
strokeWeight(weight);

Set the line width.

Arguments

weightThe line width in pixels

strokeWeight(8);
+line(200, 200, mouseX, mouseY);
See strokeWeight in setting.h
noFill();

Disable fill.

noFill();
+circle(200, 200, 32);
See noFill in setting.h
stroke

Set the stroke color for shapes

Arguments

rThe red byte
gThe green byte
bThe blue byte
 stroke(255, 255, 100);

Arguments

rThe red byte
gThe green byte
bThe blue byte
aThe alpha byte
 stroke(255, 255, 100, 150);

Arguments

vThe grayscale value
 stroke(255);

Arguments

color_nameThe color name
 stroke('red');

See stroke in setting.h
noStroke();

Disable stroke.

See noStroke in setting.h
push();

Save the style and transformation settings.

Pushes the lu5 style settings off the stack.
Pushes the OpenGL transformation matrix off the stack.

function setup()
     createWindow(400, 400);
 end
 
@@ -34,7 +34,7 @@
 
     -- Not Affected by transformation
     circle(0, 0, 32);
-end
See push in setting.h
pop();

Restore the style and transformation settings.

Pops the lu5 style settings off the stack.
Pops the OpenGL transformation matrix off the stack.

See pop in setting.h
rectMode(mode);

Set rectangle alignment mode.

Arguments

modeeither CENTER, CORNER, RADIUS

function setup()
+end
See push in setting.h
pop();

Restore the style and transformation settings.

Pops the lu5 style settings off the stack.
Pops the OpenGL transformation matrix off the stack.

See pop in setting.h
rectMode(mode);

Set rectangle alignment mode.

Arguments

modeeither CENTER, CORNER, RADIUS

function setup()
   createWindow(800, 800, GL3D);
 
   rectMode(CENTER);
@@ -44,7 +44,7 @@
   background(51);
   
   rect(width/2, height/2, 100, 50);
-end
See rectMode in setting.h
debugMode([enable]);

Toggle a helpful mode with 3D Graphics.

Arguments

[enable]Whether or not to enable the debug mode, if not provided, it defaults to true

function setup()
+end
See rectMode in setting.h
debugMode([enable]);

Toggle a helpful mode with 3D Graphics.

Arguments

[enable]Whether or not to enable the debug mode, if not provided, it defaults to true

function setup()
   createWindow(800, 800, GL3D);
 
   debugMode();
@@ -69,4 +69,4 @@
   end
 
   box(100);
-end
See debugMode in setting.h
CENTERConstant

Alignment mode for rectMode.

See CENTER in setting.h
CORNERConstant

Alignment mode for rectMode.

See CORNER in setting.h
RADIUSConstant

Alignment mode for rectMode.

See RADIUS in setting.h
This project is licensed under the MIT License.
It also includes the FreeType font engine, which is licensed under the FreeType License (FTL).
\ No newline at end of file +end
See debugMode in setting.h
CENTERConstant

Alignment mode for rectMode.

See CENTER in setting.h
CORNERConstant

Alignment mode for rectMode.

See CORNER in setting.h
RADIUSConstant

Alignment mode for rectMode.

See RADIUS in setting.h
\ No newline at end of file diff --git a/docs/v0.1.7/setting/noFill/index.html b/docs/v0.1.7/setting/noFill/index.html index eb47fa2..a5c4a59 100644 --- a/docs/v0.1.7/setting/noFill/index.html +++ b/docs/v0.1.7/setting/noFill/index.html @@ -1,2 +1,2 @@ -lu5 | noFill

noFill

v0.1.7
noFill();

Disable fill.

noFill();
-circle(200, 200, 32);
See noFill in setting.h
\ No newline at end of file +lu5 | noFill

noFill

v0.1.7
noFill();

Disable fill.

noFill();
+circle(200, 200, 32);
See noFill in setting.h
\ No newline at end of file diff --git a/docs/v0.1.7/setting/noFill/meta.json b/docs/v0.1.7/setting/noFill/meta.json index ffaa494..0ffda62 100644 --- a/docs/v0.1.7/setting/noFill/meta.json +++ b/docs/v0.1.7/setting/noFill/meta.json @@ -1 +1 @@ -{"doc":{"bottom_description":"","name":"noFill","description":"Disable fill. ","calls":[{"arguments":{}}],"_type":"method","examples":["noFill();\ncircle(200, 200, 32);"]},"source":{"end_line":114,"start_line":106,"header":"setting.h"}} \ No newline at end of file +{"doc":{"description":"Disable fill. ","bottom_description":"","examples":["noFill();\ncircle(200, 200, 32);"],"name":"noFill","calls":[{"arguments":{}}],"_type":"method"},"source":{"header":"setting.h","start_line":106,"end_line":114}} \ No newline at end of file diff --git a/docs/v0.1.7/setting/noStroke/index.html b/docs/v0.1.7/setting/noStroke/index.html index 531dd26..6e43261 100644 --- a/docs/v0.1.7/setting/noStroke/index.html +++ b/docs/v0.1.7/setting/noStroke/index.html @@ -1 +1 @@ -lu5 | noStroke

noStroke

v0.1.7
noStroke();

Disable stroke.

See noStroke in setting.h
\ No newline at end of file +lu5 | noStroke

noStroke

v0.1.7
noStroke();

Disable stroke.

See noStroke in setting.h
\ No newline at end of file diff --git a/docs/v0.1.7/setting/noStroke/meta.json b/docs/v0.1.7/setting/noStroke/meta.json index e738c72..c6ccef0 100644 --- a/docs/v0.1.7/setting/noStroke/meta.json +++ b/docs/v0.1.7/setting/noStroke/meta.json @@ -1 +1 @@ -{"doc":{"bottom_description":"","name":"noStroke","description":"Disable stroke. ","calls":[{"arguments":{}}],"_type":"method","examples":{}},"source":{"end_line":156,"start_line":153,"header":"setting.h"}} \ No newline at end of file +{"doc":{"description":"Disable stroke. ","bottom_description":"","examples":{},"name":"noStroke","calls":[{"arguments":{}}],"_type":"method"},"source":{"header":"setting.h","start_line":153,"end_line":156}} \ No newline at end of file diff --git a/docs/v0.1.7/setting/pop/index.html b/docs/v0.1.7/setting/pop/index.html index f3c8ce3..90e2969 100644 --- a/docs/v0.1.7/setting/pop/index.html +++ b/docs/v0.1.7/setting/pop/index.html @@ -1 +1 @@ -lu5 | pop

pop

v0.1.7
pop();

Restore the style and transformation settings.

Pops the lu5 style settings off the stack.
Pops the OpenGL transformation matrix off the stack.

See pop in setting.h
\ No newline at end of file +lu5 | pop

pop

v0.1.7
pop();

Restore the style and transformation settings.

Pops the lu5 style settings off the stack.
Pops the OpenGL transformation matrix off the stack.

See pop in setting.h
\ No newline at end of file diff --git a/docs/v0.1.7/setting/pop/meta.json b/docs/v0.1.7/setting/pop/meta.json index 6faa722..c2b6329 100644 --- a/docs/v0.1.7/setting/pop/meta.json +++ b/docs/v0.1.7/setting/pop/meta.json @@ -1 +1 @@ -{"doc":{"bottom_description":"","name":"pop","description":"Restore the style and transformation settings.

Pops the lu5 style settings off the stack.
Pops the OpenGL transformation matrix off the stack.","calls":[{"arguments":{}}],"_type":"method","examples":{}},"source":{"end_line":214,"start_line":208,"header":"setting.h"}} \ No newline at end of file +{"doc":{"description":"Restore the style and transformation settings.

Pops the lu5 style settings off the stack.
Pops the OpenGL transformation matrix off the stack.","bottom_description":"","examples":{},"name":"pop","calls":[{"arguments":{}}],"_type":"method"},"source":{"header":"setting.h","start_line":208,"end_line":214}} \ No newline at end of file diff --git a/docs/v0.1.7/setting/push/index.html b/docs/v0.1.7/setting/push/index.html index 1a46d63..b9ccce6 100644 --- a/docs/v0.1.7/setting/push/index.html +++ b/docs/v0.1.7/setting/push/index.html @@ -1,4 +1,4 @@ -lu5 | push

push

v0.1.7
push();

Save the style and transformation settings.

Pushes the lu5 style settings off the stack.
Pushes the OpenGL transformation matrix off the stack.

function setup()
+lu5 | push

push

v0.1.7
push();

Save the style and transformation settings.

Pushes the lu5 style settings off the stack.
Pushes the OpenGL transformation matrix off the stack.

function setup()
     createWindow(400, 400);
 end
 
@@ -32,4 +32,4 @@
 
     -- Not Affected by transformation
     circle(0, 0, 32);
-end
See push in setting.h
This project is licensed under the MIT License.
It also includes the FreeType font engine, which is licensed under the FreeType License (FTL).
\ No newline at end of file +end
See push in setting.h
\ No newline at end of file diff --git a/docs/v0.1.7/setting/push/meta.json b/docs/v0.1.7/setting/push/meta.json index 296ea3a..b3fd647 100644 --- a/docs/v0.1.7/setting/push/meta.json +++ b/docs/v0.1.7/setting/push/meta.json @@ -1 +1 @@ -{"doc":{"bottom_description":"","name":"push","description":"Save the style and transformation settings.

Pushes the lu5 style settings off the stack.
Pushes the OpenGL transformation matrix off the stack.","calls":[{"arguments":{}}],"_type":"method","examples":["function setup()\n createWindow(400, 400);\nend\n\nfunction draw()\n background(51);\n\n push();\n fill(155, 255, 0);\n strokeWeight(12);\n\n -- Affected by style\n circle(300, 200, 32);\n pop();\n\n -- Not Affected by style\n circle(100, 200, 32);\nend","function setup()\n createWindow(400, 400);\nend\n\nfunction draw()\n background(51);\n\n push();\n fill('red');\n translate(200, 200);\n\n -- Affected by transformation\n circle(0, 0, 32);\n pop();\n\n -- Not Affected by transformation\n circle(0, 0, 32);\nend"]},"source":{"end_line":206,"start_line":158,"header":"setting.h"}} \ No newline at end of file +{"doc":{"description":"Save the style and transformation settings.

Pushes the lu5 style settings off the stack.
Pushes the OpenGL transformation matrix off the stack.","bottom_description":"","examples":["function setup()\n createWindow(400, 400);\nend\n\nfunction draw()\n background(51);\n\n push();\n fill(155, 255, 0);\n strokeWeight(12);\n\n -- Affected by style\n circle(300, 200, 32);\n pop();\n\n -- Not Affected by style\n circle(100, 200, 32);\nend","function setup()\n createWindow(400, 400);\nend\n\nfunction draw()\n background(51);\n\n push();\n fill('red');\n translate(200, 200);\n\n -- Affected by transformation\n circle(0, 0, 32);\n pop();\n\n -- Not Affected by transformation\n circle(0, 0, 32);\nend"],"name":"push","calls":[{"arguments":{}}],"_type":"method"},"source":{"header":"setting.h","start_line":158,"end_line":206}} \ No newline at end of file diff --git a/docs/v0.1.7/setting/rectMode/index.html b/docs/v0.1.7/setting/rectMode/index.html index 292bc7d..84d24ee 100644 --- a/docs/v0.1.7/setting/rectMode/index.html +++ b/docs/v0.1.7/setting/rectMode/index.html @@ -1,4 +1,4 @@ -lu5 | rectMode

rectMode

v0.1.7
rectMode(mode);

Set rectangle alignment mode.

Arguments

modeeither CENTER, CORNER, RADIUS

function setup()
+lu5 | rectMode

rectMode

v0.1.7
rectMode(mode);

Set rectangle alignment mode.

Arguments

modeeither CENTER, CORNER, RADIUS

function setup()
   createWindow(800, 800, GL3D);
 
   rectMode(CENTER);
@@ -8,4 +8,4 @@
   background(51);
   
   rect(width/2, height/2, 100, 50);
-end
See rectMode in setting.h
This project is licensed under the MIT License.
It also includes the FreeType font engine, which is licensed under the FreeType License (FTL).
\ No newline at end of file +end
See rectMode in setting.h
\ No newline at end of file diff --git a/docs/v0.1.7/setting/rectMode/meta.json b/docs/v0.1.7/setting/rectMode/meta.json index 4b68f11..531b6b5 100644 --- a/docs/v0.1.7/setting/rectMode/meta.json +++ b/docs/v0.1.7/setting/rectMode/meta.json @@ -1 +1 @@ -{"doc":{"bottom_description":"","name":"rectMode","description":"Set rectangle alignment mode.","calls":[{"arguments":[{"name":"mode","description":"either `CENTER`, `CORNER`, `RADIUS`"}]}],"_type":"method","examples":["function setup()\n createWindow(800, 800, GL3D);\n\n rectMode(CENTER);\nend\n\nfunction draw()\n background(51);\n \n rect(width/2, height/2, 100, 50);\nend"]},"source":{"end_line":235,"start_line":216,"header":"setting.h"}} \ No newline at end of file +{"doc":{"description":"Set rectangle alignment mode.","bottom_description":"","examples":["function setup()\n createWindow(800, 800, GL3D);\n\n rectMode(CENTER);\nend\n\nfunction draw()\n background(51);\n \n rect(width/2, height/2, 100, 50);\nend"],"name":"rectMode","calls":[{"arguments":[{"name":"mode","description":"either `CENTER`, `CORNER`, `RADIUS`"}]}],"_type":"method"},"source":{"header":"setting.h","start_line":216,"end_line":235}} \ No newline at end of file diff --git a/docs/v0.1.7/setting/stroke/index.html b/docs/v0.1.7/setting/stroke/index.html index 640633f..b8fbc66 100644 --- a/docs/v0.1.7/setting/stroke/index.html +++ b/docs/v0.1.7/setting/stroke/index.html @@ -1 +1 @@ -lu5 | stroke

stroke

v0.1.7
stroke

Set the stroke color for shapes

Arguments

rThe red byte
gThe green byte
bThe blue byte
 stroke(255, 255, 100);

Arguments

rThe red byte
gThe green byte
bThe blue byte
aThe alpha byte
 stroke(255, 255, 100, 150);

Arguments

vThe grayscale value
 stroke(255);

Arguments

color_nameThe color name
 stroke('red');

See stroke in setting.h
\ No newline at end of file +lu5 | stroke

stroke

v0.1.7
stroke

Set the stroke color for shapes

Arguments

rThe red byte
gThe green byte
bThe blue byte
 stroke(255, 255, 100);

Arguments

rThe red byte
gThe green byte
bThe blue byte
aThe alpha byte
 stroke(255, 255, 100, 150);

Arguments

vThe grayscale value
 stroke(255);

Arguments

color_nameThe color name
 stroke('red');

See stroke in setting.h
\ No newline at end of file diff --git a/docs/v0.1.7/setting/stroke/meta.json b/docs/v0.1.7/setting/stroke/meta.json index c493b4c..7837cfb 100644 --- a/docs/v0.1.7/setting/stroke/meta.json +++ b/docs/v0.1.7/setting/stroke/meta.json @@ -1 +1 @@ -{"doc":{"bottom_description":"","name":"stroke","description":"Set the stroke color for shapes","calls":[{"example":" stroke(255, 255, 100);","arguments":[{"name":"r","description":"The red byte"},{"name":"g","description":"The green byte"},{"name":"b","description":"The blue byte"}]},{"example":" stroke(255, 255, 100, 150);","arguments":[{"name":"r","description":"The red byte"},{"name":"g","description":"The green byte"},{"name":"b","description":"The blue byte"},{"name":"a","description":"The alpha byte"}]},{"example":" stroke(255);","arguments":[{"name":"v","description":"The grayscale value"}]},{"example":" stroke('red');","arguments":[{"name":"color_name","description":"The color name"}]}],"_type":"method","examples":{}},"source":{"end_line":151,"start_line":116,"header":"setting.h"}} \ No newline at end of file +{"doc":{"description":"Set the stroke color for shapes","bottom_description":"","examples":{},"name":"stroke","calls":[{"example":" stroke(255, 255, 100);","arguments":[{"name":"r","description":"The red byte"},{"name":"g","description":"The green byte"},{"name":"b","description":"The blue byte"}]},{"example":" stroke(255, 255, 100, 150);","arguments":[{"name":"r","description":"The red byte"},{"name":"g","description":"The green byte"},{"name":"b","description":"The blue byte"},{"name":"a","description":"The alpha byte"}]},{"example":" stroke(255);","arguments":[{"name":"v","description":"The grayscale value"}]},{"example":" stroke('red');","arguments":[{"name":"color_name","description":"The color name"}]}],"_type":"method"},"source":{"header":"setting.h","start_line":116,"end_line":151}} \ No newline at end of file diff --git a/docs/v0.1.7/setting/strokeWeight/index.html b/docs/v0.1.7/setting/strokeWeight/index.html index 0b5e735..8530e6f 100644 --- a/docs/v0.1.7/setting/strokeWeight/index.html +++ b/docs/v0.1.7/setting/strokeWeight/index.html @@ -1,2 +1,2 @@ -lu5 | strokeWeight

strokeWeight

v0.1.7
strokeWeight(weight);

Set the line width.

Arguments

weightThe line width in pixels

strokeWeight(8);
-line(200, 200, mouseX, mouseY);
See strokeWeight in setting.h
\ No newline at end of file +lu5 | strokeWeight

strokeWeight

v0.1.7
strokeWeight(weight);

Set the line width.

Arguments

weightThe line width in pixels

strokeWeight(8);
+line(200, 200, mouseX, mouseY);
See strokeWeight in setting.h
\ No newline at end of file diff --git a/docs/v0.1.7/setting/strokeWeight/meta.json b/docs/v0.1.7/setting/strokeWeight/meta.json index 73b68ae..4b0d920 100644 --- a/docs/v0.1.7/setting/strokeWeight/meta.json +++ b/docs/v0.1.7/setting/strokeWeight/meta.json @@ -1 +1 @@ -{"doc":{"bottom_description":"","name":"strokeWeight","description":"Set the line width. ","calls":[{"arguments":[{"name":"weight","description":"The line width in pixels"}]}],"_type":"method","examples":["strokeWeight(8);\nline(200, 200, mouseX, mouseY);"]},"source":{"end_line":104,"start_line":94,"header":"setting.h"}} \ No newline at end of file +{"doc":{"description":"Set the line width. ","bottom_description":"","examples":["strokeWeight(8);\nline(200, 200, mouseX, mouseY);"],"name":"strokeWeight","calls":[{"arguments":[{"name":"weight","description":"The line width in pixels"}]}],"_type":"method"},"source":{"header":"setting.h","start_line":94,"end_line":104}} \ No newline at end of file diff --git a/docs/v0.1.7/shapes/arc/index.html b/docs/v0.1.7/shapes/arc/index.html index 3807b2b..c5428f9 100644 --- a/docs/v0.1.7/shapes/arc/index.html +++ b/docs/v0.1.7/shapes/arc/index.html @@ -1,4 +1,4 @@ -lu5 | arc

arc

v0.1.7
arc(x, y, w, h, start, stop);

Draw an arc on the screen.

Arguments

xThe x position of the arc
yThe y position of the arc
wThe width of the arc
hThe height of the arc
startThe angle to start the arc
stopThe angle to stop the arc

function setup()
+lu5 | arc

arc

v0.1.7
arc(x, y, w, h, start, stop);

Draw an arc on the screen.

Arguments

xThe x position of the arc
yThe y position of the arc
wThe width of the arc
hThe height of the arc
startThe angle to start the arc
stopThe angle to stop the arc

function setup()
     createWindow(400, 400);
 end
 
@@ -10,4 +10,4 @@
 
     -- 3/4 of a pizza
     arc(200, 200, 120, 120, 0, HALF_PI * 3);
-end
See arc in shapes.h
This project is licensed under the MIT License.
It also includes the FreeType font engine, which is licensed under the FreeType License (FTL).
\ No newline at end of file +end
See arc in shapes.h
\ No newline at end of file diff --git a/docs/v0.1.7/shapes/arc/meta.json b/docs/v0.1.7/shapes/arc/meta.json index 952d684..6e10f14 100644 --- a/docs/v0.1.7/shapes/arc/meta.json +++ b/docs/v0.1.7/shapes/arc/meta.json @@ -1 +1 @@ -{"doc":{"bottom_description":"","name":"arc","description":"Draw an arc on the screen.","calls":[{"arguments":[{"name":"x","description":"The x position of the arc"},{"name":"y","description":"The y position of the arc"},{"name":"w","description":"The width of the arc"},{"name":"h","description":"The height of the arc"},{"name":"start","description":"The angle to start the arc"},{"name":"stop","description":"The angle to stop the arc"}]}],"_type":"method","examples":["function setup()\n createWindow(400, 400);\nend\n\nfunction draw()\n background(51);\n\n strokeWeight(12)\n stroke(0);\n\n -- 3/4 of a pizza\n arc(200, 200, 120, 120, 0, HALF_PI * 3);\nend"]},"source":{"end_line":156,"start_line":130,"header":"shapes.h"}} \ No newline at end of file +{"doc":{"description":"Draw an arc on the screen.","bottom_description":"","examples":["function setup()\n createWindow(400, 400);\nend\n\nfunction draw()\n background(51);\n\n strokeWeight(12)\n stroke(0);\n\n -- 3/4 of a pizza\n arc(200, 200, 120, 120, 0, HALF_PI * 3);\nend"],"name":"arc","calls":[{"arguments":[{"name":"x","description":"The x position of the arc"},{"name":"y","description":"The y position of the arc"},{"name":"w","description":"The width of the arc"},{"name":"h","description":"The height of the arc"},{"name":"start","description":"The angle to start the arc"},{"name":"stop","description":"The angle to stop the arc"}]}],"_type":"method"},"source":{"header":"shapes.h","start_line":130,"end_line":156}} \ No newline at end of file diff --git a/docs/v0.1.7/shapes/beginShape/index.html b/docs/v0.1.7/shapes/beginShape/index.html index cce43a2..2a43c21 100644 --- a/docs/v0.1.7/shapes/beginShape/index.html +++ b/docs/v0.1.7/shapes/beginShape/index.html @@ -1,4 +1,4 @@ -lu5 | beginShape

beginShape

v0.1.7
beginShape(mode);

Begin adding vertices to a custom shape.

Arguments

modeThe opengl shape mode LINES, POINTS, QUADS, TRIANGLES, TRIANGLE_FAN

The following would draw a 100 by 100 square at position 100, 100

function setup()
+lu5 | beginShape

beginShape

v0.1.7
beginShape(mode);

Begin adding vertices to a custom shape.

Arguments

modeThe opengl shape mode LINES, POINTS, QUADS, TRIANGLES, TRIANGLE_FAN

The following would draw a 100 by 100 square at position 100, 100

function setup()
   createWindow(400, 400);
 end
 
@@ -11,4 +11,4 @@
     vertex(200, 200);
     vertex(200, 100);
   endShape();
-end
See beginShape in shapes.h
This project is licensed under the MIT License.
It also includes the FreeType font engine, which is licensed under the FreeType License (FTL).
\ No newline at end of file +end
See beginShape in shapes.h
\ No newline at end of file diff --git a/docs/v0.1.7/shapes/beginShape/meta.json b/docs/v0.1.7/shapes/beginShape/meta.json index ae6afed..f5adcaf 100644 --- a/docs/v0.1.7/shapes/beginShape/meta.json +++ b/docs/v0.1.7/shapes/beginShape/meta.json @@ -1 +1 @@ -{"doc":{"bottom_description":"The following would draw a 100 by 100 square at position 100, 100","name":"beginShape","description":"Begin adding vertices to a custom shape.","calls":[{"arguments":[{"name":"mode","description":"The opengl shape mode `LINES`, `POINTS`, `QUADS`, `TRIANGLES`, `TRIANGLE_FAN`"}]}],"_type":"method","examples":["function setup()\n createWindow(400, 400);\nend\n\nfunction draw()\n background(51);\n \n beginShape(QUADS);\n vertex(100, 100);\n vertex(100, 200);\n vertex(200, 200);\n vertex(200, 100);\n endShape();\nend"]},"source":{"end_line":274,"start_line":250,"header":"shapes.h"}} \ No newline at end of file +{"doc":{"description":"Begin adding vertices to a custom shape.","bottom_description":"The following would draw a 100 by 100 square at position 100, 100","examples":["function setup()\n createWindow(400, 400);\nend\n\nfunction draw()\n background(51);\n \n beginShape(QUADS);\n vertex(100, 100);\n vertex(100, 200);\n vertex(200, 200);\n vertex(200, 100);\n endShape();\nend"],"name":"beginShape","calls":[{"arguments":[{"name":"mode","description":"The opengl shape mode `LINES`, `POINTS`, `QUADS`, `TRIANGLES`, `TRIANGLE_FAN`"}]}],"_type":"method"},"source":{"header":"shapes.h","start_line":250,"end_line":274}} \ No newline at end of file diff --git a/docs/v0.1.7/shapes/circle/index.html b/docs/v0.1.7/shapes/circle/index.html index 44b83ef..b07595d 100644 --- a/docs/v0.1.7/shapes/circle/index.html +++ b/docs/v0.1.7/shapes/circle/index.html @@ -1,4 +1,4 @@ -lu5 | circle

circle

v0.1.7
circle(x, y, d);

Draw a circle on the screen.

Arguments

xThe x position of the circle
yThe y position of the circle
dThe diameter of the circle

function setup()
+lu5 | circle

circle

v0.1.7
circle(x, y, d);

Draw a circle on the screen.

Arguments

xThe x position of the circle
yThe y position of the circle
dThe diameter of the circle

function setup()
   createWindow(400, 400);
 end
 
@@ -6,4 +6,4 @@
   background(51);
  
   circle(200, 200, 32);
-end
See circle in shapes.h
This project is licensed under the MIT License.
It also includes the FreeType font engine, which is licensed under the FreeType License (FTL).
\ No newline at end of file +end
See circle in shapes.h
\ No newline at end of file diff --git a/docs/v0.1.7/shapes/circle/meta.json b/docs/v0.1.7/shapes/circle/meta.json index 38604f2..29c45ec 100644 --- a/docs/v0.1.7/shapes/circle/meta.json +++ b/docs/v0.1.7/shapes/circle/meta.json @@ -1 +1 @@ -{"doc":{"bottom_description":"","name":"circle","description":"Draw a circle on the screen.","calls":[{"arguments":[{"name":"x","description":"The x position of the circle"},{"name":"y","description":"The y position of the circle"},{"name":"d","description":"The diameter of the circle"}]}],"_type":"method","examples":["function setup()\n createWindow(400, 400);\nend\n\nfunction draw()\n background(51);\n \n circle(200, 200, 32);\nend"]},"source":{"end_line":56,"start_line":36,"header":"shapes.h"}} \ No newline at end of file +{"doc":{"description":"Draw a circle on the screen.","bottom_description":"","examples":["function setup()\n createWindow(400, 400);\nend\n\nfunction draw()\n background(51);\n \n circle(200, 200, 32);\nend"],"name":"circle","calls":[{"arguments":[{"name":"x","description":"The x position of the circle"},{"name":"y","description":"The y position of the circle"},{"name":"d","description":"The diameter of the circle"}]}],"_type":"method"},"source":{"header":"shapes.h","start_line":36,"end_line":56}} \ No newline at end of file diff --git a/docs/v0.1.7/shapes/ellipse/index.html b/docs/v0.1.7/shapes/ellipse/index.html index 891c8cb..ab48320 100644 --- a/docs/v0.1.7/shapes/ellipse/index.html +++ b/docs/v0.1.7/shapes/ellipse/index.html @@ -1,4 +1,4 @@ -lu5 | ellipse

ellipse

v0.1.7
ellipse(x, y, w, h);

Draw an ellipse on the screen.

Arguments

xThe x position of the ellipse
yThe y position of the ellipse
wThe width diameter of the ellipse
hThe height diameter of the ellipse

function setup()
+lu5 | ellipse

ellipse

v0.1.7
ellipse(x, y, w, h);

Draw an ellipse on the screen.

Arguments

xThe x position of the ellipse
yThe y position of the ellipse
wThe width diameter of the ellipse
hThe height diameter of the ellipse

function setup()
   createWindow(400, 400);
 end
 
@@ -6,4 +6,4 @@
   background(51);
  
   ellipse(200, 200, 64, 72);
-end
See ellipse in shapes.h
This project is licensed under the MIT License.
It also includes the FreeType font engine, which is licensed under the FreeType License (FTL).
\ No newline at end of file +end
See ellipse in shapes.h
\ No newline at end of file diff --git a/docs/v0.1.7/shapes/ellipse/meta.json b/docs/v0.1.7/shapes/ellipse/meta.json index f1426b6..eac552c 100644 --- a/docs/v0.1.7/shapes/ellipse/meta.json +++ b/docs/v0.1.7/shapes/ellipse/meta.json @@ -1 +1 @@ -{"doc":{"bottom_description":"","name":"ellipse","description":"Draw an ellipse on the screen.","calls":[{"arguments":[{"name":"x","description":"The x position of the ellipse"},{"name":"y","description":"The y position of the ellipse"},{"name":"w","description":"The width diameter of the ellipse"},{"name":"h","description":"The height diameter of the ellipse"}]}],"_type":"method","examples":["function setup()\n createWindow(400, 400);\nend\n\nfunction draw()\n background(51);\n \n ellipse(200, 200, 64, 72);\nend"]},"source":{"end_line":34,"start_line":3,"header":"shapes.h"}} \ No newline at end of file +{"doc":{"description":"Draw an ellipse on the screen.","bottom_description":"","examples":["function setup()\n createWindow(400, 400);\nend\n\nfunction draw()\n background(51);\n \n ellipse(200, 200, 64, 72);\nend"],"name":"ellipse","calls":[{"arguments":[{"name":"x","description":"The x position of the ellipse"},{"name":"y","description":"The y position of the ellipse"},{"name":"w","description":"The width diameter of the ellipse"},{"name":"h","description":"The height diameter of the ellipse"}]}],"_type":"method"},"source":{"header":"shapes.h","start_line":3,"end_line":34}} \ No newline at end of file diff --git a/docs/v0.1.7/shapes/endShape/index.html b/docs/v0.1.7/shapes/endShape/index.html index 6277687..c54d585 100644 --- a/docs/v0.1.7/shapes/endShape/index.html +++ b/docs/v0.1.7/shapes/endShape/index.html @@ -1 +1 @@ -lu5 | endShape

endShape

v0.1.7
endShape();

Close the custom shape.
beginShape must be called prior.

See endShape in shapes.h
\ No newline at end of file +lu5 | endShape

endShape

v0.1.7
endShape();

Close the custom shape.
beginShape must be called prior.

See endShape in shapes.h
\ No newline at end of file diff --git a/docs/v0.1.7/shapes/endShape/meta.json b/docs/v0.1.7/shapes/endShape/meta.json index b136aca..54f169f 100644 --- a/docs/v0.1.7/shapes/endShape/meta.json +++ b/docs/v0.1.7/shapes/endShape/meta.json @@ -1 +1 @@ -{"doc":{"bottom_description":"","name":"endShape","description":"Close the custom shape.
beginShape must be called prior.","calls":[{"arguments":{}}],"_type":"method","examples":{}},"source":{"end_line":292,"start_line":287,"header":"shapes.h"}} \ No newline at end of file +{"doc":{"description":"Close the custom shape.
beginShape must be called prior.","bottom_description":"","examples":{},"name":"endShape","calls":[{"arguments":{}}],"_type":"method"},"source":{"header":"shapes.h","start_line":287,"end_line":292}} \ No newline at end of file diff --git a/docs/v0.1.7/shapes/index.html b/docs/v0.1.7/shapes/index.html index d83f823..52db4b5 100644 --- a/docs/v0.1.7/shapes/index.html +++ b/docs/v0.1.7/shapes/index.html @@ -1,4 +1,4 @@ -lu5 | 2D Shapes

2D Shapes

v0.1.7
ellipse(x, y, w, h);

Draw an ellipse on the screen.

Arguments

xThe x position of the ellipse
yThe y position of the ellipse
wThe width diameter of the ellipse
hThe height diameter of the ellipse

function setup()
+lu5 | 2D Shapes

2D Shapes

v0.1.7
ellipse(x, y, w, h);

Draw an ellipse on the screen.

Arguments

xThe x position of the ellipse
yThe y position of the ellipse
wThe width diameter of the ellipse
hThe height diameter of the ellipse

function setup()
   createWindow(400, 400);
 end
 
@@ -6,7 +6,7 @@
   background(51);
  
   ellipse(200, 200, 64, 72);
-end
See ellipse in shapes.h
circle(x, y, d);

Draw a circle on the screen.

Arguments

xThe x position of the circle
yThe y position of the circle
dThe diameter of the circle

function setup()
+end
See ellipse in shapes.h
circle(x, y, d);

Draw a circle on the screen.

Arguments

xThe x position of the circle
yThe y position of the circle
dThe diameter of the circle

function setup()
   createWindow(400, 400);
 end
 
@@ -14,7 +14,7 @@
   background(51);
  
   circle(200, 200, 32);
-end
See circle in shapes.h
rect(x, y, w, h);

Draw a rectangle on the screen.

Arguments

xThe x position of the reactangle
yThe y position of the reactangle
wThe width
hThe height

function setup()
+end
See circle in shapes.h
rect(x, y, w, h);

Draw a rectangle on the screen.

Arguments

xThe x position of the reactangle
yThe y position of the reactangle
wThe width
hThe height

function setup()
   createWindow(400, 400);
 end
 
@@ -23,7 +23,7 @@
 
  -- rectangle near the top-left corner
   rect(10, 10, 80, 60); 
-end
See rect in shapes.h
square(x, y, s);

Draw a square on the screen.

Arguments

xThe x position of the square
yThe y position of the square
sThe size of the square

function setup()
+end
See rect in shapes.h
square(x, y, s);

Draw a square on the screen.

Arguments

xThe x position of the square
yThe y position of the square
sThe size of the square

function setup()
   createWindow(400, 400);
 end
 
@@ -32,7 +32,7 @@
 
   -- square near the top-left corner
   rect(10, 10, 80);
-end
See square in shapes.h
line(x1, y1, x2, y2);

Draw a line on the screen.

Arguments

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

function setup()
+end
See square in shapes.h
line(x1, y1, x2, y2);

Draw a line on the screen.

Arguments

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

function setup()
   createWindow(400, 400);
 end
 
@@ -41,7 +41,7 @@
 
   -- diagonal line from top-left to bottom-right
   line(0, 0, width, height);
-end
See line in shapes.h
arc(x, y, w, h, start, stop);

Draw an arc on the screen.

Arguments

xThe x position of the arc
yThe y position of the arc
wThe width of the arc
hThe height of the arc
startThe angle to start the arc
stopThe angle to stop the arc

function setup()
+end
See line in shapes.h
arc(x, y, w, h, start, stop);

Draw an arc on the screen.

Arguments

xThe x position of the arc
yThe y position of the arc
wThe width of the arc
hThe height of the arc
startThe angle to start the arc
stopThe angle to stop the arc

function setup()
     createWindow(400, 400);
 end
 
@@ -53,7 +53,7 @@
 
     -- 3/4 of a pizza
     arc(200, 200, 120, 120, 0, HALF_PI * 3);
-end
See arc in shapes.h
point(x, y);

Draw a point on the screen.

Arguments

xThe point
yThe point

Use stroke to set the point's color, and use strokeWeight to set the point's radius. +end

See arc in shapes.h
point(x, y);

Draw a point on the screen.

Arguments

xThe point
yThe point

Use stroke to set the point's color, and use strokeWeight to set the point's radius.

Setting the color with fill will not affect point

function setup()
     createWindow(400, 400);
@@ -66,7 +66,7 @@
     stroke('yellow');
 
     point(mouseX, mouseY);
-end
See point in shapes.h
quad(x1, y1, x2, y2, x3, y3, x4, y4);

Draw a quad on the screen.

Arguments

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

function setup()
+end
See point in shapes.h
quad(x1, y1, x2, y2, x3, y3, x4, y4);

Draw a quad on the screen.

Arguments

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

function setup()
     createWindow(400, 400);
 end
 
@@ -82,7 +82,7 @@
       50, 10
    );
    pop();
-end
See quad in shapes.h
triangle(x1, y1, x2, y2, x3, y3);

Draw a triangle on the screen.

Arguments

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

function setup()
+end
See quad in shapes.h
triangle(x1, y1, x2, y2, x3, y3);

Draw a triangle on the screen.

Arguments

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

function setup()
     createWindow(400, 400);
 end
 
@@ -94,7 +94,7 @@
 
     triangle(0,0, 100, 0, 50, 50);
     pop();
-end
See triangle in shapes.h
beginShape(mode);

Begin adding vertices to a custom shape.

Arguments

modeThe opengl shape mode LINES, POINTS, QUADS, TRIANGLES, TRIANGLE_FAN

The following would draw a 100 by 100 square at position 100, 100

function setup()
+end
See triangle in shapes.h
beginShape(mode);

Begin adding vertices to a custom shape.

Arguments

modeThe opengl shape mode LINES, POINTS, QUADS, TRIANGLES, TRIANGLE_FAN

The following would draw a 100 by 100 square at position 100, 100

function setup()
   createWindow(400, 400);
 end
 
@@ -107,4 +107,4 @@
     vertex(200, 200);
     vertex(200, 100);
   endShape();
-end
See beginShape in shapes.h
vertex(x, y);

Add a vertex to a custom shape.

Arguments

xThe x position
yThe y position

beginShape must be called prior.

See vertex in shapes.h
endShape();

Close the custom shape.
beginShape must be called prior.

See endShape in shapes.h
\ No newline at end of file +endSee beginShape in shapes.h
vertex(x, y);

Add a vertex to a custom shape.

Arguments

xThe x position
yThe y position

beginShape must be called prior.

See vertex in shapes.h
endShape();

Close the custom shape.
beginShape must be called prior.

See endShape in shapes.h
\ No newline at end of file diff --git a/docs/v0.1.7/shapes/line/index.html b/docs/v0.1.7/shapes/line/index.html index 75d22ef..1cd2f34 100644 --- a/docs/v0.1.7/shapes/line/index.html +++ b/docs/v0.1.7/shapes/line/index.html @@ -1,4 +1,4 @@ -lu5 | line

line

v0.1.7
line(x1, y1, x2, y2);

Draw a line on the screen.

Arguments

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

function setup()
+lu5 | line

line

v0.1.7
line(x1, y1, x2, y2);

Draw a line on the screen.

Arguments

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

function setup()
   createWindow(400, 400);
 end
 
@@ -7,4 +7,4 @@
 
   -- diagonal line from top-left to bottom-right
   line(0, 0, width, height);
-end
See line in shapes.h
This project is licensed under the MIT License.
It also includes the FreeType font engine, which is licensed under the FreeType License (FTL).
\ No newline at end of file +end
See line in shapes.h
\ No newline at end of file diff --git a/docs/v0.1.7/shapes/line/meta.json b/docs/v0.1.7/shapes/line/meta.json index d762f89..7a99996 100644 --- a/docs/v0.1.7/shapes/line/meta.json +++ b/docs/v0.1.7/shapes/line/meta.json @@ -1 +1 @@ -{"doc":{"bottom_description":"","name":"line","description":"Draw a line on the screen.","calls":[{"arguments":[{"name":"x1","description":"The x position of the first point"},{"name":"y1","description":"The y position of the first point"},{"name":"x2","description":"The x position of the second point"},{"name":"y2","description":"The y position of the second point"}]}],"_type":"method","examples":["function setup()\n createWindow(400, 400);\nend\n\nfunction draw()\n background(51);\n\n -- diagonal line from top-left to bottom-right\n line(0, 0, width, height);\nend"]},"source":{"end_line":127,"start_line":105,"header":"shapes.h"}} \ No newline at end of file +{"doc":{"description":"Draw a line on the screen.","bottom_description":"","examples":["function setup()\n createWindow(400, 400);\nend\n\nfunction draw()\n background(51);\n\n -- diagonal line from top-left to bottom-right\n line(0, 0, width, height);\nend"],"name":"line","calls":[{"arguments":[{"name":"x1","description":"The x position of the first point"},{"name":"y1","description":"The y position of the first point"},{"name":"x2","description":"The x position of the second point"},{"name":"y2","description":"The y position of the second point"}]}],"_type":"method"},"source":{"header":"shapes.h","start_line":105,"end_line":127}} \ No newline at end of file diff --git a/docs/v0.1.7/shapes/point/index.html b/docs/v0.1.7/shapes/point/index.html index 7d51b4e..1a92248 100644 --- a/docs/v0.1.7/shapes/point/index.html +++ b/docs/v0.1.7/shapes/point/index.html @@ -1,4 +1,4 @@ -lu5 | point

point

v0.1.7
point(x, y);

Draw a point on the screen.

Arguments

xThe point
yThe point

Use stroke to set the point's color, and use strokeWeight to set the point's radius. +lu5 | point

point

v0.1.7
point(x, y);

Draw a point on the screen.

Arguments

xThe point
yThe point

Use stroke to set the point's color, and use strokeWeight to set the point's radius.

Setting the color with fill will not affect point

function setup()
     createWindow(400, 400);
@@ -11,4 +11,4 @@
     stroke('yellow');
 
     point(mouseX, mouseY);
-end
See point in shapes.h
This project is licensed under the MIT License.
It also includes the FreeType font engine, which is licensed under the FreeType License (FTL).
\ No newline at end of file +endSee point in shapes.h
\ No newline at end of file diff --git a/docs/v0.1.7/shapes/point/meta.json b/docs/v0.1.7/shapes/point/meta.json index a95dc16..d2edaff 100644 --- a/docs/v0.1.7/shapes/point/meta.json +++ b/docs/v0.1.7/shapes/point/meta.json @@ -1 +1 @@ -{"doc":{"bottom_description":"Use stroke to set the point's color, and use strokeWeight to set the point's radius.\n

\nSetting the color with fill will not affect point","name":"point","description":"Draw a point on the screen.","calls":[{"arguments":[{"name":"x","description":"The point"},{"name":"y","description":"The point"}]}],"_type":"method","examples":["function setup()\n createWindow(400, 400);\nend\n\nfunction draw()\n background(51);\n\n strokeWeight(12);\n stroke('yellow');\n\n point(mouseX, mouseY);\nend"]},"source":{"end_line":184,"start_line":159,"header":"shapes.h"}} \ No newline at end of file +{"doc":{"description":"Draw a point on the screen.","bottom_description":"Use stroke to set the point's color, and use strokeWeight to set the point's radius.\n

\nSetting the color with fill will not affect point","examples":["function setup()\n createWindow(400, 400);\nend\n\nfunction draw()\n background(51);\n\n strokeWeight(12);\n stroke('yellow');\n\n point(mouseX, mouseY);\nend"],"name":"point","calls":[{"arguments":[{"name":"x","description":"The point"},{"name":"y","description":"The point"}]}],"_type":"method"},"source":{"header":"shapes.h","start_line":159,"end_line":184}} \ No newline at end of file diff --git a/docs/v0.1.7/shapes/quad/index.html b/docs/v0.1.7/shapes/quad/index.html index 280bacd..48c789d 100644 --- a/docs/v0.1.7/shapes/quad/index.html +++ b/docs/v0.1.7/shapes/quad/index.html @@ -1,4 +1,4 @@ -lu5 | quad

quad

v0.1.7
quad(x1, y1, x2, y2, x3, y3, x4, y4);

Draw a quad on the screen.

Arguments

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

function setup()
+lu5 | quad

quad

v0.1.7
quad(x1, y1, x2, y2, x3, y3, x4, y4);

Draw a quad on the screen.

Arguments

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

function setup()
     createWindow(400, 400);
 end
 
@@ -14,4 +14,4 @@
       50, 10
    );
    pop();
-end
See quad in shapes.h
This project is licensed under the MIT License.
It also includes the FreeType font engine, which is licensed under the FreeType License (FTL).
\ No newline at end of file +end
See quad in shapes.h
\ No newline at end of file diff --git a/docs/v0.1.7/shapes/quad/meta.json b/docs/v0.1.7/shapes/quad/meta.json index f542fc2..2495d42 100644 --- a/docs/v0.1.7/shapes/quad/meta.json +++ b/docs/v0.1.7/shapes/quad/meta.json @@ -1 +1 @@ -{"doc":{"bottom_description":"","name":"quad","description":"Draw a quad on the screen.","calls":[{"arguments":[{"name":"x1","description":"The x position of the first point"},{"name":"y1","description":"The y position of the first point"},{"name":"x2","description":"The x position of the second point"},{"name":"y2","description":"The y position of the second point"},{"name":"x3","description":"The x position of the third point"},{"name":"y3","description":"The y position of the third point"},{"name":"x4","description":"The x position of the fourth point"},{"name":"y4","description":"The y position of the fourth point"}]}],"_type":"method","examples":["function setup()\n createWindow(400, 400);\nend\n\nfunction draw()\n background(51);\n\n push();\n translate(50, 50);\n quad(\n 0, 0,\n 0, 60,\n 60, 70,\n 50, 10\n );\n pop();\nend"]},"source":{"end_line":219,"start_line":187,"header":"shapes.h"}} \ No newline at end of file +{"doc":{"description":"Draw a quad on the screen.","bottom_description":"","examples":["function setup()\n createWindow(400, 400);\nend\n\nfunction draw()\n background(51);\n\n push();\n translate(50, 50);\n quad(\n 0, 0,\n 0, 60,\n 60, 70,\n 50, 10\n );\n pop();\nend"],"name":"quad","calls":[{"arguments":[{"name":"x1","description":"The x position of the first point"},{"name":"y1","description":"The y position of the first point"},{"name":"x2","description":"The x position of the second point"},{"name":"y2","description":"The y position of the second point"},{"name":"x3","description":"The x position of the third point"},{"name":"y3","description":"The y position of the third point"},{"name":"x4","description":"The x position of the fourth point"},{"name":"y4","description":"The y position of the fourth point"}]}],"_type":"method"},"source":{"header":"shapes.h","start_line":187,"end_line":219}} \ No newline at end of file diff --git a/docs/v0.1.7/shapes/rect/index.html b/docs/v0.1.7/shapes/rect/index.html index e4211a9..e3e41fe 100644 --- a/docs/v0.1.7/shapes/rect/index.html +++ b/docs/v0.1.7/shapes/rect/index.html @@ -1,4 +1,4 @@ -lu5 | rect

rect

v0.1.7
rect(x, y, w, h);

Draw a rectangle on the screen.

Arguments

xThe x position of the reactangle
yThe y position of the reactangle
wThe width
hThe height

function setup()
+lu5 | rect

rect

v0.1.7
rect(x, y, w, h);

Draw a rectangle on the screen.

Arguments

xThe x position of the reactangle
yThe y position of the reactangle
wThe width
hThe height

function setup()
   createWindow(400, 400);
 end
 
@@ -7,4 +7,4 @@
 
  -- rectangle near the top-left corner
   rect(10, 10, 80, 60); 
-end
See rect in shapes.h
This project is licensed under the MIT License.
It also includes the FreeType font engine, which is licensed under the FreeType License (FTL).
\ No newline at end of file +end
See rect in shapes.h
\ No newline at end of file diff --git a/docs/v0.1.7/shapes/rect/meta.json b/docs/v0.1.7/shapes/rect/meta.json index 562ba7c..8b8fb15 100644 --- a/docs/v0.1.7/shapes/rect/meta.json +++ b/docs/v0.1.7/shapes/rect/meta.json @@ -1 +1 @@ -{"doc":{"bottom_description":"","name":"rect","description":"Draw a rectangle on the screen.","calls":[{"arguments":[{"name":"x","description":"The x position of the reactangle"},{"name":"y","description":"The y position of the reactangle"},{"name":"w","description":"The width"},{"name":"h","description":"The height"}]}],"_type":"method","examples":["function setup()\n createWindow(400, 400);\nend\n\nfunction draw()\n background(51);\n\n -- rectangle near the top-left corner\n rect(10, 10, 80, 60); \nend"]},"source":{"end_line":80,"start_line":58,"header":"shapes.h"}} \ No newline at end of file +{"doc":{"description":"Draw a rectangle on the screen.","bottom_description":"","examples":["function setup()\n createWindow(400, 400);\nend\n\nfunction draw()\n background(51);\n\n -- rectangle near the top-left corner\n rect(10, 10, 80, 60); \nend"],"name":"rect","calls":[{"arguments":[{"name":"x","description":"The x position of the reactangle"},{"name":"y","description":"The y position of the reactangle"},{"name":"w","description":"The width"},{"name":"h","description":"The height"}]}],"_type":"method"},"source":{"header":"shapes.h","start_line":58,"end_line":80}} \ No newline at end of file diff --git a/docs/v0.1.7/shapes/square/index.html b/docs/v0.1.7/shapes/square/index.html index a8208fc..764eafe 100644 --- a/docs/v0.1.7/shapes/square/index.html +++ b/docs/v0.1.7/shapes/square/index.html @@ -1,4 +1,4 @@ -lu5 | square

square

v0.1.7
square(x, y, s);

Draw a square on the screen.

Arguments

xThe x position of the square
yThe y position of the square
sThe size of the square

function setup()
+lu5 | square

square

v0.1.7
square(x, y, s);

Draw a square on the screen.

Arguments

xThe x position of the square
yThe y position of the square
sThe size of the square

function setup()
   createWindow(400, 400);
 end
 
@@ -7,4 +7,4 @@
 
   -- square near the top-left corner
   rect(10, 10, 80);
-end
See square in shapes.h
This project is licensed under the MIT License.
It also includes the FreeType font engine, which is licensed under the FreeType License (FTL).
\ No newline at end of file +end
See square in shapes.h
\ No newline at end of file diff --git a/docs/v0.1.7/shapes/square/meta.json b/docs/v0.1.7/shapes/square/meta.json index 091bfc8..b9743c7 100644 --- a/docs/v0.1.7/shapes/square/meta.json +++ b/docs/v0.1.7/shapes/square/meta.json @@ -1 +1 @@ -{"doc":{"bottom_description":"","name":"square","description":"Draw a square on the screen.","calls":[{"arguments":[{"name":"x","description":"The x position of the square"},{"name":"y","description":"The y position of the square"},{"name":"s","description":"The size of the square"}]}],"_type":"method","examples":["function setup()\n createWindow(400, 400);\nend\n\nfunction draw()\n background(51);\n\n -- square near the top-left corner\n rect(10, 10, 80);\nend"]},"source":{"end_line":103,"start_line":82,"header":"shapes.h"}} \ No newline at end of file +{"doc":{"description":"Draw a square on the screen.","bottom_description":"","examples":["function setup()\n createWindow(400, 400);\nend\n\nfunction draw()\n background(51);\n\n -- square near the top-left corner\n rect(10, 10, 80);\nend"],"name":"square","calls":[{"arguments":[{"name":"x","description":"The x position of the square"},{"name":"y","description":"The y position of the square"},{"name":"s","description":"The size of the square"}]}],"_type":"method"},"source":{"header":"shapes.h","start_line":82,"end_line":103}} \ No newline at end of file diff --git a/docs/v0.1.7/shapes/triangle/index.html b/docs/v0.1.7/shapes/triangle/index.html index af17ca1..68a189f 100644 --- a/docs/v0.1.7/shapes/triangle/index.html +++ b/docs/v0.1.7/shapes/triangle/index.html @@ -1,4 +1,4 @@ -lu5 | triangle

triangle

v0.1.7
triangle(x1, y1, x2, y2, x3, y3);

Draw a triangle on the screen.

Arguments

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

function setup()
+lu5 | triangle

triangle

v0.1.7
triangle(x1, y1, x2, y2, x3, y3);

Draw a triangle on the screen.

Arguments

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

function setup()
     createWindow(400, 400);
 end
 
@@ -10,4 +10,4 @@
 
     triangle(0,0, 100, 0, 50, 50);
     pop();
-end
See triangle in shapes.h
This project is licensed under the MIT License.
It also includes the FreeType font engine, which is licensed under the FreeType License (FTL).
\ No newline at end of file +end
See triangle in shapes.h
\ No newline at end of file diff --git a/docs/v0.1.7/shapes/triangle/meta.json b/docs/v0.1.7/shapes/triangle/meta.json index f43690d..0ef8d1b 100644 --- a/docs/v0.1.7/shapes/triangle/meta.json +++ b/docs/v0.1.7/shapes/triangle/meta.json @@ -1 +1 @@ -{"doc":{"bottom_description":"","name":"triangle","description":"Draw a triangle on the screen.","calls":[{"arguments":[{"name":"x1","description":"The x position of the first point"},{"name":"y1","description":"The y position of the first point"},{"name":"x2","description":"The x position of the second point"},{"name":"y2","description":"The y position of the second point"},{"name":"x3","description":"The x position of the third point"},{"name":"y3","description":"The y position of the third point"}]}],"_type":"method","examples":["function setup()\n createWindow(400, 400);\nend\n\nfunction draw()\n background(51);\n\n push();\n translate(130, 50);\n\n triangle(0,0, 100, 0, 50, 50);\n pop();\nend"]},"source":{"end_line":248,"start_line":221,"header":"shapes.h"}} \ No newline at end of file +{"doc":{"description":"Draw a triangle on the screen.","bottom_description":"","examples":["function setup()\n createWindow(400, 400);\nend\n\nfunction draw()\n background(51);\n\n push();\n translate(130, 50);\n\n triangle(0,0, 100, 0, 50, 50);\n pop();\nend"],"name":"triangle","calls":[{"arguments":[{"name":"x1","description":"The x position of the first point"},{"name":"y1","description":"The y position of the first point"},{"name":"x2","description":"The x position of the second point"},{"name":"y2","description":"The y position of the second point"},{"name":"x3","description":"The x position of the third point"},{"name":"y3","description":"The y position of the third point"}]}],"_type":"method"},"source":{"header":"shapes.h","start_line":221,"end_line":248}} \ No newline at end of file diff --git a/docs/v0.1.7/shapes/vertex/index.html b/docs/v0.1.7/shapes/vertex/index.html index 929908f..7ea88b1 100644 --- a/docs/v0.1.7/shapes/vertex/index.html +++ b/docs/v0.1.7/shapes/vertex/index.html @@ -1 +1 @@ -lu5 | vertex

vertex

v0.1.7
vertex(x, y);

Add a vertex to a custom shape.

Arguments

xThe x position
yThe y position

beginShape must be called prior.

See vertex in shapes.h
\ No newline at end of file +lu5 | vertex

vertex

v0.1.7
vertex(x, y);

Add a vertex to a custom shape.

Arguments

xThe x position
yThe y position

beginShape must be called prior.

See vertex in shapes.h
\ No newline at end of file diff --git a/docs/v0.1.7/shapes/vertex/meta.json b/docs/v0.1.7/shapes/vertex/meta.json index e91d82a..8d4285e 100644 --- a/docs/v0.1.7/shapes/vertex/meta.json +++ b/docs/v0.1.7/shapes/vertex/meta.json @@ -1 +1 @@ -{"doc":{"bottom_description":"beginShape must be called prior.","name":"vertex","description":"Add a vertex to a custom shape.","calls":[{"arguments":[{"name":"x","description":"The x position"},{"name":"y","description":"The y position"}]}],"_type":"method","examples":{}},"source":{"end_line":285,"start_line":276,"header":"shapes.h"}} \ No newline at end of file +{"doc":{"description":"Add a vertex to a custom shape.","bottom_description":"beginShape must be called prior.","examples":{},"name":"vertex","calls":[{"arguments":[{"name":"x","description":"The x position"},{"name":"y","description":"The y position"}]}],"_type":"method"},"source":{"header":"shapes.h","start_line":276,"end_line":285}} \ No newline at end of file diff --git a/docs/v0.1.7/shapes3D/box/index.html b/docs/v0.1.7/shapes3D/box/index.html index 5e88b56..0165341 100644 --- a/docs/v0.1.7/shapes3D/box/index.html +++ b/docs/v0.1.7/shapes3D/box/index.html @@ -1,4 +1,4 @@ -lu5 | box

box

v0.1.7
box(w, [h], [d]);

Draw a 3D box.

Arguments

wThe width dimension
[h]The height dimension
[d]The depth dimension

function setup()
+lu5 | box

box

v0.1.7
box(w, [h], [d]);

Draw a 3D box.

Arguments

wThe width dimension
[h]The height dimension
[d]The depth dimension

function setup()
   createWindow(800, 800, GL3D);
 end
 
@@ -7,4 +7,4 @@
  
   box(50, 25, 80);
 end
-
See box in shapes3D.h
This project is licensed under the MIT License.
It also includes the FreeType font engine, which is licensed under the FreeType License (FTL).
\ No newline at end of file +
See box in shapes3D.h
\ No newline at end of file diff --git a/docs/v0.1.7/shapes3D/box/meta.json b/docs/v0.1.7/shapes3D/box/meta.json index c03dc35..77b4382 100644 --- a/docs/v0.1.7/shapes3D/box/meta.json +++ b/docs/v0.1.7/shapes3D/box/meta.json @@ -1 +1 @@ -{"doc":{"bottom_description":"","name":"box","description":"Draw a 3D box.","calls":[{"arguments":[{"name":"w","description":"The width dimension"},{"name":"[h]","description":"The height dimension"},{"name":"[d]","description":"The depth dimension"}]}],"_type":"method","examples":["function setup()\n createWindow(800, 800, GL3D);\nend\n\nfunction draw()\n background(51);\n \n box(50, 25, 80);\nend\n"]},"source":{"end_line":50,"start_line":30,"header":"shapes3D.h"}} \ No newline at end of file +{"doc":{"description":"Draw a 3D box.","bottom_description":"","examples":["function setup()\n createWindow(800, 800, GL3D);\nend\n\nfunction draw()\n background(51);\n \n box(50, 25, 80);\nend\n"],"name":"box","calls":[{"arguments":[{"name":"w","description":"The width dimension"},{"name":"[h]","description":"The height dimension"},{"name":"[d]","description":"The depth dimension"}]}],"_type":"method"},"source":{"header":"shapes3D.h","start_line":30,"end_line":50}} \ No newline at end of file diff --git a/docs/v0.1.7/shapes3D/index.html b/docs/v0.1.7/shapes3D/index.html index cd3ab01..957a0e4 100644 --- a/docs/v0.1.7/shapes3D/index.html +++ b/docs/v0.1.7/shapes3D/index.html @@ -1,4 +1,4 @@ -lu5 | 3D Shapes

3D Shapes

v0.1.7
plane(w, h);

Draw a plane.

Arguments

wThe width dimension
hThe height dimension

function setup()
+lu5 | 3D Shapes

3D Shapes

v0.1.7
plane(w, h);

Draw a plane.

Arguments

wThe width dimension
hThe height dimension

function setup()
   createWindow(800, 800, GL3D);
 end
 
@@ -8,7 +8,7 @@
   rotateX(90);
   plane(400, 400);
 end
-
See plane in shapes3D.h
box(w, [h], [d]);

Draw a 3D box.

Arguments

wThe width dimension
[h]The height dimension
[d]The depth dimension

function setup()
+
See plane in shapes3D.h
box(w, [h], [d]);

Draw a 3D box.

Arguments

wThe width dimension
[h]The height dimension
[d]The depth dimension

function setup()
   createWindow(800, 800, GL3D);
 end
 
@@ -17,7 +17,7 @@
  
   box(50, 25, 80);
 end
-
See box in shapes3D.h
sphere(w, [detailX], [detailY]);

Draw a 3D Sphere.

Arguments

wThe width dimension
[detailX]The detail in the X axis
[detailY]the detailt in the Y axis

function setup()
+
See box in shapes3D.h
sphere(w, [detailX], [detailY]);

Draw a 3D Sphere.

Arguments

wThe width dimension
[detailX]The detail in the X axis
[detailY]the detailt in the Y axis

function setup()
   createWindow(800, 800, GL3D);
 end
 
@@ -25,4 +25,4 @@
   background(51);
  
   sphere(50);
-end
See sphere in shapes3D.h
This project is licensed under the MIT License.
It also includes the FreeType font engine, which is licensed under the FreeType License (FTL).
\ No newline at end of file +end
See sphere in shapes3D.h
\ No newline at end of file diff --git a/docs/v0.1.7/shapes3D/plane/index.html b/docs/v0.1.7/shapes3D/plane/index.html index db8a953..866b9c4 100644 --- a/docs/v0.1.7/shapes3D/plane/index.html +++ b/docs/v0.1.7/shapes3D/plane/index.html @@ -1,4 +1,4 @@ -lu5 | plane

plane

v0.1.7
plane(w, h);

Draw a plane.

Arguments

wThe width dimension
hThe height dimension

function setup()
+lu5 | plane

plane

v0.1.7
plane(w, h);

Draw a plane.

Arguments

wThe width dimension
hThe height dimension

function setup()
   createWindow(800, 800, GL3D);
 end
 
@@ -8,4 +8,4 @@
   rotateX(90);
   plane(400, 400);
 end
-
See plane in shapes3D.h
This project is licensed under the MIT License.
It also includes the FreeType font engine, which is licensed under the FreeType License (FTL).
\ No newline at end of file +
See plane in shapes3D.h
\ No newline at end of file diff --git a/docs/v0.1.7/shapes3D/plane/meta.json b/docs/v0.1.7/shapes3D/plane/meta.json index 5068034..7419b7f 100644 --- a/docs/v0.1.7/shapes3D/plane/meta.json +++ b/docs/v0.1.7/shapes3D/plane/meta.json @@ -1 +1 @@ -{"doc":{"bottom_description":"","name":"plane","description":"Draw a plane.","calls":[{"arguments":[{"name":"w","description":"The width dimension"},{"name":"h","description":"The height dimension"}]}],"_type":"method","examples":["function setup()\n createWindow(800, 800, GL3D);\nend\n\nfunction draw()\n background(51);\n \n rotateX(90);\n plane(400, 400);\nend\n"]},"source":{"end_line":28,"start_line":3,"header":"shapes3D.h"}} \ No newline at end of file +{"doc":{"description":"Draw a plane.","bottom_description":"","examples":["function setup()\n createWindow(800, 800, GL3D);\nend\n\nfunction draw()\n background(51);\n \n rotateX(90);\n plane(400, 400);\nend\n"],"name":"plane","calls":[{"arguments":[{"name":"w","description":"The width dimension"},{"name":"h","description":"The height dimension"}]}],"_type":"method"},"source":{"header":"shapes3D.h","start_line":3,"end_line":28}} \ No newline at end of file diff --git a/docs/v0.1.7/shapes3D/sphere/index.html b/docs/v0.1.7/shapes3D/sphere/index.html index 44b409c..631530d 100644 --- a/docs/v0.1.7/shapes3D/sphere/index.html +++ b/docs/v0.1.7/shapes3D/sphere/index.html @@ -1,4 +1,4 @@ -lu5 | sphere

sphere

v0.1.7
sphere(w, [detailX], [detailY]);

Draw a 3D Sphere.

Arguments

wThe width dimension
[detailX]The detail in the X axis
[detailY]the detailt in the Y axis

function setup()
+lu5 | sphere

sphere

v0.1.7
sphere(w, [detailX], [detailY]);

Draw a 3D Sphere.

Arguments

wThe width dimension
[detailX]The detail in the X axis
[detailY]the detailt in the Y axis

function setup()
   createWindow(800, 800, GL3D);
 end
 
@@ -6,4 +6,4 @@
   background(51);
  
   sphere(50);
-end
See sphere in shapes3D.h
This project is licensed under the MIT License.
It also includes the FreeType font engine, which is licensed under the FreeType License (FTL).
\ No newline at end of file +end
See sphere in shapes3D.h
\ No newline at end of file diff --git a/docs/v0.1.7/shapes3D/sphere/meta.json b/docs/v0.1.7/shapes3D/sphere/meta.json index db67db0..5a77f22 100644 --- a/docs/v0.1.7/shapes3D/sphere/meta.json +++ b/docs/v0.1.7/shapes3D/sphere/meta.json @@ -1 +1 @@ -{"doc":{"bottom_description":"","name":"sphere","description":"Draw a 3D Sphere.","calls":[{"arguments":[{"name":"w","description":"The width dimension"},{"name":"[detailX]","description":"The detail in the X axis"},{"name":"[detailY]","description":"the detailt in the Y axis"}]}],"_type":"method","examples":["function setup()\n createWindow(800, 800, GL3D);\nend\n\nfunction draw()\n background(51);\n \n sphere(50);\nend"]},"source":{"end_line":71,"start_line":52,"header":"shapes3D.h"}} \ No newline at end of file +{"doc":{"description":"Draw a 3D Sphere.","bottom_description":"","examples":["function setup()\n createWindow(800, 800, GL3D);\nend\n\nfunction draw()\n background(51);\n \n sphere(50);\nend"],"name":"sphere","calls":[{"arguments":[{"name":"w","description":"The width dimension"},{"name":"[detailX]","description":"The detail in the X axis"},{"name":"[detailY]","description":"the detailt in the Y axis"}]}],"_type":"method"},"source":{"header":"shapes3D.h","start_line":52,"end_line":71}} \ No newline at end of file diff --git a/docs/v0.1.7/transform/index.html b/docs/v0.1.7/transform/index.html index 5d71daa..caffb91 100644 --- a/docs/v0.1.7/transform/index.html +++ b/docs/v0.1.7/transform/index.html @@ -1 +1 @@ -lu5 | transform

transform

v0.1.7
rotateX(angle);

Rotate geometry around the X axis.

Arguments

angleThe angle of rotation

See rotateX in transform.h
rotateY(angle);

Rotate geometry around the Y axis.

Arguments

angleThe angle of rotation

See rotateY in transform.h
rotateZ(angle);

Rotate geometry around the Z axis.

Arguments

angleThe angle of rotation

See rotateZ in transform.h
rotate(angle);

Rotate geometry in 2D.

Arguments

angleThe angle of rotation

See rotate in transform.h
scale(x, y, [z]);

scale geometry.

Arguments

xThe x scaling
yThe y scaling
[z]The z scaling

See scale in transform.h
translate(x, y, [z]);

translate geometry.

Arguments

xThe x translation
yThe y translation
[z]The z translation

See translate in transform.h
\ No newline at end of file +lu5 | transform

transform

v0.1.7
rotateX(angle);

Rotate geometry around the X axis.

Arguments

angleThe angle of rotation

See rotateX in transform.h
rotateY(angle);

Rotate geometry around the Y axis.

Arguments

angleThe angle of rotation

See rotateY in transform.h
rotateZ(angle);

Rotate geometry around the Z axis.

Arguments

angleThe angle of rotation

See rotateZ in transform.h
rotate(angle);

Rotate geometry in 2D.

Arguments

angleThe angle of rotation

See rotate in transform.h
scale(x, y, [z]);

scale geometry.

Arguments

xThe x scaling
yThe y scaling
[z]The z scaling

See scale in transform.h
translate(x, y, [z]);

translate geometry.

Arguments

xThe x translation
yThe y translation
[z]The z translation

See translate in transform.h
\ No newline at end of file diff --git a/docs/v0.1.7/transform/rotate/index.html b/docs/v0.1.7/transform/rotate/index.html index c211db6..cff905e 100644 --- a/docs/v0.1.7/transform/rotate/index.html +++ b/docs/v0.1.7/transform/rotate/index.html @@ -1 +1 @@ -lu5 | rotate

rotate

v0.1.7
rotate(angle);

Rotate geometry in 2D.

Arguments

angleThe angle of rotation

See rotate in transform.h
\ No newline at end of file +lu5 | rotate

rotate

v0.1.7
rotate(angle);

Rotate geometry in 2D.

Arguments

angleThe angle of rotation

See rotate in transform.h
\ No newline at end of file diff --git a/docs/v0.1.7/transform/rotate/meta.json b/docs/v0.1.7/transform/rotate/meta.json index 213386a..b8d7d16 100644 --- a/docs/v0.1.7/transform/rotate/meta.json +++ b/docs/v0.1.7/transform/rotate/meta.json @@ -1 +1 @@ -{"doc":{"bottom_description":"","name":"rotate","description":"Rotate geometry in 2D.","calls":[{"arguments":[{"name":"angle","description":"The angle of rotation"}]}],"_type":"method","examples":{}},"source":{"end_line":32,"start_line":27,"header":"transform.h"}} \ No newline at end of file +{"doc":{"description":"Rotate geometry in 2D.","bottom_description":"","examples":{},"name":"rotate","calls":[{"arguments":[{"name":"angle","description":"The angle of rotation"}]}],"_type":"method"},"source":{"header":"transform.h","start_line":27,"end_line":32}} \ No newline at end of file diff --git a/docs/v0.1.7/transform/rotateX/index.html b/docs/v0.1.7/transform/rotateX/index.html index f901d9a..b2e8df7 100644 --- a/docs/v0.1.7/transform/rotateX/index.html +++ b/docs/v0.1.7/transform/rotateX/index.html @@ -1 +1 @@ -lu5 | rotateX

rotateX

v0.1.7
rotateX(angle);

Rotate geometry around the X axis.

Arguments

angleThe angle of rotation

See rotateX in transform.h
\ No newline at end of file +lu5 | rotateX

rotateX

v0.1.7
rotateX(angle);

Rotate geometry around the X axis.

Arguments

angleThe angle of rotation

See rotateX in transform.h
\ No newline at end of file diff --git a/docs/v0.1.7/transform/rotateX/meta.json b/docs/v0.1.7/transform/rotateX/meta.json index 5f4b0b1..c36e495 100644 --- a/docs/v0.1.7/transform/rotateX/meta.json +++ b/docs/v0.1.7/transform/rotateX/meta.json @@ -1 +1 @@ -{"doc":{"bottom_description":"","name":"rotateX","description":"Rotate geometry around the X axis.","calls":[{"arguments":[{"name":"angle","description":"The angle of rotation"}]}],"_type":"method","examples":{}},"source":{"end_line":11,"start_line":6,"header":"transform.h"}} \ No newline at end of file +{"doc":{"description":"Rotate geometry around the X axis.","bottom_description":"","examples":{},"name":"rotateX","calls":[{"arguments":[{"name":"angle","description":"The angle of rotation"}]}],"_type":"method"},"source":{"header":"transform.h","start_line":6,"end_line":11}} \ No newline at end of file diff --git a/docs/v0.1.7/transform/rotateY/index.html b/docs/v0.1.7/transform/rotateY/index.html index 65f9ddc..ee08bc9 100644 --- a/docs/v0.1.7/transform/rotateY/index.html +++ b/docs/v0.1.7/transform/rotateY/index.html @@ -1 +1 @@ -lu5 | rotateY

rotateY

v0.1.7
rotateY(angle);

Rotate geometry around the Y axis.

Arguments

angleThe angle of rotation

See rotateY in transform.h
\ No newline at end of file +lu5 | rotateY

rotateY

v0.1.7
rotateY(angle);

Rotate geometry around the Y axis.

Arguments

angleThe angle of rotation

See rotateY in transform.h
\ No newline at end of file diff --git a/docs/v0.1.7/transform/rotateY/meta.json b/docs/v0.1.7/transform/rotateY/meta.json index 67b29f5..c6e1821 100644 --- a/docs/v0.1.7/transform/rotateY/meta.json +++ b/docs/v0.1.7/transform/rotateY/meta.json @@ -1 +1 @@ -{"doc":{"bottom_description":"","name":"rotateY","description":"Rotate geometry around the Y axis.","calls":[{"arguments":[{"name":"angle","description":"The angle of rotation"}]}],"_type":"method","examples":{}},"source":{"end_line":18,"start_line":13,"header":"transform.h"}} \ No newline at end of file +{"doc":{"description":"Rotate geometry around the Y axis.","bottom_description":"","examples":{},"name":"rotateY","calls":[{"arguments":[{"name":"angle","description":"The angle of rotation"}]}],"_type":"method"},"source":{"header":"transform.h","start_line":13,"end_line":18}} \ No newline at end of file diff --git a/docs/v0.1.7/transform/rotateZ/index.html b/docs/v0.1.7/transform/rotateZ/index.html index a4a668d..7d71f0e 100644 --- a/docs/v0.1.7/transform/rotateZ/index.html +++ b/docs/v0.1.7/transform/rotateZ/index.html @@ -1 +1 @@ -lu5 | rotateZ

rotateZ

v0.1.7
rotateZ(angle);

Rotate geometry around the Z axis.

Arguments

angleThe angle of rotation

See rotateZ in transform.h
\ No newline at end of file +lu5 | rotateZ

rotateZ

v0.1.7
rotateZ(angle);

Rotate geometry around the Z axis.

Arguments

angleThe angle of rotation

See rotateZ in transform.h
\ No newline at end of file diff --git a/docs/v0.1.7/transform/rotateZ/meta.json b/docs/v0.1.7/transform/rotateZ/meta.json index 6f2d7bd..a9530c0 100644 --- a/docs/v0.1.7/transform/rotateZ/meta.json +++ b/docs/v0.1.7/transform/rotateZ/meta.json @@ -1 +1 @@ -{"doc":{"bottom_description":"","name":"rotateZ","description":"Rotate geometry around the Z axis.","calls":[{"arguments":[{"name":"angle","description":"The angle of rotation"}]}],"_type":"method","examples":{}},"source":{"end_line":25,"start_line":20,"header":"transform.h"}} \ No newline at end of file +{"doc":{"description":"Rotate geometry around the Z axis.","bottom_description":"","examples":{},"name":"rotateZ","calls":[{"arguments":[{"name":"angle","description":"The angle of rotation"}]}],"_type":"method"},"source":{"header":"transform.h","start_line":20,"end_line":25}} \ No newline at end of file diff --git a/docs/v0.1.7/transform/scale/index.html b/docs/v0.1.7/transform/scale/index.html index b0728e2..d41a6bb 100644 --- a/docs/v0.1.7/transform/scale/index.html +++ b/docs/v0.1.7/transform/scale/index.html @@ -1 +1 @@ -lu5 | scale

scale

v0.1.7
scale(x, y, [z]);

scale geometry.

Arguments

xThe x scaling
yThe y scaling
[z]The z scaling

See scale in transform.h
\ No newline at end of file +lu5 | scale

scale

v0.1.7
scale(x, y, [z]);

scale geometry.

Arguments

xThe x scaling
yThe y scaling
[z]The z scaling

See scale in transform.h
\ No newline at end of file diff --git a/docs/v0.1.7/transform/scale/meta.json b/docs/v0.1.7/transform/scale/meta.json index e2d7069..b19a88d 100644 --- a/docs/v0.1.7/transform/scale/meta.json +++ b/docs/v0.1.7/transform/scale/meta.json @@ -1 +1 @@ -{"doc":{"bottom_description":"","name":"scale","description":"scale geometry.","calls":[{"arguments":[{"name":"x","description":"The x scaling"},{"name":"y","description":"The y scaling"},{"name":"[z]","description":"The z scaling"}]}],"_type":"method","examples":{}},"source":{"end_line":41,"start_line":34,"header":"transform.h"}} \ No newline at end of file +{"doc":{"description":"scale geometry.","bottom_description":"","examples":{},"name":"scale","calls":[{"arguments":[{"name":"x","description":"The x scaling"},{"name":"y","description":"The y scaling"},{"name":"[z]","description":"The z scaling"}]}],"_type":"method"},"source":{"header":"transform.h","start_line":34,"end_line":41}} \ No newline at end of file diff --git a/docs/v0.1.7/transform/translate/index.html b/docs/v0.1.7/transform/translate/index.html index 6c1d048..b00704d 100644 --- a/docs/v0.1.7/transform/translate/index.html +++ b/docs/v0.1.7/transform/translate/index.html @@ -1 +1 @@ -lu5 | translate

translate

v0.1.7
translate(x, y, [z]);

translate geometry.

Arguments

xThe x translation
yThe y translation
[z]The z translation

See translate in transform.h
\ No newline at end of file +lu5 | translate

translate

v0.1.7
translate(x, y, [z]);

translate geometry.

Arguments

xThe x translation
yThe y translation
[z]The z translation

See translate in transform.h
\ No newline at end of file diff --git a/docs/v0.1.7/transform/translate/meta.json b/docs/v0.1.7/transform/translate/meta.json index 9383cfd..a3f345e 100644 --- a/docs/v0.1.7/transform/translate/meta.json +++ b/docs/v0.1.7/transform/translate/meta.json @@ -1 +1 @@ -{"doc":{"bottom_description":"","name":"translate","description":"translate geometry.","calls":[{"arguments":[{"name":"x","description":"The x translation"},{"name":"y","description":"The y translation"},{"name":"[z]","description":"The z translation"}]}],"_type":"method","examples":{}},"source":{"end_line":51,"start_line":43,"header":"transform.h"}} \ No newline at end of file +{"doc":{"description":"translate geometry.","bottom_description":"","examples":{},"name":"translate","calls":[{"arguments":[{"name":"x","description":"The x translation"},{"name":"y","description":"The y translation"},{"name":"[z]","description":"The z translation"}]}],"_type":"method"},"source":{"header":"transform.h","start_line":43,"end_line":51}} \ No newline at end of file diff --git a/docs/v0.1.7/typography/index.html b/docs/v0.1.7/typography/index.html index 0739ce2..00a5752 100644 --- a/docs/v0.1.7/typography/index.html +++ b/docs/v0.1.7/typography/index.html @@ -1,4 +1,4 @@ -lu5 | typography

typography

v0.1.7
loadFont(path);

Load a font.

Arguments

pathThe font path on the local system

Returns

fontThe image reference

function setup()
+lu5 | typography

typography

v0.1.7
loadFont(path);

Load a font.

Arguments

pathThe font path on the local system

Returns

fontThe image reference

function setup()
   createWindow(600, 600);
   font = loadFont('/path/to/myfont.ttf');
 end
@@ -8,7 +8,7 @@
 
   textFont(font);
   text('Hello from lu5!', 30, 50);
-end   
See loadFont in typography.h
textSize(size);

Set a font size.

Arguments

sizeThe size of the font in pixels

If this is called using fonts, make sure to call textSize after calling textFont

textSize(56);
-text('Big Text', 50, 50);
See textSize in typography.h
textAlign(mode);

Set a font alignment.

Arguments

modeCENTER, LEFT, RIGHT

textAlign(CENTER);
-text('Big Text', 50, 50);
See textAlign in typography.h
textFont(font);

Set a font family.

Arguments

fontThe font value returned when using loadFont

textFont(myfont);
-text('Hello world!', 100, 200);
See textFont in typography.h
text(str, x, y);

Draw text on the screen.

Arguments

strString to render
xThe x position of the start of the text
yThe y position of the top of the text

Fonts are not yet implemented

text('Hello lu5!', 40, 60);
See text in typography.h
CENTERConstant

Alignment mode for textAlign.

See CENTER in typography.h
LEFTConstant

Alignment mode for textAlign.

See LEFT in typography.h
This project is licensed under the MIT License.
It also includes the FreeType font engine, which is licensed under the FreeType License (FTL).
\ No newline at end of file +end
See loadFont in typography.h
textSize(size);

Set a font size.

Arguments

sizeThe size of the font in pixels

If this is called using fonts, make sure to call textSize after calling textFont

textSize(56);
+text('Big Text', 50, 50);
See textSize in typography.h
textAlign(mode);

Set a font alignment.

Arguments

modeCENTER, LEFT, RIGHT

textAlign(CENTER);
+text('Big Text', 50, 50);
See textAlign in typography.h
textFont(font);

Set a font family.

Arguments

fontThe font value returned when using loadFont

textFont(myfont);
+text('Hello world!', 100, 200);
See textFont in typography.h
text(str, x, y);

Draw text on the screen.

Arguments

strString to render
xThe x position of the start of the text
yThe y position of the top of the text

Fonts are not yet implemented

text('Hello lu5!', 40, 60);
See text in typography.h
CENTERConstant

Alignment mode for textAlign.

See CENTER in typography.h
LEFTConstant

Alignment mode for textAlign.

See LEFT in typography.h
\ No newline at end of file diff --git a/docs/v0.1.7/typography/loadFont/index.html b/docs/v0.1.7/typography/loadFont/index.html index 189bdcf..f2aa281 100644 --- a/docs/v0.1.7/typography/loadFont/index.html +++ b/docs/v0.1.7/typography/loadFont/index.html @@ -1,4 +1,4 @@ -lu5 | loadFont

loadFont

v0.1.7
loadFont(path);

Load a font.

Arguments

pathThe font path on the local system

Returns

fontThe image reference

function setup()
+lu5 | loadFont

loadFont

v0.1.7
loadFont(path);

Load a font.

Arguments

pathThe font path on the local system

Returns

fontThe image reference

function setup()
   createWindow(600, 600);
   font = loadFont('/path/to/myfont.ttf');
 end
@@ -8,4 +8,4 @@
 
   textFont(font);
   text('Hello from lu5!', 30, 50);
-end   
See loadFont in typography.h
This project is licensed under the MIT License.
It also includes the FreeType font engine, which is licensed under the FreeType License (FTL).
\ No newline at end of file +end
See loadFont in typography.h
\ No newline at end of file diff --git a/docs/v0.1.7/typography/loadFont/meta.json b/docs/v0.1.7/typography/loadFont/meta.json index b07151e..51d1840 100644 --- a/docs/v0.1.7/typography/loadFont/meta.json +++ b/docs/v0.1.7/typography/loadFont/meta.json @@ -1 +1 @@ -{"doc":{"bottom_description":"","_return":{"description":"The image reference","var":"font"},"name":"loadFont","description":"Load a font.","calls":[{"arguments":[{"name":"path","description":"The font path on the local system"}]}],"_type":"method","examples":["function setup()\n createWindow(600, 600);\n font = loadFont('/path/to/myfont.ttf');\nend\n\nfunction draw()\n background(51);\n\n textFont(font);\n text('Hello from lu5!', 30, 50);\nend "]},"source":{"end_line":27,"start_line":6,"header":"typography.h"}} \ No newline at end of file +{"doc":{"description":"Load a font.","bottom_description":"","examples":["function setup()\n createWindow(600, 600);\n font = loadFont('/path/to/myfont.ttf');\nend\n\nfunction draw()\n background(51);\n\n textFont(font);\n text('Hello from lu5!', 30, 50);\nend "],"name":"loadFont","_type":"method","calls":[{"arguments":[{"name":"path","description":"The font path on the local system"}]}],"_return":{"var":"font","description":"The image reference"}},"source":{"header":"typography.h","start_line":6,"end_line":27}} \ No newline at end of file diff --git a/docs/v0.1.7/typography/text/index.html b/docs/v0.1.7/typography/text/index.html index b318823..5807325 100644 --- a/docs/v0.1.7/typography/text/index.html +++ b/docs/v0.1.7/typography/text/index.html @@ -1 +1 @@ -lu5 | text

text

v0.1.7
text(str, x, y);

Draw text on the screen.

Arguments

strString to render
xThe x position of the start of the text
yThe y position of the top of the text

Fonts are not yet implemented

text('Hello lu5!', 40, 60);
See text in typography.h
\ No newline at end of file +lu5 | text

text

v0.1.7
text(str, x, y);

Draw text on the screen.

Arguments

strString to render
xThe x position of the start of the text
yThe y position of the top of the text

Fonts are not yet implemented

text('Hello lu5!', 40, 60);
See text in typography.h
\ No newline at end of file diff --git a/docs/v0.1.7/typography/text/meta.json b/docs/v0.1.7/typography/text/meta.json index 8e3cd43..76d1a94 100644 --- a/docs/v0.1.7/typography/text/meta.json +++ b/docs/v0.1.7/typography/text/meta.json @@ -1 +1 @@ -{"doc":{"bottom_description":"Fonts are not yet implemented","name":"text","description":"Draw text on the screen.","calls":[{"arguments":[{"name":"str","description":"String to render"},{"name":"x","description":"The x position of the start of the text"},{"name":"y","description":"The y position of the top of the text"}]}],"_type":"method","examples":["text('Hello lu5!', 40, 60);"]},"source":{"end_line":82,"start_line":69,"header":"typography.h"}} \ No newline at end of file +{"doc":{"description":"Draw text on the screen.","bottom_description":"Fonts are not yet implemented","examples":["text('Hello lu5!', 40, 60);"],"name":"text","calls":[{"arguments":[{"name":"str","description":"String to render"},{"name":"x","description":"The x position of the start of the text"},{"name":"y","description":"The y position of the top of the text"}]}],"_type":"method"},"source":{"header":"typography.h","start_line":69,"end_line":82}} \ No newline at end of file diff --git a/docs/v0.1.7/typography/textAlign/index.html b/docs/v0.1.7/typography/textAlign/index.html index 4bdf9a9..4070e76 100644 --- a/docs/v0.1.7/typography/textAlign/index.html +++ b/docs/v0.1.7/typography/textAlign/index.html @@ -1,2 +1,2 @@ -lu5 | textAlign

textAlign

v0.1.7
textAlign(mode);

Set a font alignment.

Arguments

modeCENTER, LEFT, RIGHT

textAlign(CENTER);
-text('Big Text', 50, 50);
See textAlign in typography.h
\ No newline at end of file +lu5 | textAlign

textAlign

v0.1.7
textAlign(mode);

Set a font alignment.

Arguments

modeCENTER, LEFT, RIGHT

textAlign(CENTER);
+text('Big Text', 50, 50);
See textAlign in typography.h
\ No newline at end of file diff --git a/docs/v0.1.7/typography/textAlign/meta.json b/docs/v0.1.7/typography/textAlign/meta.json index a7f3de7..47848aa 100644 --- a/docs/v0.1.7/typography/textAlign/meta.json +++ b/docs/v0.1.7/typography/textAlign/meta.json @@ -1 +1 @@ -{"doc":{"bottom_description":"","name":"textAlign","description":"Set a font alignment.","calls":[{"arguments":[{"name":"mode","description":"`CENTER`, `LEFT`, `RIGHT`"}]}],"_type":"method","examples":["textAlign(CENTER);\ntext('Big Text', 50, 50);"]},"source":{"end_line":55,"start_line":44,"header":"typography.h"}} \ No newline at end of file +{"doc":{"description":"Set a font alignment.","bottom_description":"","examples":["textAlign(CENTER);\ntext('Big Text', 50, 50);"],"name":"textAlign","calls":[{"arguments":[{"name":"mode","description":"`CENTER`, `LEFT`, `RIGHT`"}]}],"_type":"method"},"source":{"header":"typography.h","start_line":44,"end_line":55}} \ No newline at end of file diff --git a/docs/v0.1.7/typography/textFont/index.html b/docs/v0.1.7/typography/textFont/index.html index 99afddb..1bc4fbe 100644 --- a/docs/v0.1.7/typography/textFont/index.html +++ b/docs/v0.1.7/typography/textFont/index.html @@ -1,2 +1,2 @@ -lu5 | textFont

textFont

v0.1.7
textFont(font);

Set a font family.

Arguments

fontThe font value returned when using loadFont

textFont(myfont);
-text('Hello world!', 100, 200);
See textFont in typography.h
\ No newline at end of file +lu5 | textFont

textFont

v0.1.7
textFont(font);

Set a font family.

Arguments

fontThe font value returned when using loadFont

textFont(myfont);
+text('Hello world!', 100, 200);
See textFont in typography.h
\ No newline at end of file diff --git a/docs/v0.1.7/typography/textFont/meta.json b/docs/v0.1.7/typography/textFont/meta.json index 148ac68..f6d2532 100644 --- a/docs/v0.1.7/typography/textFont/meta.json +++ b/docs/v0.1.7/typography/textFont/meta.json @@ -1 +1 @@ -{"doc":{"bottom_description":"","name":"textFont","description":"Set a font family.","calls":[{"arguments":[{"name":"font","description":"The font value returned when using `loadFont`"}]}],"_type":"method","examples":["textFont(myfont);\ntext('Hello world!', 100, 200);"]},"source":{"end_line":67,"start_line":57,"header":"typography.h"}} \ No newline at end of file +{"doc":{"description":"Set a font family.","bottom_description":"","examples":["textFont(myfont);\ntext('Hello world!', 100, 200);"],"name":"textFont","calls":[{"arguments":[{"name":"font","description":"The font value returned when using `loadFont`"}]}],"_type":"method"},"source":{"header":"typography.h","start_line":57,"end_line":67}} \ No newline at end of file diff --git a/docs/v0.1.7/typography/textSize/index.html b/docs/v0.1.7/typography/textSize/index.html index 91ddea4..fae3cbc 100644 --- a/docs/v0.1.7/typography/textSize/index.html +++ b/docs/v0.1.7/typography/textSize/index.html @@ -1,2 +1,2 @@ -lu5 | textSize

textSize

v0.1.7
textSize(size);

Set a font size.

Arguments

sizeThe size of the font in pixels

If this is called using fonts, make sure to call textSize after calling textFont

textSize(56);
-text('Big Text', 50, 50);
See textSize in typography.h
\ No newline at end of file +lu5 | textSize

textSize

v0.1.7
textSize(size);

Set a font size.

Arguments

sizeThe size of the font in pixels

If this is called using fonts, make sure to call textSize after calling textFont

textSize(56);
+text('Big Text', 50, 50);
See textSize in typography.h
\ No newline at end of file diff --git a/docs/v0.1.7/typography/textSize/meta.json b/docs/v0.1.7/typography/textSize/meta.json index fed65fd..aa6a900 100644 --- a/docs/v0.1.7/typography/textSize/meta.json +++ b/docs/v0.1.7/typography/textSize/meta.json @@ -1 +1 @@ -{"doc":{"bottom_description":"If this is called using fonts, make sure to call textSize after calling textFont","name":"textSize","description":"Set a font size.","calls":[{"arguments":[{"name":"size","description":"The size of the font in pixels"}]}],"_type":"method","examples":["textSize(56);\ntext('Big Text', 50, 50);"]},"source":{"end_line":42,"start_line":29,"header":"typography.h"}} \ No newline at end of file +{"doc":{"description":"Set a font size.","bottom_description":"If this is called using fonts, make sure to call textSize after calling textFont","examples":["textSize(56);\ntext('Big Text', 50, 50);"],"name":"textSize","calls":[{"arguments":[{"name":"size","description":"The size of the font in pixels"}]}],"_type":"method"},"source":{"header":"typography.h","start_line":29,"end_line":42}} \ No newline at end of file diff --git a/docs/v0.1.7/vector/Vector.add/index.html b/docs/v0.1.7/vector/Vector.add/index.html index b9634c8..cedcf85 100644 --- a/docs/v0.1.7/vector/Vector.add/index.html +++ b/docs/v0.1.7/vector/Vector.add/index.html @@ -1,4 +1,4 @@ -lu5 | Vector.add

Vector.add

v0.1.7
Vector.add(a, b);

No description

Arguments

aThe first vector
bThe second vector

Returns

VectorThe added vector

local a = createVector(4, 2);
+lu5 | Vector.add

Vector.add

v0.1.7
Vector.add(a, b);

No description

Arguments

aThe first vector
bThe second vector

Returns

VectorThe added vector

local a = createVector(4, 2);
 local b = createVector(2, 1);
 
 -- Non-mutable
@@ -8,4 +8,4 @@
 
 -- Mutable
 print(a:add(b));	-- { 6.0, 3.0 }
-print(a) 		-- { 6.0, 3.0 }
See Vector.add in lu5_vector.h
This project is licensed under the MIT License.
It also includes the FreeType font engine, which is licensed under the FreeType License (FTL).
\ No newline at end of file +print(a) -- { 6.0, 3.0 }
See Vector.add in lu5_vector.h
\ No newline at end of file diff --git a/docs/v0.1.7/vector/Vector.add/meta.json b/docs/v0.1.7/vector/Vector.add/meta.json index b76e30f..ca97d8b 100644 --- a/docs/v0.1.7/vector/Vector.add/meta.json +++ b/docs/v0.1.7/vector/Vector.add/meta.json @@ -1 +1 @@ -{"doc":{"bottom_description":"","_return":{"description":"The added vector","var":"Vector"},"name":"Vector.add","description":"","calls":[{"arguments":[{"name":"a","description":"The first vector"},{"name":"b","description":"The second vector"}]}],"_type":"method","examples":["local a = createVector(4, 2);\nlocal b = createVector(2, 1);\n\n-- Non-mutable\nprint(Vector.add(a, b)); -- { 6.0, 3.0 }\nprint(a + b); -- { 6.0, 3.0 }\nprint(a); -- { 4.0, 2.0 }\n\n-- Mutable\nprint(a:add(b));\t-- { 6.0, 3.0 }\nprint(a) \t\t-- { 6.0, 3.0 }"]},"source":{"end_line":117,"start_line":95,"header":"lu5_vector.h"}} \ No newline at end of file +{"doc":{"description":"","bottom_description":"","examples":["local a = createVector(4, 2);\nlocal b = createVector(2, 1);\n\n-- Non-mutable\nprint(Vector.add(a, b)); -- { 6.0, 3.0 }\nprint(a + b); -- { 6.0, 3.0 }\nprint(a); -- { 4.0, 2.0 }\n\n-- Mutable\nprint(a:add(b));\t-- { 6.0, 3.0 }\nprint(a) \t\t-- { 6.0, 3.0 }"],"name":"Vector.add","_type":"method","calls":[{"arguments":[{"name":"a","description":"The first vector"},{"name":"b","description":"The second vector"}]}],"_return":{"var":"Vector","description":"The added vector"}},"source":{"header":"lu5_vector.h","start_line":95,"end_line":117}} \ No newline at end of file diff --git a/docs/v0.1.7/vector/Vector.copy/index.html b/docs/v0.1.7/vector/Vector.copy/index.html index e224514..e624394 100644 --- a/docs/v0.1.7/vector/Vector.copy/index.html +++ b/docs/v0.1.7/vector/Vector.copy/index.html @@ -1,5 +1,5 @@ -lu5 | Vector.copy

Vector.copy

v0.1.7
Vector.copy();

No description

Returns

VectorThe copied vector

local a = createVector(300, 450, 400);
+lu5 | Vector.copy

Vector.copy

v0.1.7
Vector.copy();

No description

Returns

VectorThe copied vector

local a = createVector(300, 450, 400);
 
 local copy_1 = a:copy();
 
-local copy_2 = Vector.copy(a);
See Vector.copy in lu5_vector.h
This project is licensed under the MIT License.
It also includes the FreeType font engine, which is licensed under the FreeType License (FTL).
\ No newline at end of file +local copy_2 = Vector.copy(a);
See Vector.copy in lu5_vector.h
\ No newline at end of file diff --git a/docs/v0.1.7/vector/Vector.copy/meta.json b/docs/v0.1.7/vector/Vector.copy/meta.json index 1b3f58b..7372f27 100644 --- a/docs/v0.1.7/vector/Vector.copy/meta.json +++ b/docs/v0.1.7/vector/Vector.copy/meta.json @@ -1 +1 @@ -{"doc":{"bottom_description":"","_return":{"description":"The copied vector","var":"Vector"},"name":"Vector.copy","description":"","calls":[{"arguments":{}}],"_type":"method","examples":["local a = createVector(300, 450, 400);\n\nlocal copy_1 = a:copy();\n\nlocal copy_2 = Vector.copy(a);"]},"source":{"end_line":231,"start_line":218,"header":"lu5_vector.h"}} \ No newline at end of file +{"doc":{"description":"","bottom_description":"","examples":["local a = createVector(300, 450, 400);\n\nlocal copy_1 = a:copy();\n\nlocal copy_2 = Vector.copy(a);"],"name":"Vector.copy","_type":"method","calls":[{"arguments":{}}],"_return":{"var":"Vector","description":"The copied vector"}},"source":{"header":"lu5_vector.h","start_line":218,"end_line":231}} \ No newline at end of file diff --git a/docs/v0.1.7/vector/Vector.dist/index.html b/docs/v0.1.7/vector/Vector.dist/index.html index 84a1b2d..e301d78 100644 --- a/docs/v0.1.7/vector/Vector.dist/index.html +++ b/docs/v0.1.7/vector/Vector.dist/index.html @@ -1,5 +1,5 @@ -lu5 | Vector.dist

Vector.dist

v0.1.7
Vector.dist(a, b);

No description

Arguments

aThe first point
bThe second point

Returns

numberThe distance between the two points

local a = createVector(300, 500);
+lu5 | Vector.dist

Vector.dist

v0.1.7
Vector.dist(a, b);

No description

Arguments

aThe first point
bThe second point

Returns

numberThe distance between the two points

local a = createVector(300, 500);
 local b = createVector(200, 250);
 
 local distance = a:dist(b);
-print(distance);
See Vector.dist in lu5_vector.h
This project is licensed under the MIT License.
It also includes the FreeType font engine, which is licensed under the FreeType License (FTL).
\ No newline at end of file +print(distance);
See Vector.dist in lu5_vector.h
\ No newline at end of file diff --git a/docs/v0.1.7/vector/Vector.dist/meta.json b/docs/v0.1.7/vector/Vector.dist/meta.json index 0192c00..8100142 100644 --- a/docs/v0.1.7/vector/Vector.dist/meta.json +++ b/docs/v0.1.7/vector/Vector.dist/meta.json @@ -1 +1 @@ -{"doc":{"bottom_description":"","_return":{"description":"The distance between the two points","var":"number"},"name":"Vector.dist","description":"","calls":[{"arguments":[{"name":"a","description":"The first point"},{"name":"b","description":"The second point"}]}],"_type":"method","examples":["local a = createVector(300, 500);\nlocal b = createVector(200, 250);\n\nlocal distance = a:dist(b);\nprint(distance);"]},"source":{"end_line":69,"start_line":53,"header":"lu5_vector.h"}} \ No newline at end of file +{"doc":{"description":"","bottom_description":"","examples":["local a = createVector(300, 500);\nlocal b = createVector(200, 250);\n\nlocal distance = a:dist(b);\nprint(distance);"],"name":"Vector.dist","_type":"method","calls":[{"arguments":[{"name":"a","description":"The first point"},{"name":"b","description":"The second point"}]}],"_return":{"var":"number","description":"The distance between the two points"}},"source":{"header":"lu5_vector.h","start_line":53,"end_line":69}} \ No newline at end of file diff --git a/docs/v0.1.7/vector/Vector.div/index.html b/docs/v0.1.7/vector/Vector.div/index.html index 3d3282b..3277f28 100644 --- a/docs/v0.1.7/vector/Vector.div/index.html +++ b/docs/v0.1.7/vector/Vector.div/index.html @@ -1,4 +1,4 @@ -lu5 | Vector.div

Vector.div

v0.1.7
Vector.div(a, b);

No description

Arguments

aThe first vector
bThe second vector

Returns

VectorThe divided vector

local a = createVector(4, 2);
+lu5 | Vector.div

Vector.div

v0.1.7
Vector.div(a, b);

No description

Arguments

aThe first vector
bThe second vector

Returns

VectorThe divided vector

local a = createVector(4, 2);
 local b = createVector(2, 1);
 
 -- Non-mutable
@@ -8,4 +8,4 @@
 
 -- Mutable
 print(a:div(b));	-- { 2.0, 2.0 }
-print(a) 		-- { 2.0, 2.0 }
See Vector.div in lu5_vector.h
This project is licensed under the MIT License.
It also includes the FreeType font engine, which is licensed under the FreeType License (FTL).
\ No newline at end of file +print(a) -- { 2.0, 2.0 }
See Vector.div in lu5_vector.h
\ No newline at end of file diff --git a/docs/v0.1.7/vector/Vector.div/meta.json b/docs/v0.1.7/vector/Vector.div/meta.json index 7f017f9..adfe70e 100644 --- a/docs/v0.1.7/vector/Vector.div/meta.json +++ b/docs/v0.1.7/vector/Vector.div/meta.json @@ -1 +1 @@ -{"doc":{"bottom_description":"","_return":{"description":"The divided vector","var":"Vector"},"name":"Vector.div","description":"","calls":[{"arguments":[{"name":"a","description":"The first vector"},{"name":"b","description":"The second vector"}]}],"_type":"method","examples":["local a = createVector(4, 2);\nlocal b = createVector(2, 1);\n\n-- Non-mutable\nprint(Vector.div(a, b)); -- { 2.0, 2.0 }\nprint(a / b); -- { 2.0, 2.0 }\nprint(a); -- { 4.0, 2.0 }\n\n-- Mutable\nprint(a:div(b));\t-- { 2.0, 2.0 }\nprint(a) \t\t-- { 2.0, 2.0 }"]},"source":{"end_line":189,"start_line":167,"header":"lu5_vector.h"}} \ No newline at end of file +{"doc":{"description":"","bottom_description":"","examples":["local a = createVector(4, 2);\nlocal b = createVector(2, 1);\n\n-- Non-mutable\nprint(Vector.div(a, b)); -- { 2.0, 2.0 }\nprint(a / b); -- { 2.0, 2.0 }\nprint(a); -- { 4.0, 2.0 }\n\n-- Mutable\nprint(a:div(b));\t-- { 2.0, 2.0 }\nprint(a) \t\t-- { 2.0, 2.0 }"],"name":"Vector.div","_type":"method","calls":[{"arguments":[{"name":"a","description":"The first vector"},{"name":"b","description":"The second vector"}]}],"_return":{"var":"Vector","description":"The divided vector"}},"source":{"header":"lu5_vector.h","start_line":167,"end_line":189}} \ No newline at end of file diff --git a/docs/v0.1.7/vector/Vector.dot/index.html b/docs/v0.1.7/vector/Vector.dot/index.html index 572cd5a..b93a223 100644 --- a/docs/v0.1.7/vector/Vector.dot/index.html +++ b/docs/v0.1.7/vector/Vector.dot/index.html @@ -1,4 +1,4 @@ -lu5 | Vector.dot

Vector.dot

v0.1.7
Vector.dot(a, b);

No description

Arguments

aThe first vector
bThe second vector

Returns

numberThe dot product

local a = createVector(3, 5);
+lu5 | Vector.dot

Vector.dot

v0.1.7
Vector.dot(a, b);

No description

Arguments

aThe first vector
bThe second vector

Returns

numberThe dot product

local a = createVector(3, 5);
 local b = createVector(1, 3);
 
 -- From prototype
@@ -8,4 +8,4 @@
 print(Vector.dot(a, b)); -- 18.0
 
 -- With concat syntax
-print(a .. b); -- 18.0
See Vector.dot in lu5_vector.h
This project is licensed under the MIT License.
It also includes the FreeType font engine, which is licensed under the FreeType License (FTL).
\ No newline at end of file +print(a .. b); -- 18.0
See Vector.dot in lu5_vector.h
\ No newline at end of file diff --git a/docs/v0.1.7/vector/Vector.dot/meta.json b/docs/v0.1.7/vector/Vector.dot/meta.json index 6a869bb..9740e24 100644 --- a/docs/v0.1.7/vector/Vector.dot/meta.json +++ b/docs/v0.1.7/vector/Vector.dot/meta.json @@ -1 +1 @@ -{"doc":{"bottom_description":"","_return":{"description":"The dot product","var":"number"},"name":"Vector.dot","description":"","calls":[{"arguments":[{"name":"a","description":"The first vector"},{"name":"b","description":"The second vector"}]}],"_type":"method","examples":["local a = createVector(3, 5);\nlocal b = createVector(1, 3);\n\n-- From prototype\nprint(a:dot(b)); -- 18.0\n\n-- With static method\nprint(Vector.dot(a, b)); -- 18.0\n\n-- With concat syntax\nprint(a .. b); -- 18.0"]},"source":{"end_line":93,"start_line":71,"header":"lu5_vector.h"}} \ No newline at end of file +{"doc":{"description":"","bottom_description":"","examples":["local a = createVector(3, 5);\nlocal b = createVector(1, 3);\n\n-- From prototype\nprint(a:dot(b)); -- 18.0\n\n-- With static method\nprint(Vector.dot(a, b)); -- 18.0\n\n-- With concat syntax\nprint(a .. b); -- 18.0"],"name":"Vector.dot","_type":"method","calls":[{"arguments":[{"name":"a","description":"The first vector"},{"name":"b","description":"The second vector"}]}],"_return":{"var":"number","description":"The dot product"}},"source":{"header":"lu5_vector.h","start_line":71,"end_line":93}} \ No newline at end of file diff --git a/docs/v0.1.7/vector/Vector.idiv/index.html b/docs/v0.1.7/vector/Vector.idiv/index.html index 64a2615..5cdacd2 100644 --- a/docs/v0.1.7/vector/Vector.idiv/index.html +++ b/docs/v0.1.7/vector/Vector.idiv/index.html @@ -1,4 +1,4 @@ -lu5 | Vector.idiv

Vector.idiv

v0.1.7
Vector.idiv(a, b);

No description

Arguments

aThe first vector
bThe second vector

Returns

VectorThe divided vector

local a = createVector(7, 8);
+lu5 | Vector.idiv

Vector.idiv

v0.1.7
Vector.idiv(a, b);

No description

Arguments

aThe first vector
bThe second vector

Returns

VectorThe divided vector

local a = createVector(7, 8);
 local b = createVector(2, 3);
 
 -- Non-mutable
@@ -8,4 +8,4 @@
 
 -- Mutable
 print(a:idiv(b)); -- { 3.0, 2.0 }
-print(a)          -- { 3.0, 2.0 }
See Vector.idiv in lu5_vector.h
This project is licensed under the MIT License.
It also includes the FreeType font engine, which is licensed under the FreeType License (FTL).
\ No newline at end of file +print(a) -- { 3.0, 2.0 }
See Vector.idiv in lu5_vector.h
\ No newline at end of file diff --git a/docs/v0.1.7/vector/Vector.idiv/meta.json b/docs/v0.1.7/vector/Vector.idiv/meta.json index 932de37..351e610 100644 --- a/docs/v0.1.7/vector/Vector.idiv/meta.json +++ b/docs/v0.1.7/vector/Vector.idiv/meta.json @@ -1 +1 @@ -{"doc":{"bottom_description":"","_return":{"description":"The divided vector","var":"Vector"},"name":"Vector.idiv","description":"","calls":[{"arguments":[{"name":"a","description":"The first vector"},{"name":"b","description":"The second vector"}]}],"_type":"method","examples":["local a = createVector(7, 8);\nlocal b = createVector(2, 3);\n\n-- Non-mutable\nprint(Vector.idiv(a, b)) -- { 3.0, 2.0 }\nprint(a // b); -- { 3.0, 2.0 }\nprint(a); -- { 7.0, 8.0 }\n\n-- Mutable\nprint(a:idiv(b)); -- { 3.0, 2.0 }\nprint(a) -- { 3.0, 2.0 }"]},"source":{"end_line":215,"start_line":193,"header":"lu5_vector.h"}} \ No newline at end of file +{"doc":{"description":"","bottom_description":"","examples":["local a = createVector(7, 8);\nlocal b = createVector(2, 3);\n\n-- Non-mutable\nprint(Vector.idiv(a, b)) -- { 3.0, 2.0 }\nprint(a // b); -- { 3.0, 2.0 }\nprint(a); -- { 7.0, 8.0 }\n\n-- Mutable\nprint(a:idiv(b)); -- { 3.0, 2.0 }\nprint(a) -- { 3.0, 2.0 }"],"name":"Vector.idiv","_type":"method","calls":[{"arguments":[{"name":"a","description":"The first vector"},{"name":"b","description":"The second vector"}]}],"_return":{"var":"Vector","description":"The divided vector"}},"source":{"header":"lu5_vector.h","start_line":193,"end_line":215}} \ No newline at end of file diff --git a/docs/v0.1.7/vector/Vector.mult/index.html b/docs/v0.1.7/vector/Vector.mult/index.html index 6887208..3030d1e 100644 --- a/docs/v0.1.7/vector/Vector.mult/index.html +++ b/docs/v0.1.7/vector/Vector.mult/index.html @@ -1,4 +1,4 @@ -lu5 | Vector.mult

Vector.mult

v0.1.7
Vector.mult(a, b);

No description

Arguments

aThe first vector
bThe second vector

Returns

VectorThe multiplied vector

local a = createVector(3, 5);
+lu5 | Vector.mult

Vector.mult

v0.1.7
Vector.mult(a, b);

No description

Arguments

aThe first vector
bThe second vector

Returns

VectorThe multiplied vector

local a = createVector(3, 5);
 local b = createVector(2, 3);
 
 -- Non-mutable
@@ -8,4 +8,4 @@
 
 -- Mutable
 print(a:mult(b)); -- { 3.0, 15.0 }
-print(a);         -- { 3.0, 15.0 }
See Vector.mult in lu5_vector.h
This project is licensed under the MIT License.
It also includes the FreeType font engine, which is licensed under the FreeType License (FTL).
\ No newline at end of file +print(a); -- { 3.0, 15.0 }
See Vector.mult in lu5_vector.h
\ No newline at end of file diff --git a/docs/v0.1.7/vector/Vector.mult/meta.json b/docs/v0.1.7/vector/Vector.mult/meta.json index ea19914..4e987a1 100644 --- a/docs/v0.1.7/vector/Vector.mult/meta.json +++ b/docs/v0.1.7/vector/Vector.mult/meta.json @@ -1 +1 @@ -{"doc":{"bottom_description":"","_return":{"description":"The multiplied vector","var":"Vector"},"name":"Vector.mult","description":"","calls":[{"arguments":[{"name":"a","description":"The first vector"},{"name":"b","description":"The second vector"}]}],"_type":"method","examples":["local a = createVector(3, 5);\nlocal b = createVector(2, 3);\n\n-- Non-mutable\nprint(Vector.mult(a, b)); -- { 6.0, 15.0 }\nprint(a * b); -- { 6.0, 15.0 }\nprint(a); -- { 3.0, 5.0 }\n\n-- Mutable\nprint(a:mult(b)); -- { 3.0, 15.0 }\nprint(a); -- { 3.0, 15.0 }"]},"source":{"end_line":165,"start_line":143,"header":"lu5_vector.h"}} \ No newline at end of file +{"doc":{"description":"","bottom_description":"","examples":["local a = createVector(3, 5);\nlocal b = createVector(2, 3);\n\n-- Non-mutable\nprint(Vector.mult(a, b)); -- { 6.0, 15.0 }\nprint(a * b); -- { 6.0, 15.0 }\nprint(a); -- { 3.0, 5.0 }\n\n-- Mutable\nprint(a:mult(b)); -- { 3.0, 15.0 }\nprint(a); -- { 3.0, 15.0 }"],"name":"Vector.mult","_type":"method","calls":[{"arguments":[{"name":"a","description":"The first vector"},{"name":"b","description":"The second vector"}]}],"_return":{"var":"Vector","description":"The multiplied vector"}},"source":{"header":"lu5_vector.h","start_line":143,"end_line":165}} \ No newline at end of file diff --git a/docs/v0.1.7/vector/Vector.print/index.html b/docs/v0.1.7/vector/Vector.print/index.html index 1775c68..507bfa0 100644 --- a/docs/v0.1.7/vector/Vector.print/index.html +++ b/docs/v0.1.7/vector/Vector.print/index.html @@ -1,4 +1,4 @@ -lu5 | Vector.print

Vector.print

v0.1.7
Vector.print();

Since a Vector implements a print method, it can be used in the print function.

local a = createVector(3, 5);
+lu5 | Vector.print

Vector.print

v0.1.7
Vector.print();

Since a Vector implements a print method, it can be used in the print function.

local a = createVector(3, 5);
 
 -- With print
 print(a);
@@ -7,4 +7,4 @@
 Vector.print(a);
 
 -- with instance
-a:print();
See Vector.print in lu5_vector.h
This project is licensed under the MIT License.
It also includes the FreeType font engine, which is licensed under the FreeType License (FTL).
\ No newline at end of file +a:print();
See Vector.print in lu5_vector.h
\ No newline at end of file diff --git a/docs/v0.1.7/vector/Vector.print/meta.json b/docs/v0.1.7/vector/Vector.print/meta.json index 1fdbede..15b65f9 100644 --- a/docs/v0.1.7/vector/Vector.print/meta.json +++ b/docs/v0.1.7/vector/Vector.print/meta.json @@ -1 +1 @@ -{"doc":{"bottom_description":"","name":"Vector.print","description":"Since a Vector implements a print method, it can be used in the print function.","calls":[{"arguments":{}}],"_type":"method","examples":["local a = createVector(3, 5);\n\n-- With print\nprint(a);\n\n-- With class method\nVector.print(a);\n\n-- with instance\na:print();"]},"source":{"end_line":51,"start_line":34,"header":"lu5_vector.h"}} \ No newline at end of file +{"doc":{"description":"Since a Vector implements a print method, it can be used in the print function.","bottom_description":"","examples":["local a = createVector(3, 5);\n\n-- With print\nprint(a);\n\n-- With class method\nVector.print(a);\n\n-- with instance\na:print();"],"name":"Vector.print","calls":[{"arguments":{}}],"_type":"method"},"source":{"header":"lu5_vector.h","start_line":34,"end_line":51}} \ No newline at end of file diff --git a/docs/v0.1.7/vector/Vector.sub/index.html b/docs/v0.1.7/vector/Vector.sub/index.html index 09cd994..27f145e 100644 --- a/docs/v0.1.7/vector/Vector.sub/index.html +++ b/docs/v0.1.7/vector/Vector.sub/index.html @@ -1,4 +1,4 @@ -lu5 | Vector.sub

Vector.sub

v0.1.7
Vector.sub(a, b);

No description

Arguments

aThe first vector
bThe second vector

Returns

VectorThe subtracted vector

local a = createVector(3, 5);
+lu5 | Vector.sub

Vector.sub

v0.1.7
Vector.sub(a, b);

No description

Arguments

aThe first vector
bThe second vector

Returns

VectorThe subtracted vector

local a = createVector(3, 5);
 local b = createVector(2, 3);
 
 -- Non-mutable
@@ -8,4 +8,4 @@
 
 -- Mutable
 print(a:sub(b)); -- { 1.0, 2.0 }
-print(a);        -- { 1.0, 2.0 }
See Vector.sub in lu5_vector.h
This project is licensed under the MIT License.
It also includes the FreeType font engine, which is licensed under the FreeType License (FTL).
\ No newline at end of file +print(a); -- { 1.0, 2.0 }
See Vector.sub in lu5_vector.h
\ No newline at end of file diff --git a/docs/v0.1.7/vector/Vector.sub/meta.json b/docs/v0.1.7/vector/Vector.sub/meta.json index e0b2ca2..70b4e71 100644 --- a/docs/v0.1.7/vector/Vector.sub/meta.json +++ b/docs/v0.1.7/vector/Vector.sub/meta.json @@ -1 +1 @@ -{"doc":{"bottom_description":"","_return":{"description":"The subtracted vector","var":"Vector"},"name":"Vector.sub","description":"","calls":[{"arguments":[{"name":"a","description":"The first vector"},{"name":"b","description":"The second vector"}]}],"_type":"method","examples":["local a = createVector(3, 5);\nlocal b = createVector(2, 3);\n\n-- Non-mutable\nprint(Vector.sub(a, b)); -- { 1.0, 2.0 }\nprint(a - b); -- { 1.0, 2.0 }\nprint(a); -- { 3.0, 5.0 }\n\n-- Mutable\nprint(a:sub(b)); -- { 1.0, 2.0 }\nprint(a); -- { 1.0, 2.0 }"]},"source":{"end_line":141,"start_line":119,"header":"lu5_vector.h"}} \ No newline at end of file +{"doc":{"description":"","bottom_description":"","examples":["local a = createVector(3, 5);\nlocal b = createVector(2, 3);\n\n-- Non-mutable\nprint(Vector.sub(a, b)); -- { 1.0, 2.0 }\nprint(a - b); -- { 1.0, 2.0 }\nprint(a); -- { 3.0, 5.0 }\n\n-- Mutable\nprint(a:sub(b)); -- { 1.0, 2.0 }\nprint(a); -- { 1.0, 2.0 }"],"name":"Vector.sub","_type":"method","calls":[{"arguments":[{"name":"a","description":"The first vector"},{"name":"b","description":"The second vector"}]}],"_return":{"var":"Vector","description":"The subtracted vector"}},"source":{"header":"lu5_vector.h","start_line":119,"end_line":141}} \ No newline at end of file diff --git a/docs/v0.1.7/vector/Vector/index.html b/docs/v0.1.7/vector/Vector/index.html index 440533a..466263c 100644 --- a/docs/v0.1.7/vector/Vector/index.html +++ b/docs/v0.1.7/vector/Vector/index.html @@ -1,7 +1,7 @@ -lu5 | Vector

Vector

v0.1.7
Vector();

No description

Returns

VectorThe composed vector

local a = createVector(300, 450, 400);
+lu5 | Vector

Vector

v0.1.7
Vector();

No description

Returns

VectorThe composed vector

local a = createVector(300, 450, 400);
 
 local copy = a.xyz;
 
 local a_2d = a.xy; -- { 300, 450 }
 local b = a.xyx; -- { 300, 450, 300 }
-local c = a.zxy; -- { 400, 300, 450 }
See Vector in lu5_vector.h
This project is licensed under the MIT License.
It also includes the FreeType font engine, which is licensed under the FreeType License (FTL).
\ No newline at end of file +local c = a.zxy; -- { 400, 300, 450 }
See Vector in lu5_vector.h
\ No newline at end of file diff --git a/docs/v0.1.7/vector/Vector/meta.json b/docs/v0.1.7/vector/Vector/meta.json index f0ed236..b8d4d81 100644 --- a/docs/v0.1.7/vector/Vector/meta.json +++ b/docs/v0.1.7/vector/Vector/meta.json @@ -1 +1 @@ -{"doc":{"bottom_description":"","_return":{"description":"The composed vector","var":"Vector"},"name":"Vector","description":"","calls":[{"arguments":{}}],"_type":"method","examples":["local a = createVector(300, 450, 400);\n\nlocal copy = a.xyz;\n\nlocal a_2d = a.xy; -- { 300, 450 }\nlocal b = a.xyx; -- { 300, 450, 300 }\nlocal c = a.zxy; -- { 400, 300, 450 }"]},"source":{"end_line":253,"start_line":233,"header":"lu5_vector.h"}} \ No newline at end of file +{"doc":{"description":"","bottom_description":"","examples":["local a = createVector(300, 450, 400);\n\nlocal copy = a.xyz;\n\nlocal a_2d = a.xy; -- { 300, 450 }\nlocal b = a.xyx; -- { 300, 450, 300 }\nlocal c = a.zxy; -- { 400, 300, 450 }"],"name":"Vector","_type":"method","calls":[{"arguments":{}}],"_return":{"var":"Vector","description":"The composed vector"}},"source":{"header":"lu5_vector.h","start_line":233,"end_line":253}} \ No newline at end of file diff --git a/docs/v0.1.7/vector/createVector/index.html b/docs/v0.1.7/vector/createVector/index.html index 08b2aef..68c60f4 100644 --- a/docs/v0.1.7/vector/createVector/index.html +++ b/docs/v0.1.7/vector/createVector/index.html @@ -1,3 +1,3 @@ -lu5 | createVector

createVector

v0.1.7
createVector(x, y);

Create a vector instance.

Arguments

xThe first component of the vector
yThe second component of the vector

Returns

VectorThe created vector

local point = createVector(80, 125);
+lu5 | createVector

createVector

v0.1.7
createVector(x, y);

Create a vector instance.

Arguments

xThe first component of the vector
yThe second component of the vector

Returns

VectorThe created vector

local point = createVector(80, 125);
 
-print(point);
See createVector in lu5_vector.h
This project is licensed under the MIT License.
It also includes the FreeType font engine, which is licensed under the FreeType License (FTL).
\ No newline at end of file +print(point);
See createVector in lu5_vector.h
\ No newline at end of file diff --git a/docs/v0.1.7/vector/createVector/meta.json b/docs/v0.1.7/vector/createVector/meta.json index 8d36e30..00f263e 100644 --- a/docs/v0.1.7/vector/createVector/meta.json +++ b/docs/v0.1.7/vector/createVector/meta.json @@ -1 +1 @@ -{"doc":{"bottom_description":"","_return":{"description":"The created vector","var":"Vector"},"name":"createVector","description":"Create a vector instance.","calls":[{"arguments":[{"name":"x","description":"The first component of the vector"},{"name":"y","description":"The second component of the vector"}]}],"_type":"method","examples":["local point = createVector(80, 125);\n\nprint(point);"]},"source":{"end_line":32,"start_line":18,"header":"lu5_vector.h"}} \ No newline at end of file +{"doc":{"description":"Create a vector instance.","bottom_description":"","examples":["local point = createVector(80, 125);\n\nprint(point);"],"name":"createVector","_type":"method","calls":[{"arguments":[{"name":"x","description":"The first component of the vector"},{"name":"y","description":"The second component of the vector"}]}],"_return":{"var":"Vector","description":"The created vector"}},"source":{"header":"lu5_vector.h","start_line":18,"end_line":32}} \ No newline at end of file diff --git a/docs/v0.1.7/vector/index.html b/docs/v0.1.7/vector/index.html index 01b26d5..97e1604 100644 --- a/docs/v0.1.7/vector/index.html +++ b/docs/v0.1.7/vector/index.html @@ -1,6 +1,6 @@ -lu5 | vector

vector

v0.1.7
createVector(x, y);

Create a vector instance.

Arguments

xThe first component of the vector
yThe second component of the vector

Returns

VectorThe created vector

local point = createVector(80, 125);
+lu5 | vector

vector

v0.1.7
createVector(x, y);

Create a vector instance.

Arguments

xThe first component of the vector
yThe second component of the vector

Returns

VectorThe created vector

local point = createVector(80, 125);
 
-print(point);
See createVector in lu5_vector.h
Vector.print();

Since a Vector implements a print method, it can be used in the print function.

local a = createVector(3, 5);
+print(point);
See createVector in lu5_vector.h
Vector.print();

Since a Vector implements a print method, it can be used in the print function.

local a = createVector(3, 5);
 
 -- With print
 print(a);
@@ -9,11 +9,11 @@
 Vector.print(a);
 
 -- with instance
-a:print();
See Vector.print in lu5_vector.h
Vector.dist(a, b);

No description

Arguments

aThe first point
bThe second point

Returns

numberThe distance between the two points

local a = createVector(300, 500);
+a:print();
See Vector.print in lu5_vector.h
Vector.dist(a, b);

No description

Arguments

aThe first point
bThe second point

Returns

numberThe distance between the two points

local a = createVector(300, 500);
 local b = createVector(200, 250);
 
 local distance = a:dist(b);
-print(distance);
See Vector.dist in lu5_vector.h
Vector.dot(a, b);

No description

Arguments

aThe first vector
bThe second vector

Returns

numberThe dot product

local a = createVector(3, 5);
+print(distance);
See Vector.dist in lu5_vector.h
Vector.dot(a, b);

No description

Arguments

aThe first vector
bThe second vector

Returns

numberThe dot product

local a = createVector(3, 5);
 local b = createVector(1, 3);
 
 -- From prototype
@@ -23,7 +23,7 @@
 print(Vector.dot(a, b)); -- 18.0
 
 -- With concat syntax
-print(a .. b); -- 18.0
See Vector.dot in lu5_vector.h
Vector.add(a, b);

No description

Arguments

aThe first vector
bThe second vector

Returns

VectorThe added vector

local a = createVector(4, 2);
+print(a .. b); -- 18.0
See Vector.dot in lu5_vector.h
Vector.add(a, b);

No description

Arguments

aThe first vector
bThe second vector

Returns

VectorThe added vector

local a = createVector(4, 2);
 local b = createVector(2, 1);
 
 -- Non-mutable
@@ -33,7 +33,7 @@
 
 -- Mutable
 print(a:add(b));	-- { 6.0, 3.0 }
-print(a) 		-- { 6.0, 3.0 }
See Vector.add in lu5_vector.h
Vector.sub(a, b);

No description

Arguments

aThe first vector
bThe second vector

Returns

VectorThe subtracted vector

local a = createVector(3, 5);
+print(a) 		-- { 6.0, 3.0 }
See Vector.add in lu5_vector.h
Vector.sub(a, b);

No description

Arguments

aThe first vector
bThe second vector

Returns

VectorThe subtracted vector

local a = createVector(3, 5);
 local b = createVector(2, 3);
 
 -- Non-mutable
@@ -43,7 +43,7 @@
 
 -- Mutable
 print(a:sub(b)); -- { 1.0, 2.0 }
-print(a);        -- { 1.0, 2.0 }
See Vector.sub in lu5_vector.h
Vector.mult(a, b);

No description

Arguments

aThe first vector
bThe second vector

Returns

VectorThe multiplied vector

local a = createVector(3, 5);
+print(a);        -- { 1.0, 2.0 }
See Vector.sub in lu5_vector.h
Vector.mult(a, b);

No description

Arguments

aThe first vector
bThe second vector

Returns

VectorThe multiplied vector

local a = createVector(3, 5);
 local b = createVector(2, 3);
 
 -- Non-mutable
@@ -53,7 +53,7 @@
 
 -- Mutable
 print(a:mult(b)); -- { 3.0, 15.0 }
-print(a);         -- { 3.0, 15.0 }
See Vector.mult in lu5_vector.h
Vector.div(a, b);

No description

Arguments

aThe first vector
bThe second vector

Returns

VectorThe divided vector

local a = createVector(4, 2);
+print(a);         -- { 3.0, 15.0 }
See Vector.mult in lu5_vector.h
Vector.div(a, b);

No description

Arguments

aThe first vector
bThe second vector

Returns

VectorThe divided vector

local a = createVector(4, 2);
 local b = createVector(2, 1);
 
 -- Non-mutable
@@ -63,7 +63,7 @@
 
 -- Mutable
 print(a:div(b));	-- { 2.0, 2.0 }
-print(a) 		-- { 2.0, 2.0 }
See Vector.div in lu5_vector.h
Vector.idiv(a, b);

No description

Arguments

aThe first vector
bThe second vector

Returns

VectorThe divided vector

local a = createVector(7, 8);
+print(a) 		-- { 2.0, 2.0 }
See Vector.div in lu5_vector.h
Vector.idiv(a, b);

No description

Arguments

aThe first vector
bThe second vector

Returns

VectorThe divided vector

local a = createVector(7, 8);
 local b = createVector(2, 3);
 
 -- Non-mutable
@@ -73,14 +73,14 @@
 
 -- Mutable
 print(a:idiv(b)); -- { 3.0, 2.0 }
-print(a)          -- { 3.0, 2.0 }
See Vector.idiv in lu5_vector.h
Vector.copy();

No description

Returns

VectorThe copied vector

local a = createVector(300, 450, 400);
+print(a)          -- { 3.0, 2.0 }
See Vector.idiv in lu5_vector.h
Vector.copy();

No description

Returns

VectorThe copied vector

local a = createVector(300, 450, 400);
 
 local copy_1 = a:copy();
 
-local copy_2 = Vector.copy(a);
See Vector.copy in lu5_vector.h
Vector();

No description

Returns

VectorThe composed vector

local a = createVector(300, 450, 400);
+local copy_2 = Vector.copy(a);
See Vector.copy in lu5_vector.h
Vector();

No description

Returns

VectorThe composed vector

local a = createVector(300, 450, 400);
 
 local copy = a.xyz;
 
 local a_2d = a.xy; -- { 300, 450 }
 local b = a.xyx; -- { 300, 450, 300 }
-local c = a.zxy; -- { 400, 300, 450 }
See Vector in lu5_vector.h
This project is licensed under the MIT License.
It also includes the FreeType font engine, which is licensed under the FreeType License (FTL).
\ No newline at end of file +local c = a.zxy; -- { 400, 300, 450 }
See Vector in lu5_vector.h
\ No newline at end of file diff --git a/docs/v0.1.7/window/createWindow/index.html b/docs/v0.1.7/window/createWindow/index.html index ec47183..0d03e39 100644 --- a/docs/v0.1.7/window/createWindow/index.html +++ b/docs/v0.1.7/window/createWindow/index.html @@ -1,8 +1,8 @@ -lu5 | createWindow

createWindow

v0.1.7
createWindow(w, h, [mode]);

Create a GLFW window.

Arguments

wWindow width
hWindow height
[mode]Rendering mode, either GL2D or GL3D, by default GL2D is set.

It is also possible to create a window in the global scope without defining a setup function.

function setup()
+lu5 | createWindow

createWindow

v0.1.7
createWindow(w, h, [mode]);

Create a GLFW window.

Arguments

wWindow width
hWindow height
[mode]Rendering mode, either GL2D or GL3D, by default GL2D is set.

It is also possible to create a window in the global scope without defining a setup function.

function setup()
   -- Create the window here
   createWindow(600, 600);
 end
 
 function draw()
   -- draw things
-end
See createWindow in window.h
This project is licensed under the MIT License.
It also includes the FreeType font engine, which is licensed under the FreeType License (FTL).
\ No newline at end of file +end
See createWindow in window.h
\ No newline at end of file diff --git a/docs/v0.1.7/window/createWindow/meta.json b/docs/v0.1.7/window/createWindow/meta.json index 186125a..bfd3224 100644 --- a/docs/v0.1.7/window/createWindow/meta.json +++ b/docs/v0.1.7/window/createWindow/meta.json @@ -1 +1 @@ -{"doc":{"bottom_description":"It is also possible to create a window in the global scope without defining a setup function.","name":"createWindow","description":"Create a GLFW window.","calls":[{"arguments":[{"name":"w","description":"Window width"},{"name":"h","description":"Window height"},{"name":"[mode]","description":"Rendering mode, either `GL2D` or `GL3D`, by default `GL2D` is set."}]}],"_type":"method","examples":["function setup()\n -- Create the window here\n createWindow(600, 600);\nend\n\nfunction draw()\n -- draw things\nend"]},"source":{"end_line":28,"start_line":7,"header":"window.h"}} \ No newline at end of file +{"doc":{"description":"Create a GLFW window.","bottom_description":"It is also possible to create a window in the global scope without defining a setup function.","examples":["function setup()\n -- Create the window here\n createWindow(600, 600);\nend\n\nfunction draw()\n -- draw things\nend"],"name":"createWindow","calls":[{"arguments":[{"name":"w","description":"Window width"},{"name":"h","description":"Window height"},{"name":"[mode]","description":"Rendering mode, either `GL2D` or `GL3D`, by default `GL2D` is set."}]}],"_type":"method"},"source":{"header":"window.h","start_line":7,"end_line":28}} \ No newline at end of file diff --git a/docs/v0.1.7/window/deltaTime/index.html b/docs/v0.1.7/window/deltaTime/index.html index ec1b4e0..8954a75 100644 --- a/docs/v0.1.7/window/deltaTime/index.html +++ b/docs/v0.1.7/window/deltaTime/index.html @@ -1,4 +1,4 @@ -lu5 | deltaTime

deltaTime

v0.1.7
deltaTimeGlobal

Elapsed time since the last draw call in seconds.

x = 0;
+lu5 | deltaTime

deltaTime

v0.1.7
deltaTimeGlobal

Elapsed time since the last draw call in seconds.

x = 0;
 vx = 128;
 
 function setup()
@@ -13,4 +13,4 @@
 
   -- Get the same velocity with different framerates
   x = x + vx * deltaTime;
-end
See deltaTime in window.h
This project is licensed under the MIT License.
It also includes the FreeType font engine, which is licensed under the FreeType License (FTL).
\ No newline at end of file +end
See deltaTime in window.h
\ No newline at end of file diff --git a/docs/v0.1.7/window/deltaTime/meta.json b/docs/v0.1.7/window/deltaTime/meta.json index fd1db50..cd7c955 100644 --- a/docs/v0.1.7/window/deltaTime/meta.json +++ b/docs/v0.1.7/window/deltaTime/meta.json @@ -1 +1 @@ -{"doc":{"bottom_description":"","name":"deltaTime","description":"Elapsed time since the last draw call in seconds.","calls":[{"arguments":{}}],"_type":"global","examples":["x = 0;\nvx = 128;\n\nfunction setup()\n createWindow(400, 400);\n frameRate(24); -- try with 60\nend\n\nfunction draw()\n background(51);\n\n circle(x, height/2, 32);\n\n -- Get the same velocity with different framerates\n x = x + vx * deltaTime;\nend"]},"source":{"end_line":94,"start_line":70,"header":"window.h"}} \ No newline at end of file +{"doc":{"description":"Elapsed time since the last draw call in seconds.","bottom_description":"","examples":["x = 0;\nvx = 128;\n\nfunction setup()\n createWindow(400, 400);\n frameRate(24); -- try with 60\nend\n\nfunction draw()\n background(51);\n\n circle(x, height/2, 32);\n\n -- Get the same velocity with different framerates\n x = x + vx * deltaTime;\nend"],"name":"deltaTime","calls":[{"arguments":{}}],"_type":"global"},"source":{"header":"window.h","start_line":70,"end_line":94}} \ No newline at end of file diff --git a/docs/v0.1.7/window/frameRate/index.html b/docs/v0.1.7/window/frameRate/index.html index dab1790..d1e607b 100644 --- a/docs/v0.1.7/window/frameRate/index.html +++ b/docs/v0.1.7/window/frameRate/index.html @@ -1,4 +1,4 @@ -lu5 | frameRate

frameRate

v0.1.7
frameRate(fps);

Set the frame rate.

Arguments

fpsThe frame rate to set

If frame rate is called without an argument, it will return frame per seconds

x = 0;
+lu5 | frameRate

frameRate

v0.1.7
frameRate(fps);

Set the frame rate.

Arguments

fpsThe frame rate to set

If frame rate is called without an argument, it will return frame per seconds

x = 0;
 
 function setup()
   createWindow(400, 400);
@@ -11,4 +11,4 @@
 
   circle(x, 200, 32);
   x = x + 1;
-end
See frameRate in window.h
This project is licensed under the MIT License.
It also includes the FreeType font engine, which is licensed under the FreeType License (FTL).
\ No newline at end of file +end
See frameRate in window.h
\ No newline at end of file diff --git a/docs/v0.1.7/window/frameRate/meta.json b/docs/v0.1.7/window/frameRate/meta.json index f66ee7b..8c0990b 100644 --- a/docs/v0.1.7/window/frameRate/meta.json +++ b/docs/v0.1.7/window/frameRate/meta.json @@ -1 +1 @@ -{"doc":{"bottom_description":"If frame rate is called without an argument, it will return frame per seconds ","name":"frameRate","description":"Set the frame rate.","calls":[{"arguments":[{"name":"fps","description":"The frame rate to set"}]}],"_type":"method","examples":["x = 0;\n\nfunction setup()\n createWindow(400, 400);\n frameRate(24);\nend\n\nfunction draw()\n background(51);\n text('fps: ' .. frameRate(), 20, 10);\n\n circle(x, 200, 32);\n x = x + 1;\nend"]},"source":{"end_line":54,"start_line":30,"header":"window.h"}} \ No newline at end of file +{"doc":{"description":"Set the frame rate.","bottom_description":"If frame rate is called without an argument, it will return frame per seconds ","examples":["x = 0;\n\nfunction setup()\n createWindow(400, 400);\n frameRate(24);\nend\n\nfunction draw()\n background(51);\n text('fps: ' .. frameRate(), 20, 10);\n\n circle(x, 200, 32);\n x = x + 1;\nend"],"name":"frameRate","calls":[{"arguments":[{"name":"fps","description":"The frame rate to set"}]}],"_type":"method"},"source":{"header":"window.h","start_line":30,"end_line":54}} \ No newline at end of file diff --git a/docs/v0.1.7/window/height/index.html b/docs/v0.1.7/window/height/index.html index 5ca4def..023c515 100644 --- a/docs/v0.1.7/window/height/index.html +++ b/docs/v0.1.7/window/height/index.html @@ -1,4 +1,4 @@ -lu5 | height

height

v0.1.7
heightGlobal

The window's height in pixels. If no window was created, this value is nil.

createWindow(800, 600);
+lu5 | height

height

v0.1.7
heightGlobal

The window's height in pixels. If no window was created, this value is nil.

createWindow(800, 600);
 
 print(height);
--- 600
See height in window.h
This project is licensed under the MIT License.
It also includes the FreeType font engine, which is licensed under the FreeType License (FTL).
\ No newline at end of file +-- 600
See height in window.h
\ No newline at end of file diff --git a/docs/v0.1.7/window/height/meta.json b/docs/v0.1.7/window/height/meta.json index cc43d5c..7d84ee7 100644 --- a/docs/v0.1.7/window/height/meta.json +++ b/docs/v0.1.7/window/height/meta.json @@ -1 +1 @@ -{"doc":{"bottom_description":"","name":"height","description":"The window's height in pixels. If no window was created, this value is nil.","calls":[{"arguments":{}}],"_type":"global","examples":["createWindow(800, 600);\n\nprint(height);\n-- 600"]},"source":{"end_line":124,"start_line":112,"header":"window.h"}} \ No newline at end of file +{"doc":{"description":"The window's height in pixels. If no window was created, this value is nil.","bottom_description":"","examples":["createWindow(800, 600);\n\nprint(height);\n-- 600"],"name":"height","calls":[{"arguments":{}}],"_type":"global"},"source":{"header":"window.h","start_line":112,"end_line":124}} \ No newline at end of file diff --git a/docs/v0.1.7/window/index.html b/docs/v0.1.7/window/index.html index 59fbc33..7cadf16 100644 --- a/docs/v0.1.7/window/index.html +++ b/docs/v0.1.7/window/index.html @@ -1,11 +1,11 @@ -lu5 | window

window

v0.1.7
createWindow(w, h, [mode]);

Create a GLFW window.

Arguments

wWindow width
hWindow height
[mode]Rendering mode, either GL2D or GL3D, by default GL2D is set.

It is also possible to create a window in the global scope without defining a setup function.

function setup()
+lu5 | window

window

v0.1.7
createWindow(w, h, [mode]);

Create a GLFW window.

Arguments

wWindow width
hWindow height
[mode]Rendering mode, either GL2D or GL3D, by default GL2D is set.

It is also possible to create a window in the global scope without defining a setup function.

function setup()
   -- Create the window here
   createWindow(600, 600);
 end
 
 function draw()
   -- draw things
-end
See createWindow in window.h
frameRate(fps);

Set the frame rate.

Arguments

fpsThe frame rate to set

If frame rate is called without an argument, it will return frame per seconds

x = 0;
+end
See createWindow in window.h
frameRate(fps);

Set the frame rate.

Arguments

fpsThe frame rate to set

If frame rate is called without an argument, it will return frame per seconds

x = 0;
 
 function setup()
   createWindow(400, 400);
@@ -18,7 +18,7 @@
 
   circle(x, 200, 32);
   x = x + 1;
-end
See frameRate in window.h
noLoop();

Prevents lu5 from calling draw again.

When noLoop is called, the draw continues execution, but will not be called again.

See noLoop in window.h
loop();

Allow lu5 to call the draw function.

See loop in window.h
deltaTimeGlobal

Elapsed time since the last draw call in seconds.

x = 0;
+end
See frameRate in window.h
noLoop();

Prevents lu5 from calling draw again.

When noLoop is called, the draw continues execution, but will not be called again.

See noLoop in window.h
loop();

Allow lu5 to call the draw function.

See loop in window.h
deltaTimeGlobal

Elapsed time since the last draw call in seconds.

x = 0;
 vx = 128;
 
 function setup()
@@ -33,13 +33,13 @@
 
   -- Get the same velocity with different framerates
   x = x + vx * deltaTime;
-end
See deltaTime in window.h
widthGlobal

The window's width in pixels. If no window was created, this value is nil.

createWindow(800, 600);
+end
See deltaTime in window.h
widthGlobal

The window's width in pixels. If no window was created, this value is nil.

createWindow(800, 600);
 
 print(width);
--- 800
See width in window.h
heightGlobal

The window's height in pixels. If no window was created, this value is nil.

createWindow(800, 600);
+-- 800
See width in window.h
heightGlobal

The window's height in pixels. If no window was created, this value is nil.

createWindow(800, 600);
 
 print(height);
--- 600
See height in window.h
windowResized();Event

Called when the window is resized.

function setup()
+-- 600
See height in window.h
windowResized();Event

Called when the window is resized.

function setup()
     createWindow(500, 500);
 end
 
@@ -49,4 +49,4 @@
 
 function windowResized()
     print('Resized!');
-end
See windowResized in window.h
This project is licensed under the MIT License.
It also includes the FreeType font engine, which is licensed under the FreeType License (FTL).
\ No newline at end of file +end
See windowResized in window.h
\ No newline at end of file diff --git a/docs/v0.1.7/window/loop/index.html b/docs/v0.1.7/window/loop/index.html index 755ef5d..cfcb2fd 100644 --- a/docs/v0.1.7/window/loop/index.html +++ b/docs/v0.1.7/window/loop/index.html @@ -1 +1 @@ -lu5 | loop

loop

v0.1.7
loop();

Allow lu5 to call the draw function.

See loop in window.h
\ No newline at end of file +lu5 | loop

loop

v0.1.7
loop();

Allow lu5 to call the draw function.

See loop in window.h
\ No newline at end of file diff --git a/docs/v0.1.7/window/loop/meta.json b/docs/v0.1.7/window/loop/meta.json index a67ffa3..c150f0b 100644 --- a/docs/v0.1.7/window/loop/meta.json +++ b/docs/v0.1.7/window/loop/meta.json @@ -1 +1 @@ -{"doc":{"bottom_description":"","name":"loop","description":"Allow lu5 to call the draw function.","calls":[{"arguments":{}}],"_type":"method","examples":{}},"source":{"end_line":68,"start_line":64,"header":"window.h"}} \ No newline at end of file +{"doc":{"description":"Allow lu5 to call the draw function.","bottom_description":"","examples":{},"name":"loop","calls":[{"arguments":{}}],"_type":"method"},"source":{"header":"window.h","start_line":64,"end_line":68}} \ No newline at end of file diff --git a/docs/v0.1.7/window/noLoop/index.html b/docs/v0.1.7/window/noLoop/index.html index 1a7e08e..80a0ebc 100644 --- a/docs/v0.1.7/window/noLoop/index.html +++ b/docs/v0.1.7/window/noLoop/index.html @@ -1 +1 @@ -lu5 | noLoop

noLoop

v0.1.7
noLoop();

Prevents lu5 from calling draw again.

When noLoop is called, the draw continues execution, but will not be called again.

See noLoop in window.h
\ No newline at end of file +lu5 | noLoop

noLoop

v0.1.7
noLoop();

Prevents lu5 from calling draw again.

When noLoop is called, the draw continues execution, but will not be called again.

See noLoop in window.h
\ No newline at end of file diff --git a/docs/v0.1.7/window/noLoop/meta.json b/docs/v0.1.7/window/noLoop/meta.json index 10f11a7..0ed6994 100644 --- a/docs/v0.1.7/window/noLoop/meta.json +++ b/docs/v0.1.7/window/noLoop/meta.json @@ -1 +1 @@ -{"doc":{"bottom_description":"","name":"noLoop","description":"Prevents lu5 from calling draw again.

When noLoop is called, the draw continues execution, but will not be called again.","calls":[{"arguments":{}}],"_type":"method","examples":{}},"source":{"end_line":62,"start_line":56,"header":"window.h"}} \ No newline at end of file +{"doc":{"description":"Prevents lu5 from calling draw again.

When noLoop is called, the draw continues execution, but will not be called again.","bottom_description":"","examples":{},"name":"noLoop","calls":[{"arguments":{}}],"_type":"method"},"source":{"header":"window.h","start_line":56,"end_line":62}} \ No newline at end of file diff --git a/docs/v0.1.7/window/width/index.html b/docs/v0.1.7/window/width/index.html index 3c1af9e..2bbd81d 100644 --- a/docs/v0.1.7/window/width/index.html +++ b/docs/v0.1.7/window/width/index.html @@ -1,4 +1,4 @@ -lu5 | width

width

v0.1.7
widthGlobal

The window's width in pixels. If no window was created, this value is nil.

createWindow(800, 600);
+lu5 | width

width

v0.1.7
widthGlobal

The window's width in pixels. If no window was created, this value is nil.

createWindow(800, 600);
 
 print(width);
--- 800
See width in window.h
This project is licensed under the MIT License.
It also includes the FreeType font engine, which is licensed under the FreeType License (FTL).
\ No newline at end of file +-- 800
See width in window.h
\ No newline at end of file diff --git a/docs/v0.1.7/window/width/meta.json b/docs/v0.1.7/window/width/meta.json index de4a87e..74cd3ac 100644 --- a/docs/v0.1.7/window/width/meta.json +++ b/docs/v0.1.7/window/width/meta.json @@ -1 +1 @@ -{"doc":{"bottom_description":"","name":"width","description":"The window's width in pixels. If no window was created, this value is nil.","calls":[{"arguments":{}}],"_type":"global","examples":["createWindow(800, 600);\n\nprint(width);\n-- 800"]},"source":{"end_line":109,"start_line":97,"header":"window.h"}} \ No newline at end of file +{"doc":{"description":"The window's width in pixels. If no window was created, this value is nil.","bottom_description":"","examples":["createWindow(800, 600);\n\nprint(width);\n-- 800"],"name":"width","calls":[{"arguments":{}}],"_type":"global"},"source":{"header":"window.h","start_line":97,"end_line":109}} \ No newline at end of file diff --git a/docs/v0.1.7/window/windowResized/index.html b/docs/v0.1.7/window/windowResized/index.html index a22a9b8..8e5601b 100644 --- a/docs/v0.1.7/window/windowResized/index.html +++ b/docs/v0.1.7/window/windowResized/index.html @@ -1,4 +1,4 @@ -lu5 | windowResized

windowResized

v0.1.7
windowResized();Event

Called when the window is resized.

function setup()
+lu5 | windowResized

windowResized

v0.1.7
windowResized();Event

Called when the window is resized.

function setup()
     createWindow(500, 500);
 end
 
@@ -8,4 +8,4 @@
 
 function windowResized()
     print('Resized!');
-end
See windowResized in window.h
This project is licensed under the MIT License.
It also includes the FreeType font engine, which is licensed under the FreeType License (FTL).
\ No newline at end of file +end
See windowResized in window.h
\ No newline at end of file diff --git a/docs/v0.1.7/window/windowResized/meta.json b/docs/v0.1.7/window/windowResized/meta.json index 3187ccf..0c45cef 100644 --- a/docs/v0.1.7/window/windowResized/meta.json +++ b/docs/v0.1.7/window/windowResized/meta.json @@ -1 +1 @@ -{"doc":{"bottom_description":"","name":"windowResized","description":"Called when the window is resized.","calls":[{"arguments":{}}],"_type":"event","examples":["function setup()\n createWindow(500, 500);\nend\n\nfunction draw()\n background(51);\nend\n\nfunction windowResized()\n print('Resized!');\nend"]},"source":{"end_line":145,"start_line":127,"header":"window.h"}} \ No newline at end of file +{"doc":{"description":"Called when the window is resized.","bottom_description":"","examples":["function setup()\n createWindow(500, 500);\nend\n\nfunction draw()\n background(51);\nend\n\nfunction windowResized()\n print('Resized!');\nend"],"name":"windowResized","calls":[{"arguments":{}}],"_type":"event"},"source":{"header":"window.h","start_line":127,"end_line":145}} \ No newline at end of file diff --git a/site/static/css/style.css b/site/static/css/style.css index dbf6431..e8789cb 100644 --- a/site/static/css/style.css +++ b/site/static/css/style.css @@ -152,7 +152,7 @@ body { height: fit-content; display: flex; flex-direction: column; - align-items: flex-end; + align-items: center; } a, p, span.text, span.small, span.smaller, span.decorator, h1, h2, h3, h4, h5, h6 {