ReiLua API Reference

This function will be called after window has been initialized. Should be used as the main init point.

This function will be called every frame during execution. It will get time duration from last frame on argument 'delta'

This function will be called every frame after update and it should have all rendering related functions. Note: Engine will call Raylib functions 'BeginDrawing()' before this function call and 'EndDrawing()' after it. You can still use RL.BeginDrawing() and RL.EndDrawing() manually from anywhere.

This function will be called on events input. Content of event table is determined by event type.

This function can be used for custom log message handling.

This function will be called on program close. Cleanup could be done here.

This function will be called before InitWindow. Note! Only place where you should call InitWindow manually. Doesn't have OpenGL context at this point.

This function will be called when loading resource that allocates memory. Usefull for memory leak debugging. Note! Cannot detect all resources, for example material textures.

This function will be called when unloading resource that has allocated memory. Usefull for memory leak debugging. Note! Cannot detect all resources, for example material textures.

Initialize asset loading progress tracking and show the loading screen. This displays a beautiful loading UI with progress bar and asset names.

Parameters:

• totalAssets (integer) - Total number of assets to load

Example:

RL.BeginAssetLoading(10)  -- We're loading 10 assets

Features:

• Shows animated "LOADING..." text with dots
• Displays progress bar with shimmer effect
• Shows current asset name being loaded
• Shows progress counter (e.g., "3 / 10")
• 1-bit pixel art aesthetic

Update loading progress for the current asset. Call this after each asset is loaded to update the progress bar and display.

Parameters:

• assetName (string) - Name of the asset currently being loaded

Example:

RL.UpdateAssetLoading("player.png")
-- Load the asset here
playerTexture = RL.LoadTexture("assets/player.png")

Notes:

• Automatically increments the loaded asset counter
• Updates the loading screen UI
• Shows the asset name on screen
• Updates progress bar percentage

Finish asset loading and hide the loading screen. Call this after all assets have been loaded.

Example:

RL.EndAssetLoading()

Complete Example:

