raylib/
lib.rs

1/* raylib-rs
2   lib.rs - Main library code (the safe layer)
3
4Copyright (c) 2018-2024 raylib-rs team
5
6This software is provided "as-is", without any express or implied warranty. In no event will the authors be held liable for any damages arising from the use of this software.
7
8Permission is granted to anyone to use this software for any purpose, including commercial applications, and to alter it and redistribute it freely, subject to the following restrictions:
9
10  1. The origin of this software must not be misrepresented; you must not claim that you wrote the original software. If you use this software in a product, an acknowledgment in the product documentation would be appreciated but is not required.
11
12  2. Altered source versions must be plainly marked as such, and must not be misrepresented as being the original software.
13
14  3. This notice may not be removed or altered from any source distribution.
15*/
16
17//! # raylib-rs
18//!
19//! `raylib` is a safe Rust binding to [Raylib](https://www.raylib.com/), a C library for enjoying games programming.
20//!
21//! To get started, take a look at the [`init_window`] function. This initializes Raylib and shows a window, and returns a [`RaylibHandle`]. This handle is very important, because it is the way in which one accesses the vast majority of Raylib's functionality. This means that it must not go out of scope until the game is ready to exit. You will also recieve a !Send and !Sync [`RaylibThread`] required for thread local functions.
22//!
23//! For more control over the game window, the [`init`] function will return a [`RaylibBuilder`] which allows for tweaking various settings such as VSync, anti-aliasing, fullscreen, and so on. Calling [`RaylibBuilder::build`] will then provide a [`RaylibHandle`].
24//!
25//! Some useful constants can be found in the [`consts`] module, which is also re-exported in the [`prelude`] module. In most cases you will probably want to `use raylib::prelude::*;` to make your experience more smooth.
26//!
27//! [`init_window`]: fn.init_window.html
28//! [`init`]: fn.init.html
29//! [`RaylibHandle`]: struct.RaylibHandle.html
30//! [`RaylibThread`]: struct.RaylibThread.html
31//! [`RaylibBuilder`]: struct.RaylibBuilder.html
32//! [`RaylibBuilder::build`]: struct.RaylibBuilder.html#method.build
33//! [`consts`]: consts/index.html
34//! [`prelude`]: prelude/index.html
35//!
36//! # Examples
37//!
38//! The classic "Hello, world":
39//!
40//! ```no_run
41//! use raylib::prelude::*;
42//!
43//! fn main() {
44//!     let (mut rl, thread) = raylib::init()
45//!         .size(640, 480)
46//!         .title("Hello, World")
47//!         .build();
48//!     
49//!     while !rl.window_should_close() {
50//!         let mut d = rl.begin_drawing(&thread);
51//!         
52//!         d.clear_background(Color::WHITE);
53//!         d.draw_text("Hello, world!", 12, 12, 20, Color::BLACK);
54//!     }
55//! }
56//! ```
57//#![cfg_attr(feature = "nightly", feature(auto_traits))]
58
59#![allow(dead_code)]
60pub mod consts;
61pub mod core;
62pub mod ease;
63pub mod prelude;
64pub mod rgui;
65
66/// The raw, unsafe FFI binding, in case you need that escape hatch or the safe layer doesn't provide something you need.
67pub mod ffi {
68    pub use raylib_sys::*;
69}
70
71pub use crate::core::collision::*;
72pub use crate::core::logging::*;
73pub use crate::core::misc::open_url;
74pub use crate::core::*;
75
76// Re-exports
77#[cfg(feature = "nalgebra_interop")]
78pub use nalgebra as na;
79#[cfg(feature = "with_serde")]
80pub use serde;
81
82#[cfg(feature = "imgui")]
83pub mod imgui;
raylib/lib.rs

raylib/
lib.rs
