Interpreter for Creative Coding
Lu5 is a free and open-source Lua interpreter for Creative Coding.
Lu5 is a free and open-source Lua interpreter for Creative Coding.
Lu5 is a free and open-source Lua interpreter for Creative Coding.
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
+
+function draw()
+ background(51);
+
+ -- Allows us to control the camera
+ orbitControl();
+
+ noFill();
+ stroke(80, 255, 50);
+ strokeWeight(4);
+
+ box(60);
+endclass(name);Create a class.
if a class implements a print method, it can be used in the print function
nameThe class name local Player = class('Player');
+lu5 | classes classes
v0.1.6class(name);Create a class.
if a class implements a print method, it can be used in the print function
Arguments
nameThe class namelocal Player = class('Player');
- function Player:init(x, y)
- self.x = x;
- self.y = y;
- return self;
- end
+function Player:init(x, y)
+ self.x = x;
+ self.y = y;
+ return self;
+end
- function Player:draw()
- circle(self.x, self.y, 16);
- end
+function Player:draw()
+ circle(self.x, self.y, 16);
+end
- -- Create 2 players and draw them
- local p1 = Player:new(100, 200);
- local p2 = Player:new(300, 200);
+-- Create 2 players and draw them
+local p1 = Player:new(100, 200);
+local p2 = Player:new(300, 200);
- function setup()
- createWindow(400, 400);
- end
-
- function draw()
- background(51);
+function setup()
+ createWindow(400, 400);
+end
- p1:draw();
- p2:draw();
- end
loadImage(path);Load a png or jpeg image
pathThe local image pathimgThe image reference function setup()
- createWindow(600, 600);
- img = loadImage('/path/to/mypic.png');
- end
+lu5 | image image
v0.1.6loadImage(path);Load a png or jpeg image
Arguments
pathThe local image pathReturns
ImageThe image instancefunction setup()
+ createWindow(600, 600);
+ img = loadImage('/path/to/mypic.png');
+end
- function draw()
- background(51);
+function draw()
+ background(51);
- image(img, 0, 0);
- end
image(image, x, y, [w], [h]);Draw an image to the screen
Arguments
imageThe image referencexThe x position of the imageyThe 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
image(img, x, y, [w], [h]);Draw an image to the screen
imgThe Image instancexThe x position of the imageyThe 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 heightImage.crop(x, y, w, h);Crop an Image into an other Image
xThe x position of the imageyThe y position of the imagewThe width of the new cropped imagehThe height of the new cropped imageImagethe cropped image
print(value);Printing utility, can take any lua type.
valueThe value to print to stdout print(42);
+lu5 | io io
v0.1.6print(value);Printing utility, can take any lua type.
Arguments
valueThe value to print to stdoutprint(42);
- print(1, 2, 3);
-
- print('Hello world');
+print(1, 2, 3);
- print({ 3, 8, 1 });
loadText(file_path);Read a file as a string
Arguments
file_pathThe path of the file file = loadText("./your-file.txt");
- print(file)
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)
loadText(file_path);Read a file as a string
file_pathThe path of the filefile = loadText("./your-file.txt");
+print(file)loadStrings(file_path);Read a file as an array of strings split by line
file_pathThe path of the filefile = loadStrings("./your-file.txt");
+print(file)keyIsDown(k);Check if a keyboard key is pressed, returns true if key is down and returns false if it's not
kThe keyboard key to check as a key global, or a stringbooleanWhether or not the key is down -- Use a string
- if (keyIsDown('a')) then
- -- key 'a' is down
- end
+lu5 | keyboard keyboard
v0.1.6keyIsDown(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 stringReturns
booleanWhether or not the key is down-- Use a string
+if (keyIsDown('a')) then
+ -- key 'a' is down
+end
- -- use a global
- if (keyIsDown(LEFT_ARROW)) then
- -- left arrow is down
- end
keyPressed(key, keyCode);EventCalled whenever a key is pressed.
Arguments
keyThe pressed key as a string, is nil if glfw cannot find a name for the keykeyCodeThe pressed key as a key code function setup()
- createWindow(600, 600);
- end
-
- function draw()
- background(51);
- end
-
- function keyPressed(key, keyCode)
- print(key, keyCode)
- end
keyReleased(key, keyCode);EventCalled whenever a key is released.
Arguments
keyThe released key as a string, is nil if glfw cannot find a name for the keykeyCodeThe released key as a key code
keyHeld(key, keyCode);EventCalled whenever a key is held down.
Arguments
keyThe held key as a string, is nil if glfw cannot find a name for the keykeyCodeThe held key as a key code
UP_ARROWGlobalNo description
DOWN_ARROWGlobalNo description
LEFT_ARROWGlobalNo description
RIGHT_ARROWGlobalNo description
KEY_ENTERGlobalNo description
KEY_BACKSPACEGlobalNo description
KEY_AGlobalNo description
KEY_BGlobalNo description
KEY_CGlobalNo description
KEY_DGlobalNo description
KEY_EGlobalNo description
KEY_FGlobalNo description
KEY_GGlobalNo description
KEY_HGlobalNo description
KEY_IGlobalNo description
KEY_JGlobalNo description
KEY_KGlobalNo description
KEY_LGlobalNo description
KEY_MGlobalNo description
KEY_NGlobalNo description
KEY_OGlobalNo description
KEY_PGlobalNo description
KEY_QGlobalNo description
KEY_RGlobalNo description
KEY_SGlobalNo description
KEY_TGlobalNo description
KEY_UGlobalNo description
KEY_VGlobalNo description
KEY_WGlobalNo description
KEY_XGlobalNo description
KEY_YGlobalNo description
KEY_ZGlobalNo description
keyPressed(key, keyCode);EventCalled whenever a key is pressed.
keyThe pressed key as a string, is nil if glfw cannot find a name for the keykeyCodeThe pressed key as a key codefunction setup()
+ createWindow(600, 600);
+end
+
+function draw()
+ background(51);
+end
+
+function keyPressed(key, keyCode)
+ print(key, keyCode)
+endkeyReleased(key, keyCode);EventCalled whenever a key is released.
keyThe released key as a string, is nil if glfw cannot find a name for the keykeyCodeThe released key as a key codekeyHeld(key, keyCode);EventCalled whenever a key is held down.
keyThe held key as a string, is nil if glfw cannot find a name for the keykeyCodeThe held key as a key codeUP_ARROWConstantNo description
DOWN_ARROWConstantNo description
LEFT_ARROWConstantNo description
RIGHT_ARROWConstantNo description
KEY_ENTERConstantNo description
KEY_BACKSPACEConstantNo description
KEY_AConstantNo description
KEY_BConstantNo description
KEY_CConstantNo description
KEY_DConstantNo description
KEY_EConstantNo description
KEY_FConstantNo description
KEY_GConstantNo description
KEY_HConstantNo description
KEY_IConstantNo description
KEY_JConstantNo description
KEY_KConstantNo description
KEY_LConstantNo description
KEY_MConstantNo description
KEY_NConstantNo description
KEY_OConstantNo description
KEY_PConstantNo description
KEY_QConstantNo description
KEY_RConstantNo description
KEY_SConstantNo description
KEY_TConstantNo description
KEY_UConstantNo description
KEY_VConstantNo description
KEY_WConstantNo description
KEY_XConstantNo description
KEY_YConstantNo description
KEY_ZConstantNo description
randomSeed(seed);Set a random seed
seedThe seed valuenumberThe random valuerandom(min, max);Get a random number
minThe minimum of the rangemaxThe maximum of the rangenumberThe random value random() -- random number between 0 and 1
- random(3) -- random number between 0 and 3
- random(3, 12) -- random number between 3 and 12
+lu5 | math math
v0.1.6randomSeed(seed);Set a random seed
Arguments
seedThe seed valueReturns
numberThe random value
random(min, max);Get a random number
Arguments
minThe minimum of the rangemaxThe maximum of the rangeReturns
numberThe random valuerandom() -- random number between 0 and 1
+random(3) -- random number between 0 and 3
+random(3, 12) -- random number between 3 and 12
- random({ 'A', 'B', 'C' }) -- random element in table
round(x);Round a number to the nearest integer
Arguments
xThe value to roundReturns
intThe rounded value
floor(x);floor is a function that takes in a number, and returns the greatest integer less or equal to x
see here
Arguments
xThe value to floorReturns
intgreatest integer less than or equals to x
ceil(x);ceil is a function that takes in a number, and returns the smallest integer greater or equal to x
see here
Arguments
xThe value to floorReturns
intThe floored value
min(a, b);Return the smallest value.
Can also take any number of arguments, or a table.
Arguments
aThe first valuebThe second valueReturns
numberThe smallest value min(6, 7); -- returns 6
+random({ 'A', 'B', 'C' }) -- random element in table
round(x);Round a number to the nearest integer
Arguments
xThe value to roundReturns
intThe rounded value
floor(x);floor is a function that takes in a number, and returns the greatest integer less or equal to x
see here
Arguments
xThe value to floorReturns
intgreatest integer less than or equals to x
ceil(x);ceil is a function that takes in a number, and returns the smallest integer greater or equal to x
see here
Arguments
xThe value to floorReturns
intThe floored value
min(a, b);Return the smallest value.
Can also take any number of arguments, or a table.
Arguments
aThe first valuebThe second valueReturns
numberThe smallest valuemin(6, 7); -- returns 6
- min(6, 7, 4); -- returns 4
+min(6, 7, 4); -- returns 4
- min({ 6, 7, 4 }); -- returns 4
max(a, b);Return the largest value.
Can also take any number of arguments, or a table.
Arguments
aThe first valuebThe second valueReturns
numberThe largest value max(2, 5); -- returns 5
+min({ 6, 7, 4 }); -- returns 4
max(a, b);Return the largest value.
Can also take any number of arguments, or a table.
Arguments
aThe first valuebThe second valueReturns
numberThe largest valuemax(2, 5); -- returns 5
- max(2, 5, 7); -- returns 7
+max(2, 5, 7); -- returns 7
- max({ 2, 5, 7 }); -- returns 7
abs(x);Returns the absolute value of x which is its distance from 0
see here
Arguments
xThe input valueReturns
numberThe absolote value of the input
map(x, s1, e1, s2, e2);Maps x from an original range to a target range
Arguments
xThe value to maps1The start of the initial rangee1The end of the initial ranges2The start of the target rangee2The end of the target rangeReturns
numberThe mapped value
dist(x1, y1, x2, y1);Calculates the distance between 2 points in 2D space
Arguments
x1The x coordinate of the first pointy1The y coordinate of the first pointx2The x coordinate of the second pointy1The y coordinate of the second pointReturns
numberThe distance between the points
constrain(x, min, max);Limits x to a minimum and maximum value
Arguments
xThe input valueminThe minimum valuemaxThe maximum valueReturns
numberThe constrained value
sin(x);Sine function (Trigonometry)
Arguments
xThe input valueReturns
numberThe output value
cos(x);Cosine function (Trigonometry)
Arguments
xThe input valueReturns
numberThe output value
tan(x);Tangent function (Trigonometry)
Arguments
xThe input valueReturns
numberThe output value
PIGlobalNo description
TWO_PIGlobalNo description
HALF_PIGlobalNo description
QUARTER_PIGlobalNo description
abs(x);Returns the absolute value of x
see here
xThe input valuenumberThe absolote value of the inputmap(x, s1, e1, s2, e2);Maps x from an original range to a target range
xThe value to maps1The start of the initial rangee1The end of the initial ranges2The start of the target rangee2The end of the target rangenumberThe mapped valuedist(x1, y1, x2, y1);Calculates the distance between 2 points in 2D space
x1The x coordinate of the first pointy1The y coordinate of the first pointx2The x coordinate of the second pointy1The y coordinate of the second pointnumberThe distance between the pointsconstrain(x, min, max);Limits x to a minimum and maximum value
xThe input valueminThe minimum valuemaxThe maximum valuenumberThe constrained valuesin(x);Sine function (Trigonometry)
xThe input valuenumberThe output valuecos(x);Cosine function (Trigonometry)
xThe input valuenumberThe output valuetan(x);Tangent function (Trigonometry)
xThe input valuenumberThe output valuePIConstantNo description
TWO_PIConstantNo description
HALF_PIConstantNo description
QUARTER_PIConstantNo description
model(model);Draw a 3D model
modelThe 3D modelloadModel(model);Load a 3D model
modelThe 3D modelmouseXGlobalThe x mouse coordinate
createWindow(400, 400);
-
- function draw()
- background(51);
-
- line(mouseX, 0, mouseX, height);
- endmouseYGlobalThe y mouse coordinate
createWindow(400, 400);
-
- function draw()
- background(51);
-
- line(0, mouseY, width, mouseY);
- endmouseIsPressedGlobalIs true when the mouse is pressed, is false when it's not
mousePressed(button);EventCalled when a mouse button is pressed.
buttonThe pressed mouse button
-In the following example, the circle's size increases when the user clicks the mouse.
size = 0;
-
- function setup()
- createWindow(400, 400);
- end
-
- function draw()
- background(51);
-
- circle(mouseX, mouseY, size);
- end
-
- -- Increase circle size when mouse pressed
- function mousePressed()
- size = size + 1;
- endmouseReleased(button);EventCalled when a mouse button is released.
buttonThe released mouse button
-In the following example, the circle's size increases when the user clicks the mouse.
size = 32;
-
- function setup()
- createWindow(400, 400);
- end
-
- function draw()
- background(51);
-
- circle(mouseX, mouseY, size);
- end
-
- -- Set larger circle size
- function mousePressed()
- size = 64;
- end
-
- -- Reset size
- function mouseReleased()
- size = 32;
- endmouseYGlobalThe y mouse coordinate
createWindow(400, 400);
+
+function draw()
+ background(51);
+
+ line(0, mouseY, width, mouseY);
+endmouseXGlobalThe x mouse coordinate
createWindow(400, 400);
+
+function draw()
+ background(51);
+
+ line(mouseX, 0, mouseX, height);
+endpmouseYGlobalNo description
pmouseXGlobalNo description
mouseIsPressedGlobalIs true when the mouse is pressed, is false when it's not
mousePressed(button);EventCalled when a mouse button is pressed.
buttonThe pressed mouse button
+In the following example, the circle's size increases when the user clicks the mouse.
size = 0;
+
+function setup()
+ createWindow(400, 400);
+end
+
+function draw()
+ background(51);
+
+ circle(mouseX, mouseY, size);
+end
+
+-- Increase circle size when mouse pressed
+function mousePressed()
+ size = size + 1;
+endmouseReleased(button);EventCalled when a mouse button is released.
buttonThe released mouse button
+In the following example, the circle's size increases when the user clicks the mouse.
size = 32;
+
+function setup()
+ createWindow(400, 400);
+end
+
+function draw()
+ background(51);
+
+ circle(mouseX, mouseY, size);
+end
+
+-- Set larger circle size
+function mousePressed()
+ size = 64;
+end
+
+-- Reset size
+function mouseReleased()
+ size = size + 6;
+endmouseWheel(button);EventCalled when a mouse wheel is used
buttonThe pressed mouse button
+In the following example, the circle's size changes when the user scrolls
size = 0;
+
+function setup()
+ createWindow(400, 400);
+end
+
+function draw()
+ background(51);
+
+ circle(mouseX, mouseY, size);
+end
+
+-- Change circle size when mouse is scrolled
+function mouseWheel(delta)
+ size = size + delta;
+endbackground(r, g, b, a);Clear a background with a color
rThe red bytegThe green bytebThe blue byteaThe alpha bytefill(r, g, b, [a]);Set the fill color for shapes
rThe red bytegThe green bytebThe blue byte[a]The alpha byteCan also accept a hexadecimal or color name as string
fill(255, 150, 40);
- square(200, 200, 64);strokeWeight(weight);No description
weightThe line width in pixels strokeWeight(8);
- line(200, 200, mouseX, mouseY);noFill();Disable fill
stroke(r, g, b, a);Set the stroke color for shapes
rThe red bytegThe green bytebThe blue byteaThe alpha byteOnly implemented for line and circle
noStroke();Disable stroke
Only implemented for line and circle
push();Save the style settings
pop();Restore the style settings
background(r, g, b, a);Clear a background with a color
rThe red bytegThe green bytebThe blue byteaThe alpha bytefill(r, g, b, [a]);Set the fill color for shapes
rThe red bytegThe green bytebThe blue byte[a]The alpha byteCan also accept a hexadecimal or color name as string
fill(255, 150, 40);
+square(200, 200, 64);strokeWeight(weight);No description
weightThe line width in pixelstrokeWeight(8);
+ine(200, 200, mouseX, mouseY);noFill();Disable fill
stroke(r, g, b, a);Set the stroke color for shapes
rThe red bytegThe green bytebThe blue byteaThe alpha byteOnly implemented for line and circle
noStroke();Disable stroke
Only implemented for line and circle
push();Save the style settings
pop();Restore the style settings
circle(x, y, d);Draw a circle to the opengl context
xThe x position of the circleyThe y position of the circledThe diameter of the circlerect(x, y, w, h);Draw a rectangle to the opengl context
xThe x position of the reactangleyThe y position of the reactanglewThe widthhThe heightsquare(x, y, s);Draw a square to the opengl context
xThe x position of the squareyThe y position of the squaresThe size of the squareline(x1, y1, x2, y2);Draw a line to the opengl context
x1The x position of the first pointy1The y position of the first pointx2The x position of the second pointy2The y position of the second pointquad(x1, y1, x2, y2, x3, y3, x4, y4);Draw a quad on the screen
x1The x position of the first pointy1The y position of the first pointx2The x position of the second pointy2The y position of the second pointx3The x position of the third pointy3The y position of the third pointx4The x position of the fourth pointy4The y position of the fourth pointpoint();Draw a point on the screen
arc();Draw an arc on the screen
ellipse();Draw an ellipse on the screen
triangle();Draw a triangle on the screen
beginShape(mode);Begin adding vertices to a custom shape
modeThe opengl shape mode LINES, POINTS, QUADS, TRIANGLES, TRIANGLE_FANThe following would draw a 100 by 100 square at position 100, 100 -The following would draw a 100 by 100 square at position 100, 100
beginShape(QUADS);
- vertex(100, 100);
- vertex(100, 200);
- vertex(200, 200);
- vertex(200, 100);
- endShape();vertex(x, y);beginShape must be called prior
Adding a vertex to a custom shape
xThe x positionyThe y positionendShape();beginShape must be called prior
Close the custom shape
circle(x, y, d);Draw a circle to the opengl context
xThe x position of the circleyThe y position of the circledThe diameter of the circlerect(x, y, w, h);Draw a rectangle to the opengl context
xThe x position of the reactangleyThe y position of the reactanglewThe widthhThe heightsquare(x, y, s);Draw a square to the opengl context
xThe x position of the squareyThe y position of the squaresThe size of the squareline(x1, y1, x2, y2);Draw a line to the opengl context
x1The x position of the first pointy1The y position of the first pointx2The x position of the second pointy2The y position of the second pointquad(x1, y1, x2, y2, x3, y3, x4, y4);Draw a quad on the screen
x1The x position of the first pointy1The y position of the first pointx2The x position of the second pointy2The y position of the second pointx3The x position of the third pointy3The y position of the third pointx4The x position of the fourth pointy4The y position of the fourth pointpoint();Draw a point on the screen
arc();Draw an arc on the screen
ellipse();Draw an ellipse on the screen
triangle();Draw a triangle on the screen
beginShape(mode);Begin adding vertices to a custom shape
modeThe opengl shape mode LINES, POINTS, QUADS, TRIANGLES, TRIANGLE_FANThe following would draw a 100 by 100 square at position 100, 100 +The following would draw a 100 by 100 square at position 100, 100
beginShape(QUADS);
+ vertex(100, 100);
+ vertex(100, 200);
+ vertex(200, 200);
+ vertex(200, 100);
+endShape();vertex(x, y);beginShape must be called prior
Adding a vertex to a custom shape
xThe x positionyThe y positionendShape();beginShape must be called prior
Close the custom shape
plane(w, h);Draw a plane
wThe width dimensionhThe height dimensionbox(w, [h], [d]);Draw a 3D box
wThe width dimension[h]The height dimension[d]The depth dimensionsphere(w, [detailX], [detailY]);Draw a 3D Sphere
wThe width dimension[detailX]The detail in the X axis[detailY]the detailt in the Y axisdebugMode();Helpful 3D Graphics
rotateX(angle);Rotate geometry around the X axis
angleThe angle of rotationrotateY(angle);Rotate geometry around the Y axis
angleThe angle of rotationrotateZ(angle);Rotate geometry around the Z axis
angleThe angle of rotationrotate(angle);Rotate geometry in 2D
angleThe angle of rotationscale(x, y, [z]);scale geometry
currently only used for 3D
xThe x scalingyThe y scaling[z]The z scalingtranslate(x, y, [z]);translate geometry
currently only used for 3D
xThe x translationyThe y translation[z]The z translationloadFont(path);Load a font
pathThe font path on the local systemfontThe image reference function setup()
- createWindow(600, 600);
- font = loadFont('/path/to/myfont.ttf');
- end
+lu5 | typography typography
v0.1.6loadFont(path);Load a font
Arguments
pathThe font path on the local systemReturns
fontThe image referencefunction setup()
+ createWindow(600, 600);
+ font = loadFont('/path/to/myfont.ttf');
+end
- function draw()
- background(51);
+function draw()
+ background(51);
- textFont(font);
- text('Hello from lu5!', 30, 50);
- end
textSize(size);Set the font size
Arguments
sizeThe size of the font in pixelsIf this is called using fonts, make sure to call textSize after calling textFont
textSize(56);
- text('Big Text', 50, 50);
textFont(font);Set the font family
Arguments
fontThe font value returned when using loadFont textFont(myfont);
- text('Hello world!', 100, 200);
text(str, x, y);Draw text on the screen
Arguments
strString to renderxThe x position of the start of the textyThe y position of the top of the textFonts are not yet implemented
text('Hello lu5!', 40, 60);
textSize(size);Set the font size
sizeThe size of the font in pixelsIf this is called using fonts, make sure to call textSize after calling textFont
textSize(56);
+text('Big Text', 50, 50);textFont(font);Set the font family
fontThe font value returned when using loadFonttextFont(myfont);
+text('Hello world!', 100, 200);text(str, x, y);Draw text on the screen
strString to renderxThe x position of the start of the textyThe y position of the top of the textFonts are not yet implemented
text('Hello lu5!', 40, 60);createVector(x, y);Create a vector instance
xThe first component of the vectoryThe second component of the vectorVectorThe created vector local a = createVector(3, 5);
- local b = createVector(1, 3);
-
- local c = a:add(b);
-
- print(c);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);
-
- -- With class method
- Vector.print(a);
-
- -- with instance
- a:print();Vector.mult(a, b);No description
aThe first vectorbThe second vectorVectorThe added vector local a = createVector(3, 5);
- local b = createVector(1, 3);
-
- print(a:mult(b));
- print(Vector.mult(a, b));Vector.add(a, b);No description
aThe first vectorbThe second vectorVectorThe multiplied vector local a = createVector(1, 4);
- local b = createVector(8, 2);
-
- print(a:add(b));
- print(Vector.add(a, b));createVector(x, y);Create a vector instance
xThe first component of the vectoryThe second component of the vectorVectorThe created vectorlocal point = createVector(80, 125);
+
+print(point);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);
+
+-- With class method
+Vector.print(a);
+
+-- with instance
+a:print();Vector.dist(a, b);No description
aThe first pointbThe second pointnumberThe distance between the two pointslocal a = createVector(300, 500);
+local b = createVector(200, 250);
+
+local distance = a:dist(b);
+print(distance);Vector.dot(a, b);No description
aThe first vectorbThe second vectornumberThe dot productlocal a = createVector(3, 5);
+local b = createVector(1, 3);
+
+-- From prototype
+print(a:dot(b)); -- 18.0
+
+-- With static method
+print(Vector.dot(a, b)); -- 18.0
+
+-- With concat syntax
+print(a .. b); -- 18.0Vector.add(a, b);No description
aThe first vectorbThe second vectorVectorThe added vectorlocal a = createVector(4, 2);
+local b = createVector(2, 1);
+
+-- Non-mutable
+print(Vector.add(a, b)); -- { 6.0, 3.0 }
+print(a + b); -- { 6.0, 3.0 }
+print(a); -- { 4.0, 2.0 }
+
+-- Mutable
+print(a:add(b)); -- { 6.0, 3.0 }
+print(a) -- { 6.0, 3.0 }Vector.sub(a, b);No description
aThe first vectorbThe second vectorVectorThe subtracted vectorlocal a = createVector(3, 5);
+local b = createVector(2, 3);
+
+-- Non-mutable
+print(Vector.sub(a, b)); -- { 1.0, 2.0 }
+print(a - b); -- { 1.0, 2.0 }
+print(a); -- { 3.0, 5.0 }
+
+-- Mutable
+print(a:sub(b)); -- { 1.0, 2.0 }
+print(a); -- { 1.0, 2.0 }Vector.mult(a, b);No description
aThe first vectorbThe second vectorVectorThe multiplied vectorlocal a = createVector(3, 5);
+local b = createVector(2, 3);
+
+-- Non-mutable
+print(Vector.mult(a, b)); -- { 6.0, 15.0 }
+print(a * b); -- { 6.0, 15.0 }
+print(a); -- { 3.0, 5.0 }
+
+-- Mutable
+print(a:mult(b)); -- { 3.0, 15.0 }
+print(a); -- { 3.0, 15.0 }Vector.div(a, b);No description
aThe first vectorbThe second vectorVectorThe divided vectorlocal a = createVector(4, 2);
+local b = createVector(2, 1);
+
+-- Non-mutable
+print(Vector.div(a, b)); -- { 2.0, 2.0 }
+print(a / b); -- { 2.0, 2.0 }
+print(a); -- { 4.0, 2.0 }
+
+-- Mutable
+print(a:div(b)); -- { 2.0, 2.0 }
+print(a) -- { 2.0, 2.0 }Vector.idiv(a, b);No description
aThe first vectorbThe second vectorVectorThe divided vectorlocal a = createVector(7, 8);
+local b = createVector(2, 3);
+
+-- Non-mutable
+print(Vector.idiv(a, b)) -- { 3.0, 2.0 }
+print(a // b); -- { 3.0, 2.0 }
+print(a); -- { 7.0, 8.0 }
+
+-- Mutable
+print(a:idiv(b)); -- { 3.0, 2.0 }
+print(a) -- { 3.0, 2.0 }Vector.copy();No description
VectorThe divided vectorlocal a = createVector(300, 450, 400);
+
+local copy_1 = a:copy();
+
+local copy_2 = Vector.copy(a);createWindow(w, h);Create a GLFW window.
wWindow widthhWindow heightIt 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
- endframeRate(fps);Set the frame rate
fpsThe frame rate to setIf frame rate is called without an argument, it will return frame per seconds
x = 0;
-
- function setup()
- createWindow(400, 400);
- frameRate(24);
- end
-
- function draw()
- background(51);
- text('fps: ' .. frameRate(), 20, 10);
-
- circle(x, 200, 32);
- x = x + 1;
- enddeltaTimeGlobalElapsed time since the last draw call in seconds
x = 0;
- vx = 128;
-
- function setup()
- createWindow(400, 400);
- frameRate(24); -- try with 60
- end
-
- function draw()
- background(51);
-
- circle(x, height/2, 32);
-
- -- Get the same velocity with different framerates
- x = x + vx deltaTime;
- endwidthGlobalThe window's width in pixels. If no window was created, this value is nil
createWindow(800, 600);
-
- print(width);
- -- 800heightGlobalThe window's height in pixels. If no window was created, this value is nil
createWindow(800, 600);
-
- print(height);
- -- 600windowResized();EventCalled when the window is resized
function setup()
- createWindow(500, 500);
- end
-
- function draw()
- background(51)
- end
-
- function windowResized()
- print('Resized!')
- endcreateWindow(w, h);Create a GLFW window.
wWindow widthhWindow heightIt 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
+endframeRate(fps);Set the frame rate
fpsThe frame rate to setIf frame rate is called without an argument, it will return frame per seconds
x = 0;
+
+function setup()
+ createWindow(400, 400);
+ frameRate(24);
+end
+
+function draw()
+ background(51);
+ text('fps: ' .. frameRate(), 20, 10);
+
+ circle(x, 200, 32);
+ x = x + 1;
+enddeltaTimeGlobalElapsed time since the last draw call in seconds
x = 0;
+vx = 128;
+
+function setup()
+ createWindow(400, 400);
+ frameRate(24); -- try with 60
+end
+
+function draw()
+ background(51);
+
+ circle(x, height/2, 32);
+
+ -- Get the same velocity with different framerates
+ x = x + vx * deltaTime;
+endwidthGlobalThe window's width in pixels. If no window was created, this value is nil
createWindow(800, 600);
+
+print(width);
+-- 800heightGlobalThe window's height in pixels. If no window was created, this value is nil
createWindow(800, 600);
+
+print(height);
+-- 600windowResized();EventCalled when the window is resized
function setup()
+ createWindow(500, 500);
+end
+
+function draw()
+ background(51)
+end
+
+function windowResized()
+ print('Resized!')
+endorbitControl();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
+
+function draw()
+ background(51);
+
+ -- Allows us to control the camera
+ orbitControl();
+
+ noFill();
+ stroke(80, 255, 50);
+ strokeWeight(4);
+
+ box(60);
+endclass(name);Create a class.
if a class implements a print method, it can be used in the print function
nameThe class namelocal Player = class('Player');
+
+function Player:init(x, y)
+ self.x = x;
+ self.y = y;
+ return self;
+end
+
+function Player:draw()
+ circle(self.x, self.y, 16);
+end
+
+
+-- Create 2 players and draw them
+local p1 = Player:new(100, 200);
+local p2 = Player:new(300, 200);
+
+function setup()
+ createWindow(400, 400);
+end
+
+function draw()
+ background(51);
+
+ p1:draw();
+ p2:draw();
+endloadImage(path);Load a png or jpeg image
pathThe local image pathImageThe image instancefunction setup()
+ createWindow(600, 600);
+ img = loadImage('/path/to/mypic.png');
+end
+
+function draw()
+ background(51);
+
+ image(img, 0, 0);
+end image(img, x, y, [w], [h]);Draw an image to the screen
imgThe Image instancexThe x position of the imageyThe 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 heightImage.crop(x, y, w, h);Crop an Image into an other Image
xThe x position of the imageyThe y position of the imagewThe width of the new cropped imagehThe height of the new cropped imageImagethe cropped imageprint(value);Printing utility, can take any lua type.
valueThe value to print to stdoutprint(42);
+
+print(1, 2, 3);
+
+print('Hello world');
+
+print({ 3, 8, 1 });loadText(file_path);Read a file as a string
file_pathThe path of the filefile = loadText("./your-file.txt");
+print(file)loadStrings(file_path);Read a file as an array of strings split by line
file_pathThe path of the filefile = loadStrings("./your-file.txt");
+print(file)keyIsDown(k);Check if a keyboard key is pressed, returns true if key is down and returns false if it's not
kThe keyboard key to check as a key global, or a stringbooleanWhether or not the key is down-- Use a string
+if (keyIsDown('a')) then
+ -- key 'a' is down
+end
+
+-- use a global
+if (keyIsDown(LEFT_ARROW)) then
+ -- left arrow is down
+endkeyPressed(key, keyCode);EventCalled whenever a key is pressed.
keyThe pressed key as a string, is nil if glfw cannot find a name for the keykeyCodeThe pressed key as a key codefunction setup()
+ createWindow(600, 600);
+end
+
+function draw()
+ background(51);
+end
+
+function keyPressed(key, keyCode)
+ print(key, keyCode)
+endkeyReleased(key, keyCode);EventCalled whenever a key is released.
keyThe released key as a string, is nil if glfw cannot find a name for the keykeyCodeThe released key as a key codekeyHeld(key, keyCode);EventCalled whenever a key is held down.
keyThe held key as a string, is nil if glfw cannot find a name for the keykeyCodeThe held key as a key codeUP_ARROWConstantNo description
DOWN_ARROWConstantNo description
LEFT_ARROWConstantNo description
RIGHT_ARROWConstantNo description
KEY_ENTERConstantNo description
KEY_BACKSPACEConstantNo description
KEY_AConstantNo description
KEY_BConstantNo description
KEY_CConstantNo description
KEY_DConstantNo description
KEY_EConstantNo description
KEY_FConstantNo description
KEY_GConstantNo description
KEY_HConstantNo description
KEY_IConstantNo description
KEY_JConstantNo description
KEY_KConstantNo description
KEY_LConstantNo description
KEY_MConstantNo description
KEY_NConstantNo description
KEY_OConstantNo description
KEY_PConstantNo description
KEY_QConstantNo description
KEY_RConstantNo description
KEY_SConstantNo description
KEY_TConstantNo description
KEY_UConstantNo description
KEY_VConstantNo description
KEY_WConstantNo description
KEY_XConstantNo description
KEY_YConstantNo description
KEY_ZConstantNo description
randomSeed(seed);Set a random seed
seedThe seed valuenumberThe random valuerandom(min, max);Get a random number
minThe minimum of the rangemaxThe maximum of the rangenumberThe random valuerandom() -- random number between 0 and 1
+random(3) -- random number between 0 and 3
+random(3, 12) -- random number between 3 and 12
+
+random({ 'A', 'B', 'C' }) -- random element in tableround(x);Round a number to the nearest integer
xThe value to roundintThe rounded valuefloor(x);floor is a function that takes in a number, and returns the greatest integer less or equal to x
see here
xThe value to floorintgreatest integer less than or equals to xceil(x);ceil is a function that takes in a number, and returns the smallest integer greater or equal to x
see here
xThe value to floorintThe floored valuemin(a, b);Return the smallest value.
Can also take any number of arguments, or a table.
aThe first valuebThe second valuenumberThe smallest valuemin(6, 7); -- returns 6
+
+min(6, 7, 4); -- returns 4
+
+min({ 6, 7, 4 }); -- returns 4max(a, b);Return the largest value.
Can also take any number of arguments, or a table.
aThe first valuebThe second valuenumberThe largest valuemax(2, 5); -- returns 5
+
+max(2, 5, 7); -- returns 7
+
+max({ 2, 5, 7 }); -- returns 7abs(x);Returns the absolute value of x
see here
xThe input valuenumberThe absolote value of the inputmap(x, s1, e1, s2, e2);Maps x from an original range to a target range
xThe value to maps1The start of the initial rangee1The end of the initial ranges2The start of the target rangee2The end of the target rangenumberThe mapped valuedist(x1, y1, x2, y1);Calculates the distance between 2 points in 2D space
x1The x coordinate of the first pointy1The y coordinate of the first pointx2The x coordinate of the second pointy1The y coordinate of the second pointnumberThe distance between the pointsconstrain(x, min, max);Limits x to a minimum and maximum value
xThe input valueminThe minimum valuemaxThe maximum valuenumberThe constrained valuesin(x);Sine function (Trigonometry)
xThe input valuenumberThe output valuecos(x);Cosine function (Trigonometry)
xThe input valuenumberThe output valuetan(x);Tangent function (Trigonometry)
xThe input valuenumberThe output valuePIConstantNo description
TWO_PIConstantNo description
HALF_PIConstantNo description
QUARTER_PIConstantNo description
model(model);Draw a 3D model
modelThe 3D modelloadModel(model);Load a 3D model
modelThe 3D modelmouseYGlobalThe y mouse coordinate
createWindow(400, 400);
+
+function draw()
+ background(51);
+
+ line(0, mouseY, width, mouseY);
+endmouseXGlobalThe x mouse coordinate
createWindow(400, 400);
+
+function draw()
+ background(51);
+
+ line(mouseX, 0, mouseX, height);
+endpmouseYGlobalNo description
pmouseXGlobalNo description
mouseIsPressedGlobalIs true when the mouse is pressed, is false when it's not
mousePressed(button);EventCalled when a mouse button is pressed.
buttonThe pressed mouse button
+In the following example, the circle's size increases when the user clicks the mouse.
size = 0;
+
+function setup()
+ createWindow(400, 400);
+end
+
+function draw()
+ background(51);
+
+ circle(mouseX, mouseY, size);
+end
+
+-- Increase circle size when mouse pressed
+function mousePressed()
+ size = size + 1;
+endmouseReleased(button);EventCalled when a mouse button is released.
buttonThe released mouse button
+In the following example, the circle's size increases when the user clicks the mouse.
size = 32;
+
+function setup()
+ createWindow(400, 400);
+end
+
+function draw()
+ background(51);
+
+ circle(mouseX, mouseY, size);
+end
+
+-- Set larger circle size
+function mousePressed()
+ size = 64;
+end
+
+-- Reset size
+function mouseReleased()
+ size = size + 6;
+endmouseWheel(button);EventCalled when a mouse wheel is used
buttonThe pressed mouse button
+In the following example, the circle's size changes when the user scrolls
size = 0;
+
+function setup()
+ createWindow(400, 400);
+end
+
+function draw()
+ background(51);
+
+ circle(mouseX, mouseY, size);
+end
+
+-- Change circle size when mouse is scrolled
+function mouseWheel(delta)
+ size = size + delta;
+endbackground(r, g, b, a);Clear a background with a color
rThe red bytegThe green bytebThe blue byteaThe alpha bytefill(r, g, b, [a]);Set the fill color for shapes
rThe red bytegThe green bytebThe blue byte[a]The alpha byteCan also accept a hexadecimal or color name as string
fill(255, 150, 40);
+square(200, 200, 64);strokeWeight(weight);No description
weightThe line width in pixelstrokeWeight(8);
+ine(200, 200, mouseX, mouseY);noFill();Disable fill
stroke(r, g, b, a);Set the stroke color for shapes
rThe red bytegThe green bytebThe blue byteaThe alpha byteOnly implemented for line and circle
noStroke();Disable stroke
Only implemented for line and circle
push();Save the style settings
pop();Restore the style settings
circle(x, y, d);Draw a circle to the opengl context
xThe x position of the circleyThe y position of the circledThe diameter of the circlerect(x, y, w, h);Draw a rectangle to the opengl context
xThe x position of the reactangleyThe y position of the reactanglewThe widthhThe heightsquare(x, y, s);Draw a square to the opengl context
xThe x position of the squareyThe y position of the squaresThe size of the squareline(x1, y1, x2, y2);Draw a line to the opengl context
x1The x position of the first pointy1The y position of the first pointx2The x position of the second pointy2The y position of the second pointquad(x1, y1, x2, y2, x3, y3, x4, y4);Draw a quad on the screen
x1The x position of the first pointy1The y position of the first pointx2The x position of the second pointy2The y position of the second pointx3The x position of the third pointy3The y position of the third pointx4The x position of the fourth pointy4The y position of the fourth pointpoint();Draw a point on the screen
arc();Draw an arc on the screen
ellipse();Draw an ellipse on the screen
triangle();Draw a triangle on the screen
beginShape(mode);Begin adding vertices to a custom shape
modeThe opengl shape mode LINES, POINTS, QUADS, TRIANGLES, TRIANGLE_FANThe following would draw a 100 by 100 square at position 100, 100 +The following would draw a 100 by 100 square at position 100, 100
beginShape(QUADS);
+ vertex(100, 100);
+ vertex(100, 200);
+ vertex(200, 200);
+ vertex(200, 100);
+endShape();vertex(x, y);beginShape must be called prior
Adding a vertex to a custom shape
xThe x positionyThe y positionendShape();beginShape must be called prior
Close the custom shape
plane(w, h);Draw a plane
wThe width dimensionhThe height dimensionbox(w, [h], [d]);Draw a 3D box
wThe width dimension[h]The height dimension[d]The depth dimensionsphere(w, [detailX], [detailY]);Draw a 3D Sphere
wThe width dimension[detailX]The detail in the X axis[detailY]the detailt in the Y axisdebugMode();Helpful 3D Graphics
rotateX(angle);Rotate geometry around the X axis
angleThe angle of rotationrotateY(angle);Rotate geometry around the Y axis
angleThe angle of rotationrotateZ(angle);Rotate geometry around the Z axis
angleThe angle of rotationrotate(angle);Rotate geometry in 2D
angleThe angle of rotationscale(x, y, [z]);scale geometry
currently only used for 3D
xThe x scalingyThe y scaling[z]The z scalingtranslate(x, y, [z]);translate geometry
currently only used for 3D
xThe x translationyThe y translation[z]The z translationloadFont(path);Load a font
pathThe font path on the local systemfontThe image referencefunction setup()
+ createWindow(600, 600);
+ font = loadFont('/path/to/myfont.ttf');
+end
+
+function draw()
+ background(51);
+
+ textFont(font);
+ text('Hello from lu5!', 30, 50);
+end textSize(size);Set the font size
sizeThe size of the font in pixelsIf this is called using fonts, make sure to call textSize after calling textFont
textSize(56);
+text('Big Text', 50, 50);textFont(font);Set the font family
fontThe font value returned when using loadFonttextFont(myfont);
+text('Hello world!', 100, 200);text(str, x, y);Draw text on the screen
strString to renderxThe x position of the start of the textyThe y position of the top of the textFonts are not yet implemented
text('Hello lu5!', 40, 60);createVector(x, y);Create a vector instance
xThe first component of the vectoryThe second component of the vectorVectorThe created vectorlocal point = createVector(80, 125);
+
+print(point);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);
+
+-- With class method
+Vector.print(a);
+
+-- with instance
+a:print();Vector.dist(a, b);No description
aThe first pointbThe second pointnumberThe distance between the two pointslocal a = createVector(300, 500);
+local b = createVector(200, 250);
+
+local distance = a:dist(b);
+print(distance);Vector.dot(a, b);No description
aThe first vectorbThe second vectornumberThe dot productlocal a = createVector(3, 5);
+local b = createVector(1, 3);
+
+-- From prototype
+print(a:dot(b)); -- 18.0
+
+-- With static method
+print(Vector.dot(a, b)); -- 18.0
+
+-- With concat syntax
+print(a .. b); -- 18.0Vector.add(a, b);No description
aThe first vectorbThe second vectorVectorThe added vectorlocal a = createVector(4, 2);
+local b = createVector(2, 1);
+
+-- Non-mutable
+print(Vector.add(a, b)); -- { 6.0, 3.0 }
+print(a + b); -- { 6.0, 3.0 }
+print(a); -- { 4.0, 2.0 }
+
+-- Mutable
+print(a:add(b)); -- { 6.0, 3.0 }
+print(a) -- { 6.0, 3.0 }Vector.sub(a, b);No description
aThe first vectorbThe second vectorVectorThe subtracted vectorlocal a = createVector(3, 5);
+local b = createVector(2, 3);
+
+-- Non-mutable
+print(Vector.sub(a, b)); -- { 1.0, 2.0 }
+print(a - b); -- { 1.0, 2.0 }
+print(a); -- { 3.0, 5.0 }
+
+-- Mutable
+print(a:sub(b)); -- { 1.0, 2.0 }
+print(a); -- { 1.0, 2.0 }Vector.mult(a, b);No description
aThe first vectorbThe second vectorVectorThe multiplied vectorlocal a = createVector(3, 5);
+local b = createVector(2, 3);
+
+-- Non-mutable
+print(Vector.mult(a, b)); -- { 6.0, 15.0 }
+print(a * b); -- { 6.0, 15.0 }
+print(a); -- { 3.0, 5.0 }
+
+-- Mutable
+print(a:mult(b)); -- { 3.0, 15.0 }
+print(a); -- { 3.0, 15.0 }Vector.div(a, b);No description
aThe first vectorbThe second vectorVectorThe divided vectorlocal a = createVector(4, 2);
+local b = createVector(2, 1);
+
+-- Non-mutable
+print(Vector.div(a, b)); -- { 2.0, 2.0 }
+print(a / b); -- { 2.0, 2.0 }
+print(a); -- { 4.0, 2.0 }
+
+-- Mutable
+print(a:div(b)); -- { 2.0, 2.0 }
+print(a) -- { 2.0, 2.0 }Vector.idiv(a, b);No description
aThe first vectorbThe second vectorVectorThe divided vectorlocal a = createVector(7, 8);
+local b = createVector(2, 3);
+
+-- Non-mutable
+print(Vector.idiv(a, b)) -- { 3.0, 2.0 }
+print(a // b); -- { 3.0, 2.0 }
+print(a); -- { 7.0, 8.0 }
+
+-- Mutable
+print(a:idiv(b)); -- { 3.0, 2.0 }
+print(a) -- { 3.0, 2.0 }Vector.copy();No description
VectorThe divided vectorlocal a = createVector(300, 450, 400);
+
+local copy_1 = a:copy();
+
+local copy_2 = Vector.copy(a);createWindow(w, h);Create a GLFW window.
wWindow widthhWindow heightIt 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
+endframeRate(fps);Set the frame rate
fpsThe frame rate to setIf frame rate is called without an argument, it will return frame per seconds
x = 0;
+
+function setup()
+ createWindow(400, 400);
+ frameRate(24);
+end
+
+function draw()
+ background(51);
+ text('fps: ' .. frameRate(), 20, 10);
+
+ circle(x, 200, 32);
+ x = x + 1;
+enddeltaTimeGlobalElapsed time since the last draw call in seconds
x = 0;
+vx = 128;
+
+function setup()
+ createWindow(400, 400);
+ frameRate(24); -- try with 60
+end
+
+function draw()
+ background(51);
+
+ circle(x, height/2, 32);
+
+ -- Get the same velocity with different framerates
+ x = x + vx * deltaTime;
+endwidthGlobalThe window's width in pixels. If no window was created, this value is nil
createWindow(800, 600);
+
+print(width);
+-- 800heightGlobalThe window's height in pixels. If no window was created, this value is nil
createWindow(800, 600);
+
+print(height);
+-- 600windowResized();EventCalled when the window is resized
function setup()
+ createWindow(500, 500);
+end
+
+function draw()
+ background(51)
+end
+
+function windowResized()
+ print('Resized!')
+end