Merge pull request #589 from coderedart/master

- It changes dependency to glfw-sys (with generated bindings). Most of the diff is just prefixing constants with GLFW in ffi module.
- changes error callback to not panic on get_clipboard_string
- adds passthrough and runtime platform selection support.
- changes vulkan types to use the ones from glfw-sys. (removes ash dependency)
- enable all features docs.rs.

Author: coderedart

.github/workflows/check.yaml

@@ -0,0 +1,33 @@
+# run cargo check on all platforms
+name: Check
+on: [push]
+jobs:
+    check:
+        name: Check
+        runs-on: ${{ matrix.os }}
+        strategy:
+            matrix:
+                os: [ubuntu-latest, macos-latest, windows-latest]
+        steps:
+            - uses: actions/checkout@v4
+              with:
+                submodules: true
+            
+            - uses: dtolnay/rust-toolchain@stable
+            - uses: lukka/get-cmake@latest
+            
+            - name: Install dependencies
+              if: matrix.os == 'ubuntu-latest'
+              run: |
+                sudo apt update
+                sudo apt install -y libglfw3-dev libxrandr-dev libxinerama-dev libxcursor-dev libxi-dev libxext-dev libwayland-dev libxkbcommon-dev libglfw3-dev cmake
+            
+            # glfw 3.4 is not available on ubuntu yet. So, skip pkg-config check for now.
+            - name: PreBuilt Libs
+              if: matrix.os != 'ubuntu-latest' 
+              run: cargo run --example=version --features=prebuilt-libs
+
+            - name: Src Builds
+              run: |       
+                cargo run --example=version --features=src-build
+                cargo run --example=version --features=src-build,static-link

Cargo.toml

@@ -14,16 +14,15 @@ rust-version = "1.56"
 bitflags = "1.0.0"
 raw-window-handle-0-5 = { package = "raw-window-handle", version = "0.5.0", optional = true }
 raw-window-handle-0-6 = { package = "raw-window-handle", version = "0.6.0", optional = true }
+# TODO: remove the package attribute after glfw-sys is published
+glfw-sys = { version = "6", package = "glfw-sys-passthrough"} 
 
 [target.'cfg(target_os = "macos")'.dependencies]
 objc2 = "0.5.1"
 
 [target.'cfg(target_os = "windows")'.dependencies]
 winapi = { version = "0.3", features = ["libloaderapi"] }
 
-[dependencies.glfw-sys]
-optional = true
-version = "5.0.0"
 
 [dependencies.image]
 optional = true
@@ -33,9 +32,6 @@ version = "^0.25.1"
 optional = true
 version = "0.4"
 
-[dependencies.ash]
-optional = true
-version = "0.38"
 
 [dependencies.serde]
 optional = true
@@ -44,13 +40,25 @@ features = ["derive"]
 
 [dev-dependencies]
 log = "0.4"
+ash = "0.38"
 
 [features]
-all = ["image", "vulkan", "log", "wayland", "raw-window-handle-v0-6"]
-default = ["glfw-sys", "raw-window-handle-v0-6"]
-with-window-handle-v0-5 = ["glfw-sys", "raw-window-handle-v0-5"]
-vulkan = ["ash"]
+all = ["image", "vulkan", "log", "wayland", "x11", "raw-window-handle-v0-6"]
+default = ["all", "prebuilt-libs"]
+with-window-handle-v0-5 = ["raw-window-handle-v0-5"]
+vulkan = ["glfw-sys/vulkan"]
 wayland = ["glfw-sys/wayland"]
-raw-window-handle-v0-6 = ["dep:raw-window-handle-0-6"]
-raw-window-handle-v0-5 = ["dep:raw-window-handle-0-5"]
+x11 = ["glfw-sys/x11"]
+native-handles = ["glfw-sys/native-handles"]
+src-build = ["glfw-sys/src-build"]
+prebuilt-libs = ["glfw-sys/prebuilt-libs"]
+static-link = ["glfw-sys/static-link"]
+raw-window-handle-v0-6 = ["dep:raw-window-handle-0-6", "native-handles"]
+raw-window-handle-v0-5 = ["dep:raw-window-handle-0-5", "native-handles"]
 serde = ["dep:serde"]
+
+
+[package.metadata.docs.rs]
+features = ["all"]
+no-default-features = true
+targets = ["x86_64-unknown-linux-gnu", "x86_64-apple-darwin", "x86_64-pc-windows-msvc"]

examples/error.rs

@@ -20,8 +20,7 @@ extern crate glfw;
 extern crate log;
 
 fn main() {
-    let mut glfw = glfw::init(error_callback)
-    .unwrap();
+    let mut glfw = glfw::init(error_callback).unwrap();
 
     // Force the error callback to be triggered
     glfw.window_hint(glfw::WindowHint::ContextVersion(40000, 3000)); // Ridiculous!

examples/multiwindow.rs

@@ -15,8 +15,8 @@
 
 extern crate glfw;
 
-use glfw::{Action, Key};
 use glfw::GlfwReceiver as Receiver;
+use glfw::{Action, Key};
 
 type WindowInstance = (glfw::PWindow, Receiver<(f64, glfw::WindowEvent)>);
 type WindowVector = Vec<WindowInstance>;

examples/raw_window_handle.rs

@@ -21,10 +21,10 @@ extern crate raw_window_handle_0_6 as raw_window_handle;
 extern crate raw_window_handle_0_5 as raw_window_handle;
 
 use glfw::{Action, Context, Key};
-#[cfg(feature = "raw-window-handle-v0-6")]
-use raw_window_handle::{HasWindowHandle, RawWindowHandle};
 #[cfg(not(feature = "raw-window-handle-v0-6"))]
 use raw_window_handle::{HasRawWindowHandle, RawWindowHandle};
+#[cfg(feature = "raw-window-handle-v0-6")]
+use raw_window_handle::{HasWindowHandle, RawWindowHandle};
 
 fn main() {
     let mut glfw = glfw::init_no_callbacks().unwrap();

examples/vulkan.rs

@@ -26,6 +26,8 @@ use std::ptr;
 
 #[cfg(feature = "vulkan")]
 fn main() {
+    use ash::vk::Handle;
+
     let mut glfw = glfw::init_no_callbacks().unwrap();
 
     glfw.window_hint(glfw::WindowHint::Visible(true));
@@ -52,8 +54,13 @@ fn main() {
 
     let mut surface: std::mem::MaybeUninit<vk::SurfaceKHR> = std::mem::MaybeUninit::uninit();
 
-    if window.create_window_surface(instance.handle(), ptr::null(), surface.as_mut_ptr())
-        != vk::Result::SUCCESS
+    if unsafe {
+        window.create_window_surface(
+            instance.handle().as_raw() as _,
+            ptr::null(),
+            surface.as_mut_ptr() as _,
+        )
+    } != vk::Result::SUCCESS.as_raw()
     {
         panic!("Failed to create GLFW window surface.");
     }

src/callbacks.rs

@@ -157,4 +157,4 @@ pub mod unbuffered {
         });
         UnsetHandlerGuard { _private: () }
     }
-}
+}