Repository files navigation

Versions normally match Raylib's own, with the minor number incremented for any patches (i.e. 5.5.1 for Raylib v5.5). On occassion, if enough breaking changes are made in between Raylib releases, we'll release a 5.6, which is 5.5 but with breaking changes.

Requiresglfw,cmake, andcurl. Tips on making things work smoothly on all platforms is appreciated.Follow instructions for building raylib for your platformhere

1. Add the dependency to yourCargo.toml:

[dependencies]raylib = {version ="5.7.0",features = [] }

2. Start coding!

use raylib::prelude::*;fnmain(){let(mut rl, thread) = raylib::init().size(640,480).title("Hello, World").build();while !rl.window_should_close(){letmut d = rl.begin_drawing(&thread);        d.clear_background(Color::WHITE);        d.draw_text("Hello, world!",12,12,20,Color::BLACK);}}

To use raylib-rs on NixOS there's a provided nix-shell fileshell.nix at the root of the repo that should get you up and running, which can be used like so:

nix-shell ./shell.nix

You'll also need to enable the Wayland feature on the raylib crate:

cargo add raylib -F wayland

Contributions are welcome to improve or fix the shell.nix!

1. Clone repository:git clone --recurse-submodules
2. cargo build

3. Install these packages:
   libglfw3-dev wayland-devel libxkbcommon-devel wayland-protocols wayland-protocols-devel libecm-dev

4. Enable wayland by addingfeatures=["wayland"] to your dependency definition

Cross compiling with raylib-rs can be made easier with cross.See more on the wiki

1. cd samples
2. cargo run --bin 3d_camera_first_person

• Seethe wiki for more info
• Raylib has tons of features that arenot included by default, such as support for various file formats like JPG, etc. We match raylibs default build configuration but this can be customized by enabling and disablingfeature flags
• For a leaner custom build of raylib, setdefault-features = false,but beware that there are mandatory flags that when compiled without will break raylib(such asSUPPORT_STANDARD_FILEIO)
• See how to integrate dearimgui into your project insamples/imgui.rs

• Runcargo test andcargo test --doc while inraylib safe bindings directory and make sure no tests fail
• Test on major platforms (windows, linux)
• Run examples:cd samples andcargo run --bin <sample_name>
• Find & replace the version numbers in every Cargo.toml "5.6.x" -> "5.6.x"
• Update the changelog
• Keep a lookout on tagging functions with#[inline] ,#[must_use] , andconst

Theraygui.h file has to have this ifdef modified to point to whereraylib.h is:

#if !defined(RAYGUI_STANDALONE)#include"../raylib/src/raylib.h"#endif

• Resources are automatically cleaned up when they go out of scope (or whenstd::mem::drop is called). This is essentially RAII. This means that "Unload" functions are not exposed (and not necessary unless you obtain aWeak resource using make_weak()).
• Most of the Raylib API is exposed throughRaylibHandle, which is for enforcing that Raylib is only initialized once, and for making sure the window is closed properly. RaylibHandle has no size and goes away at compile time. Because of mutability rules, Raylib-rs is thread safe!
• ARaylibHandle andRaylibThread are obtained throughraylib::init_window(...) or through the newerinit() function which will allow you tobuild up some window options before initialization (replacesset_config_flags). RaylibThread should not be sent to any other threads, or used in a any syncronization primitives (Mutex, Arc) etc.
• Manually closing the window is unnecessary, becauseCloseWindow is automatically called whenRaylibHandle goes out of scope.
• Model::set_material,Material::set_shader, andMaterialMap::set_texture methods were added since one cannot set the fields directly. Also enforces correct ownership semantics.
• Font::from_data,Font::set_chars, andFont::set_texture methods were added to create aFont from loadedCharInfo data.
• SubText andFormatText are omitted, and are instead covered by Rust's string slicing and Rust'sformat! macro, respectively.

• Structs holding resources have RAII/move semantics, including:Image,Texture2D,RenderTexture2D,Font,Mesh,Shader,Material, andModel.
• Wave,Sound,Music, andAudioStream have lifetimes bound toAudioHandle.
• Functions dealing with string data take in&str and/or return an ownedString, for the sake of safety. The exception to this is the gui draw functions which take &CStr to avoid per frame allocations. Therstr! macro helps make this easy.
• In C,LoadFontData returns a pointer to a heap-allocated array ofCharInfo structs. In this Rust binding, said array is copied into an ownedVec<CharInfo>, the original data is freed, and the owned Vec is returned.
• In C,LoadDroppedFiles returns a pointer to an array of strings owned by raylib. Again, for safety and also ease of use, this binding copies said array into aVec<String> which is returned to the caller.
• I've tried to make linking automatic, though I've only tested on Windows 10, Ubuntu, and MacOS 15. Other platforms may have other considerations.
• OpenGL 3.3, 2.1, and ES 2.0 may be forced via adding["opengl_33"],["opengl_21"] or["opengl_es_20] to thefeatures array in your Cargo.toml dependency definition.

The raylib-test crate tests the bindings by opening a window, and checking the results of various functions. It requires nightly to use.

All contributions are welcome. Chat about raylib ondiscord