function RL.init()
    local assets = {}
    local assetsToLoad = {
        "assets/player.png",
        "assets/enemy.png",
        "assets/background.png",
        "assets/music.wav",
    }
    
    -- Begin loading
    RL.BeginAssetLoading(#assetsToLoad)
    
    -- Load each asset
    for i, path in ipairs(assetsToLoad) do
        RL.UpdateAssetLoading(path)
        
        if path:match("%.png$") then
            assets[i] = RL.LoadTexture(path)
        elseif path:match("%.wav$") then
            assets[i] = RL.LoadSound(path)
        end
    end
    
    -- Done loading
    RL.EndAssetLoading()
end

Vector2, 2 components

Vector3, 3 components

Vector4, 4 components

Quaternion, 4 components (Vector4 alias)

Matrix, 4x4 components, column major, OpenGL style, right-handed. Identity matrix example

Color, 4 components, R8G8B8A8 (32bit)

Rectangle, 4 components

Image, pixel data stored in CPU memory (RAM)

Texture, tex data stored in GPU memory (VRAM)

textureData = {
	id = unsigned int,		--OpenGL texture id
	width = int,			--Texture base width
	height = int,			--Texture base height
	mipmaps = int,			--Mipmap levels, 1 by default
	format = int			--Data format (PixelFormat type)
}

RenderTexture, fbo for texture rendering

renderTextureData = {
	id = unsigned int,		--OpenGL framebuffer object id
	texture = Texture,		--Color buffer attachment texture
	depth = Texture,		--Depth buffer attachment texture
}

Font, font texture and GlyphInfo array data

Camera2D, defines position/orientation in 2d space

Camera, defines position/orientation in 3d space

Mesh, vertex data and vao/vbo

meshData = {
	vertices = Vector3{},		--Vertex position (XYZ - 3 components per vertex) (shader-location = 0)
	texcoords = Vector2{},		--Vertex texture coordinates (UV - 2 components per vertex) (shader-location = 1)
	texcoords2 = Vector2{},		--Vertex texture second coordinates (UV - 2 components per vertex) (shader-location = 5)
	normals = Vector3{},		--Vertex normals (XYZ - 3 components per vertex) (shader-location = 2)
	tangents = Vector4{},		--Vertex tangents (XYZW - 4 components per vertex) (shader-location = 4)
	colors = Color{},			--Vertex colors (RGBA - 4 components per vertex) (shader-location = 3)
	indices = int{}				--Vertex indices (in case vertex data comes indexed)
}

Material, includes shader and maps

materialData = {
	shader = Shader,
	maps = {									--Material maps array (MAX_MATERIAL_MAPS)
		{
    		MATERIAL_MAP_*,						--Example MATERIAL_MAP_ALBEDO
			{
    			texture = Texture,				--Material map texture
        		color = Color,					--Material map color
        		value = float,					--Material map value
      		},
    	},
    	...
  	},
  	params = { float, float, float, float }		--Material generic parameters (if required)
}

Model, meshes, materials and animation data

Ray, ray for raycasting

RayCollision, ray hit information

BoundingBox

GlyphInfo, font characters glyphs info

glyphInfoData = {
	value = int,		--Character value (Unicode)
	offsetX = int,		--Character offset X when drawing
	offsetY = int,		--Character offset Y when drawing
	advanceX = int,		--Character advance position X
	image = Image,		--Character image data
}

Bone, skeletal animation bone

Transform, vertex transformation data

Wave, audio wave data

Sound

SoundAlias

Music, audio stream, anything longer than ~10 seconds should be streamed

NPatchInfo, n-patch layout info

ModelAnimation

Automation event

Automation event list

Data buffer for C primitive types. Type should be one of the Buffer types.

Set to try enabling V-Sync on GPU

Set to run program in fullscreen

Set to allow resizable window

Set to disable window decoration (frame and buttons)

Set to hide window

Set to minimize window (iconify)

Set to maximize window (expanded to monitor)

Set to window non focused

Set to window always on top

Set to allow windows running while minimized

Set to allow transparent framebuffer

Set to support HighDPI

Set to support mouse passthrough, only supported when FLAG_WINDOW_UNDECORATED

Set to try enabling MSAA 4X

Set to try enabling interlaced video format (for V3D)

Display all logs

Trace logging, intended for internal use only

Debug logging, used for internal debugging, it should be disabled on release builds

Info logging, used for program execution info

Warning logging, used on recoverable failures

Error logging, used on unrecoverable failures

Fatal logging, used to abort program: exit(EXIT_FAILURE)

Disable logging

Key: NULL, used for no key pressed

Key: '

Key: ,

Key: -

Key: .

Key: /

Key: 0

Key: 1

Key: 2

Key: 3

Key: 4

Key: 5

Key: 6

Key: 7

Key: 8

Key: 9

Key: ;

Key: =

Key: A | a

Key: B | b

Key: C | c

Key: D | d

Key: E | e

Key: F | f

Key: G | g

Key: H | h

Key: I | i

Key: J | j

Key: K | k

Key: L | l

Key: M | m

Key: N | n

Key: O | o

Key: P | p

Key: Q | q

Key: R | r

Key: S | s

Key: T | t

Key: U | u

Key: V | v

Key: W | w

Key: X | x

Key: Y | y

Key: Z | z

Key: [

Key: '\'

Key: ]

Key: `

Key: Space

Key: Esc

Key: Enter

Key: Tab

Key: Backspace

Key: Ins

Key: Del

Key: Cursor right

Key: Cursor left

Key: Cursor down

Key: Cursor up

Key: Page up

Key: Page down

Key: Home

Key: End

Key: Caps lock

Key: Scroll down

Key: Num lock

Key: Print screen

Key: Pause

Key: F1

Key: F2

Key: F3

Key: F4

Key: F5

Key: F6

Key: F7

Key: F8

Key: F9

Key: F10

Key: F11

Key: F12

Key: Shift left

Key: Control left

Key: Alt left

Key: Super left

Key: Shift right

Key: Control right

Key: Alt right

Key: Super right

Key: KB menu

Key: Keypad 0

Key: Keypad 1

Key: Keypad 2

Key: Keypad 3

Key: Keypad 4

Key: Keypad 5

Key: Keypad 6

Key: Keypad 7

Key: Keypad 8

Key: Keypad 9

Key: Keypad .

Key: Keypad /

Key: Keypad *

Key: Keypad -

Key: Keypad +

Key: Keypad Enter

Key: Keypad =

Key: Android back button

Key: Android menu button

Key: Android volume up button

Key: Android volume down button

Mouse button left

Mouse button right

Mouse button middle (pressed wheel)

Mouse button side (advanced mouse device)

Mouse button extra (advanced mouse device)

Mouse button forward (advanced mouse device)

Mouse button back (advanced mouse device)

Default pointer shape

Arrow shape

Text writing cursor shape

Cross shape

Pointing hand cursor

Horizontal resize/move arrow shape

Vertical resize/move arrow shape

Top-left to bottom-right diagonal resize/move arrow shape

The top-right to bottom-left diagonal resize/move arrow shape

The omnidirectional resize/move cursor shape

The operation-not-allowed shape

Unknown button, just for error checking

Gamepad left DPAD up button

Gamepad left DPAD right button

Gamepad left DPAD down button

Gamepad left DPAD left button

Gamepad right button up (i.e. PS3: Triangle, Xbox: Y)

Gamepad right button right (i.e. PS3: Square, Xbox: X)

Gamepad right button down (i.e. PS3: Cross, Xbox: A)

Gamepad right button left (i.e. PS3: Circle, Xbox: B)

Gamepad top/back trigger left (first), it could be a trailing button

Gamepad top/back trigger left (second), it could be a trailing button

Gamepad top/back trigger right (one), it could be a trailing button

Gamepad top/back trigger right (second), it could be a trailing button

Gamepad center buttons, left one (i.e. PS3: Select)

Gamepad center buttons, middle one (i.e. PS3: PS, Xbox: XBOX)

Gamepad center buttons, right one (i.e. PS3: Start)

Gamepad joystick pressed button left

Gamepad joystick pressed button right

Gamepad left stick X axis

Gamepad left stick Y axis

Gamepad right stick X axis

Gamepad right stick Y axis

Gamepad back trigger left, pressure level: [1..-1]

Gamepad back trigger right, pressure level: [1..-1]

Albedo material (same as: MATERIAL_MAP_DIFFUSE)

Metalness material (same as: MATERIAL_MAP_SPECULAR)

Normal material

Roughness material

Ambient occlusion material

Emission material

Heightmap material

Cubemap material (NOTE: Uses GL_TEXTURE_CUBE_MAP)

Irradiance material (NOTE: Uses GL_TEXTURE_CUBE_MAP)

Prefilter material (NOTE: Uses GL_TEXTURE_CUBE_MAP)

Brdf material

Diffuce material (same as: MATERIAL_MAP_ALBEDO)

Specular material (same as: MATERIAL_MAP_METALNESS)

Shader location: vertex attribute: position

Shader location: vertex attribute: texcoord01

Shader location: vertex attribute: texcoord02

Shader location: vertex attribute: normal

Shader location: vertex attribute: tangent

Shader location: vertex attribute: color

Shader location: matrix uniform: model-view-projection

Shader location: matrix uniform: view (camera transform)

Shader location: matrix uniform: projection

Shader location: matrix uniform: model (transform)

Shader location: matrix uniform: normal

Shader location: vector uniform: view

Shader location: vector uniform: diffuse color

Shader location: vector uniform: specular color

Shader location: vector uniform: ambient color

Shader location: sampler2d texture: albedo (same as: SHADER_LOC_MAP_DIFFUSE)

Shader location: sampler2d texture: metalness (same as: SHADER_LOC_MAP_SPECULAR)

Shader location: sampler2d texture: normal

Shader location: sampler2d texture: roughness

Shader location: sampler2d texture: occlusion

Shader location: sampler2d texture: emission

Shader location: sampler2d texture: height

Shader location: samplerCube texture: cubemap

Shader location: samplerCube texture: irradiance

Shader location: samplerCube texture: prefilter

Shader location: sampler2d texture: brdf

Shader location: vertex attribute: boneIds

Shader location: vertex attribute: boneWeights

Shader location: array of matrices uniform: boneMatrices

Shader location: sampler2d texture: diffuce (same as: SHADER_LOC_MAP_ALBEDO)

Shader location: sampler2d texture: specular (same as: SHADER_LOC_MAP_METALNESS)

Shader uniform type: float

Shader uniform type: vec2 (2 float)

Shader uniform type: vec3 (3 float)

Shader uniform type: vec4 (4 float)

Shader uniform type: int

Shader uniform type: ivec2 (2 int)

Shader uniform type: ivec3 (3 int)

Shader uniform type: ivec4 (4 int)

Shader uniform type: sampler2d

Shader attribute type: float

Shader attribute type: vec2 (2 float)

Shader attribute type: vec3 (3 float)

Shader attribute type: vec4 (4 float)

8 bit per pixel (no alpha)

8*2 bpp (2 channels)

16 bpp

24 bpp

16 bpp (1 bit alpha)

16 bpp (4 bit alpha)

32 bpp

32 bpp (1 channel - float)

32*3 bpp (3 channels - float)

32*4 bpp (4 channels - float)

4 bpp (no alpha)

4 bpp (1 bit alpha)

8 bpp

8 bpp

4 bpp

4 bpp

8 bpp

4 bpp

4 bpp

8 bpp

2 bpp

No filter, just pixel approximation

Linear filtering

Trilinear filtering (linear with mipmaps)

Anisotropic filtering 4x

Anisotropic filtering 8x

Anisotropic filtering 16x

Repeats texture in tiled mode

Clamps texture to edge pixel in tiled mode

Mirrors and repeats the texture in tiled mode

Mirrors and clamps to border the texture in tiled mode

Automatically detect layout type

Layout is defined by a vertical line with faces

Layout is defined by a horizontal line with faces

Layout is defined by a 3x4 cross with cubemap faces

Layout is defined by a 4x3 cross with cubemap faces

Default font generation, anti-aliased

Bitmap font generation, no anti-aliasing

SDF font generation, requires external shader

Blend textures considering alpha (default)

Blend textures adding colors

Blend textures multiplying colors

Blend textures adding colors (alternative)

Blend textures subtracting colors (alternative)

Blend premultiplied textures considering alpha

Blend textures using custom src/dst factors (use rlSetBlendFactors())

Blend textures using custom rgb/alpha separate src/dst factors (use rlSetBlendFactorsSeparate())

No gesture

Tap gesture

Double tap gesture

Hold gesture

Drag gesture

Swipe right gesture

Swipe left gesture

Swipe up gesture

Swipe down gesture

Pinch in gesture

Pinch out gesture

Custom camera

Free camera

Orbital camera

First person camera

Third person camera

Perspective projection

Orthographic projection

Npatch layout: 3x3 tiles

Npatch layout: 1x3 tiles

Npatch layout: 3x1 tiles

Pi

Epsilon

Degrees to radians

Radians to degrees

Used also for: LABELBUTTON

Used also for: TOGGLEGROUP

Used also for: SLIDERBAR

Used also for: TEXTBOXMULTI

Uses: BUTTON, VALUEBOX

Text size (glyphs max height)

Text spacing between glyphs

Line control color

Background color

Text spacing between lines

Text vertical alignment inside text bounds (after border and padding)

Text wrap-mode inside text bounds

ToggleGroup separation between toggles

Slider size of internal bar

Slider/SliderBar internal bar padding

ProgressBar internal padding

(SLIDERBAR, SLIDER_PADDING)

CheckBox internal check padding

ComboBox right button width

ComboBox button separation

DropdownBox arrow separation from border and items

DropdownBox items separation

TextBox in read-only mode: 0-text editable, 1-text no-editable

Spinner left/right buttons width

Spinner buttons separation

ListView items height

ListView items separation

ListView scrollbar size (usually width)

ListView scrollbar side (0-left, 1-right)

ColorPicker right hue bar width

ColorPicker right hue bar separation from panel

ColorPicker right hue bar selector height

ColorPicker right hue bar selector overflow

Directional light

Point light

Default internal render batch elements limits

Default number of batch buffers (multi-buffering)

Default number of batch draw calls (by state changes: mode, texture)

Maximum number of textures units that can be activated on batch drawing (SetShaderValueTexture())

Maximum size of internal Matrix stack

Maximum number of shader locations supported

Default projection matrix near cull distance

Default projection matrix far cull distance

GL_TEXTURE_WRAP_S

GL_TEXTURE_WRAP_T

GL_TEXTURE_MAG_FILTER

GL_TEXTURE_MIN_FILTER

GL_NEAREST

GL_LINEAR

GL_NEAREST_MIPMAP_NEAREST

GL_NEAREST_MIPMAP_LINEAR

GL_LINEAR_MIPMAP_NEAREST

GL_LINEAR_MIPMAP_LINEAR

Anisotropic filter (custom identifier)

Texture mipmap bias, percentage ratio (custom identifier)

GL_REPEAT

GL_CLAMP_TO_EDGE

GL_MIRRORED_REPEAT

GL_MIRROR_CLAMP_EXT

GL_MODELVIEW

GL_PROJECTION

GL_TEXTURE

GL_LINES

GL_TRIANGLES

GL_QUADS

GL_UNSIGNED_BYTE

GL_FLOAT

GL_STREAM_DRAW

GL_STREAM_READ

GL_STREAM_COPY

GL_STATIC_DRAW

GL_STATIC_READ

GL_STATIC_COPY

GL_DYNAMIC_DRAW

GL_DYNAMIC_READ

GL_DYNAMIC_COPY

GL_FRAGMENT_SHADER

GL_VERTEX_SHADER

GL_COMPUTE_SHADER

GL_ZERO

GL_ONE

GL_SRC_COLOR

GL_ONE_MINUS_SRC_COLOR

GL_SRC_ALPHA

GL_ONE_MINUS_SRC_ALPHA

GL_DST_ALPHA

GL_ONE_MINUS_DST_ALPHA

GL_DST_COLOR

GL_ONE_MINUS_DST_COLOR

GL_SRC_ALPHA_SATURATE

GL_CONSTANT_COLOR

GL_ONE_MINUS_CONSTANT_COLOR

GL_CONSTANT_ALPHA

GL_ONE_MINUS_CONSTANT_ALPHA

GL_FUNC_ADD

GL_MIN

GL_MAX

GL_FUNC_SUBTRACT

GL_FUNC_REVERSE_SUBTRACT

GL_BLEND_EQUATION

GL_BLEND_EQUATION_RGB // (Same as BLEND_EQUATION)

GL_BLEND_EQUATION_ALPHA

GL_BLEND_DST_RGB

GL_BLEND_SRC_RGB

GL_BLEND_DST_ALPHA

GL_BLEND_SRC_ALPHA

GL_BLEND_COLOR

GL_READ_FRAMEBUFFER

GL_DRAW_FRAMEBUFFER

OpenGL 1.1

OpenGL 2.1 (GLSL 120)

OpenGL 3.3 (GLSL 330)

OpenGL 4.3 (using GLSL 330)

OpenGL ES 2.0 (GLSL 100)

Framebuffer attachment type: color 0

Framebuffer attachment type: color 1

Framebuffer attachment type: color 2

Framebuffer attachment type: color 3

Framebuffer attachment type: color 4

Framebuffer attachment type: color 5

Framebuffer attachment type: color 6

Framebuffer attachment type: color 7

Framebuffer attachment type: depth

Framebuffer attachment type: stencil

Framebuffer texture attachment type: cubemap, +X side

Framebuffer texture attachment type: cubemap, -X side

Framebuffer texture attachment type: cubemap, +Y side

Framebuffer texture attachment type: cubemap, -Y side

Framebuffer texture attachment type: cubemap, +Z side

Framebuffer texture attachment type: cubemap, -Z side

Framebuffer texture attachment type: texture2d

Framebuffer texture attachment type: renderbuffer

If enabled, blend the computed fragment color values with the values in the color buffers. See glBlendFunc

If enabled, cull polygons based on their winding in window coordinates. See glCullFace

If enabled, do depth comparisons and update the depth buffer. Note that even if the depth buffer exists and the depth mask is non-zero, the depth buffer is not updated if the depth test is disabled. See glDepthFunc and glDepthRangef

If enabled, dither color components or indices before they are written to the color buffer

If enabled, an offset is added to depth values of a polygon's fragments produced by rasterization. See glPolygonOffset

If enabled, compute a temporary coverage value where each bit is determined by the alpha value at the corresponding sample location. The temporary coverage value is then ANDed with the fragment coverage value

If enabled, the fragment's coverage is ANDed with the temporary coverage value. If GL_SAMPLE_COVERAGE_INVERT is set to GL_TRUE, invert the coverage value. See glSampleCoverage

If enabled, discard fragments that are outside the scissor rectangle. See glScissor

If enabled, do stencil testing and update the stencil buffer. See glStencilFunc and glStencilOp

Always fails

Passes if ( ref & mask ) < ( stencil & mask )

Passes if ( ref & mask ) <= ( stencil & mask )

Passes if ( ref & mask ) > ( stencil & mask )

Passes if ( ref & mask ) >= ( stencil & mask )

Passes if ( ref & mask ) = ( stencil & mask )

Passes if ( ref & mask ) != ( stencil & mask )

Always passes

Keeps the current value

Sets the stencil buffer value to 0

Sets the stencil buffer value to ref, as specified by glStencilFunc

Increments the current stencil buffer value. Clamps to the maximum representable unsigned value

Increments the current stencil buffer value. Wraps stencil buffer value to zero when incrementing the maximum representable unsigned value

Decrements the current stencil buffer value. Clamps to 0

Decrements the current stencil buffer value. Wraps stencil buffer value to the maximum representable unsigned value when decrementing a stencil buffer value of zero

Bitwise inverts the current stencil buffer value

Returns the company responsible for this GL implementation. This name does not change from release to release

Returns the name of the renderer. This name is typically specific to a particular configuration of a hardware platform. It does not change from release to release

Returns a version or release number of the form OpenGLES

Returns a version or release number for the shading language of the form OpenGLESGLSLES

Returns a space-separated list of supported extensions to GL

C type unsigned char

C type unsigned short

C type unsigned int

C type unsigned long

C type char

C type short

C type int

C type long

C type float

C type double

Key: Unknown

The key or mouse button was released

The key or mouse button was pressed

The key was held down until it repeated

Joystick connected

Joystick disconnected

GLFW event window size changed

GLFW event window maximize

GLFW event window iconify

GLFW event window focus

GLFW event window drop

GLFW event keyboard key

GLFW event Unicode character

GLFW event mouse button

GLFW event cursor position

GLFW event mouse scroll

GLFW event cursor enter/leave

GLFW event joystick

Initialize window and OpenGL context. Note! Should be called only in RL.config. InitWindow will still be called automatically before RL.init

Close window and unload OpenGL context and free all resources

Check if application should close (KEY_ESCAPE pressed or windows close icon clicked). Note! Not needed unless you want to make custom main loop

Check if window has been initialized successfully

• Success return bool

Check if window is currently fullscreen

• Success return bool

Check if window is currently hidden (only PLATFORM_DESKTOP)

• Success return bool

Check if window is currently minimized (only PLATFORM_DESKTOP)

• Success return bool

Check if window is currently maximized (only PLATFORM_DESKTOP)

• Success return bool

Check if window is currently focused (only PLATFORM_DESKTOP)

• Success return bool

Check if window has been resized from last frame

• Success return bool

Check if one specific window flag is enabled (FLAG_FULLSCREEN_MODE, FLAG_WINDOW_RESIZABLE...)

• Success return bool

Set window configuration state using flags (FLAG_FULLSCREEN_MODE, FLAG_WINDOW_RESIZABLE...)

Clear window configuration state flags (FLAG_FULLSCREEN_MODE, FLAG_WINDOW_RESIZABLE...)

• Success return bool

Toggle window state: fullscreen/windowed, resizes monitor to match window resolution

Toggle window state: borderless windowed, resizes window to match monitor resolution

Set window state: maximized, if resizable (only PLATFORM_DESKTOP)

Set window state: minimized, if resizable (only PLATFORM_DESKTOP)

Set window state: not minimized/maximized (only PLATFORM_DESKTOP)

Set icon for window (Only PLATFORM_DESKTOP)

Set icon for window (multiple images, RGBA 32bit, only PLATFORM_DESKTOP)

Set title for window (only PLATFORM_DESKTOP and PLATFORM_WEB)

Set window position on screen

Set monitor for the current window

Set window minimum dimensions (for FLAG_WINDOW_RESIZABLE)

Set window maximum dimensions (for FLAG_WINDOW_RESIZABLE)

Set window dimensions

Set window opacity [0.0f..1.0f] (only PLATFORM_DESKTOP)

Set window focused (only PLATFORM_DESKTOP)

Get native window handle. Return as lightuserdata

• Success return lightuserdata

Get screen size

• Success return Vector2

Get render size

• Success return Vector2

Get number of connected monitors

• Success return int

Get current connected monitor

• Success return int

Get specified monitor position

• Success return Vector2

Get specified monitor size

• Success return Vector2

Get specified monitor physical size in millimetres

• Success return Vector2

Get specified monitor refresh rate

• Success return int

Get window position on monitor

• Success return Vector2

Get window scale DPI factor

• Success return Vector2

Get the human-readable, UTF-8 encoded name of the specified monitor

• Success return string

Set clipboard text content

Get clipboard text content

• Success return string

Get clipboard image content

• Success return Image

Enable waiting for events on EndDrawing(), no automatic event polling

Disable waiting for events on EndDrawing(), automatic events polling

Shows cursor

Hides cursor

Check if cursor is not visible

• Success return bool

Enables cursor (unlock cursor)

Disables cursor (lock cursor)

Check if cursor is on the screen

• Success return bool

Set background color (framebuffer clear color)

Setup canvas (framebuffer) to start drawing

End canvas drawing and swap buffers (double buffering)

Begin 2D mode with custom camera (2D)

Ends 2D mode with custom camera

Begin 3D mode with custom camera (3D)

Ends 3D mode and returns to default 2D orthographic mode

Begin drawing to render texture

Ends drawing to render texture

Begin custom shader drawing

End custom shader drawing (use default shader)

Begin blending mode (BLEND_ALPHA, BLEND_ADDITIVE, BLEND_MULTIPLIED...)

End blending mode (reset to default: BLEND_ALPHA)

Begin scissor mode (define screen area for following drawing)

End scissor mode

Load shader from files and bind default locations. NOTE: Set nil if no shader

• Failure return nil
• Success return Shader

Load shader from code strings and bind default locations NOTE: Set nil if no shader

• Failure return nil
• Success return Shader

Check if a shader is valid (loaded on GPU)

• Success return bool

Get shader program id

• Success return int

Get shader uniform location

• Success return int

Get shader attribute location

• Success return int

Set shader location index

Get shader location index

• Success return int

Set shader uniform value (matrix 4x4)

Set shader uniform value for texture (sampler2d)

Set shader uniform value NOTE: Even one value should be in table

Set shader uniform value vector NOTE: Even one value should be in table

Set shader uniform value using Buffer object

Set shader uniform value vector using Buffer object

Unload shader from GPU memory (VRAM)

Get a ray trace from screen position (i.e mouse)

• Success return Ray

Get a ray trace from screen position (i.e mouse) in a viewport

• Success return Ray

Get the screen space position for a 3d world space position

• Success return Vector2

Get size position for a 3d world space position

• Success return Vector2

Get the screen space position for a 2d camera world space position

• Success return Vector2

Get the world space position for a 2d camera screen space position

• Success return Vector2

Get camera transform matrix (view matrix)

• Success return Matrix

Get camera 2d transform matrix

• Success return Matrix

Set target FPS (maximum)

Get time in seconds for last frame drawn (Delta time)

• Success return float

Get elapsed time in seconds since InitWindow()

• Success return float

Get current FPS

• Success return int

Swap back buffer with front buffer (screen drawing)

Register all input events

Wait for some time (halt program execution)

Set the seed for the random number generator

Get a random value between min and max (both included)

• Success return int

Load random values sequence, no values repeated

• Success return int{}

Takes a screenshot of current screen (filename extension defines format)

Setup init configuration flags (view FLAGS)

Show trace log messages (LOG_DEBUG, LOG_INFO, LOG_WARNING, LOG_ERROR...)

Set the current threshold (minimum) log level

Set the log level for bad function calls and invalid data formats.

Get the log level for bad function calls and invalid data formats.

• Success return int

Open URL with default system browser (if available)

Check if Lua garbage collection is set to unload object data

• Success return bool

Set Lua garbage collection to unload object data

Get platform. Returns "Windows", "Linux", "FreeBSD", "OpenBSD", "Apple" or "Emscripten"

• Success return string

Load file data as byte array (read). Buffer type is BUFFER_UNSIGNED_CHAR

• Success return Buffer

Save data to file from byte array (write), returns true on success

• Success return bool

Export data to code (.h), returns true on success

• Success return bool

Load text data from file (read)

• Success return string

Save text data to file (write), returns true on success

• Success return bool

Return game directory (where main.lua is located)

• Success return string

Check if file exists

• Success return bool

Check if a directory path exists

• Success return bool

Check file extension (Including point: .png, .wav)

• Success return bool

Get file length in bytes (NOTE: GetFileSize() conflicts with windows.h)

• Success return int

Get pointer to extension for a filename string (Includes dot: '.png')

• Success return string

Get pointer to filename for a path string

• Success return string

Get filename string without extension (Uses static string)

• Success return string

Get full path for a given fileName with path (Uses static string)

• Success return string

Get previous directory path for a given path (Uses static string)

• Success return string

Get current working directory (Uses static string)

• Success return string

Get the directory of the running application (uses static string)

• Success return string

Create directories (including full path requested), returns 0 on success

• Success return int

Change working directory, return true on success

• Success return bool

Check if a given path is a file or a directory

• Success return bool

Check if fileName is valid for the platform/OS

• Success return bool

Load directory filepaths

• Success return string{}

Load directory filepaths with extension filtering and recursive directory scan

• Success return string{}

Check if a file has been dropped into window

• Success return bool

Load dropped filepaths

• Success return string{}

Get file modification time (Last write time)

• Success return int

Compress data (DEFLATE algorithm)

• Success return Buffer

Decompress data (DEFLATE algorithm).

• Success Buffer

Encode data to Base64 string

• Success return string, int

Decode Base64 string data

• Success return string, int

Compute CRC32 hash code.

• Failure return false
• Success return int

Compute MD5 hash code, returns static int[4] (16 bytes).

• Failure return false
• Success return int{4}

Compute SHA1 hash code, returns static int[5] (20 bytes).

• Failure return false
• Success return int{5}

Load automation events list from file, nil for empty list, capacity = MAX_AUTOMATION_EVENTS

• Success return AutomationEventList

Unload automation events list from file

Export automation events list as text file

• Failure return false
• Success return true

Set automation event list to record to

Set automation event internal base frame to start recording

Start recording automation events (AutomationEventList must be set)

Stop recording automation events

Play a recorded automation event

Get automation event list capacity

• Success return int

Get automation event list count

• Success return int

Get automation event from automation event list. Return as lightuserdata

• Failure return nil
• Success return AutomationEvent

Get automation event frame

• Success return int

Get automation event type

• Success return int

Get automation event params

• Success return int{}

Detect if a key has been pressed once

• Success return bool

Check if a key has been pressed again (Only PLATFORM_DESKTOP)

• Success return bool

Detect if a key is being pressed

• Success return bool

Detect if a key has been released once

• Success return bool

Check if a key is NOT being pressed

• Success return bool

Get key pressed (keycode), call it multiple times for keys queued, returns 0 when the queue is empty

• Success return int

Get char pressed (unicode), call it multiple times for chars queued, returns 0 when the queue is empty

• Success return int

Set a custom key to exit program (default is ESC)

Detect if a gamepad is available

• Success return bool

Return gamepad internal name id

• Success return string

Detect if a gamepad button has been pressed once

• Success return bool

Detect if a gamepad button is being pressed

• Success return bool

Detect if a gamepad button has been released once

• Success return bool

Check if a gamepad button is NOT being pressed

• Success return bool

Get the last gamepad button pressed

• Success return int

Return gamepad axis count for a gamepad

• Success return int

Return axis movement value for a gamepad axis

• Success return float

Set internal gamepad mappings (SDL_GameControllerDB)

• Success return int

Set gamepad vibration for both motors (duration in seconds)

Detect if a mouse button has been pressed once

• Success return bool

Detect if a mouse button is being pressed

• Success return bool

Detect if a mouse button has been released once

• Success return bool

Check if a mouse button is NOT being pressed

• Success return bool

Returns mouse position

• Success return Vector2

Get mouse delta between frames

• Success return Vector2

Set mouse position XY

Set mouse offset

Set mouse scaling

Get mouse offset

• Success return Vector2

Get mouse scale

• Success return Vector2

Get mouse wheel movement for X or Y, whichever is larger

• Success return float

Get mouse wheel movement for both X and Y

• Success return Vector2

Set mouse cursor

Get touch position XY for a touch point index (relative to screen size)

• Success return Vector2

Get touch point identifier for given index

• Success return int

Get touch point identifier for given index

• Success return int

Enable a set of gestures using flags

Check if a gesture have been detected

• Success return bool

Get latest detected gesture

• Success return int

Get gesture hold time in milliseconds

• Success return float

Get gesture drag vector

• Success return Vector2

Get gesture drag angle

• Success return float

Get gesture pinch delta

• Success return Vector2

Get gesture pinch angle

• Success return float

Return camera2D set to default configuration

• Success return Camera2D

Set camera target (rotation and zoom origin)

Set camera offset (displacement from target)

Set camera rotation in degrees

Set camera zoom (scaling), should be 1.0f by default

Get camera2D target

• Success return Vector2

Get camera2D offset

• Success return Vector2

Get camera2D rotation

• Success return float

Get camera2D zoom

• Success return float

Return camera3D id set to default configuration

• Success return int

Set camera position (Remember to call "RL.UpdateCamera3D()" to apply changes)

Set camera target it looks-at

Set camera up vector (Rotation over it's axis)

Set camera field-of-view apperture in Y (degrees) in perspective, used as near plane width in orthographic

Set camera projection mode (CAMERA_PERSPECTIVE or CAMERA_ORTHOGRAPHIC)

Get camera position

• Success return Vector3

Get camera target it looks-at

• Success return Vector3

Get camera up vector (Rotation over it's axis)

• Success return Vector3

Get camera field-of-view apperture in Y (degrees) in perspective, used as near plane width in orthographic

• Success return float

Get camera projection mode

• Success return int

Returns the cameras forward vector (normalized)

• Success return Vector3

Returns the cameras up vector (normalized) Note: The up vector might not be perpendicular to the forward vector

• Success return Vector3

Returns the cameras right vector (normalized)

• Success return Vector3

Moves the camera in it's forward direction

Moves the camera in it's up direction

Moves the camera target in it's current right direction

Moves the camera position closer/farther to/from the camera target

Rotates the camera around it's up vector Yaw is "looking left and right" If rotateAroundTarget is false, the camera rotates around it's position Note: angle must be provided in radians

Rotates the camera around it's right vector, pitch is "looking up and down"

• lockView prevents camera overrotation (aka "somersaults")
• rotateAroundTarget defines if rotation is around target or around it's position
• rotateUp rotates the up direction as well (typically only usefull in CAMERA_FREE)

NOTE: angle must be provided in radians

Rotates the camera around it's forward vector Roll is "turning your head sideways to the left or right" Note: angle must be provided in radians

Returns the camera view matrix

• Success return Matrix

Returns the camera projection matrix

• Success return Matrix

Update camera position for selected mode

Update camera movement, movement/rotation values should be provided by user

Load Buffer. Type should be one of the Buffer types. Empty buffer will set data to NULL.

• Success return Buffer

Load formatted buffer with all values set to 'value'

• Success return Buffer

Read buffer data from binary file

• Failure return nil
• Success return Buffer

Read buffer data from string

• Failure return nil
• Success return Buffer

Unload buffer data

Copy buffer data to another buffer. Size is in bytes

Set buffer data value

Swap buffer endianness from big endian to little endian and vice versa

Get buffer data as table in the format it was stored

• Success return data{}

Get buffer as string

• Success return string

Get buffer type

• Success return int

Get buffer size in bytes

• Success return int

Get buffer element size in bytes

• Success return int

Get buffer element count

• Success return int

Write buffer data to binary file

Set texture and rectangle to be used on shapes drawing NOTE: It can be useful when using basic shapes and one single font, defining a font char white rectangle would allow drawing everything in a single draw call

Get texture that is used for shapes drawing. Return as lightuserdata

• Success return Texture

Get texture source rectangle that is used for shapes drawing

• Success return Rectangle

Draw a pixel

Draw a line defining thickness

Draw lines sequence

Draw a line using cubic-bezier curves in-out

Draw a color-filled circle

Draw a piece of a circle

Draw circle sector outline

Draw a gradient-filled circle

Draw circle outline

Draw ellipse

Draw ellipse outline

Draw ring

Draw ring outline

Draw a color-filled rectangle

Draw a color-filled rectangle with pro parameters

Draw a vertical-gradient-filled rectangle

Draw a horizontal-gradient-filled rectangle

Draw a gradient-filled rectangle with custom vertex colors

Draw rectangle outline

Draw rectangle outline with extended parameters

Draw rectangle with rounded edges

Draw rectangle lines with rounded edges

Draw rectangle with rounded edges outline

Draw a color-filled triangle (Vertex in counter-clockwise order!)

Draw triangle outline (Vertex in counter-clockwise order!)

Draw a triangle fan defined by points (first vertex is the center)

Draw a triangle strip defined by points

Draw a regular polygon (Vector version)

Draw a polygon outline of n sides

Draw a polygon outline of n sides with extended parameters

Draw spline: Linear, minimum 2 points

Draw spline: B-Spline, minimum 4 points

Draw spline: Catmull-Rom, minimum 4 points

Draw spline: Quadratic Bezier, minimum 3 points (1 control point): [p1, c2, p3, c4...]

Draw spline: Cubic Bezier, minimum 4 points (2 control points): [p1, c2, c3, p4, c5, c6...]

Draw spline segment: Linear, 2 points

Draw spline segment: B-Spline, 4 points

Draw spline segment: Catmull-Rom, 4 points

Draw spline segment: Quadratic Bezier, 2 points, 1 control point

Draw spline segment: Cubic Bezier, 2 points, 2 control points

Get (evaluate) spline point: Linear

• Success return Vector2

Get (evaluate) spline point: B-Spline

• Success return Vector2

Get (evaluate) spline point: Catmull-Rom

• Success return Vector2

Get (evaluate) spline point: Quadratic Bezier

• Success return Vector2

Get (evaluate) spline point: Cubic Bezier

• Success return Vector2

Check collision between two rectangles

• Success return bool

Check collision between two circles

• Success return bool

Check collision between circle and rectangle

• Success return bool

Check if circle collides with a line created betweeen two points [p1] and [p2]

• Success return bool

Check if point is inside rectangle

• Success return bool

Check if point is inside circle

• Success return bool

Check if point is inside a triangle

• Success return bool

Check if point is within a polygon described by array of vertices

• Success return bool

Check the collision between two lines defined by two points each, returns collision point by reference

• Success return bool, Vector2

Check if point belongs to line created between two points [p1] and [p2] with defined margin in pixels [threshold]

• Success return bool

Get collision rectangle for two rectangles collision

• Success return Rectangle

Useful for e.g. packing rectangular textures into an atlas. stbrp_pack_rects

• Success return Rectangle{}

Load image from file into CPU memory (RAM)

• Failure return nil
• Success return Image

Load image from RAW file data

• Failure return nil
• Success return Image

Load image sequence from file (frames appended to image.data). All frames are returned in RGBA format

• Failure return nil
• Success return Image, int

Load image sequence from memory buffer. All frames are returned in RGBA format

• Success return Image, int

Load image from memory buffer, fileType refers to extension: i.e. '.png'

• Success return Image

Load image from data

• Success return Image

Load image from GPU texture data

• Success return Image

Load image from screen buffer and (screenshot)

• Success return Image

Check if an image is valid (data and parameters)

• Success return bool

Unload image from CPU memory (RAM)

Export image data to file, returns true on success

• Success return bool

Export image to memory buffer

• Success return Buffer

Export image as code file defining an array of bytes, returns true on success

• Success return bool

Generate image: plain color

• Success return Image

Generate image: linear gradient, direction in degrees [0..360], 0=Vertical gradient

• Success return Image

Generate image: radial gradient

• Success return Image

Generate image: square gradient

• Success return Image

Generate image: checked

• Success return Image

Generate image: white noise

• Success return Image

Generate image: perlin noise

• Success return Image

Generate image: cellular algorithm. Bigger tileSize means bigger cells

• Success return Image

Generate image: grayscale image from text data

• Success return Image

Create an image duplicate (useful for transformations)

• Success return Image

Create an image from another image piece

• Success return Image

Create an image from a selected channel of another image (GRAYSCALE)

• Success return Image

Create an image from text (default font)

• Success return Image

Create an image from text (custom sprite font)

• Success return Image

Convert image data to desired format

Convert image to POT (power-of-two)

Crop an image to a defined rectangle

Crop image depending on alpha value

Clear alpha channel to desired color

Apply alpha mask to image

Premultiply alpha channel

Apply Gaussian blur using a box blur approximation

Apply custom square convolution kernel to image

Resize image (Bicubic scaling algorithm)

Resize image (Nearest-Neighbor scaling algorithm)

Resize canvas and fill with color

Generate all mipmap levels for a provided image

Dither image data to 16bpp or lower (Floyd-Steinberg dithering)

Flip image vertically

Flip image horizontally

Rotate image by input angle in degrees (-359 to 359)

Rotate image clockwise 90deg

Rotate image counter-clockwise 90deg

Modify image color: tint

Modify image color: invert

Modify image color: grayscale

Modify image color: contrast (-100 to 100)

Modify image color: brightness (-255 to 255)

Modify image color: replace color

Load color data from image as a Color array (RGBA - 32bit)

• Success return Color{}

Load colors palette from image as a Color array (RGBA - 32bit)

• Success return Color{}

Get image alpha border rectangle

• Success return Rectangle

Get image pixel color at (x, y) position

• Success return Color

Set image data from Buffer

Get image data as Buffer

• Success return Buffer

Get image size

• Success return Vector2

Get image mipmaps. Mipmap levels, 1 by default

• Success return int

Get image data format (PixelFormat type)

• Success return int

Clear image background with given color

Draw pixel within an image

Draw line within an image

Draw a line defining thickness within an image

Draw circle within an image

Draw circle outline within an image

Draw rectangle within an image

Draw rectangle lines within an image

Draw triangle within an image

Draw triangle with interpolated colors within an image

Draw triangle outline within an image

Draw a triangle fan defined by points within an image (first vertex is the center)

Draw a triangle strip defined by points within an image

Draw a source image within a destination image (Tint applied to source)

Draw text (using default font) within an image (destination)

Draw text (Custom sprite font) within an image (Destination)

Get default texture. Return as lightuserdata

• Success return Texture

Load texture from file into GPU memory ( VRAM )

• Failure return nil
• Success return Texture

Load texture from image data

• Success return Texture

Load cubemap from image, multiple image cubemap layouts supported

• Success return Texture

Load Texture from data

• Success return Texture

Load texture for rendering (framebuffer)

• Success return RenderTexture

Load RenderTexture from data (framebuffer)

• Success return RenderTexture

Check if a texture is valid (loaded in GPU)

• Success return bool

Unload texture from GPU memory (VRAM)

Check if a render texture is valid (loaded in GPU)

• Success return bool

Unload render texture from GPU memory (VRAM)

Update GPU texture with new data

Update GPU texture rectangle with new data.

Generate GPU mipmaps for a texture

Set texture scaling filter mode (TEXTURE_FILTER_POINT, TEXTURE_FILTER_BILINEAR...)

Set texture wrapping mode (TEXTURE_WRAP_REPEAT, TEXTURE_WRAP_CLAMP...)

Get OpenGL texture id

• Success return int

Get texture size

• Success return Vector2

Get texture mipmaps. Mipmap levels, 1 by default

• Success return int

Get texture data format (PixelFormat type)

• Success return int

Draw a Texture2D

Draw a Texture2D with extended parameters

Draw a part of a texture defined by a rectangle

Draw a part of a texture defined by a rectangle with "pro" parameters

Draws a texture (or part of it) that stretches or shrinks nicely

Draws a texture (or part of it) that repeats nicely

Get OpenGL framebuffer object id

• Success return int

Get color buffer attachment texture. Returns as lightuserdata

• Success return Texture

Get depth buffer attachment texture. Returns as lightuserdata

• Success return Texture

Check if two colors are equal

• Success return bool

Returns color with alpha applied, alpha goes from 0.0f to 1.0f

• Success return Color

Returns hexadecimal value for a Color

• Success return int

Returns Color normalized as float [0..1]

• Success return Vector4

Color from normalized values [0..1]

• Success return Color

Returns HSV values for a Color, hue [0..360], saturation/value [0..1]

• Success return Vector3

Returns a Color from HSV values, hue [0..360], saturation/value [0..1]

• Success return Color

Get color multiplied with another color

• Success return Color

Get color with brightness correction, brightness factor goes from -1.0f to 1.0f

• Success return Color

Get color with contrast correction, contrast values between -1.0f and 1.0f

• Success return Color

Returns color with alpha applied, alpha goes from 0.0f to 1.0f

• Success return Color

Returns src alpha-blended into dst color with tint

• Success return Color

Get color lerp interpolation between two colors, factor [0.0f..1.0f]

• Success return Color

Get Color structure from hexadecimal value

• Success return Color

Get pixel data size in bytes for certain format

• Success return int

Get the default Font. Return as lightuserdata

• Success return Font

Load font from file into GPU memory (VRAM)

• Failure return nil
• Success return Font

Load font from file with extended parameters, use NULL for codepoints to load the default character set

• Failure return nil
• Success return Font

Load font from Image (XNA style)

• Success return Font

Load font from memory buffer, fileType refers to extension: i.e. '.ttf'. NOTE: fileData type should be unsigned char

• Success return Font

Load Font from data

• Success return Font

Load font copy as new userdata

• Success return Font

Check if a font is valid (font data loaded, WARNING: GPU texture not checked)

• Success return bool

Load font data for further use. NOTE: fileData type should be unsigned char

• Success return GlyphInfo{}

Generate image font atlas using chars info. NOTE: Packing method: 0-Default, 1-Skyline

• Success Image, Rectangle{}

Unload font from GPU memory (VRAM)

Export font as code file, returns true on success

• Success return bool

Draw current FPS

Draw text (using default font)

Draw text using font and additional parameters

Draw text using Font and pro parameters (rotation)

Draw one character (codepoint)

Draw multiple character (codepoint)

Draw text inside rectangle limits. Return character id from mouse position (default 0). textOffset can be used to set start position inside rectangle. Usefull to pass from previous DrawTextBoxed for continuous text. Support for tint change with "\a#FFFFFFFF"

• Success return int, Vector2

Set vertical line spacing when drawing with line-breaks

Get vertical line spacing when drawing with line-breaks

• Success return int

Measure string width for default font

• Success return int

Measure string size for Font

• Success return Vector2

Measure text inside rectangle limits.

• Success return Vector2, Vector2

Get glyph index position in font for a codepoint (unicode character), fallback to '?' if not found

• Success return int

Get glyph font info data for a codepoint (unicode character), fallback to '?' if not found. Return as lightuserdata

• Success return GlyphInfo

Get glyph font info data by index. Return as lightuserdata

• Failure return nil
• Success return GlyphInfo

Get glyph rectangle in font atlas for a codepoint (unicode character), fallback to '?' if not found

• Success return Rectangle

Get glyph rectangle in font atlas by index

• Failure return nil
• Success return Rectangle

Get font base size (default chars height)

• Success return int

Get font number of glyph characters

• Success return int

Get font padding around the glyph characters

• Success return int

Get font texture atlas containing the glyphs. Return as lightuserdata

• Success return Texture

Load GlyphInfo from data

• Success return GlyphInfo

Unload glyphInfo image from CPU memory (RAM)

Set glyphInfo character value (Unicode)

Set glyphInfo character offset when drawing

Set glyphInfo character advance position X

Set glyphInfo character image data

Get glyphInfo character value (Unicode)

• Success return int

Get glyphInfo character offset when drawing

• Success return Vector2

Get glyphInfo character advance position X

• Success return int

Get glyphInfo character image data. Return as lightuserdata

• Success return Image

Load UTF-8 text encoded from codepoints array

• Success return string

Load all codepoints from a UTF-8 text string

• Success return int{}

Get total number of codepoints in a UTF-8 encoded string

• Success return int

Get codepoint in a UTF-8 encoded string, 0x3f('?') is returned on failure

• Success return int, int

Get next codepoint in a UTF-8 encoded string, 0x3f('?') is returned on failure

• Success return int, int

Get previous codepoint in a UTF-8 encoded string, 0x3f('?') is returned on failure

• Success return int, int

Encode one codepoint into UTF-8 byte array

• Success return string

Get a piece of a text string

• Success return string

Replace text string

• Success return string

Insert text in a specific position, moves all text forward

• Success return string

Split text into multiple strings

• Success return string{}

Find first text occurrence within a string

• Success return int

Get Pascal case notation version of provided string

• Success return string

Get Snake case notation version of provided string

• Success return string

Get Camel case notation version of provided string

• Success return string

Draw a line in 3D world space

Draw a point in 3D space, actually a small line

Draw a circle in 3D world space

Draw a color-filled triangle (Vertex in counter-clockwise order!)

Draw a triangle strip defined by points

Draw cube

Draw cube wires

Draw sphere

Draw sphere with extended parameters

Draw sphere wires

Draw a cylinder/cone

Draw a cylinder with base at startPos and top at endPos

Draw a cylinder/cone wires

Draw a cylinder wires with base at startPos and top at endPos

Draw a capsule with the center of its sphere caps at startPos and endPos

Draw capsule wireframe with the center of its sphere caps at startPos and endPos

Draw a plane XZ

Draw 3D textured quad. (Texture coordinates opengl style 0.0 - 1.0)

Draw a ray line

Draw a grid (Centered at ( 0, 0, 0 ))

Draw a grid with extended parameters. Optionally you can define divider with different color for every n slices

Load model from files (Meshes and materials)

• Failure return nil
• Success return Model

Load model from generated mesh (Default material)

• Success return Model

Check if a model is valid (loaded in GPU, VAO/VBOs)

• Success return bool

Unload model (meshes/materials) from memory (RAM and/or VRAM)

Compute model bounding box limits (considers all meshes)

• Success return BoundingBox

Set model transform matrix

Set model mesh.

• Failure return false
• Success return true

Set material to model material

• Failure return false
• Success return true

Set material for a mesh (Mesh and material on this model)

Set model bone information (skeleton)

• Failure return false
• Success return true

Set model bones base transformation (pose)

• Failure return false
• Success return true

Get model transform matrix

• Success return Matrix

Get model number of meshes

• Success return int

Get model number of materials

• Success return int

Get model mesh. Return as lightuserdata

• Failure return nil
• Success return Mesh

Get model material. Return as lightuserdata

• Failure return nil
• Success return Material

Get model number of bones

• Success return int

Get model bones information (skeleton)

• Failure return nil
• Success return BoneInfo

Get models bones base transformation (pose)

• Failure return nil
• Success return Transform

Draw a model (With texture if set)

Draw a model with extended parameters

Draw a model wires (with texture if set)

Draw a model wires (with texture if set) with extended parameters

Draw a model as points

Draw a model as points with extended parameters

Draw bounding box (wires)

Draw a billboard texture

Draw a billboard texture defined by source

Draw a billboard texture defined by source and rotation

Update mesh vertex data in GPU. NOTE: Mainly intented to be used with custom meshes.

Unload mesh data from CPU and GPU

Draw a 3d mesh with material and transform

Draw multiple mesh instances with material and different transforms

Updades mesh color vertex attribute buffer NOTE: Currently only works on custom mesh

• Failure return false
• Success return true

Export mesh data to file, returns true on success

• Success return bool

Export mesh as code file (.h) defining multiple arrays of vertex attributes

• Success return bool

Compute mesh bounding box limits

• Success return BoundingBox

Compute mesh tangents

Get mesh vertex attributes data as table.

• Success return Mesh{}

Generate polygonal mesh

• Success return Mesh

Generate plane mesh (With subdivisions)

• Success return Mesh

Generate cuboid mesh

• Success return Mesh

Generate sphere mesh (Standard sphere)

• Success return Mesh

Generate half-sphere mesh (no bottom cap)

• Success return Mesh

Generate cylinder mesh

• Success return Mesh

Generate cone/pyramid mesh

• Success return Mesh

Generate torus mesh

• Success return Mesh

Generate torus mesh

• Success return Mesh

Generate heightmap mesh from image data

• Success return Mesh

Generate cubes-based map mesh from image data

• Success return Mesh

Generate custom mesh from vertex attribute data and uploads it into a VAO (if supported) and VBO

• Success return Mesh

Load materials from model file

• Success return Material{}

Default material for reference. Return as lightuserdata

• Success return Material

Load default material as new object

• Success return Material

Load material from table. See material table definition

• Success return Material

Check if a material is valid (shader assigned, map textures loaded in GPU)

• Success return bool

Unload material from GPU memory (VRAM). Note! Use freeAll to unload shaders and textures

Set texture for a material map type (MATERIAL_MAP_ALBEDO, MATERIAL_MAP_METALNESS...)

Set color for a material map type

Set value for a material map type

Set shader for material

Set material generic parameters (if required)

Get texture from material map type. Return as lightuserdata

• Success return Texture

Get color from material map type

• Success return Color

Get color from material map type

• Success return float

Get material shader. Return as lightuserdata

• Success return Shader

Get material parameters

• Success return float{}

Load model animations from file

• Failure return nil
• Success return ModelAnimations{}

Update model animation pose

Update model animation mesh bone matrices (GPU skinning)

Unload animation data

Unload animation table data

Check model animation skeleton match

• Success return bool

Set modelAnimation bones information (skeleton)

• Failure return false
• Success return true

Set modelAnimation bones base transformation (pose)

• Failure return false
• Success return true

Set modelAnimation name

Return modelAnimation bone count

• Success return int

Return modelAnimation frame count

• Success return int

Get modelAnimation bones information (skeleton)

• Failure return nil
• Success return BoneInfo

Get modelAnimation bones base transformation (pose)

• Failure return nil
• Success return Transform

Get modelAnimation name

• Success return string

Check collision between two spheres

• Success return bool

Check collision between two bounding boxes

• Success return bool

Check collision between box and sphere

• Success return bool

Get collision info between ray and sphere. ( RayCollision is Lua table of { hit, distance, point, normal } )

• Success return RayCollision

Get collision info between ray and box

• Success return RayCollision

Get collision info between ray and mesh

• Success return RayCollision

Get collision info between ray and triangle

• Success return RayCollision

Get collision info between ray and quad. NOTE: The points are expected to be in counter-clockwise winding

• Success return RayCollision

Get cell positions inside box that intersect with the ray. Also returns ray exit point. Returns empty table if ray misses the box

• Success return Vector3{}, RayCollision|nil

Initialize audio device and context

Close the audio device and context

Check if audio device has been initialized successfully

• Success return bool

Set master volume (listener)

Get master volume (listener)

• Success return float

Load sound from file

• Failure return nil
• Success return Sound

Load wave data from file

• Failure return nil
• Success return Wave

Load wave from memory buffer, fileType refers to extension: i.e. '.wav'

• Success return Wave

Checks if wave data is valid (data loaded and parameters)

• Success return bool

Load sound from wave data

• Success return Sound

Create a new sound that shares the same sample data as the source sound, does not own the sound data

• Success return Sound

Checks if a sound is valid (data loaded and buffers initialized)

• Success return bool

Update sound buffer with new data

Unload wave data

Unload sound

Unload a sound alias (does not deallocate sample data)

Export wave data to file, returns true on success

• Success return bool

Export wave sample data to code (.h), returns true on success

• Success return true

Play a sound

Stop playing a sound

Pause a sound

Resume a paused sound

Check if a sound is currently playing

• Success return bool

Set volume for a sound (1.0 is max level)

Set pitch for a sound (1.0 is base level)

Set pan for a sound (0.5 is center)

Get sound audio stream. Return as lightuserdata

• Success return AudioStream

Convert wave data to desired format

Load samples data from wave as a 32bit float data array

• Success return float{}

Copy a wave to a new wave

• Success return Wave

Crop a wave to defined samples range

Load music stream from file

• Success return Music

Load music stream from data

• Success return Music

Checks if a music stream is valid (context and buffers initialized)

• Success return bool

Unload music stream

Start music playing

Check if music is playing

• Success return bool

Updates buffers for music streaming

Stop music playing

Pause music playing

Resume playing paused music

Seek music to a position (in seconds)

Set volume for music (1.0 is max level)

Set pitch for a music (1.0 is base level)

Set pan for a music (0.5 is center)

Set looping for a music

Get looping of a music

• Success return bool

Get music time length (in seconds)

• Success return float

Get current music time played (in seconds)

• Success return float

Get music audio stream. Return as lightuserdata

• Success return AudioStream

Load audio stream (to stream raw audio pcm data)

• Success return AudioStream

Checks if an audio stream is valid (buffers initialized)

• Success return bool

Unload audio stream and free memory

Update audio stream buffers with data

Check if any audio stream buffers requires refill

• Success return bool

Play audio stream

Pause audio stream

Resume audio stream

Check if audio stream is playing

• Success return bool

Stop audio stream

Set volume for audio stream (1.0 is max level)

Set pitch for audio stream (1.0 is base level)

Set pan for audio stream (0.5 is centered)

Default size for new audio streams

Audio thread callback to request new data. AudioCallback should be lightuserdata function pointer

Attach audio stream processor to stream, receives the samples as 'float'. AudioCallback should be lightuserdata function pointer

Detach audio stream processor from stream. AudioCallback should be lightuserdata function pointer

Attach audio stream processor to the entire audio pipeline, receives the samples as 'float'. AudioCallback should be lightuserdata function pointer

Detach audio stream processor from the entire audio pipeline. AudioCallback should be lightuserdata function pointer

Round float value

• Success return int

Sign of value

• Success return int

Clamp float value

• Success return float

Calculate linear interpolation between two floats

• Success return float

Normalize input value within input range

• Success return float

Remap input value within input range to output range

• Success return float

Wrap input value from min to max

• Success return float

Check whether two given floats are almost equal

• Success return bool

Vector with components value 0.0f

• Success return Vector2

Vector with components value 1.0f

• Success return Vector2

Add two vectors (v1 + v2)

• Success return Vector2

Add vector and float value

• Success return Vector2

Subtract two vectors (v1 - v2)

• Success return Vector2

Subtract vector by float value

• Success return Vector2

Calculate vector length

• Success return float

Calculate vector square length

• Success return float

Calculate two vectors dot product

• Success return float

Calculate distance between two vectors

• Success return float

Calculate square distance between two vectors

• Success return float

Calculate angle between two vectors NOTE: Angle is calculated from origin point (0, 0)

• Success return float

Calculate angle defined by a two vectors line NOTE: Parameters need to be normalized Current implementation should be aligned with glm::angle

• Success return float

Scale vector (multiply by value)

• Success return Vector2

Multiply vector by vector

• Success return Vector2

Negate vector

• Success return Vector2

Divide vector by vector

• Success return Vector2

Normalize provided vector

• Success return Vector2

Transforms a Vector2 by a given Matrix

• Success return Vector2

Calculate linear interpolation between two vectors

• Success return Vector2

Calculate reflected vector to normal

• Success return Vector2

Get min value for each pair of components

• Success return Vector2

Get max value for each pair of components

• Success return Vector2

Rotate vector by angle

• Success return Vector2

Move Vector towards target

• Success return Vector2

Invert the given vector

• Success return Vector2

Clamp the components of the vector between min and max values specified by the given vectors

• Success return Vector2

Clamp the magnitude of the vector between two min and max values

• Success return Vector2

Check whether two given vectors are almost equal

• Success return bool

Compute the direction of a refracted ray v: normalized direction of the incoming ray n: normalized normal vector of the interface of two optical media r: ratio of the refractive index of the medium from where the ray comes to the refractive index of the medium on the other side of the surface

• Success return Vector2

Vector with components value 0.0f

• Success return Vector3

Vector with components value 1.0f

• Success return Vector3

Add two vectors

• Success return Vector3

Add vector and float value

• Success return Vector3

Subtract two vectors

• Success return Vector3

Subtract vector by float value

• Success return Vector3

Multiply vector by scalar

• Success return Vector3

Multiply vector by vector

• Success return Vector3

Calculate two vectors cross product

• Success return Vector3

Calculate one vector perpendicular vector

• Success return Vector3

Calculate vector length

• Success return float

Calculate vector square length

• Success return float

Calculate two vectors dot product

• Success return float

Calculate distance between two vectors

• Success return float

Calculate square distance between two vectors

• Success return float

Calculate angle between two vectors

• Success return float

Negate provided vector (invert direction)

• Success return Vector3

Divide vector by vector

• Success return Vector3

Normalize provided vector

• Success return Vector3

Calculate the projection of the vector v1 on to v2

• Success return Vector3

Calculate the rejection of the vector v1 on to v2

• Success return Vector3

Orthonormalize provided vectors. Makes vectors normalized and orthogonal to each other. Gram-Schmidt function implementation

• Success return Vector3, Vector3

Transforms a Vector3 by a given Matrix

• Success return Vector3

Transform a vector by quaternion rotation

• Success return Vector3

Rotates a vector around an axis

• Success return Vector3

Move Vector towards target

• Success return Vector3

Calculate linear interpolation between two vectors

• Success return Vector3

Calculate cubic hermite interpolation between two vectors and their tangents as described in the GLTF 2.0 specification: https://registry.khronos.org/glTF/specs/2.0/glTF-2.0.html#interpolation-cubic

• Success return Vector3

Calculate reflected vector to normal

• Success return Vector3

Get min value for each pair of components

• Success return Vector3

Get max value for each pair of components

• Success return Vector3

Compute barycenter coordinates (u, v, w) for point p with respect to triangle (a, b, c) NOTE: Assumes P is on the plane of the triangle

• Success return Vector3

Projects a Vector3 from screen space into object space NOTE: We are avoiding calling other raymath functions despite available

• Success return Vector3

Invert the given vector

• Success return Vector3

Clamp the components of the vector between min and max values specified by the given vectors

• Success return Vector3

Clamp the magnitude of the vector between two values

• Success return Vector3

Check whether two given vectors are almost equal

• Success return bool

Compute the direction of a refracted ray where v specifies the normalized direction of the incoming ray, n specifies the normalized normal vector of the interface of two optical media, and r specifies the ratio of the refractive index of the medium from where the ray comes to the refractive index of the medium on the other side of the surface

• Success return Vector3

Vector with components value 0.0f

• Success return Vector4

Vector with components value 1.0f

• Success return Vector4

Add two vectors

• Success return Vector4

Add vector and float value

• Success return Vector4

Subtract two vectors

• Success return Vector4

Subtract vector by float value

• Success return Vector4

Calculate vector length

• Success return float

Calculate vector square length

• Success return float

Calculate two vectors dot product

• Success return float

Calculate distance between two vectors

• Success return float

Calculate square distance between two vectors

• Success return float

Multiply vector by scalar

• Success return Vector4

Multiply vector by vector

• Success return Vector4

Negate provided vector (invert direction)

• Success return Vector4

Divide vector by vector

• Success return Vector4

Normalize provided vector

• Success return Vector4

Get min value for each pair of components

• Success return Vector4

Get max value for each pair of components

• Success return Vector4

Calculate linear interpolation between two vectors

• Success return Vector4

Move Vector towards target

• Success return Vector4

Invert the given vector

• Success return Vector4

Check whether two given vectors are almost equal

• Success return bool

Compute matrix determinant

• Success return float

Get the trace of the matrix (sum of the values along the diagonal)

• Success return float

Transposes provided matrix

• Success return Matrix

Invert provided matrix

• Success return Matrix

Get identity matrix

• Success return Matrix

Add two matrices

• Success return Matrix

Subtract two matrices (left - right)

• Success return Matrix

Get two matrix multiplication

• Success return Matrix

Get translation matrix

• Success return Matrix

Create rotation matrix from axis and angle. NOTE: Angle should be provided in radians

• Success return Matrix

Get x-rotation matrix (angle in radians)

• Success return Matrix

Get y-rotation matrix (angle in radians)

• Success return Matrix

Get z-rotation matrix (angle in radians)

• Success return Matrix

Get xyz-rotation matrix (angles in radians)

• Success return Matrix

Get zyx-rotation matrix (angles in radians)

• Success return Matrix

Get scaling matrix

• Success return Matrix

Get perspective projection matrix

• Success return Matrix

Get perspective projection matrix

• Success return Matrix

Get orthographic projection matrix

• Success return Matrix

Get camera look-at matrix (View matrix)

• Success return Matrix

Decompose a transformation matrix into its rotational, translational and scaling components

• Success return Vector3, Quaternion, Vector3

Add two quaternions

• Success return Quaternion

Add quaternion and float value

• Success return Quaternion

Subtract two quaternions

• Success return Quaternion

Subtract quaternion and float value

• Success return Quaternion

Get identity quaternion

• Success return Quaternion

Computes the length of a quaternion

• Success return float

Normalize provided quaternion

• Success return Quaternion

Invert provided quaternion

• Success return Quaternion

Calculate two quaternion multiplication

• Success return Quaternion

Scale quaternion by float value

• Success return Quaternion

Divide two quaternions

• Success return Quaternion

Calculate linear interpolation between two quaternions

• Success return Quaternion

Calculate slerp-optimized interpolation between two quaternions

• Success return Quaternion

Calculates spherical linear interpolation between two quaternions

• Success return Quaternion

Calculate quaternion cubic spline interpolation using Cubic Hermite Spline algorithm as described in the GLTF 2.0 specification: https://registry.khronos.org/glTF/specs/2.0/glTF-2.0.html#interpolation-cubic

• Success return Quaternion

Calculate quaternion based on the rotation from one vector to another

• Success return Quaternion

Get a quaternion for a given rotation matrix

• Success return Quaternion

Get a matrix for a given quaternion

• Success return Matrix

Get rotation quaternion for an angle and axis NOTE: angle must be provided in radians

• Success return Quaternion

Get the rotation angle and axis for a given quaternion

• Success return Vector3, float

Get the quaternion equivalent to Euler angles NOTE: Rotation order is ZYX

• Success return Quaternion

Get the Euler angles equivalent to quaternion (roll, pitch, yaw) NOTE: Angles are returned in a Vector3 struct in radians

• Success return Vector3

Transform a quaternion given a transformation matrix

• Success return Quaternion

Check whether two given quaternions are almost equal

• Success return bool

Extract frustum from projection and modelView matrices.

• Success return Vector4{}

Check if point inside frustum

• Success return bool

Check if sphere inside frustum

• Success return bool

Check if AABB inside frustum

• Success return bool

Enable gui controls (global state)

Disable gui controls (global state)

Lock gui controls (global state)

Unlock gui controls (global state)

Check if gui is locked (global state)

• Success return bool

Set gui controls alpha (global state), alpha goes from 0.0f to 1.0f

Set gui state (global state)

Get gui state (global state)

• Success return int

Set guiSliderDragging

Get guiSliderDragging

• Success return bool

Set guiSliderActive

Get guiSliderActive

• Success return Rectangle

Set gui custom font (global state)

Get gui font (global state). Return as lightuserdata

• Success return Font

Set one style property

Get one style property

• Success return int

Load style file over global style variable (.rgs)

• Failure return nil
• Success return true

Load style default over global style

Enable gui tooltips (global state)

Disable gui tooltips (global state)

Set tooltip string

Get text with icon id prepended (if supported)

• Success return string

Set icon scale (1 by default)

Get raygui icons data in buffer. guiIcons size is by default: 256(1616/32) = 2048*4 = 8192 bytes = 8 KB

• Success return Buffer

Set raygui icons data in buffer. guiIcons size is by default: 256(1616/32) = 2048*4 = 8192 bytes = 8 KB

• Failure return false
• Success return true

Load raygui icons file (.rgi) into internal icons data

• Failure return nil
• Success return strings{}

Draw icon

Window Box control, shows a window that can be closed

• Success return int

Group Box control with text name

• Success return int

Line separator control, could contain text

• Success return int

Panel control, useful to group controls

• Success return int

Tab Bar control, returns TAB to be closed or -1

• Success return int, int

Scroll Panel control

• Success return int, Vector2, Rectangle

Label control, shows text

• Success return int

Button control, returns true when clicked

• Success return int

Label button control, show true when clicked

• Success return int

Toggle Button control, returns true when active

• Success return int, bool

Toggle Group control, returns active toggle index

• Success return int, int

Toggle Slider control, returns true when clicked

• Success return int, int

Check Box control, returns true when active

• Success return bool, Rectangle

Combo Box control, returns selected item index

• Success return int, int

Dropdown Box control, returns selected item

• Success return int, int

Spinner control, returns selected value

• Success return int, int, Rectangle

Value Box control, updates input text with numbers

• Success return int, int, Rectangle

Text Box control, updates input text

• Success return int, string

Slider control, returns selected value

• Success return int, float, Rectangle, Rectangle

Slider Bar control, returns selected value

• Success return int, float, Rectangle, Rectangle

Progress Bar control, shows current progress value

• Success return int, float, Rectangle, Rectangle

Status Bar control, shows info text

• Success return int

Dummy control for placeholders

• Success return int

Grid control, returns mouse cell position

• Success return int, Vector2

Scroll bar control

• Success return int

List View control, returns selected list item index

• Success return int, int, int

List View with extended parameters

• Success return int, int, int, int

Message Box control, displays a message

• Success return int

Text Input Box control, ask for text, supports secret

• Success return int, string, bool

Color Picker control (multiple color controls)

• Success return int, Color

Color Panel control

• Success return int, Color

Color Bar Alpha control

• Success return int, float

Color Bar Hue control

• Success return int, float

Color Picker control that avoids conversion to RGB on each call (multiple color controls)

• Success return int, Vector3

Color Panel control that returns HSV color value, used by GuiColorPickerHSV()

• Success return int, Vector3

Create a light and get shader locations

• Success return Light

Send light properties to shader

Set light type

Set light position

Set light target

Set light color

Set light enabled

Get light type

• Success return int

Get light position

• Success return Vector3

Get light target

• Success return Vector3

Get light color