1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83

#![allow(unused)]
#![warn(missing_docs)]
#![warn(rustdoc::broken_intra_doc_links)]
#![cfg_attr(feature = "simd_allocator", feature(allocator_api))]
#![cfg_attr(feature = "nightly", feature(doc_cfg))]

//! # rich-sdl2-rust
//!
//! The rich-sdl2-rust provides wrapper for SDL2 and abstractions of that APIs, [`audio`], [`window`], [`EventBox`] and so on.
//!
//! ## Supported SDL versions
//!
//! This crate works with libraries:
//!
//! - SDL 2.26.2 or later,
//! - SDL_ttf 2.20.1 or later (on `ttf` feature),
//! - SDL_mixer 2.6.2 or later (on `mixer` feature),
//! - SDL_image 2.6.2 or later (on `image` feature),
//! - SDL_net 2.2.0 or later (on `net` feature).
//!
//! ## Module Navigation
//!
//! - [Window and Graphics](window)
//! - [Simple Audio Control](audio)
//! - [Handling Events](EventBox)
//! - ...
//!
//! ## Crate features
//!
//! - `vulkan`: The Vulkan support API wrapper.
//! - `nightly`: The features can be used on nightly.
//!   - `simd_allocator`: The wrapper of SIMD-friendly allocator.

pub mod audio;
mod error;
pub mod event;
pub mod file;
pub mod haptic;
pub mod hint;
#[cfg(feature = "image")]
pub mod image;
#[cfg(feature = "mixer")]
pub mod mixer;
#[cfg(feature = "net")]
pub mod net;
pub mod power;
mod sdl;
pub mod system;
mod timer;
#[cfg(feature = "ttf")]
pub mod ttf;
mod video;

use rich_sdl2_rust_sys as bind;

pub use error::*;
pub use event::{app, EventBox};
pub use sdl::*;
pub use timer::*;
pub use video::*;

#[cfg(not(target_env = "msvc"))]
type EnumInt = std::os::raw::c_uint;
#[cfg(target_env = "msvc")]
type EnumInt = std::os::raw::c_int;

/// Converts an option reference into a constant raw pointer.
///
/// # Safety
///
/// The object of `opt` must live over usage of a returned pointer. Otherwise it will occur UB.
pub(crate) unsafe fn as_raw<T>(opt: &Option<T>) -> *const T {
    opt.as_ref().map_or(std::ptr::null(), |x| x)
}

/// Converts an option reference into a mutable raw pointer.
///
/// # Safety
///
/// The object of `opt` must live over usage of a returned pointer. Otherwise it will occur UB.
pub(crate) unsafe fn as_raw_mut<T>(opt: &mut Option<T>) -> *mut T {
    opt.as_mut().map_or(std::ptr::null_mut(), |x| &mut *x)
}