summaryrefslogtreecommitdiffhomepage
path: root/parser/raylib_api.lua
diff options
context:
space:
mode:
authorBenedek Szilvasy <[email protected]>2021-12-16 13:49:17 +0000
committerGitHub <[email protected]>2021-12-16 14:49:17 +0100
commitfffd78e7c862c09ff9a98a87bc937b5a3ef1f982 (patch)
tree45f10f1502c1c9dfc8b921e006f732babe9054a6 /parser/raylib_api.lua
parent48918ca5c66c24c2a430ab663abbbe60813036b3 (diff)
downloadraylib-fffd78e7c862c09ff9a98a87bc937b5a3ef1f982.tar.gz
raylib-fffd78e7c862c09ff9a98a87bc937b5a3ef1f982.zip
Parse enum descriptions and value descriptions (#2208)
* Parse enum descriptions and value descriptions * Put braces on newline * Properly escape strings * Realise that XML doesn't actually need backslash escapes * Replace FPrintfEscapes with EscapeBackslashes * Remove #include <stdarg.h> * Update EscapeBackslashes description
Diffstat (limited to 'parser/raylib_api.lua')
-rw-r--r--parser/raylib_api.lua640
1 files changed, 325 insertions, 315 deletions
diff --git a/parser/raylib_api.lua b/parser/raylib_api.lua
index 401ccca5..6d632d02 100644
--- a/parser/raylib_api.lua
+++ b/parser/raylib_api.lua
@@ -905,1582 +905,1582 @@ return {
enums = {
{
name = "ConfigFlags",
- description = "",
+ description = "System/Window config flags",
values = {
{
name = "FLAG_VSYNC_HINT",
value = 64,
- description = ""
+ description = "Set to try enabling V-Sync on GPU"
},
{
name = "FLAG_FULLSCREEN_MODE",
value = 2,
- description = ""
+ description = "Set to run program in fullscreen"
},
{
name = "FLAG_WINDOW_RESIZABLE",
value = 4,
- description = ""
+ description = "Set to allow resizable window"
},
{
name = "FLAG_WINDOW_UNDECORATED",
value = 8,
- description = ""
+ description = "Set to disable window decoration (frame and buttons)"
},
{
name = "FLAG_WINDOW_HIDDEN",
value = 128,
- description = ""
+ description = "Set to hide window"
},
{
name = "FLAG_WINDOW_MINIMIZED",
value = 512,
- description = ""
+ description = "Set to minimize window (iconify)"
},
{
name = "FLAG_WINDOW_MAXIMIZED",
value = 1024,
- description = ""
+ description = "Set to maximize window (expanded to monitor)"
},
{
name = "FLAG_WINDOW_UNFOCUSED",
value = 2048,
- description = ""
+ description = "Set to window non focused"
},
{
name = "FLAG_WINDOW_TOPMOST",
value = 4096,
- description = ""
+ description = "Set to window always on top"
},
{
name = "FLAG_WINDOW_ALWAYS_RUN",
value = 256,
- description = ""
+ description = "Set to allow windows running while minimized"
},
{
name = "FLAG_WINDOW_TRANSPARENT",
value = 16,
- description = ""
+ description = "Set to allow transparent framebuffer"
},
{
name = "FLAG_WINDOW_HIGHDPI",
value = 8192,
- description = ""
+ description = "Set to support HighDPI"
},
{
name = "FLAG_MSAA_4X_HINT",
value = 32,
- description = ""
+ description = "Set to try enabling MSAA 4X"
},
{
name = "FLAG_INTERLACED_HINT",
value = 65536,
- description = ""
+ description = "Set to try enabling interlaced video format (for V3D)"
}
}
},
{
name = "TraceLogLevel",
- description = "",
+ description = "Trace log level",
values = {
{
name = "LOG_ALL",
value = 0,
- description = ""
+ description = "Display all logs"
},
{
name = "LOG_TRACE",
value = 1,
- description = ""
+ description = "Trace logging, intended for internal use only"
},
{
name = "LOG_DEBUG",
value = 2,
- description = ""
+ description = "Debug logging, used for internal debugging, it should be disabled on release builds"
},
{
name = "LOG_INFO",
value = 3,
- description = ""
+ description = "Info logging, used for program execution info"
},
{
name = "LOG_WARNING",
value = 4,
- description = ""
+ description = "Warning logging, used on recoverable failures"
},
{
name = "LOG_ERROR",
value = 5,
- description = ""
+ description = "Error logging, used on unrecoverable failures"
},
{
name = "LOG_FATAL",
value = 6,
- description = ""
+ description = "Fatal logging, used to abort program: exit(EXIT_FAILURE)"
},
{
name = "LOG_NONE",
value = 7,
- description = ""
+ description = "Disable logging"
}
}
},
{
name = "KeyboardKey",
- description = "",
+ description = "Keyboard keys (US keyboard layout)",
values = {
{
name = "KEY_NULL",
value = 0,
- description = ""
+ description = "Key: NULL, used for no key pressed"
},
{
name = "KEY_APOSTROPHE",
value = 39,
- description = ""
+ description = "Key: '"
},
{
name = "KEY_COMMA",
value = 44,
- description = ""
+ description = "Key: ,"
},
{
name = "KEY_MINUS",
value = 45,
- description = ""
+ description = "Key: -"
},
{
name = "KEY_PERIOD",
value = 46,
- description = ""
+ description = "Key: ."
},
{
name = "KEY_SLASH",
value = 47,
- description = ""
+ description = "Key: /"
},
{
name = "KEY_ZERO",
value = 48,
- description = ""
+ description = "Key: 0"
},
{
name = "KEY_ONE",
value = 49,
- description = ""
+ description = "Key: 1"
},
{
name = "KEY_TWO",
value = 50,
- description = ""
+ description = "Key: 2"
},
{
name = "KEY_THREE",
value = 51,
- description = ""
+ description = "Key: 3"
},
{
name = "KEY_FOUR",
value = 52,
- description = ""
+ description = "Key: 4"
},
{
name = "KEY_FIVE",
value = 53,
- description = ""
+ description = "Key: 5"
},
{
name = "KEY_SIX",
value = 54,
- description = ""
+ description = "Key: 6"
},
{
name = "KEY_SEVEN",
value = 55,
- description = ""
+ description = "Key: 7"
},
{
name = "KEY_EIGHT",
value = 56,
- description = ""
+ description = "Key: 8"
},
{
name = "KEY_NINE",
value = 57,
- description = ""
+ description = "Key: 9"
},
{
name = "KEY_SEMICOLON",
value = 59,
- description = ""
+ description = "Key: ;"
},
{
name = "KEY_EQUAL",
value = 61,
- description = ""
+ description = "Key: ="
},
{
name = "KEY_A",
value = 65,
- description = ""
+ description = "Key: A | a"
},
{
name = "KEY_B",
value = 66,
- description = ""
+ description = "Key: B | b"
},
{
name = "KEY_C",
value = 67,
- description = ""
+ description = "Key: C | c"
},
{
name = "KEY_D",
value = 68,
- description = ""
+ description = "Key: D | d"
},
{
name = "KEY_E",
value = 69,
- description = ""
+ description = "Key: E | e"
},
{
name = "KEY_F",
value = 70,
- description = ""
+ description = "Key: F | f"
},
{
name = "KEY_G",
value = 71,
- description = ""
+ description = "Key: G | g"
},
{
name = "KEY_H",
value = 72,
- description = ""
+ description = "Key: H | h"
},
{
name = "KEY_I",
value = 73,
- description = ""
+ description = "Key: I | i"
},
{
name = "KEY_J",
value = 74,
- description = ""
+ description = "Key: J | j"
},
{
name = "KEY_K",
value = 75,
- description = ""
+ description = "Key: K | k"
},
{
name = "KEY_L",
value = 76,
- description = ""
+ description = "Key: L | l"
},
{
name = "KEY_M",
value = 77,
- description = ""
+ description = "Key: M | m"
},
{
name = "KEY_N",
value = 78,
- description = ""
+ description = "Key: N | n"
},
{
name = "KEY_O",
value = 79,
- description = ""
+ description = "Key: O | o"
},
{
name = "KEY_P",
value = 80,
- description = ""
+ description = "Key: P | p"
},
{
name = "KEY_Q",
value = 81,
- description = ""
+ description = "Key: Q | q"
},
{
name = "KEY_R",
value = 82,
- description = ""
+ description = "Key: R | r"
},
{
name = "KEY_S",
value = 83,
- description = ""
+ description = "Key: S | s"
},
{
name = "KEY_T",
value = 84,
- description = ""
+ description = "Key: T | t"
},
{
name = "KEY_U",
value = 85,
- description = ""
+ description = "Key: U | u"
},
{
name = "KEY_V",
value = 86,
- description = ""
+ description = "Key: V | v"
},
{
name = "KEY_W",
value = 87,
- description = ""
+ description = "Key: W | w"
},
{
name = "KEY_X",
value = 88,
- description = ""
+ description = "Key: X | x"
},
{
name = "KEY_Y",
value = 89,
- description = ""
+ description = "Key: Y | y"
},
{
name = "KEY_Z",
value = 90,
- description = ""
+ description = "Key: Z | z"
},
{
name = "KEY_LEFT_BRACKET",
value = 91,
- description = ""
+ description = "Key: ["
},
{
name = "KEY_BACKSLASH",
value = 92,
- description = ""
+ description = "Key: '\\'"
},
{
name = "KEY_RIGHT_BRACKET",
value = 93,
- description = ""
+ description = "Key: ]"
},
{
name = "KEY_GRAVE",
value = 96,
- description = ""
+ description = "Key: `"
},
{
name = "KEY_SPACE",
value = 32,
- description = ""
+ description = "Key: Space"
},
{
name = "KEY_ESCAPE",
value = 256,
- description = ""
+ description = "Key: Esc"
},
{
name = "KEY_ENTER",
value = 257,
- description = ""
+ description = "Key: Enter"
},
{
name = "KEY_TAB",
value = 258,
- description = ""
+ description = "Key: Tab"
},
{
name = "KEY_BACKSPACE",
value = 259,
- description = ""
+ description = "Key: Backspace"
},
{
name = "KEY_INSERT",
value = 260,
- description = ""
+ description = "Key: Ins"
},
{
name = "KEY_DELETE",
value = 261,
- description = ""
+ description = "Key: Del"
},
{
name = "KEY_RIGHT",
value = 262,
- description = ""
+ description = "Key: Cursor right"
},
{
name = "KEY_LEFT",
value = 263,
- description = ""
+ description = "Key: Cursor left"
},
{
name = "KEY_DOWN",
value = 264,
- description = ""
+ description = "Key: Cursor down"
},
{
name = "KEY_UP",
value = 265,
- description = ""
+ description = "Key: Cursor up"
},
{
name = "KEY_PAGE_UP",
value = 266,
- description = ""
+ description = "Key: Page up"
},
{
name = "KEY_PAGE_DOWN",
value = 267,
- description = ""
+ description = "Key: Page down"
},
{
name = "KEY_HOME",
value = 268,
- description = ""
+ description = "Key: Home"
},
{
name = "KEY_END",
value = 269,
- description = ""
+ description = "Key: End"
},
{
name = "KEY_CAPS_LOCK",
value = 280,
- description = ""
+ description = "Key: Caps lock"
},
{
name = "KEY_SCROLL_LOCK",
value = 281,
- description = ""
+ description = "Key: Scroll down"
},
{
name = "KEY_NUM_LOCK",
value = 282,
- description = ""
+ description = "Key: Num lock"
},
{
name = "KEY_PRINT_SCREEN",
value = 283,
- description = ""
+ description = "Key: Print screen"
},
{
name = "KEY_PAUSE",
value = 284,
- description = ""
+ description = "Key: Pause"
},
{
name = "KEY_F1",
value = 290,
- description = ""
+ description = "Key: F1"
},
{
name = "KEY_F2",
value = 291,
- description = ""
+ description = "Key: F2"
},
{
name = "KEY_F3",
value = 292,
- description = ""
+ description = "Key: F3"
},
{
name = "KEY_F4",
value = 293,
- description = ""
+ description = "Key: F4"
},
{
name = "KEY_F5",
value = 294,
- description = ""
+ description = "Key: F5"
},
{
name = "KEY_F6",
value = 295,
- description = ""
+ description = "Key: F6"
},
{
name = "KEY_F7",
value = 296,
- description = ""
+ description = "Key: F7"
},
{
name = "KEY_F8",
value = 297,
- description = ""
+ description = "Key: F8"
},
{
name = "KEY_F9",
value = 298,
- description = ""
+ description = "Key: F9"
},
{
name = "KEY_F10",
value = 299,
- description = ""
+ description = "Key: F10"
},
{
name = "KEY_F11",
value = 300,
- description = ""
+ description = "Key: F11"
},
{
name = "KEY_F12",
value = 301,
- description = ""
+ description = "Key: F12"
},
{
name = "KEY_LEFT_SHIFT",
value = 340,
- description = ""
+ description = "Key: Shift left"
},
{
name = "KEY_LEFT_CONTROL",
value = 341,
- description = ""
+ description = "Key: Control left"
},
{
name = "KEY_LEFT_ALT",
value = 342,
- description = ""
+ description = "Key: Alt left"
},
{
name = "KEY_LEFT_SUPER",
value = 343,
- description = ""
+ description = "Key: Super left"
},
{
name = "KEY_RIGHT_SHIFT",
value = 344,
- description = ""
+ description = "Key: Shift right"
},
{
name = "KEY_RIGHT_CONTROL",
value = 345,
- description = ""
+ description = "Key: Control right"
},
{
name = "KEY_RIGHT_ALT",
value = 346,
- description = ""
+ description = "Key: Alt right"
},
{
name = "KEY_RIGHT_SUPER",
value = 347,
- description = ""
+ description = "Key: Super right"
},
{
name = "KEY_KB_MENU",
value = 348,
- description = ""
+ description = "Key: KB menu"
},
{
name = "KEY_KP_0",
value = 320,
- description = ""
+ description = "Key: Keypad 0"
},
{
name = "KEY_KP_1",
value = 321,
- description = ""
+ description = "Key: Keypad 1"
},
{
name = "KEY_KP_2",
value = 322,
- description = ""
+ description = "Key: Keypad 2"
},
{
name = "KEY_KP_3",
value = 323,
- description = ""
+ description = "Key: Keypad 3"
},
{
name = "KEY_KP_4",
value = 324,
- description = ""
+ description = "Key: Keypad 4"
},
{
name = "KEY_KP_5",
value = 325,
- description = ""
+ description = "Key: Keypad 5"
},
{
name = "KEY_KP_6",
value = 326,
- description = ""
+ description = "Key: Keypad 6"
},
{
name = "KEY_KP_7",
value = 327,
- description = ""
+ description = "Key: Keypad 7"
},
{
name = "KEY_KP_8",
value = 328,
- description = ""
+ description = "Key: Keypad 8"
},
{
name = "KEY_KP_9",
value = 329,
- description = ""
+ description = "Key: Keypad 9"
},
{
name = "KEY_KP_DECIMAL",
value = 330,
- description = ""
+ description = "Key: Keypad ."
},
{
name = "KEY_KP_DIVIDE",
value = 331,
- description = ""
+ description = "Key: Keypad /"
},
{
name = "KEY_KP_MULTIPLY",
value = 332,
- description = ""
+ description = "Key: Keypad *"
},
{
name = "KEY_KP_SUBTRACT",
value = 333,
- description = ""
+ description = "Key: Keypad -"
},
{
name = "KEY_KP_ADD",
value = 334,
- description = ""
+ description = "Key: Keypad +"
},
{
name = "KEY_KP_ENTER",
value = 335,
- description = ""
+ description = "Key: Keypad Enter"
},
{
name = "KEY_KP_EQUAL",
value = 336,
- description = ""
+ description = "Key: Keypad ="
},
{
name = "KEY_BACK",
value = 4,
- description = ""
+ description = "Key: Android back button"
},
{
name = "KEY_MENU",
value = 82,
- description = ""
+ description = "Key: Android menu button"
},
{
name = "KEY_VOLUME_UP",
value = 24,
- description = ""
+ description = "Key: Android volume up button"
},
{
name = "KEY_VOLUME_DOWN",
value = 25,
- description = ""
+ description = "Key: Android volume down button"
}
}
},
{
name = "MouseButton",
- description = "",
+ description = "Mouse buttons",
values = {
{
name = "MOUSE_BUTTON_LEFT",
value = 0,
- description = ""
+ description = "Mouse button left"
},
{
name = "MOUSE_BUTTON_RIGHT",
value = 1,
- description = ""
+ description = "Mouse button right"
},
{
name = "MOUSE_BUTTON_MIDDLE",
value = 2,
- description = ""
+ description = "Mouse button middle (pressed wheel)"
},
{
name = "MOUSE_BUTTON_SIDE",
value = 3,
- description = ""
+ description = "Mouse button side (advanced mouse device)"
},
{
name = "MOUSE_BUTTON_EXTRA",
value = 4,
- description = ""
+ description = "Mouse button extra (advanced mouse device)"
},
{
name = "MOUSE_BUTTON_FORWARD",
value = 5,
- description = ""
+ description = "Mouse button fordward (advanced mouse device)"
},
{
name = "MOUSE_BUTTON_BACK",
value = 6,
- description = ""
+ description = "Mouse button back (advanced mouse device)"
}
}
},
{
name = "MouseCursor",
- description = "",
+ description = "Mouse cursor",
values = {
{
name = "MOUSE_CURSOR_DEFAULT",
value = 0,
- description = ""
+ description = "Default pointer shape"
},
{
name = "MOUSE_CURSOR_ARROW",
value = 1,
- description = ""
+ description = "Arrow shape"
},
{
name = "MOUSE_CURSOR_IBEAM",
value = 2,
- description = ""
+ description = "Text writing cursor shape"
},
{
name = "MOUSE_CURSOR_CROSSHAIR",
value = 3,
- description = ""
+ description = "Cross shape"
},
{
name = "MOUSE_CURSOR_POINTING_HAND",
value = 4,
- description = ""
+ description = "Pointing hand cursor"
},
{
name = "MOUSE_CURSOR_RESIZE_EW",
value = 5,
- description = ""
+ description = "Horizontal resize/move arrow shape"
},
{
name = "MOUSE_CURSOR_RESIZE_NS",
value = 6,
- description = ""
+ description = "Vertical resize/move arrow shape"
},
{
name = "MOUSE_CURSOR_RESIZE_NWSE",
value = 7,
- description = ""
+ description = "Top-left to bottom-right diagonal resize/move arrow shape"
},
{
name = "MOUSE_CURSOR_RESIZE_NESW",
value = 8,
- description = ""
+ description = "The top-right to bottom-left diagonal resize/move arrow shape"
},
{
name = "MOUSE_CURSOR_RESIZE_ALL",
value = 9,
- description = ""
+ description = "The omni-directional resize/move cursor shape"
},
{
name = "MOUSE_CURSOR_NOT_ALLOWED",
value = 10,
- description = ""
+ description = "The operation-not-allowed shape"
}
}
},
{
name = "GamepadButton",
- description = "",
+ description = "Gamepad buttons",
values = {
{
name = "GAMEPAD_BUTTON_UNKNOWN",
value = 0,
- description = ""
+ description = "Unknown button, just for error checking"
},
{
name = "GAMEPAD_BUTTON_LEFT_FACE_UP",
value = 1,
- description = ""
+ description = "Gamepad left DPAD up button"
},
{
name = "GAMEPAD_BUTTON_LEFT_FACE_RIGHT",
value = 2,
- description = ""
+ description = "Gamepad left DPAD right button"
},
{
name = "GAMEPAD_BUTTON_LEFT_FACE_DOWN",
value = 3,
- description = ""
+ description = "Gamepad left DPAD down button"
},
{
name = "GAMEPAD_BUTTON_LEFT_FACE_LEFT",
value = 4,
- description = ""
+ description = "Gamepad left DPAD left button"
},
{
name = "GAMEPAD_BUTTON_RIGHT_FACE_UP",
value = 5,
- description = ""
+ description = "Gamepad right button up (i.e. PS3: Triangle, Xbox: Y)"
},
{
name = "GAMEPAD_BUTTON_RIGHT_FACE_RIGHT",
value = 6,
- description = ""
+ description = "Gamepad right button right (i.e. PS3: Square, Xbox: X)"
},
{
name = "GAMEPAD_BUTTON_RIGHT_FACE_DOWN",
value = 7,
- description = ""
+ description = "Gamepad right button down (i.e. PS3: Cross, Xbox: A)"
},
{
name = "GAMEPAD_BUTTON_RIGHT_FACE_LEFT",
value = 8,
- description = ""
+ description = "Gamepad right button left (i.e. PS3: Circle, Xbox: B)"
},
{
name = "GAMEPAD_BUTTON_LEFT_TRIGGER_1",
value = 9,
- description = ""
+ description = "Gamepad top/back trigger left (first), it could be a trailing button"
},
{
name = "GAMEPAD_BUTTON_LEFT_TRIGGER_2",
value = 10,
- description = ""
+ description = "Gamepad top/back trigger left (second), it could be a trailing button"
},
{
name = "GAMEPAD_BUTTON_RIGHT_TRIGGER_1",
value = 11,
- description = ""
+ description = "Gamepad top/back trigger right (one), it could be a trailing button"
},
{
name = "GAMEPAD_BUTTON_RIGHT_TRIGGER_2",
value = 12,
- description = ""
+ description = "Gamepad top/back trigger right (second), it could be a trailing button"
},
{
name = "GAMEPAD_BUTTON_MIDDLE_LEFT",
value = 13,
- description = ""
+ description = "Gamepad center buttons, left one (i.e. PS3: Select)"
},
{
name = "GAMEPAD_BUTTON_MIDDLE",
value = 14,
- description = ""
+ description = "Gamepad center buttons, middle one (i.e. PS3: PS, Xbox: XBOX)"
},
{
name = "GAMEPAD_BUTTON_MIDDLE_RIGHT",
value = 15,
- description = ""
+ description = "Gamepad center buttons, right one (i.e. PS3: Start)"
},
{
name = "GAMEPAD_BUTTON_LEFT_THUMB",
value = 16,
- description = ""
+ description = "Gamepad joystick pressed button left"
},
{
name = "GAMEPAD_BUTTON_RIGHT_THUMB",
value = 17,
- description = ""
+ description = "Gamepad joystick pressed button right"
}
}
},
{
name = "GamepadAxis",
- description = "",
+ description = "Gamepad axis",
values = {
{
name = "GAMEPAD_AXIS_LEFT_X",
value = 0,
- description = ""
+ description = "Gamepad left stick X axis"
},
{
name = "GAMEPAD_AXIS_LEFT_Y",
value = 1,
- description = ""
+ description = "Gamepad left stick Y axis"
},
{
name = "GAMEPAD_AXIS_RIGHT_X",
value = 2,
- description = ""
+ description = "Gamepad right stick X axis"
},
{
name = "GAMEPAD_AXIS_RIGHT_Y",
value = 3,
- description = ""
+ description = "Gamepad right stick Y axis"
},
{
name = "GAMEPAD_AXIS_LEFT_TRIGGER",
value = 4,
- description = ""
+ description = "Gamepad back trigger left, pressure level: [1..-1]"
},
{
name = "GAMEPAD_AXIS_RIGHT_TRIGGER",
value = 5,
- description = ""
+ description = "Gamepad back trigger right, pressure level: [1..-1]"
}
}
},
{
name = "MaterialMapIndex",
- description = "",
+ description = "Material map index",
values = {
{
name = "MATERIAL_MAP_ALBEDO",
value = 0,
- description = ""
+ description = "Albedo material (same as: MATERIAL_MAP_DIFFUSE)"
},
{
name = "MATERIAL_MAP_METALNESS",
value = 1,
- description = ""
+ description = "Metalness material (same as: MATERIAL_MAP_SPECULAR)"
},
{
name = "MATERIAL_MAP_NORMAL",
value = 2,
- description = ""
+ description = "Normal material"
},
{
name = "MATERIAL_MAP_ROUGHNESS",
value = 3,
- description = ""
+ description = "Roughness material"
},
{
name = "MATERIAL_MAP_OCCLUSION",
value = 4,
- description = ""
+ description = "Ambient occlusion material"
},
{
name = "MATERIAL_MAP_EMISSION",
value = 5,
- description = ""
+ description = "Emission material"
},
{
name = "MATERIAL_MAP_HEIGHT",
value = 6,
- description = ""
+ description = "Heightmap material"
},
{
name = "MATERIAL_MAP_CUBEMAP",
value = 7,
- description = ""
+ description = "Cubemap material (NOTE: Uses GL_TEXTURE_CUBE_MAP)"
},
{
name = "MATERIAL_MAP_IRRADIANCE",
value = 8,
- description = ""
+ description = "Irradiance material (NOTE: Uses GL_TEXTURE_CUBE_MAP)"
},
{
name = "MATERIAL_MAP_PREFILTER",
value = 9,
- description = ""
+ description = "Prefilter material (NOTE: Uses GL_TEXTURE_CUBE_MAP)"
},
{
name = "MATERIAL_MAP_BRDF",
value = 10,
- description = ""
+ description = "Brdf material"
}
}
},
{
name = "ShaderLocationIndex",
- description = "",
+ description = "Shader location index",
values = {
{
name = "SHADER_LOC_VERTEX_POSITION",
value = 0,
- description = ""
+ description = "Shader location: vertex attribute: position"
},
{
name = "SHADER_LOC_VERTEX_TEXCOORD01",
value = 1,
- description = ""
+ description = "Shader location: vertex attribute: texcoord01"
},
{
name = "SHADER_LOC_VERTEX_TEXCOORD02",
value = 2,
- description = ""
+ description = "Shader location: vertex attribute: texcoord02"
},
{
name = "SHADER_LOC_VERTEX_NORMAL",
value = 3,
- description = ""
+ description = "Shader location: vertex attribute: normal"
},
{
name = "SHADER_LOC_VERTEX_TANGENT",
value = 4,
- description = ""
+ description = "Shader location: vertex attribute: tangent"
},
{
name = "SHADER_LOC_VERTEX_COLOR",
value = 5,
- description = ""
+ description = "Shader location: vertex attribute: color"
},
{
name = "SHADER_LOC_MATRIX_MVP",
value = 6,
- description = ""
+ description = "Shader location: matrix uniform: model-view-projection"
},
{
name = "SHADER_LOC_MATRIX_VIEW",
value = 7,
- description = ""
+ description = "Shader location: matrix uniform: view (camera transform)"
},
{
name = "SHADER_LOC_MATRIX_PROJECTION",
value = 8,
- description = ""
+ description = "Shader location: matrix uniform: projection"
},
{
name = "SHADER_LOC_MATRIX_MODEL",
value = 9,
- description = ""
+ description = "Shader location: matrix uniform: model (transform)"
},
{
name = "SHADER_LOC_MATRIX_NORMAL",
value = 10,
- description = ""
+ description = "Shader location: matrix uniform: normal"
},
{
name = "SHADER_LOC_VECTOR_VIEW",
value = 11,
- description = ""
+ description = "Shader location: vector uniform: view"
},
{
name = "SHADER_LOC_COLOR_DIFFUSE",
value = 12,
- description = ""
+ description = "Shader location: vector uniform: diffuse color"
},
{
name = "SHADER_LOC_COLOR_SPECULAR",
value = 13,
- description = ""
+ description = "Shader location: vector uniform: specular color"
},
{
name = "SHADER_LOC_COLOR_AMBIENT",
value = 14,
- description = ""
+ description = "Shader location: vector uniform: ambient color"
},
{
name = "SHADER_LOC_MAP_ALBEDO",
value = 15,
- description = ""
+ description = "Shader location: sampler2d texture: albedo (same as: SHADER_LOC_MAP_DIFFUSE)"
},
{
name = "SHADER_LOC_MAP_METALNESS",
value = 16,
- description = ""
+ description = "Shader location: sampler2d texture: metalness (same as: SHADER_LOC_MAP_SPECULAR)"
},
{
name = "SHADER_LOC_MAP_NORMAL",
value = 17,
- description = ""
+ description = "Shader location: sampler2d texture: normal"
},
{
name = "SHADER_LOC_MAP_ROUGHNESS",
value = 18,
- description = ""
+ description = "Shader location: sampler2d texture: roughness"
},
{
name = "SHADER_LOC_MAP_OCCLUSION",
value = 19,
- description = ""
+ description = "Shader location: sampler2d texture: occlusion"
},
{
name = "SHADER_LOC_MAP_EMISSION",
value = 20,
- description = ""
+ description = "Shader location: sampler2d texture: emission"
},
{
name = "SHADER_LOC_MAP_HEIGHT",
value = 21,
- description = ""
+ description = "Shader location: sampler2d texture: height"
},
{
name = "SHADER_LOC_MAP_CUBEMAP",
value = 22,
- description = ""
+ description = "Shader location: samplerCube texture: cubemap"
},
{
name = "SHADER_LOC_MAP_IRRADIANCE",
value = 23,
- description = ""
+ description = "Shader location: samplerCube texture: irradiance"
},
{
name = "SHADER_LOC_MAP_PREFILTER",
value = 24,
- description = ""
+ description = "Shader location: samplerCube texture: prefilter"
},
{
name = "SHADER_LOC_MAP_BRDF",
value = 25,
- description = ""
+ description = "Shader location: sampler2d texture: brdf"
}
}
},
{
name = "ShaderUniformDataType",
- description = "",
+ description = "Shader uniform data type",
values = {
{
name = "SHADER_UNIFORM_FLOAT",
value = 0,
- description = ""
+ description = "Shader uniform type: float"
},
{
name = "SHADER_UNIFORM_VEC2",
value = 1,
- description = ""
+ description = "Shader uniform type: vec2 (2 float)"
},
{
name = "SHADER_UNIFORM_VEC3",
value = 2,
- description = ""
+ description = "Shader uniform type: vec3 (3 float)"
},
{
name = "SHADER_UNIFORM_VEC4",
value = 3,
- description = ""
+ description = "Shader uniform type: vec4 (4 float)"
},
{
name = "SHADER_UNIFORM_INT",
value = 4,
- description = ""
+ description = "Shader uniform type: int"
},
{
name = "SHADER_UNIFORM_IVEC2",
value = 5,
- description = ""
+ description = "Shader uniform type: ivec2 (2 int)"
},
{
name = "SHADER_UNIFORM_IVEC3",
value = 6,
- description = ""
+ description = "Shader uniform type: ivec3 (3 int)"
},
{
name = "SHADER_UNIFORM_IVEC4",
value = 7,
- description = ""
+ description = "Shader uniform type: ivec4 (4 int)"
},
{
name = "SHADER_UNIFORM_SAMPLER2D",
value = 8,
- description = ""
+ description = "Shader uniform type: sampler2d"
}
}
},
{
name = "ShaderAttributeDataType",
- description = "",
+ description = "Shader attribute data types",
values = {
{
name = "SHADER_ATTRIB_FLOAT",
value = 0,
- description = ""
+ description = "Shader attribute type: float"
},
{
name = "SHADER_ATTRIB_VEC2",
value = 1,
- description = ""
+ description = "Shader attribute type: vec2 (2 float)"
},
{
name = "SHADER_ATTRIB_VEC3",
value = 2,
- description = ""
+ description = "Shader attribute type: vec3 (3 float)"
},
{
name = "SHADER_ATTRIB_VEC4",
value = 3,
- description = ""
+ description = "Shader attribute type: vec4 (4 float)"
}
}
},
{
name = "PixelFormat",
- description = "",
+ description = "Pixel formats",
values = {
{
name = "PIXELFORMAT_UNCOMPRESSED_GRAYSCALE",
value = 1,
- description = ""
+ description = "8 bit per pixel (no alpha)"
},
{
name = "PIXELFORMAT_UNCOMPRESSED_GRAY_ALPHA",
value = 2,
- description = ""
+ description = "8*2 bpp (2 channels)"
},
{
name = "PIXELFORMAT_UNCOMPRESSED_R5G6B5",
value = 3,
- description = ""
+ description = "16 bpp"
},
{
name = "PIXELFORMAT_UNCOMPRESSED_R8G8B8",
value = 4,
- description = ""
+ description = "24 bpp"
},
{
name = "PIXELFORMAT_UNCOMPRESSED_R5G5B5A1",
value = 5,
- description = ""
+ description = "16 bpp (1 bit alpha)"
},
{
name = "PIXELFORMAT_UNCOMPRESSED_R4G4B4A4",
value = 6,
- description = ""
+ description = "16 bpp (4 bit alpha)"
},
{
name = "PIXELFORMAT_UNCOMPRESSED_R8G8B8A8",
value = 7,
- description = ""
+ description = "32 bpp"
},
{
name = "PIXELFORMAT_UNCOMPRESSED_R32",
value = 8,
- description = ""
+ description = "32 bpp (1 channel - float)"
},
{
name = "PIXELFORMAT_UNCOMPRESSED_R32G32B32",
value = 9,
- description = ""
+ description = "32*3 bpp (3 channels - float)"
},
{
name = "PIXELFORMAT_UNCOMPRESSED_R32G32B32A32",
value = 10,
- description = ""
+ description = "32*4 bpp (4 channels - float)"
},
{
name = "PIXELFORMAT_COMPRESSED_DXT1_RGB",
value = 11,
- description = ""
+ description = "4 bpp (no alpha)"
},
{
name = "PIXELFORMAT_COMPRESSED_DXT1_RGBA",
value = 12,
- description = ""
+ description = "4 bpp (1 bit alpha)"
},
{
name = "PIXELFORMAT_COMPRESSED_DXT3_RGBA",
value = 13,
- description = ""
+ description = "8 bpp"
},
{
name = "PIXELFORMAT_COMPRESSED_DXT5_RGBA",
value = 14,
- description = ""
+ description = "8 bpp"
},
{
name = "PIXELFORMAT_COMPRESSED_ETC1_RGB",
value = 15,
- description = ""
+ description = "4 bpp"
},
{
name = "PIXELFORMAT_COMPRESSED_ETC2_RGB",
value = 16,
- description = ""
+ description = "4 bpp"
},
{
name = "PIXELFORMAT_COMPRESSED_ETC2_EAC_RGBA",
value = 17,
- description = ""
+ description = "8 bpp"
},
{
name = "PIXELFORMAT_COMPRESSED_PVRT_RGB",
value = 18,
- description = ""
+ description = "4 bpp"
},
{
name = "PIXELFORMAT_COMPRESSED_PVRT_RGBA",
value = 19,
- description = ""
+ description = "4 bpp"
},
{
name = "PIXELFORMAT_COMPRESSED_ASTC_4x4_RGBA",
value = 20,
- description = ""
+ description = "8 bpp"
},
{
name = "PIXELFORMAT_COMPRESSED_ASTC_8x8_RGBA",
value = 21,
- description = ""
+ description = "2 bpp"
}
}
},
{
name = "TextureFilter",
- description = "",
+ description = "Texture parameters: filter mode",
values = {
{
name = "TEXTURE_FILTER_POINT",
value = 0,
- description = ""
+ description = "No filter, just pixel approximation"
},
{
name = "TEXTURE_FILTER_BILINEAR",
value = 1,
- description = ""
+ description = "Linear filtering"
},
{
name = "TEXTURE_FILTER_TRILINEAR",
value = 2,
- description = ""
+ description = "Trilinear filtering (linear with mipmaps)"
},
{
name = "TEXTURE_FILTER_ANISOTROPIC_4X",
value = 3,
- description = ""
+ description = "Anisotropic filtering 4x"
},
{
name = "TEXTURE_FILTER_ANISOTROPIC_8X",
value = 4,
- description = ""
+ description = "Anisotropic filtering 8x"
},
{
name = "TEXTURE_FILTER_ANISOTROPIC_16X",
value = 5,
- description = ""
+ description = "Anisotropic filtering 16x"
}
}
},
{
name = "TextureWrap",
- description = "",
+ description = "Texture parameters: wrap mode",
values = {
{
name = "TEXTURE_WRAP_REPEAT",
value = 0,
- description = ""
+ description = "Repeats texture in tiled mode"
},
{
name = "TEXTURE_WRAP_CLAMP",
value = 1,
- description = ""
+ description = "Clamps texture to edge pixel in tiled mode"
},
{
name = "TEXTURE_WRAP_MIRROR_REPEAT",
value = 2,
- description = ""
+ description = "Mirrors and repeats the texture in tiled mode"
},
{
name = "TEXTURE_WRAP_MIRROR_CLAMP",
value = 3,
- description = ""
+ description = "Mirrors and clamps to border the texture in tiled mode"
}
}
},
{
name = "CubemapLayout",
- description = "",
+ description = "Cubemap layouts",
values = {
{
name = "CUBEMAP_LAYOUT_AUTO_DETECT",
value = 0,
- description = ""
+ description = "Automatically detect layout type"
},
{
name = "CUBEMAP_LAYOUT_LINE_VERTICAL",
value = 1,
- description = ""
+ description = "Layout is defined by a vertical line with faces"
},
{
name = "CUBEMAP_LAYOUT_LINE_HORIZONTAL",
value = 2,
- description = ""
+ description = "Layout is defined by an horizontal line with faces"
},
{
name = "CUBEMAP_LAYOUT_CROSS_THREE_BY_FOUR",
value = 3,
- description = ""
+ description = "Layout is defined by a 3x4 cross with cubemap faces"
},
{
name = "CUBEMAP_LAYOUT_CROSS_FOUR_BY_THREE",
value = 4,
- description = ""
+ description = "Layout is defined by a 4x3 cross with cubemap faces"
},
{
name = "CUBEMAP_LAYOUT_PANORAMA",
value = 5,
- description = ""
+ description = "Layout is defined by a panorama image (equirectangular map)"
}
}
},
{
name = "FontType",
- description = "",
+ description = "Font type, defines generation method",
values = {
{
name = "FONT_DEFAULT",
value = 0,
- description = ""
+ description = "Default font generation, anti-aliased"
},
{
name = "FONT_BITMAP",
value = 1,
- description = ""
+ description = "Bitmap font generation, no anti-aliasing"
},
{
name = "FONT_SDF",
value = 2,
- description = ""
+ description = "SDF font generation, requires external shader"
}
}
},
{
name = "BlendMode",
- description = "",
+ description = "Color blending modes (pre-defined)",
values = {
{
name = "BLEND_ALPHA",
value = 0,
- description = ""
+ description = "Blend textures considering alpha (default)"
},
{
name = "BLEND_ADDITIVE",
value = 1,
- description = ""
+ description = "Blend textures adding colors"
},
{
name = "BLEND_MULTIPLIED",
value = 2,
- description = ""
+ description = "Blend textures multiplying colors"
},
{
name = "BLEND_ADD_COLORS",
value = 3,
- description = ""
+ description = "Blend textures adding colors (alternative)"
},
{
name = "BLEND_SUBTRACT_COLORS",
value = 4,
- description = ""
+ description = "Blend textures subtracting colors (alternative)"
},
{
name = "BLEND_CUSTOM",
value = 5,
- description = ""
+ description = "Belnd textures using custom src/dst factors (use rlSetBlendMode())"
}
}
},
{
name = "Gesture",
- description = "",
+ description = "Gesture",
values = {
{
name = "GESTURE_NONE",
value = 0,
- description = ""
+ description = "No gesture"
},
{
name = "GESTURE_TAP",
value = 1,
- description = ""
+ description = "Tap gesture"
},
{
name = "GESTURE_DOUBLETAP",
value = 2,
- description = ""
+ description = "Double tap gesture"
},
{
name = "GESTURE_HOLD",
value = 4,
- description = ""
+ description = "Hold gesture"
},
{
name = "GESTURE_DRAG",
value = 8,
- description = ""
+ description = "Drag gesture"
},
{
name = "GESTURE_SWIPE_RIGHT",
value = 16,
- description = ""
+ description = "Swipe right gesture"
},
{
name = "GESTURE_SWIPE_LEFT",
value = 32,
- description = ""
+ description = "Swipe left gesture"
},
{
name = "GESTURE_SWIPE_UP",
value = 64,
- description = ""
+ description = "Swipe up gesture"
},
{
name = "GESTURE_SWIPE_DOWN",
value = 128,
- description = ""
+ description = "Swipe down gesture"
},
{
name = "GESTURE_PINCH_IN",
value = 256,
- description = ""
+ description = "Pinch in gesture"
},
{
name = "GESTURE_PINCH_OUT",
value = 512,
- description = ""
+ description = "Pinch out gesture"
}
}
},
{
name = "CameraMode",
- description = "",
+ description = "Camera system modes",
values = {
{
name = "CAMERA_CUSTOM",
value = 0,
- description = ""
+ description = "Custom camera"
},
{
name = "CAMERA_FREE",
value = 1,
- description = ""
+ description = "Free camera"
},
{
name = "CAMERA_ORBITAL",
value = 2,
- description = ""
+ description = "Orbital camera"
},
{
name = "CAMERA_FIRST_PERSON",
value = 3,
- description = ""
+ description = "First person camera"
},
{
name = "CAMERA_THIRD_PERSON",
value = 4,
- description = ""
+ description = "Third person camera"
}
}
},
{
name = "CameraProjection",
- description = "",
+ description = "Camera projection",
values = {
{
name = "CAMERA_PERSPECTIVE",
value = 0,
- description = ""
+ description = "Perspective projection"
},
{
name = "CAMERA_ORTHOGRAPHIC",
value = 1,
- description = ""
+ description = "Orthographic projection"
}
}
},
{
name = "NPatchLayout",
- description = "",
+ description = "N-patch layout",
values = {
{
name = "NPATCH_NINE_PATCH",
value = 0,
- description = ""
+ description = "Npatch layout: 3x3 tiles"
},
{
name = "NPATCH_THREE_PATCH_VERTICAL",
value = 1,
- description = ""
+ description = "Npatch layout: 1x3 tiles"
},
{
name = "NPATCH_THREE_PATCH_HORIZONTAL",
value = 2,
- description = ""
+ description = "Npatch layout: 3x1 tiles"
}
}
}
@@ -2652,6 +2652,16 @@ return {
returnType = "int"
},
{
+ name = "GetRenderWidth",
+ description = "Get current render width (it considers HiDPI)",
+ returnType = "int"
+ },
+ {
+ name = "GetRenderHeight",
+ description = "Get current render height (it considers HiDPI)",
+ returnType = "int"
+ },
+ {
name = "GetMonitorCount",
description = "Get number of connected monitors",
returnType = "int"
@@ -3234,7 +3244,7 @@ return {
},
{
name = "LoadFileText",
- description = "Load text data from file (read), returns a ' 0' terminated string",
+ description = "Load text data from file (read), returns a '\\0' terminated string",
returnType = "char *",
params = {
{name = "fileName", type = "const char *"}
@@ -3250,7 +3260,7 @@ return {
},
{
name = "SaveFileText",
- description = "Save text data to file (write), string must be ' 0' terminated, returns true on success",
+ description = "Save text data to file (write), string must be '\\0' terminated, returns true on success",
returnType = "bool",
params = {
{name = "fileName", type = "const char *"},
@@ -5509,7 +5519,7 @@ return {
},
{
name = "TextLength",
- description = "Get text length, checks for ' 0' ending",
+ description = "Get text length, checks for '\\0' ending",
returnType = "unsigned int",
params = {
{name = "text", type = "const char *"}