Fix build, tests, examples for SDL3 as of 2023-07-31 (#5)

* Check /usr/local/lib for libSDL on Linux

* Fix build, tests, examples for SDL3 as of 2023-07-30

This commit fixes numerous build and test failures that pop up when
linking against an updated SDL3-sys that uses recent a recent SDL3
git version (fb68e8464638976e13c6a31eb8d3a7884e4b833e used here).

Note that this version depends on an open PR to sdl3-sys-rs (to
allow for testing).

New feature:
- Feature `test-mode` allows running the integration tests without
  failing the Sdl::init() sanity check; the documentation reflects
  this now.

Missing:
- examples/audio-wav.rs is currently disabled; it needs to be ported
  from AudioCVT (which has been retired) to AudioStream.
- The examples need testing.
- The docs still refer to sdl2 all over the place.

Author: creichen

Cargo.toml

@@ -48,6 +48,8 @@ image = ["sdl3-sys/image"]
 ttf = ["sdl3-sys/ttf"]
 # Use hidapi support in SDL. Only 2.0.12 and after
 hidapi = []
+# test_mode allows SDL to be initialised from a thread that is not the main thread
+test-mode = []
 
 use-bindgen = ["sdl3-sys/use-bindgen"]
 use-pkgconfig = ["sdl3-sys/use-pkgconfig"]

README.md

@@ -725,6 +725,14 @@ the latest version of both Rust and Cargo, check that you've updated sdl3-rs
 to the latest version, and run `cargo clean`. If that fails, please let us know
 on the issue tracker.
 
+# Testing
+
+You can run the test suite via:
+```
+cargo test --features=test-mode
+```
+The `test-mode` feature allows running `Sdl::new()` from a thread other than the main thread, which is necessary for running the integration tests (`test/*.rs`).
+
 # Contributing
 
 We're looking for people to help get SDL3 support in Rust built, tested, and completed. You can help out!

build.rs

@@ -1,4 +1,4 @@
 fn main() {
-    #[cfg(any(target_os = "openbsd", target_os = "freebsd"))]
+    #[cfg(any(target_os = "linux", target_os = "openbsd", target_os = "freebsd"))]
     println!(r"cargo:rustc-link-search=/usr/local/lib");
 }

examples/animation.rs

@@ -75,14 +75,14 @@ fn main() -> Result<(), String> {
         let ticks = timer.ticks() as i32;
 
         // set the current frame for time
-        source_rect_0.set_x(32 * ((ticks / 100) % frames_per_anim));
-        dest_rect_0.set_x(1 * ((ticks / 14) % 768) - 128);
+        source_rect_0.set_x((32 * ((ticks / 100) % frames_per_anim)) as f32);
+        dest_rect_0.set_x((1 * ((ticks / 14) % 768) - 128) as f32);
 
-        source_rect_1.set_x(32 * ((ticks / 100) % frames_per_anim));
-        dest_rect_1.set_x((1 * ((ticks / 12) % 768) - 672) * -1);
+        source_rect_1.set_x((32 * ((ticks / 100) % frames_per_anim)) as f32);
+        dest_rect_1.set_x(((1 * ((ticks / 12) % 768) - 672) * -1) as f32);
 
-        source_rect_2.set_x(32 * ((ticks / 100) % frames_per_anim));
-        dest_rect_2.set_x(1 * ((ticks / 10) % 768) - 128);
+        source_rect_2.set_x((32 * ((ticks / 100) % frames_per_anim)) as f32);
+        dest_rect_2.set_x((1 * ((ticks / 10) % 768) - 128) as f32);
 
         canvas.clear();
         // copy the frame to the canvas

examples/audio-capture-and-replay.rs

@@ -1,7 +1,7 @@
-extern crate sdl2;
+extern crate sdl3;
 
-use sdl2::audio::{AudioCallback, AudioSpecDesired};
-use sdl2::AudioSubsystem;
+use sdl3::audio::{AudioCallback, AudioSpecDesired};
+use sdl3::AudioSubsystem;
 use std::i16;
 use std::sync::mpsc;
 use std::time::Duration;
@@ -140,7 +140,7 @@ fn replay_recorded_vec(
 }
 
 fn main() -> Result<(), String> {
-    let sdl_context = sdl2::init()?;
+    let sdl_context = sdl3::init()?;
     let audio_subsystem = sdl_context.audio()?;
 
     let desired_spec = AudioSpecDesired {

examples/audio-queue-squarewave.rs

@@ -1,6 +1,6 @@
-extern crate sdl2;
+extern crate sdl3;
 
-use sdl2::audio::AudioSpecDesired;
+use sdl3::audio::AudioSpecDesired;
 
 use std::time::Duration;
 
@@ -22,7 +22,7 @@ fn gen_wave(bytes_to_write: i32) -> Vec<i16> {
 }
 
 fn main() -> Result<(), String> {
-    let sdl_context = sdl2::init()?;
+    let sdl_context = sdl3::init()?;
     let audio_subsystem = sdl_context.audio()?;
 
     let desired_spec = AudioSpecDesired {

examples/audio-squarewave.rs

@@ -1,6 +1,6 @@
-extern crate sdl2;
+extern crate sdl3;
 
-use sdl2::audio::{AudioCallback, AudioSpecDesired};
+use sdl3::audio::{AudioCallback, AudioSpecDesired};
 use std::time::Duration;
 
 struct SquareWave {
@@ -26,7 +26,7 @@ impl AudioCallback for SquareWave {
 }
 
 fn main() -> Result<(), String> {
-    let sdl_context = sdl2::init()?;
+    let sdl_context = sdl3::init()?;
     let audio_subsystem = sdl_context.audio()?;
 
     let desired_spec = AudioSpecDesired {

examples/audio-wav.rs

@@ -1,6 +1,6 @@
-extern crate sdl2;
+extern crate sdl3;
 
-use sdl2::audio::{AudioCVT, AudioCallback, AudioSpecDesired, AudioSpecWAV};
+use sdl3::audio::{AudioCallback, AudioSpecDesired, AudioSpecWAV};
 use std::borrow::Cow;
 use std::path::{Path, PathBuf};
 use std::time::Duration;
@@ -38,12 +38,15 @@ impl AudioCallback for Sound {
     }
 }
 
+// FIXME: Convert to AudioStream library
+fn main() -> () {}
+#[cfg(feature = "")]
 fn main() -> Result<(), String> {
     let wav_file: Cow<'static, Path> = match std::env::args().nth(1) {
         None => Cow::from(Path::new("./assets/sine.wav")),
         Some(s) => Cow::from(PathBuf::from(s)),
     };
-    let sdl_context = sdl2::init()?;
+    let sdl_context = sdl3::init()?;
     let audio_subsystem = sdl_context.audio()?;
 
     let desired_spec = AudioSpecDesired {
@@ -85,3 +88,4 @@ fn main() -> Result<(), String> {
 
     Ok(())
 }
+

examples/audio-whitenoise.rs

@@ -1,7 +1,7 @@
 extern crate rand;
-extern crate sdl2;
+extern crate sdl3;
 
-use sdl2::audio::{AudioCallback, AudioSpecDesired};
+use sdl3::audio::{AudioCallback, AudioSpecDesired};
 use std::time::Duration;
 
 struct MyCallback {
@@ -22,7 +22,7 @@ impl AudioCallback for MyCallback {
 }
 
 fn main() -> Result<(), String> {
-    let sdl_context = sdl2::init()?;
+    let sdl_context = sdl3::init()?;
     let audio_subsystem = sdl_context.audio()?;
 
     let desired_spec = AudioSpecDesired {

examples/cursor.rs

@@ -1,21 +1,21 @@
-extern crate sdl2;
+extern crate sdl3;
 
-use sdl2::event::Event;
-use sdl2::image::{InitFlag, LoadSurface};
-use sdl2::keyboard::Keycode;
-use sdl2::mouse::Cursor;
-use sdl2::pixels::Color;
-use sdl2::rect::Rect;
-use sdl2::surface::Surface;
+use sdl3::event::Event;
+use sdl3::image::{InitFlag, LoadSurface};
+use sdl3::keyboard::Keycode;
+use sdl3::mouse::Cursor;
+use sdl3::pixels::Color;
+use sdl3::rect::Rect;
+use sdl3::surface::Surface;
 use std::env;
 use std::path::Path;
 
 pub fn run(png: &Path) -> Result<(), String> {
-    let sdl_context = sdl2::init()?;
+    let sdl_context = sdl3::init()?;
     let video_subsystem = sdl_context.video()?;
-    let _image_context = sdl2::image::init(InitFlag::PNG | InitFlag::JPG)?;
+    let _image_context = sdl3::image::init(InitFlag::PNG | InitFlag::JPG)?;
     let window = video_subsystem
-        .window("rust-sdl2 demo: Cursor", 800, 600)
+        .window("rust-sdl3 demo: Cursor", 800, 600)
         .position_centered()
         .build()
         .map_err(|e| e.to_string())?;