diff options
Diffstat (limited to 'projects/Notepad++/c_raylib.xml')
| -rw-r--r-- | projects/Notepad++/c_raylib.xml | 2276 |
1 files changed, 1591 insertions, 685 deletions
diff --git a/projects/Notepad++/c_raylib.xml b/projects/Notepad++/c_raylib.xml index 497fb7b8..5b4fa928 100644 --- a/projects/Notepad++/c_raylib.xml +++ b/projects/Notepad++/c_raylib.xml @@ -17,21 +17,28 @@ <KeyWord name="Image" /> <KeyWord name="Texture2D" /> <KeyWord name="RenderTexture2D" /> + <KeyWord name="NPatchInfo" /> + <KeyWord name="GlyphInfo" /> <KeyWord name="Font" /> <KeyWord name="Camera3D" /> <KeyWord name="Camera2D" /> <KeyWord name="BoundingBox" /> <KeyWord name="Mesh" /> <KeyWord name="Shader" /> + <KeyWord name="MaterialMap" /> <KeyWord name="Material" /> + <KeyWord name="Transform" /> + <KeyWord name="BoneInfo" /> <KeyWord name="Model" /> + <KeyWord name="ModelAnimation" /> <KeyWord name="Ray" /> - <KeyWord name="RayHitInfo" /> + <KeyWord name="RayCollision" /> <KeyWord name="Wave" /> <KeyWord name="Sound" /> <KeyWord name="Music" /> <KeyWord name="AudioStream" /> <KeyWord name="VrDeviceInfo" /> + <KeyWord name="VrStereoConfig" /> <!-------------------------------------------------------------------------------------- --> <!-- Window and Graphics Device Functions (Module: core) --> @@ -45,20 +52,59 @@ <Param name="const char *title" /> </Overload> </KeyWord> + <KeyWord name="WindowShouldClose" func="yes"> + <Overload retVal="bool" descr="Check if KEY_ESCAPE pressed or Close icon pressed"></Overload> + </KeyWord> <KeyWord name="CloseWindow" func="yes"> <Overload retVal="void" descr="Close window and unload OpenGL context"></Overload> </KeyWord> <KeyWord name="IsWindowReady" func="yes"> <Overload retVal="bool" descr="Check if window has been initialized successfully"></Overload> </KeyWord> - <KeyWord name="WindowShouldClose" func="yes"> - <Overload retVal="bool" descr="Check if KEY_ESCAPE pressed or Close icon pressed"></Overload> + <KeyWord name="IsWindowFullscreen" func="yes"> + <Overload retVal="bool" descr="Check if window is currently fullscreen"></Overload> + </KeyWord> + <KeyWord name="IsWindowHidden" func="yes"> + <Overload retVal="bool" descr="Check if window is currently hidden (only PLATFORM_DESKTOP)"></Overload> </KeyWord> <KeyWord name="IsWindowMinimized" func="yes"> - <Overload retVal="bool" descr="Check if window has been minimized (or lost focus)"></Overload> + <Overload retVal="bool" descr="Check if window is currently minimized (only PLATFORM_DESKTOP)"></Overload> + </KeyWord> + <KeyWord name="IsWindowMaximized" func="yes"> + <Overload retVal="bool" descr="Check if window is currently maximized (only PLATFORM_DESKTOP)"></Overload> + </KeyWord> + <KeyWord name="IsWindowFocused" func="yes"> + <Overload retVal="bool" descr="Check if window is currently focused (only PLATFORM_DESKTOP)"></Overload> + </KeyWord> + <KeyWord name="IsWindowResized" func="yes"> + <Overload retVal="bool" descr="Check if window has been resized last frame"></Overload> + </KeyWord> + <KeyWord name="IsWindowState" func="yes"> + <Overload retVal="bool" descr="Check if one specific window flag is enabled"> + <Param name="unsigned int flag" /> + </Overload> + </KeyWord> + <KeyWord name="SetWindowState" func="yes"> + <Overload retVal="void" descr="Set window configuration state using flags"> + <Param name="unsigned int flags" /> + </Overload> + </KeyWord> + <KeyWord name="ClearWindowState" func="yes"> + <Overload retVal="void" descr="Clear window configuration state flags"> + <Param name="unsigned int flags" /> + </Overload> </KeyWord> <KeyWord name="ToggleFullscreen" func="yes"> - <Overload retVal="void" descr="Toggle fullscreen mode (only PLATFORM_DESKTOP)"></Overload> + <Overload retVal="void" descr="Toggle window state: fullscreen/windowed (only PLATFORM_DESKTOP)"></Overload> + </KeyWord> + <KeyWord name="MaximizeWindow" func="yes"> + <Overload retVal="void" descr="Set window state: maximized, if resizable (only PLATFORM_DESKTOP)"></Overload> + </KeyWord> + <KeyWord name="MinimizeWindow" func="yes"> + <Overload retVal="void" descr="Set window state: minimized, if resizable (only PLATFORM_DESKTOP)"></Overload> + </KeyWord> + <KeyWord name="RestoreWindow" func="yes"> + <Overload retVal="void" descr="Set window state: not minimized/maximized (only PLATFORM_DESKTOP)"></Overload> </KeyWord> <KeyWord name="SetWindowIcon" func="yes"> <Overload retVal="void" descr="Set icon for window (only PLATFORM_DESKTOP)"> @@ -93,12 +139,86 @@ <Param name="int height" /> </Overload> </KeyWord> + <KeyWord name="GetWindowHandle" func="yes"> + <Overload retVal="void" descr="Get native window handle"></Overload> + </KeyWord> <KeyWord name="GetScreenWidth" func="yes"> <Overload retVal="int" descr="Get current screen width"></Overload> </KeyWord> <KeyWord name="GetScreenHeight" func="yes"> <Overload retVal="int" descr="Get current screen height"></Overload> </KeyWord> + <KeyWord name="GetMonitorCount" func="yes"> + <Overload retVal="int" descr="Get number of connected monitors"></Overload> + </KeyWord> + <KeyWord name="GetCurrentMonitor" func="yes"> + <Overload retVal="int" descr="Get current connected monitor"></Overload> + </KeyWord> + <KeyWord name="GetMonitorPosition" func="yes"> + <Overload retVal="Vector2" descr="Get specified monitor position"> + <Param name="int monitor" /> + </Overload> + </KeyWord> + <KeyWord name="GetMonitorWidth" func="yes"> + <Overload retVal="int" descr="Get specified monitor width (max available by monitor)"> + <Param name="int monitor" /> + </Overload> + </KeyWord> + <KeyWord name="GetMonitorHeight" func="yes"> + <Overload retVal="int" descr="Get specified monitor height (max available by monitor)"> + <Param name="int monitor" /> + </Overload> + </KeyWord> + <KeyWord name="GetMonitorPhysicalWidth" func="yes"> + <Overload retVal="int" descr="Get specified monitor physical width in millimetres"> + <Param name="int monitor" /> + </Overload> + </KeyWord> + <KeyWord name="GetMonitorPhysicalHeight" func="yes"> + <Overload retVal="int" descr="Get specified monitor physical height in millimetres"> + <Param name="int monitor" /> + </Overload> + </KeyWord> + <KeyWord name="GetMonitorRefreshRate" func="yes"> + <Overload retVal="int" descr="Get specified monitor refresh rate"> + <Param name="int monitor" /> + </Overload> + </KeyWord> + <KeyWord name="GetWindowPosition" func="yes"> + <Overload retVal="Vector2" descr="Get window position XY on monitor"></Overload> + </KeyWord> + <KeyWord name="GetWindowScaleDPI" func="yes"> + <Overload retVal="Vector2" descr="Get window scale DPI factor"></Overload> + </KeyWord> + <KeyWord name="GetMonitorName" func="yes"> + <Overload retVal="const char" descr="Get the human-readable, UTF-8 encoded name of the primary monitor"> + <Param name="int monitor" /> + </Overload> + </KeyWord> + <KeyWord name="SetClipboardText" func="yes"> + <Overload retVal="void" descr="Set clipboard text content"> + <Param name="const char *text" /> + </Overload> + </KeyWord> + <KeyWord name="GetClipboardText" func="yes"> + <Overload retVal="const char" descr="Get clipboard text content"></Overload> + </KeyWord> + + <!-- Custom frame control functions --> + <!-- NOTE: Those functions are intended for advance users that want full control over the frame processing --> + <!-- By default EndDrawing() does this job: draws everything + SwapScreenBuffer() + manage frame timming + PollInputEvents() --> + <!-- To avoid that behaviour and control frame processes manually, enable in config.h: SUPPORT_CUSTOM_FRAME_CONTROL --> + <KeyWord name="SwapScreenBuffer" func="yes"> + <Overload retVal="void" descr="Swap back buffer with front buffer (screen drawing)"></Overload> + </KeyWord> + <KeyWord name="PollInputEvents" func="yes"> + <Overload retVal="void" descr="Register all input events"></Overload> + </KeyWord> + <KeyWord name="WaitTime" func="yes"> + <Overload retVal="void" descr="Wait for some milliseconds (halt program execution)"> + <Param name="float ms" /> + </Overload> + </KeyWord> <!-- Cursor-related functions --> <KeyWord name="ShowCursor" func="yes"> @@ -116,6 +236,9 @@ <KeyWord name="DisableCursor" func="yes"> <Overload retVal="void" descr="Disables cursor (lock cursor)"></Overload> </KeyWord> + <KeyWord name="IsCursorOnScreen" func="yes"> + <Overload retVal="bool" descr="Check if cursor is on the screen"></Overload> + </KeyWord> <!-- Drawing-related functions --> <KeyWord name="ClearBackground" func="yes"> @@ -130,7 +253,7 @@ <Overload retVal="void" descr="End canvas drawing and swap buffers (double buffering)"></Overload> </KeyWord> <KeyWord name="BeginMode2D" func="yes"> - <Overload retVal="void" descr="Initialize 2D mode with custom camera (2D)"> + <Overload retVal="void" descr="Begin 2D mode with custom camera (2D)"> <Param name="Camera2D camera" /> </Overload> </KeyWord> @@ -138,7 +261,7 @@ <Overload retVal="void" descr="Ends 2D mode with custom camera"></Overload> </KeyWord> <KeyWord name="BeginMode3D" func="yes"> - <Overload retVal="void" descr="Initializes 3D mode with custom camera (3D)"> + <Overload retVal="void" descr="Begin 3D mode with custom camera (3D)"> <Param name="Camera3D camera" /> </Overload> </KeyWord> @@ -146,30 +269,165 @@ <Overload retVal="void" descr="Ends 3D mode and returns to default 2D orthographic mode"></Overload> </KeyWord> <KeyWord name="BeginTextureMode" func="yes"> - <Overload retVal="void" descr="Initializes render texture for drawing"> + <Overload retVal="void" descr="Begin drawing to render texture"> <Param name="RenderTexture2D target" /> </Overload> </KeyWord> <KeyWord name="EndTextureMode" func="yes"> <Overload retVal="void" descr="Ends drawing to render texture"></Overload> </KeyWord> + <KeyWord name="BeginShaderMode" func="yes"> + <Overload retVal="void" descr="Begin custom shader drawing"> + <Param name="Shader shader" /> + </Overload> + </KeyWord> + <KeyWord name="EndShaderMode" func="yes"> + <Overload retVal="void" descr="End custom shader drawing (use default shader)"></Overload> + </KeyWord> + <KeyWord name="BeginBlendMode" func="yes"> + <Overload retVal="void" descr="Begin blending mode (alpha, additive, multiplied, subtract, custom)"> + <Param name="int mode" /> + </Overload> + </KeyWord> + <KeyWord name="EndBlendMode" func="yes"> + <Overload retVal="void" descr="End blending mode (reset to default: alpha blending)"></Overload> + </KeyWord> + <KeyWord name="BeginScissorMode" func="yes"> + <Overload retVal="void" descr="Begin scissor mode (define screen area for following drawing)"> + <Param name="int x" /> + <Param name="int y" /> + <Param name="int width" /> + <Param name="int height" /> + </Overload> + </KeyWord> + <KeyWord name="EndScissorMode" func="yes"> + <Overload retVal="void" descr="End scissor mode"></Overload> + </KeyWord> + <KeyWord name="BeginVrStereoMode" func="yes"> + <Overload retVal="void" descr="Begin stereo rendering (requires VR simulator)"> + <Param name="VrStereoConfig config" /> + </Overload> + </KeyWord> + <KeyWord name="EndVrStereoMode" func="yes"> + <Overload retVal="void" descr="End stereo rendering (requires VR simulator)"></Overload> + </KeyWord> + + <!-- VR stereo config functions for VR simulator --> + <KeyWord name="LoadVrStereoConfig" func="yes"> + <Overload retVal="VrStereoConfig" descr="Load VR stereo config for VR simulator device parameters"> + <Param name="VrDeviceInfo device" /> + </Overload> + </KeyWord> + <KeyWord name="UnloadVrStereoConfig" func="yes"> + <Overload retVal="void" descr="Unload VR stereo config"> + <Param name="VrStereoConfig config" /> + </Overload> + </KeyWord> + + <!-- Shader management functions --> + <!-- NOTE: Shader functionality is not available on OpenGL 1.1 --> + <KeyWord name="LoadShader" func="yes"> + <Overload retVal="Shader" descr="Load shader from files and bind default locations"> + <Param name="const char *vsFileName" /> + <Param name="const char *fsFileName" /> + </Overload> + </KeyWord> + <KeyWord name="LoadShaderFromMemory" func="yes"> + <Overload retVal="Shader" descr="Load shader from code strings and bind default locations"> + <Param name="const char *vsCode" /> + <Param name="const char *fsCode" /> + </Overload> + </KeyWord> + <KeyWord name="GetShaderLocation" func="yes"> + <Overload retVal="int" descr="Get shader uniform location"> + <Param name="Shader shader" /> + <Param name="const char *uniformName" /> + </Overload> + </KeyWord> + <KeyWord name="GetShaderLocationAttrib" func="yes"> + <Overload retVal="int" descr="Get shader attribute location"> + <Param name="Shader shader" /> + <Param name="const char *attribName" /> + </Overload> + </KeyWord> + <KeyWord name="SetShaderValue" func="yes"> + <Overload retVal="void" descr="Set shader uniform value"> + <Param name="Shader shader" /> + <Param name="int locIndex" /> + <Param name="const void *value" /> + <Param name="int uniformType" /> + </Overload> + </KeyWord> + <KeyWord name="SetShaderValueV" func="yes"> + <Overload retVal="void" descr="Set shader uniform value vector"> + <Param name="Shader shader" /> + <Param name="int locIndex" /> + <Param name="const void *value" /> + <Param name="int uniformType" /> + <Param name="int count" /> + </Overload> + </KeyWord> + <KeyWord name="SetShaderValueMatrix" func="yes"> + <Overload retVal="void" descr="Set shader uniform value (matrix 4x4)"> + <Param name="Shader shader" /> + <Param name="int locIndex" /> + <Param name="Matrix mat" /> + </Overload> + </KeyWord> + <KeyWord name="SetShaderValueTexture" func="yes"> + <Overload retVal="void" descr="Set shader uniform value for texture (sampler2d)"> + <Param name="Shader shader" /> + <Param name="int locIndex" /> + <Param name="Texture2D texture" /> + </Overload> + </KeyWord> + <KeyWord name="UnloadShader" func="yes"> + <Overload retVal="void" descr="Unload shader from GPU memory (VRAM)"> + <Param name="Shader shader" /> + </Overload> + </KeyWord> <!-- Screen-space-related functions --> <KeyWord name="GetMouseRay" func="yes"> - <Overload retVal="Ray" descr="Returns a ray trace from mouse position"> + <Overload retVal="Ray" descr="Get a ray trace from mouse position"> <Param name="Vector2 mousePosition" /> <Param name="Camera camera" /> </Overload> </KeyWord> + <KeyWord name="GetCameraMatrix" func="yes"> + <Overload retVal="Matrix" descr="Get camera transform matrix (view matrix)"> + <Param name="Camera camera" /> + </Overload> + </KeyWord> + <KeyWord name="GetCameraMatrix2D" func="yes"> + <Overload retVal="Matrix" descr="Get camera 2d transform matrix"> + <Param name="Camera2D camera" /> + </Overload> + </KeyWord> <KeyWord name="GetWorldToScreen" func="yes"> - <Overload retVal="Vector2" descr="Returns the screen space position for a 3d world space position"> + <Overload retVal="Vector2" descr="Get the screen space position for a 3d world space position"> <Param name="Vector3 position" /> <Param name="Camera camera" /> </Overload> </KeyWord> - <KeyWord name="GetCameraMatrix" func="yes"> - <Overload retVal="Matrix" descr="Returns camera transform matrix (view matrix)"> + <KeyWord name="GetWorldToScreenEx" func="yes"> + <Overload retVal="Vector2" descr="Get size position for a 3d world space position"> + <Param name="Vector3 position" /> <Param name="Camera camera" /> + <Param name="int width" /> + <Param name="int height" /> + </Overload> + </KeyWord> + <KeyWord name="GetWorldToScreen2D" func="yes"> + <Overload retVal="Vector2" descr="Get the screen space position for a 2d camera world space position"> + <Param name="Vector2 position" /> + <Param name="Camera2D camera" /> + </Overload> + </KeyWord> + <KeyWord name="GetScreenToWorld2D" func="yes"> + <Overload retVal="Vector2" descr="Get the world space position for a 2d camera screen space position"> + <Param name="Vector2 position" /> + <Param name="Camera2D camera" /> </Overload> </KeyWord> @@ -180,85 +438,140 @@ </Overload> </KeyWord> <KeyWord name="GetFPS" func="yes"> - <Overload retVal="int" descr="Returns current FPS"></Overload> + <Overload retVal="int" descr="Get current FPS"></Overload> </KeyWord> <KeyWord name="GetFrameTime" func="yes"> - <Overload retVal="float" descr="Returns time in seconds for last frame drawn"></Overload> + <Overload retVal="float" descr="Get time in seconds for last frame drawn (delta time)"></Overload> </KeyWord> <KeyWord name="GetTime" func="yes"> - <Overload retVal="double" descr="Returns elapsed time in seconds since InitWindow()"></Overload> + <Overload retVal="double" descr="Get elapsed time in seconds since InitWindow()"></Overload> </KeyWord> - <!-- Color-related functions --> - <KeyWord name="ColorToInt" func="yes"> - <Overload retVal="int" descr="Returns hexadecimal value for a Color"> - <Param name="Color color" /> + <!-- Misc. functions --> + <KeyWord name="GetRandomValue" func="yes"> + <Overload retVal="int" descr="Get a random value between min and max (both included)"> + <Param name="int min" /> + <Param name="int max" /> </Overload> </KeyWord> - <KeyWord name="ColorNormalize" func="yes"> - <Overload retVal="Vector4" descr="Returns color normalized as float [0..1]"> - <Param name="Color color" /> + <KeyWord name="SetRandomSeed" func="yes"> + <Overload retVal="void" descr="Set the seed for the random number generator"> + <Param name="unsigned int seed" /> </Overload> </KeyWord> - <KeyWord name="ColorToHSV" func="yes"> - <Overload retVal="Vector3" descr="Returns HSV values for a Color"> - <Param name="Color color" /> + <KeyWord name="TakeScreenshot" func="yes"> + <Overload retVal="void" descr="Takes a screenshot of current screen (filename extension defines format)"> + <Param name="const char *fileName" /> </Overload> </KeyWord> - <KeyWord name="GetColor" func="yes"> - <Overload retVal="Color" descr="Returns a Color struct from hexadecimal value"> - <Param name="int hexValue" /> + <KeyWord name="SetConfigFlags" func="yes"> + <Overload retVal="void" descr="Setup init configuration flags (view FLAGS)"> + <Param name="unsigned int flags" /> </Overload> </KeyWord> - <KeyWord name="Fade" func="yes"> - <Overload retVal="Color" descr="Color fade-in or fade-out, alpha goes from 0.0f to 1.0f"> - <Param name="Color color" /> - <Param name="float alpha" /> + + <KeyWord name="TraceLog" func="yes"> + <Overload retVal="void" descr="Show trace log messages (LOG_DEBUG, LOG_INFO, LOG_WARNING, LOG_ERROR...)"> + <Param name="int logLevel" /> + <Param name="const char *text" /> + <Param name="..." /> </Overload> </KeyWord> - - <!-- Misc. functions --> - <KeyWord name="ShowLogo" func="yes"> - <Overload retVal="void" descr="Activate raylib logo at startup (can be done with flags)"></Overload> + <KeyWord name="SetTraceLogLevel" func="yes"> + <Overload retVal="void" descr="Set the current threshold (minimum) log level"> + <Param name="int logLevel" /> + </Overload> </KeyWord> - <KeyWord name="SetConfigFlags" func="yes"> - <Overload retVal="void" descr="Setup window configuration flags (view FLAGS)"> - <Param name="unsigned char flags" /> + <KeyWord name="MemAlloc" func="yes"> + <Overload retVal="void" descr="Internal memory allocator"> + <Param name="int size" /> </Overload> </KeyWord> - <KeyWord name="SetTraceLog" func="yes"> - <Overload retVal="void" descr="Enable trace log message types (bit flags based)"> - <Param name="unsigned char types" /> + <KeyWord name="MemRealloc" func="yes"> + <Overload retVal="void" descr="Internal memory reallocator"></Overload> + </KeyWord> + <KeyWord name="MemFree" func="yes"> + <Overload retVal="void" descr="Internal memory free"></Overload> + </KeyWord> + + <!-- Set custom callbacks --> + <!-- WARNING: Callbacks setup is intended for advance users --> + <KeyWord name="SetTraceLogCallback" func="yes"> + <Overload retVal="void" descr="Set custom trace log"> + <Param name="TraceLogCallback callback" /> </Overload> </KeyWord> - <KeyWord name="TraceLog" func="yes"> - <Overload retVal="void" descr="Show trace log messages (LOG_INFO, LOG_WARNING, LOG_ERROR, LOG_DEBUG)"> - <Param name="int logType" /> - <Param name="const char *text" /> - <Param name="..." /> + <KeyWord name="SetLoadFileDataCallback" func="yes"> + <Overload retVal="void" descr="Set custom file binary data loader"> + <Param name="LoadFileDataCallback callback" /> </Overload> </KeyWord> - <KeyWord name="TakeScreenshot" func="yes"> - <Overload retVal="void" descr="Takes a screenshot of current screen (saved a .png)"> - <Param name="const char *fileName" /> + <KeyWord name="SetSaveFileDataCallback" func="yes"> + <Overload retVal="void" descr="Set custom file binary data saver"> + <Param name="SaveFileDataCallback callback" /> </Overload> </KeyWord> - <KeyWord name="GetRandomValue" func="yes"> - <Overload retVal="int" descr="Returns a random value between min and max (both included)"> - <Param name="int min" /> - <Param name="int max" /> + <KeyWord name="SetLoadFileTextCallback" func="yes"> + <Overload retVal="void" descr="Set custom file text data loader"> + <Param name="LoadFileTextCallback callback" /> + </Overload> + </KeyWord> + <KeyWord name="SetSaveFileTextCallback" func="yes"> + <Overload retVal="void" descr="Set custom file text data saver"> + <Param name="SaveFileTextCallback callback" /> </Overload> </KeyWord> <!-- Files management functions --> + <KeyWord name="char *LoadFileData" func="yes"> + <Overload retVal="unsigned" descr="Load file data as byte array (read)"> + <Param name="const char *fileName" /> + <Param name="unsigned int *bytesRead" /> + </Overload> + </KeyWord> + <KeyWord name="UnloadFileData" func="yes"> + <Overload retVal="void" descr="Unload file data allocated by LoadFileData()"> + <Param name="unsigned char *data" /> + </Overload> + </KeyWord> + <KeyWord name="SaveFileData" func="yes"> + <Overload retVal="bool" descr="Save data to file from byte array (write), returns true on success"> + <Param name="const char *fileName" /></Overload> + </KeyWord> + <KeyWord name="LoadFileText" func="yes"> + <Overload retVal="char" descr="Load text data from file (read), returns a '\0' terminated string"> + <Param name="const char *fileName" /> + </Overload> + </KeyWord> + <KeyWord name="UnloadFileText" func="yes"> + <Overload retVal="void" descr="Unload file text data allocated by LoadFileText()"> + <Param name="char *text" /> + </Overload> + </KeyWord> + <KeyWord name="SaveFileText" func="yes"> + <Overload retVal="bool" descr="Save text data to file (write), string must be '\0' terminated, returns true on success"> + <Param name="const char *fileName" /> + <Param name="char *text" /> + </Overload> + </KeyWord> + <KeyWord name="FileExists" func="yes"> + <Overload retVal="bool" descr="Check if file exists"> + <Param name="const char *fileName" /> + </Overload> + </KeyWord> + <KeyWord name="DirectoryExists" func="yes"> + <Overload retVal="bool" descr="Check if a directory path exists"> + <Param name="const char *dirPath" /> + </Overload> + </KeyWord> <KeyWord name="IsFileExtension" func="yes"> - <Overload retVal="bool" descr="Check file extension"> + <Overload retVal="bool" descr="Check file extension (including point: .png, .wav)"> <Param name="const char *fileName" /> <Param name="const char *ext" /> </Overload> </KeyWord> - <KeyWord name="GetExtension" func="yes"> - <Overload retVal="const char" descr="Get pointer to extension for a filename string"> + <KeyWord name="GetFileExtension" func="yes"> + <Overload retVal="const char" descr="Get pointer to extension for a filename string (includes dot: '.png')"> <Param name="const char *fileName" /> </Overload> </KeyWord> @@ -267,16 +580,35 @@ <Param name="const char *filePath" /> </Overload> </KeyWord> + <KeyWord name="GetFileNameWithoutExt" func="yes"> + <Overload retVal="const char" descr="Get filename string without extension (uses static string)"> + <Param name="const char *filePath" /> + </Overload> + </KeyWord> <KeyWord name="GetDirectoryPath" func="yes"> - <Overload retVal="const char" descr="Get full path for a given fileName (uses static string)"> - <Param name="const char *fileName" /> + <Overload retVal="const char" descr="Get full path for a given fileName with path (uses static string)"> + <Param name="const char *filePath" /> + </Overload> + </KeyWord> + <KeyWord name="GetPrevDirectoryPath" func="yes"> + <Overload retVal="const char" descr="Get previous directory path for a given path (uses static string)"> + <Param name="const char *dirPath" /> </Overload> </KeyWord> <KeyWord name="GetWorkingDirectory" func="yes"> <Overload retVal="const char" descr="Get current working directory (uses static string)"></Overload> </KeyWord> + <KeyWord name="GetDirectoryFiles" func="yes"> + <Overload retVal="char" descr="Get filenames in a directory path (memory should be freed)"> + <Param name="const char *dirPath" /> + <Param name="int *count" /> + </Overload> + </KeyWord> + <KeyWord name="ClearDirectoryFiles" func="yes"> + <Overload retVal="void" descr="Clear directory files paths buffers (free memory)"></Overload> + </KeyWord> <KeyWord name="ChangeDirectory" func="yes"> - <Overload retVal="bool" descr="Change working directory, returns true if success"> + <Overload retVal="bool" descr="Change working directory, return true on success"> <Param name="const char *dir" /> </Overload> </KeyWord> @@ -284,24 +616,64 @@ <Overload retVal="bool" descr="Check if a file has been dropped into window"></Overload> </KeyWord> <KeyWord name="GetDroppedFiles" func="yes"> - <Overload retVal="char" descr="Get dropped files names"> + <Overload retVal="char" descr="Get dropped files names (memory should be freed)"> <Param name="int *count" /> </Overload> </KeyWord> <KeyWord name="ClearDroppedFiles" func="yes"> - <Overload retVal="void" descr="Clear dropped files paths buffer"></Overload> + <Overload retVal="void" descr="Clear dropped files paths buffer (free memory)"></Overload> + </KeyWord> + <KeyWord name="GetFileModTime" func="yes"> + <Overload retVal="long" descr="Get file modification time (last write time)"> + <Param name="const char *fileName" /> + </Overload> + </KeyWord> + + <!-- Compression/Encoding functionality --> + <KeyWord name="char *CompressData" func="yes"> + <Overload retVal="unsigned" descr="Compress data (DEFLATE algorithm)"> + <Param name="unsigned char *data" /> + <Param name="int dataLength" /> + <Param name="int *compDataLength" /> + </Overload> + </KeyWord> + <KeyWord name="char *DecompressData" func="yes"> + <Overload retVal="unsigned" descr="Decompress data (DEFLATE algorithm)"> + <Param name="unsigned char *compData" /> + <Param name="int compDataLength" /> + <Param name="int *dataLength" /> + </Overload> + </KeyWord> + <KeyWord name="EncodeDataBase64" func="yes"> + <Overload retVal="char" descr="Encode data to Base64 string"> + <Param name="const unsigned char" /> + <Param name="int dataLength" /> + <Param name="int *outputLength" /> + </Overload> + </KeyWord> + <KeyWord name="char *DecodeDataBase64" func="yes"> + <Overload retVal="unsigned" descr="Decode Base64 string data"> + <Param name="unsigned char *data" /> + <Param name="int *outputLength" /> + </Overload> </KeyWord> <!-- Persistent storage management --> - <KeyWord name="StorageSaveValue" func="yes"> - <Overload retVal="void" descr="Save integer value to storage file (to defined position)"> - <Param name="int position" /> + <KeyWord name="SaveStorageValue" func="yes"> + <Overload retVal="bool" descr="Save integer value to storage file (to defined position), returns true on success"> + <Param name="unsigned int position" /> <Param name="int value" /> </Overload> </KeyWord> - <KeyWord name="StorageLoadValue" func="yes"> + <KeyWord name="LoadStorageValue" func="yes"> <Overload retVal="int" descr="Load integer value from storage file (from defined position)"> - <Param name="int position" /> + <Param name="unsigned int position" /> + </Overload> + </KeyWord> + + <KeyWord name="OpenURL" func="yes"> + <Overload retVal="void" descr="Open URL with default system browser (if available)"> + <Param name="const char *url" /> </Overload> </KeyWord> @@ -311,71 +683,68 @@ <!-- Input-related functions: keyboard --> <KeyWord name="IsKeyPressed" func="yes"> - <Overload retVal="bool" descr="Detect if a key has been pressed once"> + <Overload retVal="bool" descr="Check if a key has been pressed once"> <Param name="int key" /> </Overload> </KeyWord> <KeyWord name="IsKeyDown" func="yes"> - <Overload retVal="bool" descr="Detect if a key is being pressed"> + <Overload retVal="bool" descr="Check if a key is being pressed"> <Param name="int key" /> </Overload> </KeyWord> <KeyWord name="IsKeyReleased" func="yes"> - <Overload retVal="bool" descr="Detect if a key has been released once"> + <Overload retVal="bool" descr="Check if a key has been released once"> <Param name="int key" /> </Overload> </KeyWord> <KeyWord name="IsKeyUp" func="yes"> - <Overload retVal="bool" descr="Detect if a key is NOT being pressed"> + <Overload retVal="bool" descr="Check if a key is NOT being pressed"> <Param name="int key" /> </Overload> </KeyWord> - <KeyWord name="GetKeyPressed" func="yes"> - <Overload retVal="int" descr="Get latest key pressed"></Overload> - </KeyWord> <KeyWord name="SetExitKey" func="yes"> <Overload retVal="void" descr="Set a custom key to exit program (default is ESC)"> <Param name="int key" /> </Overload> </KeyWord> + <KeyWord name="GetKeyPressed" func="yes"> + <Overload retVal="int" descr="Get key pressed (keycode), call it multiple times for keys queued, returns 0 when the queue is empty"></Overload> + </KeyWord> + <KeyWord name="GetCharPressed" func="yes"> + <Overload retVal="int" descr="Get char pressed (unicode), call it multiple times for chars queued, returns 0 when the queue is empty"></Overload> + </KeyWord> <!-- Input-related functions: gamepads --> <KeyWord name="IsGamepadAvailable" func="yes"> - <Overload retVal="bool" descr="Detect if a gamepad is available"> - <Param name="int gamepad" /> - </Overload> - </KeyWord> - <KeyWord name="IsGamepadName" func="yes"> - <Overload retVal="bool" descr="Check gamepad name (if available)"> + <Overload retVal="bool" descr="Check if a gamepad is available"> <Param name="int gamepad" /> - <Param name="const char *name" /> </Overload> </KeyWord> <KeyWord name="GetGamepadName" func="yes"> - <Overload retVal="const char" descr="Return gamepad internal name id"> + <Overload retVal="const char" descr="Get gamepad internal name id"> <Param name="int gamepad" /> </Overload> </KeyWord> <KeyWord name="IsGamepadButtonPressed" func="yes"> - <Overload retVal="bool" descr="Detect if a gamepad button has been pressed once"> + <Overload retVal="bool" descr="Check if a gamepad button has been pressed once"> <Param name="int gamepad" /> <Param name="int button" /> </Overload> </KeyWord> <KeyWord name="IsGamepadButtonDown" func="yes"> - <Overload retVal="bool" descr="Detect if a gamepad button is being pressed"> + <Overload retVal="bool" descr="Check if a gamepad button is being pressed"> <Param name="int gamepad" /> <Param name="int button" /> </Overload> </KeyWord> <KeyWord name="IsGamepadButtonReleased" func="yes"> - <Overload retVal="bool" descr="Detect if a gamepad button has been released once"> + <Overload retVal="bool" descr="Check if a gamepad button has been released once"> <Param name="int gamepad" /> <Param name="int button" /> </Overload> </KeyWord> <KeyWord name="IsGamepadButtonUp" func="yes"> - <Overload retVal="bool" descr="Detect if a gamepad button is NOT being pressed"> + <Overload retVal="bool" descr="Check if a gamepad button is NOT being pressed"> <Param name="int gamepad" /> <Param name="int button" /> </Overload> @@ -384,80 +753,109 @@ <Overload retVal="int" descr="Get the last gamepad button pressed"></Overload> </KeyWord> <KeyWord name="GetGamepadAxisCount" func="yes"> - <Overload retVal="int" descr="Return gamepad axis count for a gamepad"> + <Overload retVal="int" descr="Get gamepad axis count for a gamepad"> <Param name="int gamepad" /> </Overload> </KeyWord> <KeyWord name="GetGamepadAxisMovement" func="yes"> - <Overload retVal="float" descr="Return axis movement value for a gamepad axis"> + <Overload retVal="float" descr="Get axis movement value for a gamepad axis"> <Param name="int gamepad" /> <Param name="int axis" /> </Overload> </KeyWord> + <KeyWord name="SetGamepadMappings" func="yes"> + <Overload retVal="int" descr="Set internal gamepad mappings (SDL_GameControllerDB)"> + <Param name="const char *mappings" /> + </Overload> + </KeyWord> <!-- Input-related functions: mouse --> <KeyWord name="IsMouseButtonPressed" func="yes"> - <Overload retVal="bool" descr="Detect if a mouse button has been pressed once"> + <Overload retVal="bool" descr="Check if a mouse button has been pressed once"> <Param name="int button" /> </Overload> </KeyWord> <KeyWord name="IsMouseButtonDown" func="yes"> - <Overload retVal="bool" descr="Detect if a mouse button is being pressed"> + <Overload retVal="bool" descr="Check if a mouse button is being pressed"> <Param name="int button" /> </Overload> </KeyWord> <KeyWord name="IsMouseButtonReleased" func="yes"> - <Overload retVal="bool" descr="Detect if a mouse button has been released once"> + <Overload retVal="bool" descr="Check if a mouse button has been released once"> <Param name="int button" /> </Overload> </KeyWord> <KeyWord name="IsMouseButtonUp" func="yes"> - <Overload retVal="bool" descr="Detect if a mouse button is NOT being pressed"> + <Overload retVal="bool" descr="Check if a mouse button is NOT being pressed"> <Param name="int button" /> </Overload> </KeyWord> <KeyWord name="GetMouseX" func="yes"> - <Overload retVal="int" descr="Returns mouse position X"></Overload> + <Overload retVal="int" descr="Get mouse position X"></Overload> </KeyWord> <KeyWord name="GetMouseY" func="yes"> - <Overload retVal="int" descr="Returns mouse position Y"></Overload> + <Overload retVal="int" descr="Get mouse position Y"></Overload> </KeyWord> <KeyWord name="GetMousePosition" func="yes"> - <Overload retVal="Vector2" descr="Returns mouse position XY"></Overload> + <Overload retVal="Vector2" descr="Get mouse position XY"></Overload> + </KeyWord> + <KeyWord name="GetMouseDelta" func="yes"> + <Overload retVal="Vector2" descr="Get mouse delta between frames"></Overload> </KeyWord> <KeyWord name="SetMousePosition" func="yes"> <Overload retVal="void" descr="Set mouse position XY"> - <Param name="Vector2 position" /> + <Param name="int x" /> + <Param name="int y" /> + </Overload> + </KeyWord> + <KeyWord name="SetMouseOffset" func="yes"> + <Overload retVal="void" descr="Set mouse offset"> + <Param name="int offsetX" /> + <Param name="int offsetY" /> </Overload> </KeyWord> <KeyWord name="SetMouseScale" func="yes"> <Overload retVal="void" descr="Set mouse scaling"> - <Param name="float scale" /> + <Param name="float scaleX" /> + <Param name="float scaleY" /> </Overload> </KeyWord> <KeyWord name="GetMouseWheelMove" func="yes"> - <Overload retVal="float" descr="Returns mouse wheel movement Y"></Overload> + <Overload retVal="float" descr="Get mouse wheel movement Y"></Overload> + </KeyWord> + <KeyWord name="SetMouseCursor" func="yes"> + <Overload retVal="void" descr="Set mouse cursor"> + <Param name="int cursor" /> + </Overload> </KeyWord> <!-- Input-related functions: touch --> <KeyWord name="GetTouchX" func="yes"> - <Overload retVal="int" descr="Returns touch position X for touch point 0 (relative to screen size)"></Overload> + <Overload retVal="int" descr="Get touch position X for touch point 0 (relative to screen size)"></Overload> </KeyWord> <KeyWord name="GetTouchY" func="yes"> - <Overload retVal="int" descr="Returns touch position Y for touch point 0 (relative to screen size)"></Overload> + <Overload retVal="int" descr="Get touch position Y for touch point 0 (relative to screen size)"></Overload> </KeyWord> <KeyWord name="GetTouchPosition" func="yes"> - <Overload retVal="Vector2" descr="Returns touch position XY for a touch point index (relative to screen size)"> + <Overload retVal="Vector2" descr="Get touch position XY for a touch point index (relative to screen size)"> + <Param name="int index" /> + </Overload> + </KeyWord> + <KeyWord name="GetTouchPointId" func="yes"> + <Overload retVal="int" descr="Get touch point identifier for given index"> <Param name="int index" /> </Overload> </KeyWord> + <KeyWord name="GetTouchPointCount" func="yes"> + <Overload retVal="int" descr="Get number of touch points"></Overload> + </KeyWord> <!-------------------------------------------------------------------------------------- --> - <!-- Gestures and Touch Handling Functions (Module: gestures) --> + <!-- Gestures and Touch Handling Functions (Module: rgestures) --> <!-------------------------------------------------------------------------------------- --> <KeyWord name="SetGesturesEnabled" func="yes"> <Overload retVal="void" descr="Enable a set of gestures using flags"> - <Param name="unsigned int gestureFlags" /> + <Param name="unsigned int flags" /> </Overload> </KeyWord> <KeyWord name="IsGestureDetected" func="yes"> @@ -468,9 +866,6 @@ <KeyWord name="GetGestureDetected" func="yes"> <Overload retVal="int" descr="Get latest detected gesture"></Overload> </KeyWord> - <KeyWord name="GetTouchPointsCount" func="yes"> - <Overload retVal="int" descr="Get touch points count"></Overload> - </KeyWord> <KeyWord name="GetGestureHoldDuration" func="yes"> <Overload retVal="float" descr="Get gesture hold time in milliseconds"></Overload> </KeyWord> @@ -488,7 +883,7 @@ </KeyWord> <!-------------------------------------------------------------------------------------- --> - <!-- Camera System Functions (Module: camera) --> + <!-- Camera System Functions (Module: rcamera) --> <!-------------------------------------------------------------------------------------- --> <KeyWord name="SetCameraMode" func="yes"> <Overload retVal="void" descr="Set camera mode (multiple camera modes available)"> @@ -504,33 +899,42 @@ <KeyWord name="SetCameraPanControl" func="yes"> <Overload retVal="void" descr="Set camera pan key to combine with mouse movement (free camera)"> - <Param name="int panKey" /> + <Param name="int keyPan" /> </Overload> </KeyWord> <KeyWord name="SetCameraAltControl" func="yes"> <Overload retVal="void" descr="Set camera alt key to combine with mouse movement (free camera)"> - <Param name="int altKey" /> + <Param name="int keyAlt" /> </Overload> </KeyWord> <KeyWord name="SetCameraSmoothZoomControl" func="yes"> <Overload retVal="void" descr="Set camera smooth zoom key to combine with mouse (free camera)"> - <Param name="int szKey" /> + <Param name="int keySmoothZoom" /> </Overload> </KeyWord> <KeyWord name="SetCameraMoveControls" func="yes"> <Overload retVal="void" descr="Set camera move controls (1st person and 3rd person cameras)"> - <Param name="int frontKey" /> - <Param name="int backKey" /> - <Param name="int rightKey" /> - <Param name="int leftKey" /> - <Param name="int upKey" /> - <Param name="int downKey" /> + <Param name="int keyFront" /> + <Param name="int keyBack" /> + <Param name="int keyRight" /> + <Param name="int keyLeft" /> + <Param name="int keyUp" /> + <Param name="int keyDown" /> </Overload> </KeyWord> <!-------------------------------------------------------------------------------------- --> <!-- Basic Shapes Drawing Functions (Module: shapes) --> <!-------------------------------------------------------------------------------------- --> + <!-- 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 --> + <KeyWord name="SetShapesTexture" func="yes"> + <Overload retVal="void" descr="Set texture and rectangle to be used on shapes drawing"> + <Param name="Texture2D texture" /> + <Param name="Rectangle source" /> + </Overload> + </KeyWord> <!-- Basic shapes drawing functions --> <KeyWord name="DrawPixel" func="yes"> @@ -578,6 +982,32 @@ <Param name="Color color" /> </Overload> </KeyWord> + <KeyWord name="DrawLineBezierQuad" func="yes"> + <Overload retVal="void" descr="Draw line using quadratic bezier curves with a control point"> + <Param name="Vector2 startPos" /> + <Param name="Vector2 endPos" /> + <Param name="Vector2 controlPos" /> + <Param name="float thick" /> + <Param name="Color color" /> + </Overload> + </KeyWord> + <KeyWord name="DrawLineBezierCubic" func="yes"> + <Overload retVal="void" descr="Draw line using cubic bezier curves with 2 control points"> + <Param name="Vector2 startPos" /> + <Param name="Vector2 endPos" /> + <Param name="Vector2 startControlPos" /> + <Param name="Vector2 endControlPos" /> + <Param name="float thick" /> + <Param name="Color color" /> + </Overload> + </KeyWord> + <KeyWord name="DrawLineStrip" func="yes"> + <Overload retVal="void" descr="Draw lines sequence"> + <Param name="Vector2 *points" /> + <Param name="int pointCount" /> + <Param name="Color color" /> + </Overload> + </KeyWord> <KeyWord name="DrawCircle" func="yes"> <Overload retVal="void" descr="Draw a color-filled circle"> <Param name="int centerX" /> @@ -586,6 +1016,26 @@ <Param name="Color color" /> </Overload> </KeyWord> + <KeyWord name="DrawCircleSector" func="yes"> + <Overload retVal="void" descr="Draw a piece of a circle"> + <Param name="Vector2 center" /> + <Param name="float radius" /> + <Param name="float startAngle" /> + <Param name="float endAngle" /> + <Param name="int segments" /> + <Param name="Color color" /> + </Overload> + </KeyWord> + <KeyWord name="DrawCircleSectorLines" func="yes"> + <Overload retVal="void" descr="Draw circle sector outline"> + <Param name="Vector2 center" /> + <Param name="float radius" /> + <Param name="float startAngle" /> + <Param name="float endAngle" /> + <Param name="int segments" /> + <Param name="Color color" /> + </Overload> + </KeyWord> <KeyWord name="DrawCircleGradient" func="yes"> <Overload retVal="void" descr="Draw a gradient-filled circle"> <Param name="int centerX" /> @@ -610,6 +1060,46 @@ <Param name="Color color" /> </Overload> </KeyWord> + <KeyWord name="DrawEllipse" func="yes"> + <Overload retVal="void" descr="Draw ellipse"> + <Param name="int centerX" /> + <Param name="int centerY" /> + <Param name="float radiusH" /> + <Param name="float radiusV" /> + <Param name="Color color" /> + </Overload> + </KeyWord> + <KeyWord name="DrawEllipseLines" func="yes"> + <Overload retVal="void" descr="Draw ellipse outline"> + <Param name="int centerX" /> + <Param name="int centerY" /> + <Param name="float radiusH" /> + <Param name="float radiusV" /> + <Param name="Color color" /> + </Overload> + </KeyWord> + <KeyWord name="DrawRing" func="yes"> + <Overload retVal="void" descr="Draw ring"> + <Param name="Vector2 center" /> + <Param name="float innerRadius" /> + <Param name="float outerRadius" /> + <Param name="float startAngle" /> + <Param name="float endAngle" /> + <Param name="int segments" /> + <Param name="Color color" /> + </Overload> + </KeyWord> + <KeyWord name="DrawRingLines" func="yes"> + <Overload retVal="void" descr="Draw ring outline"> + <Param name="Vector2 center" /> + <Param name="float innerRadius" /> + <Param name="float outerRadius" /> + <Param name="float startAngle" /> + <Param name="float endAngle" /> + <Param name="int segments" /> + <Param name="Color color" /> + </Overload> + </KeyWord> <KeyWord name="DrawRectangle" func="yes"> <Overload retVal="void" descr="Draw a color-filled rectangle"> <Param name="int posX" /> @@ -681,12 +1171,29 @@ <KeyWord name="DrawRectangleLinesEx" func="yes"> <Overload retVal="void" descr="Draw rectangle outline with extended parameters"> <Param name="Rectangle rec" /> - <Param name="int lineThick" /> + <Param name="float lineThick" /> + <Param name="Color color" /> + </Overload> + </KeyWord> + <KeyWord name="DrawRectangleRounded" func="yes"> + <Overload retVal="void" descr="Draw rectangle with rounded edges"> + <Param name="Rectangle rec" /> + <Param name="float roundness" /> + <Param name="int segments" /> + <Param name="Color color" /> + </Overload> + </KeyWord> + <KeyWord name="DrawRectangleRoundedLines" func="yes"> + <Overload retVal="void" descr="Draw rectangle with rounded edges outline"> + <Param name="Rectangle rec" /> + <Param name="float roundness" /> + <Param name="int segments" /> + <Param name="float lineThick" /> <Param name="Color color" /> </Overload> </KeyWord> <KeyWord name="DrawTriangle" func="yes"> - <Overload retVal="void" descr="Draw a color-filled triangle"> + <Overload retVal="void" descr="Draw a color-filled triangle (vertex in counter-clockwise order!)"> <Param name="Vector2 v1" /> <Param name="Vector2 v2" /> <Param name="Vector2 v3" /> @@ -694,13 +1201,27 @@ </Overload> </KeyWord> <KeyWord name="DrawTriangleLines" func="yes"> - <Overload retVal="void" descr="Draw triangle outline"> + <Overload retVal="void" descr="Draw triangle outline (vertex in counter-clockwise order!)"> <Param name="Vector2 v1" /> <Param name="Vector2 v2" /> <Param name="Vector2 v3" /> <Param name="Color color" /> </Overload> </KeyWord> + <KeyWord name="DrawTriangleFan" func="yes"> + <Overload retVal="void" descr="Draw a triangle fan defined by points (first vertex is the center)"> + <Param name="Vector2 *points" /> + <Param name="int pointCount" /> + <Param name="Color color" /> + </Overload> + </KeyWord> + <KeyWord name="DrawTriangleStrip" func="yes"> + <Overload retVal="void" descr="Draw a triangle strip defined by points"> + <Param name="Vector2 *points" /> + <Param name="int pointCount" /> + <Param name="Color color" /> + </Overload> + </KeyWord> <KeyWord name="DrawPoly" func="yes"> <Overload retVal="void" descr="Draw a regular polygon (Vector version)"> <Param name="Vector2 center" /> @@ -710,17 +1231,22 @@ <Param name="Color color" /> </Overload> </KeyWord> - <KeyWord name="DrawPolyEx" func="yes"> - <Overload retVal="void" descr="Draw a closed polygon defined by points"> - <Param name="Vector2 *points" /> - <Param name="int numPoints" /> + <KeyWord name="DrawPolyLines" func="yes"> + <Overload retVal="void" descr="Draw a polygon outline of n sides"> + <Param name="Vector2 center" /> + <Param name="int sides" /> + <Param name="float radius" /> + <Param name="float rotation" /> <Param name="Color color" /> </Overload> </KeyWord> - <KeyWord name="DrawPolyExLines" func="yes"> - <Overload retVal="void" descr="Draw polygon lines"> - <Param name="Vector2 *points" /> - <Param name="int numPoints" /> + <KeyWord name="DrawPolyLinesEx" func="yes"> + <Overload retVal="void" descr="Draw a polygon outline of n sides with extended parameters"> + <Param name="Vector2 center" /> + <Param name="int sides" /> + <Param name="float radius" /> + <Param name="float rotation" /> + <Param name="float lineThick" /> <Param name="Color color" /> </Overload> </KeyWord> @@ -747,12 +1273,6 @@ <Param name="Rectangle rec" /> </Overload> </KeyWord> - <KeyWord name="GetCollisionRec" func="yes"> - <Overload retVal="Rectangle" descr="Get collision rectangle for two rectangles collision"> - <Param name="Rectangle rec1" /> - <Param name="Rectangle rec2" /> - </Overload> - </KeyWord> <KeyWord name="CheckCollisionPointRec" func="yes"> <Overload retVal="bool" descr="Check if point is inside rectangle"> <Param name="Vector2 point" /> @@ -774,27 +1294,41 @@ <Param name="Vector2 p3" /> </Overload> </KeyWord> + <KeyWord name="CheckCollisionLines" func="yes"> + <Overload retVal="bool" descr="Check the collision between two lines defined by two points each, returns collision point by reference"> + <Param name="Vector2 startPos1" /> + <Param name="Vector2 endPos1" /> + <Param name="Vector2 startPos2" /> + <Param name="Vector2 endPos2" /> + <Param name="Vector2 *collisionPoint" /> + </Overload> + </KeyWord> + <KeyWord name="CheckCollisionPointLine" func="yes"> + <Overload retVal="bool" descr="Check if point belongs to line created between two points [p1] and [p2] with defined margin in pixels [threshold]"> + <Param name="Vector2 point" /> + <Param name="Vector2 p1" /> + <Param name="Vector2 p2" /> + <Param name="int threshold" /> + </Overload> + </KeyWord> + <KeyWord name="GetCollisionRec" func="yes"> + <Overload retVal="Rectangle" descr="Get collision rectangle for two rectangles collision"> + <Param name="Rectangle rec1" /> + <Param name="Rectangle rec2" /> + </Overload> + </KeyWord> <!-------------------------------------------------------------------------------------- --> <!-- Texture Loading and Drawing Functions (Module: textures) --> <!-------------------------------------------------------------------------------------- --> - <!-- Image/Texture2D data loading/unloading/saving functions --> + <!-- Image loading functions --> + <!-- NOTE: This functions do not require GPU access --> <KeyWord name="LoadImage" func="yes"> <Overload retVal="Image" descr="Load image from file into CPU memory (RAM)"> <Param name="const char *fileName" /> </Overload> </KeyWord> - <KeyWord name="LoadImageEx" func="yes"> - <Overload retVal="Image" descr="Load image from Color array data (RGBA - 32bit)"> - <Param name="Color *pixels" /> - <Param name="int width" /> - <Param name="int height" /> - </Overload> - </KeyWord> - <KeyWord name="LoadImagePro" func="yes"> - <Overload retVal="Image" descr="Load image from raw data with parameters"></Overload> - </KeyWord> <KeyWord name="LoadImageRaw" func="yes"> <Overload retVal="Image" descr="Load image from RAW file data"> <Param name="const char *fileName" /> @@ -804,69 +1338,100 @@ <Param name="int headerSize" /> </Overload> </KeyWord> - <KeyWord name="ExportImage" func="yes"> - <Overload retVal="void" descr="Export image as a PNG file"> + <KeyWord name="LoadImageAnim" func="yes"> + <Overload retVal="Image" descr="Load image sequence from file (frames appended to image.data)"> <Param name="const char *fileName" /> - <Param name="Image image" /> + <Param name="int *frames" /> </Overload> </KeyWord> - <KeyWord name="LoadTexture" func="yes"> - <Overload retVal="Texture2D" descr="Load texture from file into GPU memory (VRAM)"> - <Param name="const char *fileName" /> + <KeyWord name="LoadImageFromMemory" func="yes"> + <Overload retVal="Image" descr="Load image from memory buffer, fileType refers to extension: i.e. '.png'"> + <Param name="const char *fileType" /> + <Param name="const unsigned char" /> + <Param name="int dataSize" /> </Overload> </KeyWord> - <KeyWord name="LoadTextureFromImage" func="yes"> - <Overload retVal="Texture2D" descr="Load texture from image data"> - <Param name="Image image" /> + <KeyWord name="LoadImageFromTexture" func="yes"> + <Overload retVal="Image" descr="Load image from GPU texture data"> + <Param name="Texture2D texture" /> </Overload> </KeyWord> - <KeyWord name="LoadRenderTexture" func="yes"> - <Overload retVal="RenderTexture2D" descr="Load texture for rendering (framebuffer)"> - <Param name="int width" /> - <Param name="int height" /> - </Overload> + <KeyWord name="LoadImageFromScreen" func="yes"> + <Overload retVal="Image" descr="Load image from screen buffer and (screenshot)"></Overload> </KeyWord> <KeyWord name="UnloadImage" func="yes"> <Overload retVal="void" descr="Unload image from CPU memory (RAM)"> <Param name="Image image" /> </Overload> </KeyWord> - <KeyWord name="UnloadTexture" func="yes"> - <Overload retVal="void" descr="Unload texture from GPU memory (VRAM)"> - <Param name="Texture2D texture" /> + <KeyWord name="ExportImage" func="yes"> + <Overload retVal="bool" descr="Export image data to file, returns true on success"> + <Param name="Image image" /> + <Param name="const char *fileName" /> </Overload> </KeyWord> - <KeyWord name="UnloadRenderTexture" func="yes"> - <Overload retVal="void" descr="Unload render texture from GPU memory (VRAM)"> - <Param name="RenderTexture2D target" /> + <KeyWord name="ExportImageAsCode" func="yes"> + <Overload retVal="bool" descr="Export image as code file defining an array of bytes, returns true on success"> + <Param name="Image image" /> + <Param name="const char *fileName" /> </Overload> </KeyWord> - <KeyWord name="GetImageData" func="yes"> - <Overload retVal="Color" descr="Get pixel data from image as a Color struct array"> - <Param name="Image image" /> + + <!-- Image generation functions --> + <KeyWord name="GenImageColor" func="yes"> + <Overload retVal="Image" descr="Generate image: plain color"> + <Param name="int width" /> + <Param name="int height" /> + <Param name="Color color" /> </Overload> </KeyWord> - <KeyWord name="GetImageDataNormalized" func="yes"> - <Overload retVal="Vector4" descr="Get pixel data from image as Vector4 array (float normalized)"> - <Param name="Image image" /> + <KeyWord name="GenImageGradientV" func="yes"> + <Overload retVal="Image" descr="Generate image: vertical gradient"> + <Param name="int width" /> + <Param name="int height" /> + <Param name="Color top" /> + <Param name="Color bottom" /> </Overload> </KeyWord> - <KeyWord name="GetPixelDataSize" func="yes"> - <Overload retVal="int" descr="Get pixel data size in bytes (image or texture)"> + <KeyWord name="GenImageGradientH" func="yes"> + <Overload retVal="Image" descr="Generate image: horizontal gradient"> <Param name="int width" /> <Param name="int height" /> - <Param name="int format" /> + <Param name="Color left" /> + <Param name="Color right" /> </Overload> </KeyWord> - <KeyWord name="GetTextureData" func="yes"> - <Overload retVal="Image" descr="Get pixel data from GPU texture and return an Image"> - <Param name="Texture2D texture" /> + <KeyWord name="GenImageGradientRadial" func="yes"> + <Overload retVal="Image" descr="Generate image: radial gradient"> + <Param name="int width" /> + <Param name="int height" /> + <Param name="float density" /> + <Param name="Color inner" /> + <Param name="Color outer" /> </Overload> </KeyWord> - <KeyWord name="UpdateTexture" func="yes"> - <Overload retVal="void" descr="Update GPU texture with new data"> - <Param name="Texture2D texture" /> - <Param name="const void *pixels" /> + <KeyWord name="GenImageChecked" func="yes"> + <Overload retVal="Image" descr="Generate image: checked"> + <Param name="int width" /> + <Param name="int height" /> + <Param name="int checksX" /> + <Param name="int checksY" /> + <Param name="Color col1" /> + <Param name="Color col2" /> + </Overload> + </KeyWord> + <KeyWord name="GenImageWhiteNoise" func="yes"> + <Overload retVal="Image" descr="Generate image: white noise"> + <Param name="int width" /> + <Param name="int height" /> + <Param name="float factor" /> + </Overload> + </KeyWord> + <KeyWord name="GenImageCellular" func="yes"> + <Overload retVal="Image" descr="Generate image: cellular algorithm, bigger tileSize means bigger cells"> + <Param name="int width" /> + <Param name="int height" /> + <Param name="int tileSize" /> </Overload> </KeyWord> @@ -876,10 +1441,26 @@ <Param name="Image image" /> </Overload> </KeyWord> - <KeyWord name="ImageToPOT" func="yes"> - <Overload retVal="void" descr="Convert image to POT (power-of-two)"> - <Param name="Image *image" /> - <Param name="Color fillColor" /> + <KeyWord name="ImageFromImage" func="yes"> + <Overload retVal="Image" descr="Create an image from another image piece"> + <Param name="Image image" /> + <Param name="Rectangle rec" /> + </Overload> + </KeyWord> + <KeyWord name="ImageText" func="yes"> + <Overload retVal="Image" descr="Create an image from text (default font)"> + <Param name="const char *text" /> + <Param name="int fontSize" /> + <Param name="Color color" /> + </Overload> + </KeyWord> + <KeyWord name="ImageTextEx" func="yes"> + <Overload retVal="Image" descr="Create an image from text (custom sprite font)"> + <Param name="Font font" /> + <Param name="const char *text" /> + <Param name="float fontSize" /> + <Param name="float spacing" /> + <Param name="Color tint" /> </Overload> </KeyWord> <KeyWord name="ImageFormat" func="yes"> @@ -888,17 +1469,16 @@ <Param name="int newFormat" /> </Overload> </KeyWord> - <KeyWord name="ImageAlphaMask" func="yes"> - <Overload retVal="void" descr="Apply alpha mask to image"> + <KeyWord name="ImageToPOT" func="yes"> + <Overload retVal="void" descr="Convert image to POT (power-of-two)"> <Param name="Image *image" /> - <Param name="Image alphaMask" /> + <Param name="Color fill" /> </Overload> </KeyWord> - <KeyWord name="ImageAlphaClear" func="yes"> - <Overload retVal="void" descr="Clear alpha channel to desired color"> + <KeyWord name="ImageCrop" func="yes"> + <Overload retVal="void" descr="Crop an image to a defined rectangle"> <Param name="Image *image" /> - <Param name="Color color" /> - <Param name="float threshold" /> + <Param name="Rectangle crop" /> </Overload> </KeyWord> <KeyWord name="ImageAlphaCrop" func="yes"> @@ -907,26 +1487,33 @@ <Param name="float threshold" /> </Overload> </KeyWord> - <KeyWord name="ImageAlphaPremultiply" func="yes"> - <Overload retVal="void" descr="Premultiply alpha channel"> + <KeyWord name="ImageAlphaClear" func="yes"> + <Overload retVal="void" descr="Clear alpha channel to desired color"> <Param name="Image *image" /> + <Param name="Color color" /> + <Param name="float threshold" /> </Overload> </KeyWord> - <KeyWord name="ImageCrop" func="yes"> - <Overload retVal="void" descr="Crop an image to a defined rectangle"> + <KeyWord name="ImageAlphaMask" func="yes"> + <Overload retVal="void" descr="Apply alpha mask to image"> + <Param name="Image *image" /> + <Param name="Image alphaMask" /> + </Overload> + </KeyWord> + <KeyWord name="ImageAlphaPremultiply" func="yes"> + <Overload retVal="void" descr="Premultiply alpha channel"> <Param name="Image *image" /> - <Param name="Rectangle crop" /> </Overload> </KeyWord> <KeyWord name="ImageResize" func="yes"> - <Overload retVal="void" descr="Resize and image (bilinear filtering)"> + <Overload retVal="void" descr="Resize image (Bicubic scaling algorithm)"> <Param name="Image *image" /> <Param name="int newWidth" /> <Param name="int newHeight" /> </Overload> </KeyWord> <KeyWord name="ImageResizeNN" func="yes"> - <Overload retVal="void" descr="Resize and image (Nearest-Neighbor scaling algorithm)"> + <Overload retVal="void" descr="Resize image (Nearest-Neighbor scaling algorithm)"> <Param name="Image *image" /> <Param name="int newWidth" /> <Param name="int newHeight" /> @@ -939,11 +1526,11 @@ <Param name="int newHeight" /> <Param name="int offsetX" /> <Param name="int offsetY" /> - <Param name="Color color" /> + <Param name="Color fill" /> </Overload> </KeyWord> <KeyWord name="ImageMipmaps" func="yes"> - <Overload retVal="void" descr="Generate all mipmap levels for a provided image"> + <Overload retVal="void" descr="Compute all mipmap levels for a provided image"> <Param name="Image *image" /> </Overload> </KeyWord> @@ -956,124 +1543,203 @@ <Param name="int aBpp" /> </Overload> </KeyWord> - <KeyWord name="ImageText" func="yes"> - <Overload retVal="Image" descr="Create an image from text (default font)"> - <Param name="const char *text" /> - <Param name="int fontSize" /> + <KeyWord name="ImageFlipVertical" func="yes"> + <Overload retVal="void" descr="Flip image vertically"> + <Param name="Image *image" /> + </Overload> + </KeyWord> + <KeyWord name="ImageFlipHorizontal" func="yes"> + <Overload retVal="void" descr="Flip image horizontally"> + <Param name="Image *image" /> + </Overload> + </KeyWord> + <KeyWord name="ImageRotateCW" func="yes"> + <Overload retVal="void" descr="Rotate image clockwise 90deg"> + <Param name="Image *image" /> + </Overload> + </KeyWord> + <KeyWord name="ImageRotateCCW" func="yes"> + <Overload retVal="void" descr="Rotate image counter-clockwise 90deg"> + <Param name="Image *image" /> + </Overload> + </KeyWord> + <KeyWord name="ImageColorTint" func="yes"> + <Overload retVal="void" descr="Modify image color: tint"> + <Param name="Image *image" /> <Param name="Color color" /> </Overload> </KeyWord> - <KeyWord name="ImageTextEx" func="yes"> - <Overload retVal="Image" descr="Create an image from text (custom sprite font)"> - <Param name="Font font" /> - <Param name="const char *text" /> - <Param name="float fontSize" /> - <Param name="float spacing" /> - <Param name="Color tint" /> + <KeyWord name="ImageColorInvert" func="yes"> + <Overload retVal="void" descr="Modify image color: invert"> + <Param name="Image *image" /> </Overload> </KeyWord> - <KeyWord name="ImageDraw" func="yes"> - <Overload retVal="void" descr="Draw a source image within a destination image"> + <KeyWord name="ImageColorGrayscale" func="yes"> + <Overload retVal="void" descr="Modify image color: grayscale"> + <Param name="Image *image" /> + </Overload> + </KeyWord> + <KeyWord name="ImageColorContrast" func="yes"> + <Overload retVal="void" descr="Modify image color: contrast (-100 to 100)"> + <Param name="Image *image" /> + <Param name="float contrast" /> + </Overload> + </KeyWord> + <KeyWord name="ImageColorBrightness" func="yes"> + <Overload retVal="void" descr="Modify image color: brightness (-255 to 255)"> + <Param name="Image *image" /> + <Param name="int brightness" /> + </Overload> + </KeyWord> + <KeyWord name="ImageColorReplace" func="yes"> + <Overload retVal="void" descr="Modify image color: replace color"> + <Param name="Image *image" /> + <Param name="Color color" /> + <Param name="Color replace" /> + </Overload> + </KeyWord> + <KeyWord name="LoadImageColors" func="yes"> + <Overload retVal="Color" descr="Load color data from image as a Color array (RGBA - 32bit)"> + <Param name="Image image" /> + </Overload> + </KeyWord> + <KeyWord name="LoadImagePalette" func="yes"> + <Overload retVal="Color" descr="Load colors palette from image as a Color array (RGBA - 32bit)"> + <Param name="Image image" /> + <Param name="int maxPaletteSize" /> + <Param name="int *colorCount" /> + </Overload> + </KeyWord> + <KeyWord name="UnloadImageColors" func="yes"> + <Overload retVal="void" descr="Unload color data loaded with LoadImageColors()"> + <Param name="Color *colors" /> + </Overload> + </KeyWord> + <KeyWord name="UnloadImagePalette" func="yes"> + <Overload retVal="void" descr="Unload colors palette loaded with LoadImagePalette()"> + <Param name="Color *colors" /> + </Overload> + </KeyWord> + <KeyWord name="GetImageAlphaBorder" func="yes"> + <Overload retVal="Rectangle" descr="Get image alpha border rectangle"> + <Param name="Image image" /> + <Param name="float threshold" /> + </Overload> + </KeyWord> + <KeyWord name="GetImageColor" func="yes"> + <Overload retVal="Color" descr="Get image pixel color at (x, y) position"> + <Param name="Image image" /> + <Param name="int x" /> + <Param name="int y" /> + </Overload> + </KeyWord> + + <!-- Image drawing functions --> + <!-- NOTE: Image software-rendering functions (CPU) --> + <KeyWord name="ImageClearBackground" func="yes"> + <Overload retVal="void" descr="Clear image background with given color"> <Param name="Image *dst" /> - <Param name="Image src" /> - <Param name="Rectangle srcRec" /> - <Param name="Rectangle dstRec" /> + <Param name="Color color" /> </Overload> </KeyWord> - <KeyWord name="ImageDrawRectangle" func="yes"> - <Overload retVal="void" descr="Draw rectangle within an image"> + <KeyWord name="ImageDrawPixel" func="yes"> + <Overload retVal="void" descr="Draw pixel within an image"> <Param name="Image *dst" /> <Param name="int posX" /> <Param name="int posY" /> - <Param name="int width" /> - <Param name="int height" /> <Param name="Color color" /> </Overload> </KeyWord> - <KeyWord name="ImageDrawRectangleV" func="yes"> - <Overload retVal="void" descr="Draw rectangle within an image (Vector version)"> + <KeyWord name="ImageDrawPixelV" func="yes"> + <Overload retVal="void" descr="Draw pixel within an image (Vector version)"> <Param name="Image *dst" /> <Param name="Vector2 position" /> - <Param name="Vector2 size" /> <Param name="Color color" /> </Overload> </KeyWord> - <KeyWord name="ImageDrawRectangleRec" func="yes"> - <Overload retVal="void" descr="Draw rectangle within an image"> + <KeyWord name="ImageDrawLine" func="yes"> + <Overload retVal="void" descr="Draw line within an image"> <Param name="Image *dst" /> - <Param name="Rectangle rec" /> + <Param name="int startPosX" /> + <Param name="int startPosY" /> + <Param name="int endPosX" /> + <Param name="int endPosY" /> <Param name="Color color" /> </Overload> </KeyWord> - <KeyWord name="ImageDrawRectangleLines" func="yes"> - <Overload retVal="void" descr="Draw rectangle lines within an image"> + <KeyWord name="ImageDrawLineV" func="yes"> + <Overload retVal="void" descr="Draw line within an image (Vector version)"> <Param name="Image *dst" /> - <Param name="Rectangle rec" /> - <Param name="int thick" /> + <Param name="Vector2 start" /> + <Param name="Vector2 end" /> <Param name="Color color" /> </Overload> </KeyWord> - <KeyWord name="ImageClearBackground" func="yes"> - <Overload retVal="void" descr="Clear image background with given color"> + <KeyWord name="ImageDrawCircle" func="yes"> + <Overload retVal="void" descr="Draw circle within an image"> <Param name="Image *dst" /> + <Param name="int centerX" /> + <Param name="int centerY" /> + <Param name="int radius" /> <Param name="Color color" /> </Overload> </KeyWord> - <KeyWord name="ImageDrawPixel" func="yes"> - <Overload retVal="void" descr="Clear image background with given color"> + <KeyWord name="ImageDrawCircleV" func="yes"> + <Overload retVal="void" descr="Draw circle within an image (Vector version)"> <Param name="Image *dst" /> - <Param name="int posX" /> - <Param name="int posY" /> + <Param name="Vector2 center" /> + <Param name="int radius" /> <Param name="Color color" /> </Overload> </KeyWord> - <KeyWord name="ImageDrawPixelV" func="yes"> - <Overload retVal="void" descr="Clear image background with given color (Vector version)"> + <KeyWord name="ImageDrawRectangle" func="yes"> + <Overload retVal="void" descr="Draw rectangle within an image"> <Param name="Image *dst" /> - <Param name="Vector2 position" /> + <Param name="int posX" /> + <Param name="int posY" /> + <Param name="int width" /> + <Param name="int height" /> <Param name="Color color" /> </Overload> </KeyWord> - <KeyWord name="ImageDrawCircle" func="yes"> - <Overload retVal="void" descr="Draw circle within an image"> + <KeyWord name="ImageDrawRectangleV" func="yes"> + <Overload retVal="void" descr="Draw rectangle within an image (Vector version)"> <Param name="Image *dst" /> - <Param name="int centerX" /> - <Param name="int centerY" /> - <Param name="int radius" /> + <Param name="Vector2 position" /> + <Param name="Vector2 size" /> <Param name="Color color" /> </Overload> </KeyWord> - <KeyWord name="ImageDrawCircleV" func="yes"> - <Overload retVal="void" descr="Draw circle within an image (Vector version)"> + <KeyWord name="ImageDrawRectangleRec" func="yes"> + <Overload retVal="void" descr="Draw rectangle within an image"> <Param name="Image *dst" /> - <Param name="Vector2 center" /> - <Param name="int radius" /> + <Param name="Rectangle rec" /> <Param name="Color color" /> </Overload> </KeyWord> - <KeyWord name="ImageDrawLine" func="yes"> - <Overload retVal="void" descr="Draw line within an image"> + <KeyWord name="ImageDrawRectangleLines" func="yes"> + <Overload retVal="void" descr="Draw rectangle lines within an image"> <Param name="Image *dst" /> - <Param name="int startPosX" /> - <Param name="int startPosY" /> - <Param name="int endPosX" /> - <Param name="int endPosY" /> + <Param name="Rectangle rec" /> + <Param name="int thick" /> <Param name="Color color" /> </Overload> </KeyWord> - <KeyWord name="ImageDrawLineV" func="yes"> - <Overload retVal="void" descr="Draw line within an image (Vector2 version)"> + <KeyWord name="ImageDraw" func="yes"> + <Overload retVal="void" descr="Draw a source image within a destination image (tint applied to source)"> <Param name="Image *dst" /> - <Param name="Vector2 start" /> - <Param name="Vector2 end" /> - <Param name="Color color" /> + <Param name="Image src" /> + <Param name="Rectangle srcRec" /> + <Param name="Rectangle dstRec" /> + <Param name="Color tint" /> </Overload> </KeyWord> <KeyWord name="ImageDrawText" func="yes"> - <Overload retVal="void" descr="Draw text (default font) within an image (destination)"> + <Overload retVal="void" descr="Draw text (using default font) within an image (destination)"> <Param name="Image *dst" /> - <Param name="Vector2 position" /> <Param name="const char *text" /> + <Param name="int posX" /> + <Param name="int posY" /> <Param name="int fontSize" /> <Param name="Color color" /> </Overload> @@ -1081,138 +1747,64 @@ <KeyWord name="ImageDrawTextEx" func="yes"> <Overload retVal="void" descr="Draw text (custom sprite font) within an image (destination)"> <Param name="Image *dst" /> - <Param name="Vector2 position" /> <Param name="Font font" /> <Param name="const char *text" /> + <Param name="Vector2 position" /> <Param name="float fontSize" /> <Param name="float spacing" /> - <Param name="Color color" /> - </Overload> - </KeyWord> - <KeyWord name="ImageFlipVertical" func="yes"> - <Overload retVal="void" descr="Flip image vertically"> - <Param name="Image *image" /> - </Overload> - </KeyWord> - <KeyWord name="ImageFlipHorizontal" func="yes"> - <Overload retVal="void" descr="Flip image horizontally"> - <Param name="Image *image" /> - </Overload> - </KeyWord> - <KeyWord name="ImageRotateCW" func="yes"> - <Overload retVal="void" descr="Rotate image clockwise 90deg"> - <Param name="Image *image" /> - </Overload> - </KeyWord> - <KeyWord name="ImageRotateCCW" func="yes"> - <Overload retVal="void" descr="Rotate image counter-clockwise 90deg"> - <Param name="Image *image" /> - </Overload> - </KeyWord> - <KeyWord name="ImageColorTint" func="yes"> - <Overload retVal="void" descr="Modify image color: tint"> - <Param name="Image *image" /> - <Param name="Color color" /> - </Overload> - </KeyWord> - <KeyWord name="ImageColorInvert" func="yes"> - <Overload retVal="void" descr="Modify image color: invert"> - <Param name="Image *image" /> - </Overload> - </KeyWord> - <KeyWord name="ImageColorGrayscale" func="yes"> - <Overload retVal="void" descr="Modify image color: grayscale"> - <Param name="Image *image" /> - </Overload> - </KeyWord> - <KeyWord name="ImageColorContrast" func="yes"> - <Overload retVal="void" descr="Modify image color: contrast (-100 to 100)"> - <Param name="Image *image" /> - <Param name="float contrast" /> - </Overload> - </KeyWord> - <KeyWord name="ImageColorBrightness" func="yes"> - <Overload retVal="void" descr="Modify image color: brightness (-255 to 255)"> - <Param name="Image *image" /> - <Param name="int brightness" /> - </Overload> - </KeyWord> - <KeyWord name="ImageColorReplace" func="yes"> - <Overload retVal="void" descr="Modify image color: replace color"> - <Param name="Image *image" /> - <Param name="Color color" /> - <Param name="Color replace" /> + <Param name="Color tint" /> </Overload> </KeyWord> - <!-- Image generation functions --> - <KeyWord name="GenImageColor" func="yes"> - <Overload retVal="Image" descr="Generate image: plain color"> - <Param name="int width" /> - <Param name="int height" /> - <Param name="Color color" /> + <!-- Texture loading functions --> + <!-- NOTE: These functions require GPU access --> + <KeyWord name="LoadTexture" func="yes"> + <Overload retVal="Texture2D" descr="Load texture from file into GPU memory (VRAM)"> + <Param name="const char *fileName" /> </Overload> </KeyWord> - <KeyWord name="GenImageGradientV" func="yes"> - <Overload retVal="Image" descr="Generate image: vertical gradient"> - <Param name="int width" /> - <Param name="int height" /> - <Param name="Color top" /> - <Param name="Color bottom" /> + <KeyWord name="LoadTextureFromImage" func="yes"> + <Overload retVal="Texture2D" descr="Load texture from image data"> + <Param name="Image image" /> </Overload> </KeyWord> - <KeyWord name="GenImageGradientH" func="yes"> - <Overload retVal="Image" descr="Generate image: horizontal gradient"> - <Param name="int width" /> - <Param name="int height" /> - <Param name="Color left" /> - <Param name="Color right" /> + <KeyWord name="LoadTextureCubemap" func="yes"> + <Overload retVal="TextureCubemap" descr="Load cubemap from image, multiple image cubemap layouts supported"> + <Param name="Image image" /> + <Param name="int layout" /> </Overload> </KeyWord> - <KeyWord name="GenImageGradientRadial" func="yes"> - <Overload retVal="Image" descr="Generate image: radial gradient"> + <KeyWord name="LoadRenderTexture" func="yes"> + <Overload retVal="RenderTexture2D" descr="Load texture for rendering (framebuffer)"> <Param name="int width" /> <Param name="int height" /> - <Param name="float density" /> - <Param name="Color inner" /> - <Param name="Color outer" /> </Overload> </KeyWord> - <KeyWord name="GenImageChecked" func="yes"> - <Overload retVal="Image" descr="Generate image: checked"> - <Param name="int width" /> - <Param name="int height" /> - <Param name="int checksX" /> - <Param name="int checksY" /> - <Param name="Color col1" /> - <Param name="Color col2" /> + <KeyWord name="UnloadTexture" func="yes"> + <Overload retVal="void" descr="Unload texture from GPU memory (VRAM)"> + <Param name="Texture2D texture" /> </Overload> </KeyWord> - <KeyWord name="GenImageWhiteNoise" func="yes"> - <Overload retVal="Image" descr="Generate image: white noise"> - <Param name="int width" /> - <Param name="int height" /> - <Param name="float factor" /> + <KeyWord name="UnloadRenderTexture" func="yes"> + <Overload retVal="void" descr="Unload render texture from GPU memory (VRAM)"> + <Param name="RenderTexture2D target" /> </Overload> </KeyWord> - <KeyWord name="GenImagePerlinNoise" func="yes"> - <Overload retVal="Image" descr="Generate image: perlin noise"> - <Param name="int width" /> - <Param name="int height" /> - <Param name="int offsetX" /> - <Param name="int offsetY" /> - <Param name="float scale" /> + <KeyWord name="UpdateTexture" func="yes"> + <Overload retVal="void" descr="Update GPU texture with new data"> + <Param name="Texture2D texture" /> + <Param name="const void *pixels" /> </Overload> </KeyWord> - <KeyWord name="GenImageCellular" func="yes"> - <Overload retVal="Image" descr="Generate image: cellular algorithm. Bigger tileSize means bigger cells"> - <Param name="int width" /> - <Param name="int height" /> - <Param name="int tileSize" /> + <KeyWord name="UpdateTextureRec" func="yes"> + <Overload retVal="void" descr="Update GPU texture rectangle with new data"> + <Param name="Texture2D texture" /> + <Param name="Rectangle rec" /> + <Param name="const void *pixels" /> </Overload> </KeyWord> - <!-- Texture2D configuration functions --> + <!-- Texture configuration functions --> <KeyWord name="GenTextureMipmaps" func="yes"> <Overload retVal="void" descr="Generate GPU mipmaps for a texture"> <Param name="Texture2D *texture" /> @@ -1221,17 +1813,17 @@ <KeyWord name="SetTextureFilter" func="yes"> <Overload retVal="void" descr="Set texture scaling filter mode"> <Param name="Texture2D texture" /> - <Param name="int filterMode" /> + <Param name="int filter" /> </Overload> </KeyWord> <KeyWord name="SetTextureWrap" func="yes"> <Overload retVal="void" descr="Set texture wrapping mode"> <Param name="Texture2D texture" /> - <Param name="int wrapMode" /> + <Param name="int wrap" /> </Overload> </KeyWord> - <!-- Texture2D drawing functions --> + <!-- Texture drawing functions --> <KeyWord name="DrawTexture" func="yes"> <Overload retVal="void" descr="Draw a Texture2D"> <Param name="Texture2D texture" /> @@ -1259,21 +1851,127 @@ <KeyWord name="DrawTextureRec" func="yes"> <Overload retVal="void" descr="Draw a part of a texture defined by a rectangle"> <Param name="Texture2D texture" /> - <Param name="Rectangle sourceRec" /> + <Param name="Rectangle source" /> <Param name="Vector2 position" /> <Param name="Color tint" /> </Overload> </KeyWord> + <KeyWord name="DrawTextureQuad" func="yes"> + <Overload retVal="void" descr="Draw texture quad with tiling and offset parameters"> + <Param name="Texture2D texture" /> + <Param name="Vector2 tiling" /> + <Param name="Vector2 offset" /> + <Param name="Rectangle quad" /> + <Param name="Color tint" /> + </Overload> + </KeyWord> + <KeyWord name="DrawTextureTiled" func="yes"> + <Overload retVal="void" descr="Draw part of a texture (defined by a rectangle) with rotation and scale tiled into dest."> + <Param name="Texture2D texture" /> + <Param name="Rectangle source" /> + <Param name="Rectangle dest" /> + <Param name="Vector2 origin" /> + <Param name="float rotation" /> + <Param name="float scale" /> + <Param name="Color tint" /> + </Overload> + </KeyWord> <KeyWord name="DrawTexturePro" func="yes"> <Overload retVal="void" descr="Draw a part of a texture defined by a rectangle with 'pro' parameters"> <Param name="Texture2D texture" /> - <Param name="Rectangle sourceRec" /> - <Param name="Rectangle destRec" /> + <Param name="Rectangle source" /> + <Param name="Rectangle dest" /> + <Param name="Vector2 origin" /> + <Param name="float rotation" /> + <Param name="Color tint" /> + </Overload> + </KeyWord> + <KeyWord name="DrawTextureNPatch" func="yes"> + <Overload retVal="void" descr="Draws a texture (or part of it) that stretches or shrinks nicely"> + <Param name="Texture2D texture" /> + <Param name="NPatchInfo nPatchInfo" /> + <Param name="Rectangle dest" /> <Param name="Vector2 origin" /> <Param name="float rotation" /> <Param name="Color tint" /> </Overload> </KeyWord> + <KeyWord name="DrawTexturePoly" func="yes"> + <Overload retVal="void" descr="Draw a textured polygon"> + <Param name="Texture2D texture" /> + <Param name="Vector2 center" /> + <Param name="Vector2 *points" /> + <Param name="Vector2 *texcoords" /> + <Param name="int pointCount" /> + <Param name="Color tint" /> + </Overload> + </KeyWord> + + <!-- Color/pixel related functions --> + <KeyWord name="Fade" func="yes"> + <Overload retVal="Color" descr="Get color with alpha applied, alpha goes from 0.0f to 1.0f"> + <Param name="Color color" /> + <Param name="float alpha" /> + </Overload> + </KeyWord> + <KeyWord name="ColorToInt" func="yes"> + <Overload retVal="int" descr="Get hexadecimal value for a Color"> + <Param name="Color color" /> + </Overload> + </KeyWord> + <KeyWord name="ColorNormalize" func="yes"> + <Overload retVal="Vector4" descr="Get Color normalized as float [0..1]"> + <Param name="Color color" /> + </Overload> + </KeyWord> + <KeyWord name="ColorFromNormalized" func="yes"> + <Overload retVal="Color" descr="Get Color from normalized values [0..1]"> + <Param name="Vector4 normalized" /> + </Overload> + </KeyWord> + <KeyWord name="ColorToHSV" func="yes"> + <Overload retVal="Vector3" descr="Get HSV values for a Color, hue [0..360], saturation/value [0..1]"> + <Param name="Color color" /> + </Overload> + </KeyWord> + <KeyWord name="ColorFromHSV" func="yes"> + <Overload retVal="Color" descr="Get a Color from HSV values, hue [0..360], saturation/value [0..1]"> + <Param name="float hue" /> + <Param name="float saturation" /> + <Param name="float value" /> + </Overload> + </KeyWord> + <KeyWord name="ColorAlpha" func="yes"> + <Overload retVal="Color" descr="Get color with alpha applied, alpha goes from 0.0f to 1.0f"> + <Param name="Color color" /> + <Param name="float alpha" /> + </Overload> + </KeyWord> + <KeyWord name="ColorAlphaBlend" func="yes"> + <Overload retVal="Color" descr="Get src alpha-blended into dst color with tint"> + <Param name="Color dst" /> + <Param name="Color src" /> + <Param name="Color tint" /> + </Overload> + </KeyWord> + <KeyWord name="GetColor" func="yes"> + <Overload retVal="Color" descr="Get Color structure from hexadecimal value"> + <Param name="unsigned int hexValue" /> + </Overload> + </KeyWord> + <KeyWord name="GetPixelColor" func="yes"> + <Overload retVal="Color" descr="Get Color from a source pixel pointer of certain format"></Overload> + </KeyWord> + <KeyWord name="SetPixelColor" func="yes"> + <Overload retVal="void" descr="Set color formatted into destination pixel pointer"></Overload> + </KeyWord> + <KeyWord name="GetPixelDataSize" func="yes"> + <Overload retVal="int" descr="Get pixel data size in bytes for certain format"> + <Param name="int width" /> + <Param name="int height" /> + <Param name="int format" /> + </Overload> + </KeyWord> <!-------------------------------------------------------------------------------------- --> <!-- Font Loading and Text Drawing Functions (Module: text) --> @@ -1292,28 +1990,53 @@ <Overload retVal="Font" descr="Load font from file with extended parameters"> <Param name="const char *fileName" /> <Param name="int fontSize" /> - <Param name="int charsCount" /> <Param name="int *fontChars" /> + <Param name="int glyphCount" /> + </Overload> + </KeyWord> + <KeyWord name="LoadFontFromImage" func="yes"> + <Overload retVal="Font" descr="Load font from Image (XNA style)"> + <Param name="Image image" /> + <Param name="Color key" /> + <Param name="int firstChar" /> + </Overload> + </KeyWord> + <KeyWord name="LoadFontFromMemory" func="yes"> + <Overload retVal="Font" descr="Load font from memory buffer, fileType refers to extension: i.e. '.ttf'"> + <Param name="const char *fileType" /> + <Param name="const unsigned char" /> + <Param name="int dataSize" /> + <Param name="int fontSize" /> + <Param name="int *fontChars" /> + <Param name="int glyphCount" /> </Overload> </KeyWord> <KeyWord name="LoadFontData" func="yes"> - <Overload retVal="CharInfo" descr="Load font data for further use"> - <Param name="const char *fileName" /> + <Overload retVal="GlyphInfo" descr="Load font data for further use"> + <Param name="const unsigned char" /> + <Param name="int dataSize" /> <Param name="int fontSize" /> <Param name="int *fontChars" /> - <Param name="int charsCount" /> - <Param name="bool sdf" /> + <Param name="int glyphCount" /> + <Param name="int type" /> </Overload> </KeyWord> <KeyWord name="GenImageFontAtlas" func="yes"> <Overload retVal="Image" descr="Generate image font atlas using chars info"> - <Param name="CharInfo *chars" /> + <Param name="const GlyphInfo *chars" /> + <Param name="Rectangle **recs" /> + <Param name="int glyphCount" /> <Param name="int fontSize" /> - <Param name="int charsCount" /> <Param name="int padding" /> <Param name="int packMethod" /> </Overload> </KeyWord> + <KeyWord name="UnloadFontData" func="yes"> + <Overload retVal="void" descr="Unload font chars info data (RAM)"> + <Param name="GlyphInfo *chars" /> + <Param name="int glyphCount" /> + </Overload> + </KeyWord> <KeyWord name="UnloadFont" func="yes"> <Overload retVal="void" descr="Unload Font from GPU memory (VRAM)"> <Param name="Font font" /> @@ -1322,7 +2045,7 @@ <!-- Text drawing functions --> <KeyWord name="DrawFPS" func="yes"> - <Overload retVal="void" descr="Shows current FPS"> + <Overload retVal="void" descr="Draw current FPS"> <Param name="int posX" /> <Param name="int posY" /> </Overload> @@ -1337,17 +2060,38 @@ </Overload> </KeyWord> <KeyWord name="DrawTextEx" func="yes"> - <Overload retVal="void" descr="Draw text using Font and additional parameters"> + <Overload retVal="void" descr="Draw text using font and additional parameters"> + <Param name="Font font" /> + <Param name="const char *text" /> + <Param name="Vector2 position" /> + <Param name="float fontSize" /> + <Param name="float spacing" /> + <Param name="Color tint" /> + </Overload> + </KeyWord> + <KeyWord name="DrawTextPro" func="yes"> + <Overload retVal="void" descr="Draw text using Font and pro parameters (rotation)"> <Param name="Font font" /> - <Param name="const char* text" /> + <Param name="const char *text" /> <Param name="Vector2 position" /> + <Param name="Vector2 origin" /> + <Param name="float rotation" /> <Param name="float fontSize" /> <Param name="float spacing" /> <Param name="Color tint" /> </Overload> </KeyWord> + <KeyWord name="DrawTextCodepoint" func="yes"> + <Overload retVal="void" descr="Draw one character (codepoint)"> + <Param name="Font font" /> + <Param name="int codepoint" /> + <Param name="Vector2 position" /> + <Param name="float fontSize" /> + <Param name="Color tint" /> + </Overload> + </KeyWord> - <!-- Text misc. functions --> + <!-- Text font info functions --> <KeyWord name="MeasureText" func="yes"> <Overload retVal="int" descr="Measure string width for default font"> <Param name="const char *text" /> @@ -1362,23 +2106,152 @@ <Param name="float spacing" /> </Overload> </KeyWord> - <KeyWord name="FormatText" func="yes"> - <Overload retVal="const char" descr="Formatting of text with variables to 'embed'"> + <KeyWord name="GetGlyphIndex" func="yes"> + <Overload retVal="int" descr="Get glyph index position in font for a codepoint (unicode character), fallback to '?' if not found"> + <Param name="Font font" /> + <Param name="int codepoint" /> + </Overload> + </KeyWord> + <KeyWord name="GetGlyphInfo" func="yes"> + <Overload retVal="GlyphInfo" descr="Get glyph font info data for a codepoint (unicode character), fallback to '?' if not found"> + <Param name="Font font" /> + <Param name="int codepoint" /> + </Overload> + </KeyWord> + <KeyWord name="GetGlyphAtlasRec" func="yes"> + <Overload retVal="Rectangle" descr="Get glyph rectangle in font atlas for a codepoint (unicode character), fallback to '?' if not found"> + <Param name="Font font" /> + <Param name="int codepoint" /> + </Overload> + </KeyWord> + + <!-- Text codepoints management functions (unicode characters) --> + <KeyWord name="LoadCodepoints" func="yes"> + <Overload retVal="int" descr="Load all codepoints from a UTF-8 text string, codepoints count returned by parameter"> + <Param name="const char *text" /> + <Param name="int *count" /> + </Overload> + </KeyWord> + <KeyWord name="UnloadCodepoints" func="yes"> + <Overload retVal="void" descr="Unload codepoints data from memory"> + <Param name="int *codepoints" /> + </Overload> + </KeyWord> + <KeyWord name="GetCodepointCount" func="yes"> + <Overload retVal="int" descr="Get total number of codepoints in a UTF-8 encoded string"> + <Param name="const char *text" /> + </Overload> + </KeyWord> + <KeyWord name="GetCodepoint" func="yes"> + <Overload retVal="int" descr="Get next codepoint in a UTF-8 encoded string, 0x3f('?') is returned on failure"> + <Param name="const char *text" /> + <Param name="int *bytesProcessed" /> + </Overload> + </KeyWord> + <KeyWord name="CodepointToUTF8" func="yes"> + <Overload retVal="const char" descr="Encode one codepoint into UTF-8 byte array (array length returned as parameter)"> + <Param name="int codepoint" /> + <Param name="int *byteSize" /> + </Overload> + </KeyWord> + <KeyWord name="TextCodepointsToUTF8" func="yes"> + <Overload retVal="char" descr="Encode text as codepoints array into UTF-8 text string (WARNING: memory must be freed!)"> + <Param name="int *codepoints" /> + <Param name="int length" /> + </Overload> + </KeyWord> + + <!-- Text strings management functions (no UTF-8 strings, only byte chars) --> + <!-- NOTE: Some strings allocate memory internally for returned strings, just be careful! --> + <KeyWord name="TextCopy" func="yes"> + <Overload retVal="int" descr="Copy one string to another, returns bytes copied"> + <Param name="char *dst" /> + <Param name="const char *src" /> + </Overload> + </KeyWord> + <KeyWord name="TextIsEqual" func="yes"> + <Overload retVal="bool" descr="Check if two text string are equal"> + <Param name="const char *text1" /> + <Param name="const char *text2" /> + </Overload> + </KeyWord> + <KeyWord name="int TextLength" func="yes"> + <Overload retVal="unsigned" descr="Get text length, checks for '\0' ending"> + <Param name="const char *text" /> + </Overload> + </KeyWord> + <KeyWord name="TextFormat" func="yes"> + <Overload retVal="const char" descr="Text formatting with variables (sprintf() style)"> <Param name="const char *text" /> <Param name="..." /> </Overload> </KeyWord> - <KeyWord name="SubText" func="yes"> + <KeyWord name="TextSubtext" func="yes"> <Overload retVal="const char" descr="Get a piece of a text string"> <Param name="const char *text" /> <Param name="int position" /> <Param name="int length" /> </Overload> </KeyWord> - <KeyWord name="GetGlyphIndex" func="yes"> - <Overload retVal="int" descr="Returns index position for a unicode character on sprite font"> - <Param name="Font font" /> - <Param name="int character" /> + <KeyWord name="TextReplace" func="yes"> + <Overload retVal="char" descr="Replace text string (WARNING: memory must be freed!)"> + <Param name="char *text" /> + <Param name="const char *replace" /> + <Param name="const char *by" /> + </Overload> + </KeyWord> + <KeyWord name="TextInsert" func="yes"> + <Overload retVal="char" descr="Insert text in a position (WARNING: memory must be freed!)"> + <Param name="const char *text" /> + <Param name="const char *insert" /> + <Param name="int position" /> + </Overload> + </KeyWord> + <KeyWord name="TextJoin" func="yes"> + <Overload retVal="const char" descr="Join text strings with delimiter"> + <Param name="const char **textList" /> + <Param name="int count" /> + <Param name="const char *delimiter" /> + </Overload> + </KeyWord> + <KeyWord name="TextSplit" func="yes"> + <Overload retVal="const char" descr="Split text into multiple strings"> + <Param name="const char *text" /> + <Param name="char delimiter" /> + <Param name="int *count" /> + </Overload> + </KeyWord> + <KeyWord name="TextAppend" func="yes"> + <Overload retVal="void" descr="Append text at specific position and move cursor!"> + <Param name="char *text" /> + <Param name="const char *append" /> + <Param name="int *position" /> + </Overload> + </KeyWord> + <KeyWord name="TextFindIndex" func="yes"> + <Overload retVal="int" descr="Find first text occurrence within a string"> + <Param name="const char *text" /> + <Param name="const char *find" /> + </Overload> + </KeyWord> + <KeyWord name="TextToUpper" func="yes"> + <Overload retVal="const char" descr="Get upper case version of provided string"> + <Param name="const char *text" /> + </Overload> + </KeyWord> + <KeyWord name="TextToLower" func="yes"> + <Overload retVal="const char" descr="Get lower case version of provided string"> + <Param name="const char *text" /> + </Overload> + </KeyWord> + <KeyWord name="TextToPascal" func="yes"> + <Overload retVal="const char" descr="Get Pascal case notation version of provided string"> + <Param name="const char *text" /> + </Overload> + </KeyWord> + <KeyWord name="TextToInteger" func="yes"> + <Overload retVal="int" descr="Get integer value from text (negative values not supported)"> + <Param name="const char *text" /> </Overload> </KeyWord> @@ -1394,6 +2267,12 @@ <Param name="Color color" /> </Overload> </KeyWord> + <KeyWord name="DrawPoint3D" func="yes"> + <Overload retVal="void" descr="Draw a point in 3D space, actually a small line"> + <Param name="Vector3 position" /> + <Param name="Color color" /> + </Overload> + </KeyWord> <KeyWord name="DrawCircle3D" func="yes"> <Overload retVal="void" descr="Draw a circle in 3D world space"> <Param name="Vector3 center" /> @@ -1403,6 +2282,21 @@ <Param name="Color color" /> </Overload> </KeyWord> + <KeyWord name="DrawTriangle3D" func="yes"> + <Overload retVal="void" descr="Draw a color-filled triangle (vertex in counter-clockwise order!)"> + <Param name="Vector3 v1" /> + <Param name="Vector3 v2" /> + <Param name="Vector3 v3" /> + <Param name="Color color" /> + </Overload> + </KeyWord> + <KeyWord name="DrawTriangleStrip3D" func="yes"> + <Overload retVal="void" descr="Draw a triangle strip defined by points"> + <Param name="Vector3 *points" /> + <Param name="int pointCount" /> + <Param name="Color color" /> + </Overload> + </KeyWord> <KeyWord name="DrawCube" func="yes"> <Overload retVal="void" descr="Draw cube"> <Param name="Vector3 position" /> @@ -1428,6 +2322,13 @@ <Param name="Color color" /> </Overload> </KeyWord> + <KeyWord name="DrawCubeWiresV" func="yes"> + <Overload retVal="void" descr="Draw cube wires (Vector version)"> + <Param name="Vector3 position" /> + <Param name="Vector3 size" /> + <Param name="Color color" /> + </Overload> + </KeyWord> <KeyWord name="DrawCubeTexture" func="yes"> <Overload retVal="void" descr="Draw cube textured"> <Param name="Texture2D texture" /> @@ -1438,6 +2339,17 @@ <Param name="Color color" /> </Overload> </KeyWord> + <KeyWord name="DrawCubeTextureRec" func="yes"> + <Overload retVal="void" descr="Draw cube with a region of a texture"> + <Param name="Texture2D texture" /> + <Param name="Rectangle source" /> + <Param name="Vector3 position" /> + <Param name="float width" /> + <Param name="float height" /> + <Param name="float length" /> + <Param name="Color color" /> + </Overload> + </KeyWord> <KeyWord name="DrawSphere" func="yes"> <Overload retVal="void" descr="Draw sphere"> <Param name="Vector3 centerPos" /> @@ -1473,6 +2385,16 @@ <Param name="Color color" /> </Overload> </KeyWord> + <KeyWord name="DrawCylinderEx" func="yes"> + <Overload retVal="void" descr="Draw a cylinder with base at startPos and top at endPos"> + <Param name="Vector3 startPos" /> + <Param name="Vector3 endPos" /> + <Param name="float startRadius" /> + <Param name="float endRadius" /> + <Param name="int sides" /> + <Param name="Color color" /> + </Overload> + </KeyWord> <KeyWord name="DrawCylinderWires" func="yes"> <Overload retVal="void" descr="Draw a cylinder/cone wires"> <Param name="Vector3 position" /> @@ -1483,6 +2405,16 @@ <Param name="Color color" /> </Overload> </KeyWord> + <KeyWord name="DrawCylinderWiresEx" func="yes"> + <Overload retVal="void" descr="Draw a cylinder wires with base at startPos and top at endPos"> + <Param name="Vector3 startPos" /> + <Param name="Vector3 endPos" /> + <Param name="float startRadius" /> + <Param name="float endRadius" /> + <Param name="int sides" /> + <Param name="Color color" /> + </Overload> + </KeyWord> <KeyWord name="DrawPlane" func="yes"> <Overload retVal="void" descr="Draw a plane XZ"> <Param name="Vector3 centerPos" /> @@ -1502,70 +2434,175 @@ <Param name="float spacing" /> </Overload> </KeyWord> - <KeyWord name="DrawGizmo" func="yes"> - <Overload retVal="void" descr="Draw simple gizmo"> - <Param name="Vector3 position" /> - </Overload> - </KeyWord> - <!--DrawTorus(), DrawTeapot() could be useful? --> <!-------------------------------------------------------------------------------------- --> <!-- Model 3d Loading and Drawing Functions (Module: models) --> <!-------------------------------------------------------------------------------------- --> - <!-- Model loading/unloading functions --> + <!-- Model management functions --> <KeyWord name="LoadModel" func="yes"> - <Overload retVal="Model" descr="Load model from files (mesh and material)"> + <Overload retVal="Model" descr="Load model from files (meshes and materials)"> <Param name="const char *fileName" /> </Overload> </KeyWord> <KeyWord name="LoadModelFromMesh" func="yes"> - <Overload retVal="Model" descr="Load model from generated mesh"> + <Overload retVal="Model" descr="Load model from generated mesh (default material)"> <Param name="Mesh mesh" /> </Overload> </KeyWord> <KeyWord name="UnloadModel" func="yes"> - <Overload retVal="void" descr="Unload model from memory (RAM and/or VRAM)"> + <Overload retVal="void" descr="Unload model (including meshes) from memory (RAM and/or VRAM)"> + <Param name="Model model" /> + </Overload> + </KeyWord> + <KeyWord name="UnloadModelKeepMeshes" func="yes"> + <Overload retVal="void" descr="Unload model (but not meshes) from memory (RAM and/or VRAM)"> + <Param name="Model model" /> + </Overload> + </KeyWord> + <KeyWord name="GetModelBoundingBox" func="yes"> + <Overload retVal="BoundingBox" descr="Compute model bounding box limits (considers all meshes)"> <Param name="Model model" /> </Overload> </KeyWord> - <!-- Mesh loading/unloading functions --> - <KeyWord name="LoadMesh" func="yes"> - <Overload retVal="Mesh" descr="Load mesh from file"> - <Param name="const char *fileName" /> + <!-- Model drawing functions --> + <KeyWord name="DrawModel" func="yes"> + <Overload retVal="void" descr="Draw a model (with texture if set)"> + <Param name="Model model" /> + <Param name="Vector3 position" /> + <Param name="float scale" /> + <Param name="Color tint" /> </Overload> </KeyWord> - <KeyWord name="UnloadMesh" func="yes"> - <Overload retVal="void" descr="Unload mesh from memory (RAM and/or VRAM)"> + <KeyWord name="DrawModelEx" func="yes"> + <Overload retVal="void" descr="Draw a model with extended parameters"> + <Param name="Model model" /> + <Param name="Vector3 position" /> + <Param name="Vector3 rotationAxis" /> + <Param name="float rotationAngle" /> + <Param name="Vector3 scale" /> + <Param name="Color tint" /> + </Overload> + </KeyWord> + <KeyWord name="DrawModelWires" func="yes"> + <Overload retVal="void" descr="Draw a model wires (with texture if set)"> + <Param name="Model model" /> + <Param name="Vector3 position" /> + <Param name="float scale" /> + <Param name="Color tint" /> + </Overload> + </KeyWord> + <KeyWord name="DrawModelWiresEx" func="yes"> + <Overload retVal="void" descr="Draw a model wires (with texture if set) with extended parameters"> + <Param name="Model model" /> + <Param name="Vector3 position" /> + <Param name="Vector3 rotationAxis" /> + <Param name="float rotationAngle" /> + <Param name="Vector3 scale" /> + <Param name="Color tint" /> + </Overload> + </KeyWord> + <KeyWord name="DrawBoundingBox" func="yes"> + <Overload retVal="void" descr="Draw bounding box (wires)"> + <Param name="BoundingBox box" /> + <Param name="Color color" /> + </Overload> + </KeyWord> + <KeyWord name="DrawBillboard" func="yes"> + <Overload retVal="void" descr="Draw a billboard texture"> + <Param name="Camera camera" /> + <Param name="Texture2D texture" /> + <Param name="Vector3 position" /> + <Param name="float size" /> + <Param name="Color tint" /> + </Overload> + </KeyWord> + <KeyWord name="DrawBillboardRec" func="yes"> + <Overload retVal="void" descr="Draw a billboard texture defined by source"> + <Param name="Camera camera" /> + <Param name="Texture2D texture" /> + <Param name="Rectangle source" /> + <Param name="Vector3 position" /> + <Param name="Vector2 size" /> + <Param name="Color tint" /> + </Overload> + </KeyWord> + <KeyWord name="DrawBillboardPro" func="yes"> + <Overload retVal="void" descr="Draw a billboard texture defined by source and rotation"> + <Param name="Camera camera" /> + <Param name="Texture2D texture" /> + <Param name="Rectangle source" /> + <Param name="Vector3 position" /> + <Param name="Vector3 up" /> + <Param name="Vector2 size" /> + <Param name="Vector2 origin" /> + <Param name="float rotation" /> + <Param name="Color tint" /> + </Overload> + </KeyWord> + + <!-- Mesh management functions --> + <KeyWord name="UploadMesh" func="yes"> + <Overload retVal="void" descr="Upload mesh vertex data in GPU and provide VAO/VBO ids"> <Param name="Mesh *mesh" /> + <Param name="bool dynamic" /> + </Overload> + </KeyWord> + <KeyWord name="UpdateMeshBuffer" func="yes"> + <Overload retVal="void" descr="Update mesh vertex data in GPU for a specific buffer index"> + <Param name="Mesh mesh" /> + <Param name="int index" /></Overload> + </KeyWord> + <KeyWord name="UnloadMesh" func="yes"> + <Overload retVal="void" descr="Unload mesh data from CPU and GPU"> + <Param name="Mesh mesh" /> + </Overload> + </KeyWord> + <KeyWord name="DrawMesh" func="yes"> + <Overload retVal="void" descr="Draw a 3d mesh with material and transform"> + <Param name="Mesh mesh" /> + <Param name="Material material" /> + <Param name="Matrix transform" /> + </Overload> + </KeyWord> + <KeyWord name="DrawMeshInstanced" func="yes"> + <Overload retVal="void" descr="Draw multiple mesh instances with material and different transforms"> + <Param name="Mesh mesh" /> + <Param name="Material material" /> + <Param name="Matrix *transforms" /> + <Param name="int instances" /> </Overload> </KeyWord> <KeyWord name="ExportMesh" func="yes"> - <Overload retVal="void" descr="Export mesh as an OBJ file"> - <Param name="const char *fileName" /> + <Overload retVal="bool" descr="Export mesh data to file, returns true on success"> <Param name="Mesh mesh" /> + <Param name="const char *fileName" /> </Overload> </KeyWord> - - <!-- Mesh manipulation functions --> <KeyWord name="GetMeshBoundingBox" func="yes"> <Overload retVal="BoundingBox" descr="Compute mesh bounding box limits"> <Param name="Mesh mesh" /> </Overload> </KeyWord> - <KeyWord name="MeshTangents" func="yes"> - <Overload retVal="void" descr="Compute mesh tangents "> + <KeyWord name="GenMeshTangents" func="yes"> + <Overload retVal="void" descr="Compute mesh tangents"> <Param name="Mesh *mesh" /> </Overload> </KeyWord> - <KeyWord name="MeshBinormals" func="yes"> + <KeyWord name="GenMeshBinormals" func="yes"> <Overload retVal="void" descr="Compute mesh binormals"> <Param name="Mesh *mesh" /> </Overload> </KeyWord> <!-- Mesh generation functions --> + <KeyWord name="GenMeshPoly" func="yes"> + <Overload retVal="Mesh" descr="Generate polygonal mesh"> + <Param name="int sides" /> + <Param name="float radius" /> + </Overload> + </KeyWord> <KeyWord name="GenMeshPlane" func="yes"> <Overload retVal="Mesh" descr="Generate plane mesh (with subdivisions)"> <Param name="float width" /> @@ -1602,6 +2639,13 @@ <Param name="int slices" /> </Overload> </KeyWord> + <KeyWord name="GenMeshCone" func="yes"> + <Overload retVal="Mesh" descr="Generate cone/pyramid mesh"> + <Param name="float radius" /> + <Param name="float height" /> + <Param name="int slices" /> + </Overload> + </KeyWord> <KeyWord name="GenMeshTorus" func="yes"> <Overload retVal="Mesh" descr="Generate torus mesh"> <Param name="float radius" /> @@ -1632,9 +2676,10 @@ </KeyWord> <!-- Material loading/unloading functions --> - <KeyWord name="LoadMaterial" func="yes"> - <Overload retVal="Material" descr="Load material from file"> + <KeyWord name="LoadMaterials" func="yes"> + <Overload retVal="Material" descr="Load materials from model file"> <Param name="const char *fileName" /> + <Param name="int *materialCount" /> </Overload> </KeyWord> <KeyWord name="LoadMaterialDefault" func="yes"> @@ -1645,301 +2690,118 @@ <Param name="Material material" /> </Overload> </KeyWord> - - <!-- Model drawing functions --> - <KeyWord name="DrawModel" func="yes"> - <Overload retVal="void" descr="Draw a model (with texture if set)"> - <Param name="Model model" /> - <Param name="Vector3 position" /> - <Param name="float scale" /> - <Param name="Color tint" /> + <KeyWord name="SetMaterialTexture" func="yes"> + <Overload retVal="void" descr="Set texture for a material map type (MATERIAL_MAP_DIFFUSE, MATERIAL_MAP_SPECULAR...)"> + <Param name="Material *material" /> + <Param name="int mapType" /> + <Param name="Texture2D texture" /> </Overload> </KeyWord> - <KeyWord name="DrawModelEx" func="yes"> - <Overload retVal="void" descr="Draw a model with extended parameters"> - <Param name="Model model" /> - <Param name="Vector3 position" /> - <Param name="Vector3 rotationAxis" /> - <Param name="float rotationAngle" /> - <Param name="Vector3 scale" /> - <Param name="Color tint" /> + <KeyWord name="SetModelMeshMaterial" func="yes"> + <Overload retVal="void" descr="Set material for a mesh"> + <Param name="Model *model" /> + <Param name="int meshId" /> + <Param name="int materialId" /> </Overload> </KeyWord> - <KeyWord name="DrawModelWires" func="yes"> - <Overload retVal="void" descr="Draw a model wires (with texture if set)"> - <Param name="Model model" /> - <Param name="Vector3 position" /> - <Param name="float scale" /> - <Param name="Color tint" /> + + <!-- Model animations loading/unloading functions --> + <KeyWord name="LoadModelAnimations" func="yes"> + <Overload retVal="ModelAnimation" descr="Load model animations from file"> + <Param name="const char *fileName" /> + <Param name="unsigned int *animCount" /> </Overload> </KeyWord> - <KeyWord name="DrawModelWiresEx" func="yes"> - <Overload retVal="void" descr="Draw a model wires (with texture if set) with extended parameters"> + <KeyWord name="UpdateModelAnimation" func="yes"> + <Overload retVal="void" descr="Update model animation pose"> <Param name="Model model" /> - <Param name="Vector3 position" /> - <Param name="Vector3 rotationAxis" /> - <Param name="float rotationAngle" /> - <Param name="Vector3 scale" /> - <Param name="Color tint" /> + <Param name="ModelAnimation anim" /> + <Param name="int frame" /> </Overload> </KeyWord> - <KeyWord name="DrawBoundingBox" func="yes"> - <Overload retVal="void" descr="Draw bounding box (wires)"> - <Param name="BoundingBox box" /> - <Param name="Color color" /> + <KeyWord name="UnloadModelAnimation" func="yes"> + <Overload retVal="void" descr="Unload animation data"> + <Param name="ModelAnimation anim" /> </Overload> </KeyWord> - <KeyWord name="DrawBillboard" func="yes"> - <Overload retVal="void" descr="Draw a billboard texture"> - <Param name="Camera camera" /> - <Param name="Texture2D texture" /> - <Param name="Vector3 center" /> - <Param name="float size" /> - <Param name="Color tint" /> + <KeyWord name="UnloadModelAnimations" func="yes"> + <Overload retVal="void" descr="Unload animation array data"> + <Param name="ModelAnimation* animations" /> + <Param name="unsigned int count" /> </Overload> </KeyWord> - <KeyWord name="DrawBillboardRec" func="yes"> - <Overload retVal="void" descr="Draw a billboard texture defined by sourceRec"> - <Param name="Camera camera" /> - <Param name="Texture2D texture" /> - <Param name="Rectangle sourceRec" /> - <Param name="Vector3 center" /> - <Param name="float size" /> - <Param name="Color tint" /> + <KeyWord name="IsModelAnimationValid" func="yes"> + <Overload retVal="bool" descr="Check model animation skeleton match"> + <Param name="Model model" /> + <Param name="ModelAnimation anim" /> </Overload> </KeyWord> <!-- Collision detection functions --> <KeyWord name="CheckCollisionSpheres" func="yes"> - <Overload retVal="bool" descr="Detect collision between two spheres"> - <Param name="Vector3 centerA" /> - <Param name="float radiusA" /> - <Param name="Vector3 centerB" /> - <Param name="float radiusB" /> + <Overload retVal="bool" descr="Check collision between two spheres"> + <Param name="Vector3 center1" /> + <Param name="float radius1" /> + <Param name="Vector3 center2" /> + <Param name="float radius2" /> </Overload> </KeyWord> <KeyWord name="CheckCollisionBoxes" func="yes"> - <Overload retVal="bool" descr="Detect collision between two bounding boxes"> + <Overload retVal="bool" descr="Check collision between two bounding boxes"> <Param name="BoundingBox box1" /> <Param name="BoundingBox box2" /> </Overload> </KeyWord> <KeyWord name="CheckCollisionBoxSphere" func="yes"> - <Overload retVal="bool" descr="Detect collision between box and sphere"> + <Overload retVal="bool" descr="Check collision between box and sphere"> <Param name="BoundingBox box" /> - <Param name="Vector3 centerSphere" /> - <Param name="float radiusSphere" /> + <Param name="Vector3 center" /> + <Param name="float radius" /> </Overload> </KeyWord> - <KeyWord name="CheckCollisionRaySphere" func="yes"> - <Overload retVal="bool" descr="Detect collision between ray and sphere"> + <KeyWord name="GetRayCollisionSphere" func="yes"> + <Overload retVal="RayCollision" descr="Get collision info between ray and sphere"> <Param name="Ray ray" /> - <Param name="Vector3 spherePosition" /> - <Param name="float sphereRadius" /> + <Param name="Vector3 center" /> + <Param name="float radius" /> </Overload> </KeyWord> - <KeyWord name="CheckCollisionRaySphereEx" func="yes"> - <Overload retVal="bool" descr="Detect collision between ray and sphere, returns collision point"> + <KeyWord name="GetRayCollisionBox" func="yes"> + <Overload retVal="RayCollision" descr="Get collision info between ray and box"> <Param name="Ray ray" /> - <Param name="Vector3 spherePosition" /> - <Param name="float sphereRadius" /> - <Param name="Vector3 *collisionPoint" /> + <Param name="BoundingBox box" /> </Overload> </KeyWord> - <KeyWord name="CheckCollisionRayBox" func="yes"> - <Overload retVal="bool" descr="Detect collision between ray and box"> + <KeyWord name="GetRayCollisionModel" func="yes"> + <Overload retVal="RayCollision" descr="Get collision info between ray and model"> <Param name="Ray ray" /> - <Param name="BoundingBox box" /> + <Param name="Model model" /> </Overload> </KeyWord> - <KeyWord name="GetCollisionRayModel" func="yes"> - <Overload retVal="RayHitInfo" descr="Get collision info between ray and model"> + <KeyWord name="GetRayCollisionMesh" func="yes"> + <Overload retVal="RayCollision" descr="Get collision info between ray and mesh"> <Param name="Ray ray" /> - <Param name="Model *model" /> + <Param name="Mesh mesh" /> + <Param name="Matrix transform" /> </Overload> </KeyWord> - <KeyWord name="GetCollisionRayTriangle" func="yes"> - <Overload retVal="RayHitInfo" descr="Get collision info between ray and triangle"> + <KeyWord name="GetRayCollisionTriangle" func="yes"> + <Overload retVal="RayCollision" descr="Get collision info between ray and triangle"> <Param name="Ray ray" /> <Param name="Vector3 p1" /> <Param name="Vector3 p2" /> <Param name="Vector3 p3" /> </Overload> </KeyWord> - <KeyWord name="GetCollisionRayGround" func="yes"> - <Overload retVal="RayHitInfo" descr="Get collision info between ray and ground plane (Y-normal plane)"> + <KeyWord name="GetRayCollisionQuad" func="yes"> + <Overload retVal="RayCollision" descr="Get collision info between ray and quad"> <Param name="Ray ray" /> - <Param name="float groundHeight" /> - </Overload> - </KeyWord> - - <!-------------------------------------------------------------------------------------- --> - <!-- Shaders System Functions (Module: rlgl) --> - <!-- NOTE: This functions are useless when using OpenGL 1.1 --> - <!-------------------------------------------------------------------------------------- --> - - <!-- Shader loading/unloading functions --> - <KeyWord name="LoadText" func="yes"> - <Overload retVal="char" descr="Load chars array from text file"> - <Param name="const char *fileName" /> - </Overload> - </KeyWord> - <KeyWord name="LoadShader" func="yes"> - <Overload retVal="Shader" descr="Load shader from files and bind default locations"> - <Param name="const char *vsFileName" /> - <Param name="const char *fsFileName" /> - </Overload> - </KeyWord> - <KeyWord name="LoadShaderCode" func="yes"> - <Overload retVal="Shader" descr="Load shader from code strings and bind default locations"> - <Param name="char *vsCode" /> - <Param name="char *fsCode" /> - </Overload> - </KeyWord> - <KeyWord name="UnloadShader" func="yes"> - <Overload retVal="void" descr="Unload shader from GPU memory (VRAM)"> - <Param name="Shader shader" /> - </Overload> - </KeyWord> - - <KeyWord name="GetShaderDefault" func="yes"> - <Overload retVal="Shader" descr="Get default shader"></Overload> - </KeyWord> - <KeyWord name="GetTextureDefault" func="yes"> - <Overload retVal="Texture2D" descr="Get default texture"></Overload> - </KeyWord> - - <!-- Shader configuration functions --> - <KeyWord name="GetShaderLocation" func="yes"> - <Overload retVal="int" descr="Get shader uniform location"> - <Param name="Shader shader" /> - <Param name="const char *uniformName" /> - </Overload> - </KeyWord> - <KeyWord name="SetShaderValue" func="yes"> - <Overload retVal="void" descr="Set shader uniform value (float)"> - <Param name="Shader shader" /> - <Param name="int uniformLoc" /> - <Param name="const float *value" /> - <Param name="int size" /> - </Overload> - </KeyWord> - <KeyWord name="SetShaderValuei" func="yes"> - <Overload retVal="void" descr="Set shader uniform value (int)"> - <Param name="Shader shader" /> - <Param name="int uniformLoc" /> - <Param name="const int *value" /> - <Param name="int size" /> - </Overload> - </KeyWord> - <KeyWord name="SetShaderValueMatrix" func="yes"> - <Overload retVal="void" descr="Set shader uniform value (matrix 4x4)"> - <Param name="Shader shader" /> - <Param name="int uniformLoc" /> - <Param name="Matrix mat" /> - </Overload> - </KeyWord> - <KeyWord name="SetMatrixProjection" func="yes"> - <Overload retVal="void" descr="Set a custom projection matrix (replaces internal projection matrix)"> - <Param name="Matrix proj" /> - </Overload> - </KeyWord> - <KeyWord name="SetMatrixModelview" func="yes"> - <Overload retVal="void" descr="Set a custom modelview matrix (replaces internal modelview matrix)"> - <Param name="Matrix view" /> - </Overload> - </KeyWord> - <KeyWord name="GetMatrixModelview" func="yes"> - <Overload retVal="Matrix" descr="Get internal modelview matrix"> - <Param name="Matrix view" /> - </Overload> - </KeyWord> - - <!-- Texture maps generation (PBR) --> - <!-- NOTE: Required shaders should be provided --> - <KeyWord name="GenTextureCubemap" func="yes"> - <Overload retVal="Texture2D" descr="Generate cubemap texture from HDR texture"> - <Param name="Shader shader" /> - <Param name="Texture2D skyHDR" /> - <Param name="int size" /> - </Overload> - </KeyWord> - <KeyWord name="GenTextureIrradiance" func="yes"> - <Overload retVal="Texture2D" descr="Generate irradiance texture using cubemap data"> - <Param name="Shader shader" /> - <Param name="Texture2D cubemap" /> - <Param name="int size" /> - </Overload> - </KeyWord> - <KeyWord name="GenTexturePrefilter" func="yes"> - <Overload retVal="Texture2D" descr="Generate prefilter texture using cubemap data"> - <Param name="Shader shader" /> - <Param name="Texture2D cubemap" /> - <Param name="int size" /> - </Overload> - </KeyWord> - <KeyWord name="GenTextureBRDF" func="yes"> - <Overload retVal="Texture2D" descr="Generate BRDF texture using cubemap data"> - <Param name="Shader shader" /> - <Param name="Texture2D cubemap" /> - <Param name="int size" /> - </Overload> - </KeyWord> - - <!-- Shading begin/end functions --> - <KeyWord name="BeginShaderMode" func="yes"> - <Overload retVal="void" descr="Begin custom shader drawing"> - <Param name="Shader shader" /> - </Overload> - </KeyWord> - <KeyWord name="EndShaderMode" func="yes"> - <Overload retVal="void" descr="End custom shader drawing (use default shader)"></Overload> - </KeyWord> - <KeyWord name="BeginBlendMode" func="yes"> - <Overload retVal="void" descr="Begin blending mode (alpha, additive, multiplied)"> - <Param name="int mode" /> - </Overload> - </KeyWord> - <KeyWord name="EndBlendMode" func="yes"> - <Overload retVal="void" descr="End blending mode (reset to default: alpha blending)"></Overload> - </KeyWord> - - <!-- VR control functions --> - <KeyWord name="GetVrDeviceInfo" func="yes"> - <Overload retVal="VrDeviceInfo" descr="Get VR device information for some standard devices"> - <Param name="int vrDeviceType" /> - </Overload> - </KeyWord> - <KeyWord name="InitVrSimulator" func="yes"> - <Overload retVal="void" descr="Init VR simulator for selected device parameters"> - <Param name="VrDeviceInfo info" /> - </Overload> - </KeyWord> - <KeyWord name="CloseVrSimulator" func="yes"> - <Overload retVal="void" descr="Close VR simulator for current device"></Overload> - </KeyWord> - <KeyWord name="IsVrSimulatorReady" func="yes"> - <Overload retVal="bool" descr="Detect if VR simulator is ready"></Overload> - </KeyWord> - <KeyWord name="SetVrDistortionShader" func="yes"> - <Overload retVal="void" descr="Set VR distortion shader for stereoscopic rendering"> - <Param name="Shader shader" /> - </Overload> - </KeyWord> - <KeyWord name="UpdateVrTracking" func="yes"> - <Overload retVal="void" descr="Update VR tracking (position and orientation) and camera"> - <Param name="Camera *camera" /> + <Param name="Vector3 p1" /> + <Param name="Vector3 p2" /> + <Param name="Vector3 p3" /> + <Param name="Vector3 p4" /> </Overload> </KeyWord> - <KeyWord name="ToggleVrMode" func="yes"> - <Overload retVal="void" descr="Enable/Disable VR experience"></Overload> - </KeyWord> - <KeyWord name="BeginVrDrawing" func="yes"> - <Overload retVal="void" descr="Begin VR simulator stereo rendering"></Overload> - </KeyWord> - <KeyWord name="EndVrDrawing" func="yes"> - <Overload retVal="void" descr="End VR simulator stereo rendering"></Overload> - </KeyWord> <!-------------------------------------------------------------------------------------- --> <!-- Audio Loading and Playing Functions (Module: audio) --> @@ -1967,8 +2829,12 @@ <Param name="const char *fileName" /> </Overload> </KeyWord> - <KeyWord name="LoadWaveEx" func="yes"> - <Overload retVal="Wave" descr="Load wave data from raw array data"></Overload> + <KeyWord name="LoadWaveFromMemory" func="yes"> + <Overload retVal="Wave" descr="Load wave from memory buffer, fileType refers to extension: i.e. '.wav'"> + <Param name="const char *fileType" /> + <Param name="const unsigned char" /> + <Param name="int dataSize" /> + </Overload> </KeyWord> <KeyWord name="LoadSound" func="yes"> <Overload retVal="Sound" descr="Load sound from file"> @@ -1984,7 +2850,7 @@ <Overload retVal="void" descr="Update sound buffer with new data"> <Param name="Sound sound" /> <Param name="const void *data" /> - <Param name="int samplesCount" /> + <Param name="int sampleCount" /> </Overload> </KeyWord> <KeyWord name="UnloadWave" func="yes"> @@ -1997,6 +2863,18 @@ <Param name="Sound sound" /> </Overload> </KeyWord> + <KeyWord name="ExportWave" func="yes"> + <Overload retVal="bool" descr="Export wave data to file, returns true on success"> + <Param name="Wave wave" /> + <Param name="const char *fileName" /> + </Overload> + </KeyWord> + <KeyWord name="ExportWaveAsCode" func="yes"> + <Overload retVal="bool" descr="Export wave sample data to code (.h), returns true on success"> + <Param name="Wave wave" /> + <Param name="const char *fileName" /> + </Overload> + </KeyWord> <!-- Wave/Sound management functions --> <KeyWord name="PlaySound" func="yes"> @@ -2004,6 +2882,11 @@ <Param name="Sound sound" /> </Overload> </KeyWord> + <KeyWord name="StopSound" func="yes"> + <Overload retVal="void" descr="Stop playing a sound"> + <Param name="Sound sound" /> + </Overload> + </KeyWord> <KeyWord name="PauseSound" func="yes"> <Overload retVal="void" descr="Pause a sound"> <Param name="Sound sound" /> @@ -2014,11 +2897,17 @@ <Param name="Sound sound" /> </Overload> </KeyWord> - <KeyWord name="StopSound" func="yes"> - <Overload retVal="void" descr="Stop playing a sound"> + <KeyWord name="PlaySoundMulti" func="yes"> + <Overload retVal="void" descr="Play a sound (using multichannel buffer pool)"> <Param name="Sound sound" /> </Overload> </KeyWord> + <KeyWord name="StopSoundMulti" func="yes"> + <Overload retVal="void" descr="Stop any sound playing (using multichannel buffer pool)"></Overload> + </KeyWord> + <KeyWord name="GetSoundsPlaying" func="yes"> + <Overload retVal="int" descr="Get number of sounds playing in the multichannel"></Overload> + </KeyWord> <KeyWord name="IsSoundPlaying" func="yes"> <Overload retVal="bool" descr="Check if a sound is currently playing"> <Param name="Sound sound" /> @@ -2056,11 +2945,16 @@ <Param name="int finalSample" /> </Overload> </KeyWord> - <KeyWord name="GetWaveData" func="yes"> - <Overload retVal="float" descr="Get samples data from wave as a floats array"> + <KeyWord name="LoadWaveSamples" func="yes"> + <Overload retVal="float" descr="Load samples data from wave as a floats array"> <Param name="Wave wave" /> </Overload> </KeyWord> + <KeyWord name="UnloadWaveSamples" func="yes"> + <Overload retVal="void" descr="Unload samples data loaded with LoadWaveSamples()"> + <Param name="float *samples" /> + </Overload> + </KeyWord> <!-- Music management functions --> <KeyWord name="LoadMusicStream" func="yes"> @@ -2068,6 +2962,13 @@ <Param name="const char *fileName" /> </Overload> </KeyWord> + <KeyWord name="LoadMusicStreamFromMemory" func="yes"> + <Overload retVal="Music" descr="Load music stream from data"> + <Param name="const char *fileType" /> + <Param name="unsigned char *data" /> + <Param name="int dataSize" /> + </Overload> + </KeyWord> <KeyWord name="UnloadMusicStream" func="yes"> <Overload retVal="void" descr="Unload music stream"> <Param name="Music music" /> @@ -2078,6 +2979,11 @@ <Param name="Music music" /> </Overload> </KeyWord> + <KeyWord name="IsMusicStreamPlaying" func="yes"> + <Overload retVal="bool" descr="Check if music is playing"> + <Param name="Music music" /> + </Overload> + </KeyWord> <KeyWord name="UpdateMusicStream" func="yes"> <Overload retVal="void" descr="Updates buffers for music streaming"> <Param name="Music music" /> @@ -2098,9 +3004,10 @@ <Param name="Music music" /> </Overload> </KeyWord> - <KeyWord name="IsMusicPlaying" func="yes"> - <Overload retVal="bool" descr="Check if music is playing"> + <KeyWord name="SeekMusicStream" func="yes"> + <Overload retVal="void" descr="Seek music to a position (in seconds)"> <Param name="Music music" /> + <Param name="float position" /> </Overload> </KeyWord> <KeyWord name="SetMusicVolume" func="yes"> @@ -2115,12 +3022,6 @@ <Param name="float pitch" /> </Overload> </KeyWord> - <KeyWord name="SetMusicLoopCount" func="yes"> - <Overload retVal="void" descr="Set music loop count (loop repeats)"> - <Param name="Music music" /> - <Param name="int count" /> - </Overload> - </KeyWord> <KeyWord name="GetMusicTimeLength" func="yes"> <Overload retVal="float" descr="Get music time length (in seconds)"> <Param name="Music music" /> @@ -2133,26 +3034,26 @@ </KeyWord> <!-- AudioStream management functions --> - <KeyWord name="InitAudioStream" func="yes"> - <Overload retVal="AudioStream" descr="Init audio stream (to stream raw audio pcm data)"> + <KeyWord name="LoadAudioStream" func="yes"> + <Overload retVal="AudioStream" descr="Load audio stream (to stream raw audio pcm data)"> <Param name="unsigned int sampleRate" /> <Param name="unsigned int sampleSize" /> <Param name="unsigned int channels" /> </Overload> </KeyWord> - <KeyWord name="UpdateAudioStream" func="yes"> - <Overload retVal="void" descr="Update audio stream buffers with data"> + <KeyWord name="UnloadAudioStream" func="yes"> + <Overload retVal="void" descr="Unload audio stream and free memory"> <Param name="AudioStream stream" /> - <Param name="const void *data" /> - <Param name="int samplesCount" /> </Overload> </KeyWord> - <KeyWord name="CloseAudioStream" func="yes"> - <Overload retVal="void" descr="Close audio stream and free memory"> + <KeyWord name="UpdateAudioStream" func="yes"> + <Overload retVal="void" descr="Update audio stream buffers with data"> <Param name="AudioStream stream" /> + <Param name="const void *data" /> + <Param name="int frameCount" /> </Overload> </KeyWord> - <KeyWord name="IsAudioBufferProcessed" func="yes"> + <KeyWord name="IsAudioStreamProcessed" func="yes"> <Overload retVal="bool" descr="Check if any audio stream buffers requires refill"> <Param name="AudioStream stream" /> </Overload> @@ -2194,5 +3095,10 @@ <Param name="float pitch" /> </Overload> </KeyWord> + <KeyWord name="SetAudioStreamBufferSizeDefault" func="yes"> + <Overload retVal="void" descr="Default size for new audio streams"> + <Param name="int size" /> + </Overload> + </KeyWord> </AutoComplete> </NotepadPlus> |
