Lots of cross-platform polish

* Temporary hacks for rust-lang/rust-bindgen#1244
* Implement WindowHandle trait
* Add rudimentary EGL support (see renderdoc/issues#853)
* Fix compilation bugs with Windows and winapi
* Modernize triangle example
* Change replay wrapper filenames to snake case

Author: ebkalderon

Cargo.toml

@@ -10,7 +10,7 @@ readme = "README.md"
 keywords = ["graphics", "profile", "renderdoc", "trace"]
 
 [features]
-default = ["app", "replay", "glutin"]
+default = ["app", "glutin", "replay"]
 app = ["renderdoc_sys/app"]
 replay = ["renderdoc_sys/replay"]
 
@@ -22,7 +22,7 @@ renderdoc_sys = { version = "0.1", path = "renderdoc_sys" }
 shared_library = "0.1.8"
 
 [target.'cfg(windows)'.dependencies]
-winapi = "~0.2.8"
+winapi = { version = "~0.3", features = ["d3d11", "d3d12", "guiddef"] }
 wio = "~0.1.2"
 
 [dev-dependencies]

examples/shader/triangle_150.glslf renamed to examples/shader/triangle_150_core.glslf

@@ -0,0 +1,9 @@
+#version 300 es
+precision mediump float;
+
+in vec4 v_Color;
+out vec4 Target0;
+
+void main() {
+    Target0 = v_Color;
+}

examples/shader/triangle_150.glslv renamed to examples/shader/triangle_150_core.glslv

@@ -0,0 +1,10 @@
+#version 300 es
+
+in vec2 a_Pos;
+in vec3 a_Color;
+out vec4 v_Color;
+
+void main() {
+    v_Color = vec4(a_Color, 1.0);
+    gl_Position = vec4(a_Pos, 0.0, 1.0);
+}

examples/shader/triangle_300_es.glslf

@@ -11,6 +11,7 @@
 // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 // See the License for the specific language governing permissions and
 // limitations under the License.
+#![cfg_attr(target_os = "emscripten", allow(unused_mut))] // this is annoying...
 
 #[macro_use]
 extern crate gfx;
@@ -63,16 +64,33 @@ pub fn main() {
     let window_config = glutin::WindowBuilder::new()
         .with_title("Triangle example".to_string())
         .with_dimensions(1024, 768);
-    let context = glutin::ContextBuilder::new().with_vsync(true);
+
+    let (api, version, vs_code, fs_code) = if cfg!(target_os = "emscripten") {
+        (
+            glutin::Api::WebGl,
+            (2, 0),
+            include_bytes!("shader/triangle_300_es.glslv").to_vec(),
+            include_bytes!("shader/triangle_300_es.glslf").to_vec(),
+        )
+    } else {
+        (
+            glutin::Api::OpenGl,
+            (3, 2),
+            include_bytes!("shader/triangle_150_core.glslv").to_vec(),
+            include_bytes!("shader/triangle_150_core.glslf").to_vec(),
+        )
+    };
+
+    let context = glutin::ContextBuilder::new()
+        .with_gl(glutin::GlRequest::Specific(api, version))
+        .with_gl_profile(glutin::GlProfile::Core)
+        .with_vsync(true);
     let (window, mut device, mut factory, main_color, mut main_depth) =
         gfx_window_glutin::init::<ColorFormat, DepthFormat>(window_config, context, &events_loop);
-    let mut encoder: gfx::Encoder<_, _> = factory.create_command_buffer().into();
+    let mut encoder = gfx::Encoder::from(factory.create_command_buffer());
+
     let pso = factory
-        .create_pipeline_simple(
-            include_bytes!("shader/triangle_150.glslv"),
-            include_bytes!("shader/triangle_150.glslf"),
-            pipe::new(),
-        )
+        .create_pipeline_simple(&vs_code, &fs_code, pipe::new())
         .unwrap();
     let (vertex_buffer, slice) = factory.create_vertex_buffer_with_slice(&TRIANGLE, ());
     let mut data = pipe::Data {
@@ -87,33 +105,34 @@ pub fn main() {
     let mut running = true;
     while running {
         events_loop.poll_events(|event| {
-            if let glutin::Event::WindowEvent { event, .. } = event {
+            use glutin::{Event, KeyboardInput, VirtualKeyCode, WindowEvent};
+
+            if let Event::WindowEvent { event, .. } = event {
                 match event {
-                    glutin::WindowEvent::KeyboardInput {
+                    WindowEvent::Closed
+                    | WindowEvent::KeyboardInput {
                         input:
-                            glutin::KeyboardInput {
-                                virtual_keycode: Some(glutin::VirtualKeyCode::R),
-                                state: glutin::ElementState::Pressed,
+                            KeyboardInput {
+                                virtual_keycode: Some(VirtualKeyCode::Escape),
                                 ..
                             },
                         ..
-                    } => match rd.launch_replay_ui(None) {
-                        Ok(pid) => println!("Launched replay UI ({}).", pid),
-                        Err(err) => println!("{:?}", err),
-                    },
-                    glutin::WindowEvent::KeyboardInput {
+                    } => running = false,
+                    WindowEvent::Resized(width, height) => {
+                        window.resize(width, height);
+                        gfx_window_glutin::update_views(&window, &mut data.out, &mut main_depth);
+                    }
+                    WindowEvent::KeyboardInput {
                         input:
-                            glutin::KeyboardInput {
-                                virtual_keycode: Some(glutin::VirtualKeyCode::Escape),
+                            KeyboardInput {
+                                virtual_keycode: Some(VirtualKeyCode::R),
                                 ..
                             },
                         ..
-                    }
-                    | glutin::WindowEvent::Closed => running = false,
-                    glutin::WindowEvent::Resized(width, height) => {
-                        window.resize(width, height);
-                        gfx_window_glutin::update_views(&window, &mut data.out, &mut main_depth);
-                    }
+                    } => match rd.launch_replay_ui(true, None) {
+                        Ok(pid) => println!("Launched replay UI ({}).", pid),
+                        Err(err) => println!("{:?}", err),
+                    },
                     _ => (),
                 }
             }

examples/shader/triangle_300_es.glslv

@@ -9,12 +9,14 @@ fn main() {
 
     let out_path = PathBuf::from(env::var("OUT_DIR").unwrap());
 
-    if cfg!(feature = "app") {
-        gen_app_bindings(&out_path);
-    }
+    if cfg!(not(apple)) {
+        if cfg!(feature = "app") {
+            gen_app_bindings(&out_path);
+        }
 
-    if cfg!(feature = "replay") {
-        gen_replay_bindings(&out_path);
+        if cfg!(feature = "replay") {
+            gen_replay_bindings(&out_path);
+        }
     }
 }
 
@@ -31,15 +33,21 @@ fn gen_app_bindings<P: AsRef<Path>>(out_path: P) {
 }
 
 fn gen_replay_bindings<P: AsRef<Path>>(out_path: P) {
+    #[cfg(unix)]
+    let platform_args = ["-DRENDERDOC_PLATFORM_LINUX", "-DRENDERDOC_WINDOWING_XLIB"];
+
+    #[cfg(windows)]
+    let platform_args = ["-DRENDERDOC_PLATFORM_WIN32"];
+
     let replay = bindgen::Builder::default()
         .header("replay/wrapper.h")
         .clang_args(&[
             "-x",
             "c++",
             "-std=c++11",
-            "-DRENDERDOC_PLATFORM_LINUX",
-            "-DRENDERDOC_WINDOWING_XLIB"
+            "-Irenderdoc"
         ])
+        .clang_args(&platform_args)
         .opaque_type("std::.*")
         .whitelist_function("GetNewUniqueId")
         .whitelist_function("RENDERDOC_.*")
@@ -76,19 +84,38 @@ fn gen_replay_bindings<P: AsRef<Path>>(out_path: P) {
         .write_to_file(out_path.as_ref().join("replay.rs"))
         .expect("Couldn't write replay bindings!");
 
-    cc::Build::new()
+    let mut build = cc::Build::new();
+
+    #[cfg(unix)]
+    build
+        .define("RENDERDOC_PLATFORM_LINUX", None)
+        .define("RENDERDOC_WINDOWING_XLIB", None);
+
+    #[cfg(windows)]
+    build.define("RENDERDOC_PLATFORM_WINDOWS", None);
+
+    build
         .include("replay")
         .include("renderdoc")
-        .file("replay/src/Api.cpp")
-        .file("replay/src/Camera.cpp")
-        .file("replay/src/CaptureFile.cpp")
-        .file("replay/src/RemoteServer.cpp")
-        .file("replay/src/ReplayController.cpp")
-        .file("replay/src/ReplayOutput.cpp")
-        .file("replay/src/TargetControl.cpp")
-        .define("RENDERDOC_PLATFORM_LINUX", None)
-        .define("RENDERDOC_WINDOWING_XLIB", None)
+        .file("replay/src/api.cpp")
+        .file("replay/src/camera.cpp")
+        .file("replay/src/capture_file.cpp")
+        .file("replay/src/remote_server.cpp")
+        .file("replay/src/replay_controller.cpp")
+        .file("replay/src/replay_output.cpp")
+        .file("replay/src/target_control.cpp")
+        .object(library_path())
         .pic(true)
         .cpp(true)
         .compile("librenderdoc.a");
 }
+
+#[cfg(windows)]
+fn library_path() -> &'static Path {
+    Path::new("C:\\Program Files (x64)\\RenderDoc\\renderdoc.dll")
+}
+
+#[cfg(unix)]
+fn library_path() -> &'static Path {
+    Path::new("/usr/lib/librenderdoc.so")
+}

examples/triangle.rs

@@ -29,6 +29,7 @@ typedef uint32_t bool32;
         #define RENDERDOC_API __declspec(dllimport)
     #endif
     #define RENDERDOC_CC __cdecl
+
 #elif defined(RENDERDOC_PLATFORM_LINUX) || defined(RENDERDOC_PLATFORM_APPLE) || \
     defined(RENDERDOC_PLATFORM_ANDROID)
 

renderdoc_sys/build.rs

@@ -1,13 +1,13 @@
 #include "../renderdoc/renderdoc/api/replay/renderdoc_replay.h"
 
-#include "../include/Api.h"
-
-#include "../include/Camera.h"
-#include "../include/CaptureFile.h"
-#include "../include/RemoteServer.h"
-#include "../include/ReplayController.h"
-#include "../include/ReplayOutput.h"
-#include "../include/TargetControl.h"
+#include "../include/api.h"
+
+#include "../include/camera.h"
+#include "../include/capture_file.h"
+#include "../include/remote_server.h"
+#include "../include/replay_controller.h"
+#include "../include/replay_output.h"
+#include "../include/target_control.h"
 
 Camera *RENDERDOC::InitCamera(CameraType type) {
     return new Camera(type);

renderdoc_sys/replay/include/Api.h renamed to renderdoc_sys/replay/include/api.h

@@ -1,6 +1,6 @@
 #include "../../renderdoc/renderdoc/api/replay/renderdoc_replay.h"
 
-#include "../include/Camera.h"
+#include "../include/camera.h"
 
 Camera::Camera(CameraType type) {
     this->inner = RENDERDOC_InitCamera(type);

renderdoc_sys/replay/include/Camera.h renamed to renderdoc_sys/replay/include/camera.h

@@ -1,7 +1,7 @@
 #include "../../renderdoc/renderdoc/api/replay/renderdoc_replay.h"
 
-#include "../include/CaptureFile.h"
-#include "../include/ReplayController.h"
+#include "../include/capture_file.h"
+#include "../include/replay_controller.h"
 
 CaptureFile::CaptureFile(ICaptureFile *inner) {
     this->inner = inner;

renderdoc_sys/replay/include/CaptureFile.h renamed to renderdoc_sys/replay/include/capture_file.h

@@ -1,7 +1,7 @@
 #include "../../renderdoc/renderdoc/api/replay/renderdoc_replay.h"
 
-#include "../include/RemoteServer.h"
-#include "../include/ReplayController.h"
+#include "../include/remote_server.h"
+#include "../include/replay_controller.h"
 
 RemoteServer::RemoteServer(IRemoteServer *inner) {
     this->inner = inner;

renderdoc_sys/replay/include/Core.h renamed to renderdoc_sys/replay/include/core.h

@@ -1,7 +1,7 @@
 #include "../../renderdoc/renderdoc/api/replay/renderdoc_replay.h"
 
-#include "../include/ReplayController.h"
-#include "../include/ReplayOutput.h"
+#include "../include/replay_controller.h"
+#include "../include/replay_output.h"
 
 APIProperties ReplayController::GetAPIProperties() {
     return this->inner->GetAPIProperties();

renderdoc_sys/replay/include/RemoteServer.h renamed to renderdoc_sys/replay/include/remote_server.h

@@ -1,6 +1,6 @@
 #include "../../renderdoc/renderdoc/api/replay/renderdoc_replay.h"
 
-#include "../include/ReplayOutput.h"
+#include "../include/replay_output.h"
 
 void ReplayOutput::SetTextureDisplay(const TextureDisplay &o) {
     this->inner->SetTextureDisplay(o);

renderdoc_sys/replay/include/ReplayController.h renamed to renderdoc_sys/replay/include/replay_controller.h

@@ -1,6 +1,6 @@
 #include "../../renderdoc/renderdoc/api/replay/renderdoc_replay.h"
 
-#include "../include/TargetControl.h"
+#include "../include/target_control.h"
 
 TargetControl::TargetControl(ITargetControl *inner) {
     this->inner = inner;

renderdoc_sys/replay/include/ReplayOutput.h renamed to renderdoc_sys/replay/include/replay_output.h

@@ -1,7 +1,7 @@
 #ifndef WRAPPER_H
 #define WRAPPER_H
 
-#include "include/Core.h"
+#include "include/core.h"
 
 #include "../renderdoc/renderdoc/api/replay/basic_types.h"
 #include "../renderdoc/renderdoc/api/replay/capture_options.h"
@@ -15,12 +15,12 @@
 #include "../renderdoc/renderdoc/api/replay/vk_pipestate.h"
 #include "../renderdoc/renderdoc/api/replay/version.h"
 
-#include "include/Api.h"
-#include "include/Camera.h"
-#include "include/CaptureFile.h"
-#include "include/RemoteServer.h"
-#include "include/ReplayController.h"
-#include "include/ReplayOutput.h"
-#include "include/TargetControl.h"
+#include "include/api.h"
+#include "include/camera.h"
+#include "include/capture_file.h"
+#include "include/remote_server.h"
+#include "include/replay_controller.h"
+#include "include/replay_output.h"
+#include "include/target_control.h"
 
 #endif // WRAPPER_H

renderdoc_sys/replay/include/TargetControl.h renamed to renderdoc_sys/replay/include/target_control.h

@@ -1,4 +1,6 @@
-//! Raw FFI bindings to RenderDoc.
+//! Raw FFI bindings [RenderDoc], a popular graphics debugger.
+//!
+//! [RenderDoc]: https://renderdoc.org/
 
 #![allow(non_upper_case_globals)]
 #![allow(non_camel_case_types)]