expose vsync toggle

README.md

@@ -73,6 +73,7 @@ fn main() -> Result<()> {
         resizable: true,
         fullscreen: false,
         maximized: false,
+        vsync: false,
     })
 }
 

examples/color.rs

@@ -12,6 +12,7 @@ fn main() -> Result<()> {
         resizable: false,
         fullscreen: false,
         maximized: false,
+        vsync: false,
     })
 }
 

examples/counter.rs

@@ -16,6 +16,7 @@ pub fn main() -> Result<()> {
         resizable: false,
         fullscreen: false,
         maximized: false,
+        vsync: false,
     })
 }
 

examples/gamepad.rs

@@ -14,6 +14,7 @@ fn main() -> Result<()> {
         resizable: false,
         fullscreen: false,
         maximized: false,
+        vsync: false,
     })
 }
 

examples/image.rs

@@ -15,6 +15,7 @@ pub fn main() -> Result<()> {
         resizable: false,
         fullscreen: false,
         maximized: false,
+        vsync: false,
     })
 }
 

examples/input.rs

@@ -19,6 +19,7 @@ fn main() -> Result<()> {
         resizable: false,
         fullscreen: false,
         maximized: false,
+        vsync: false,
     })
 }
 

examples/mesh.rs

@@ -19,6 +19,7 @@ fn main() -> Result<()> {
         resizable: false,
         fullscreen: false,
         maximized: false,
+        vsync: false,
     })
 }
 

examples/particles.rs

@@ -21,6 +21,7 @@ fn main() -> Result<()> {
         resizable: false,
         fullscreen: false,
         maximized: false,
+        vsync: false,
     })
 }
 

examples/progress.rs

@@ -15,6 +15,7 @@ pub fn main() -> Result<()> {
         resizable: false,
         fullscreen: false,
         maximized: false,
+        vsync: false,
     })
 }
 

examples/rectangle.rs

@@ -11,6 +11,7 @@ fn main() -> coffee::Result<()> {
         resizable: true,
         fullscreen: false,
         maximized: false,
+        vsync: false,
     })
 }
 

examples/snake.rs

@@ -1,7 +1,8 @@
 extern crate coffee;
 
 use coffee::graphics::{
-    Color, Font, Frame, Mesh, Point, Rectangle, Shape, Text, Window, WindowSettings,
+    Color, Font, Frame, Mesh, Point, Rectangle, Shape, Text, Window,
+    WindowSettings,
 };
 use coffee::input::keyboard::KeyCode;
 use coffee::input::{self, keyboard, Input};
@@ -18,6 +19,7 @@ fn main() {
         resizable: false,
         maximized: false,
         fullscreen: false,
+        vsync: false,
     })
     .expect("An error occured while starting the game");
 }

examples/ui.rs

@@ -15,6 +15,7 @@ fn main() -> Result<()> {
         resizable: false,
         fullscreen: false,
         maximized: false,
+        vsync: false,
     })
 }
 

src/graphics/backend_gfx/mod.rs

@@ -16,7 +16,7 @@ pub use types::TargetView;
 use gfx::{self, Device};
 use gfx_device_gl as gl;
 
-use crate::graphics::{Color, Transformation};
+use crate::graphics::{Color, Transformation, WindowSettings};
 use crate::Result;
 
 /// A link between your game and a graphics processor.
@@ -40,11 +40,11 @@ pub struct Gpu {
 
 impl Gpu {
     pub(super) fn for_window(
-        builder: winit::window::WindowBuilder,
-        events_loop: &winit::event_loop::EventLoop<()>,
+        settings: WindowSettings,
+        event_loop: &winit::event_loop::EventLoop<()>,
     ) -> Result<(Gpu, Surface)> {
         let (surface, device, mut factory) =
-            Surface::new(builder, events_loop)?;
+            Surface::new(settings, event_loop)?;
 
         let mut encoder: gfx::Encoder<gl::Resources, gl::CommandBuffer> =
             factory.create_command_buffer().into();

src/graphics/backend_gfx/surface.rs

@@ -1,7 +1,7 @@
 use gfx_device_gl as gl;
 
 use super::{format, Gpu, TargetView};
-use crate::{Error, Result};
+use crate::{graphics::WindowSettings, Error, Result};
 
 pub struct Surface {
     context: glutin::WindowedContext<glutin::PossiblyCurrent>,
@@ -10,7 +10,7 @@ pub struct Surface {
 
 impl Surface {
     pub(super) fn new(
-        builder: winit::window::WindowBuilder,
+        settings: WindowSettings,
         event_loop: &winit::event_loop::EventLoop<()>,
     ) -> Result<(Self, gl::Device, gl::Factory)> {
         let gl_builder = glutin::ContextBuilder::new()
@@ -19,8 +19,9 @@ impl Surface {
             .with_multisampling(0)
             // 24 color bits, 8 alpha bits
             .with_pixel_format(24, 8)
-            .with_vsync(true);
+            .with_vsync(settings.vsync);
 
+        let builder = settings.into_builder(event_loop);
         let (context, device, factory, target, _depth) = init_raw(
             builder,
             gl_builder,

src/graphics/backend_wgpu/mod.rs

@@ -12,7 +12,7 @@ pub use texture::Texture;
 pub use triangle::Vertex;
 pub use types::TargetView;
 
-use crate::graphics::{Color, Transformation};
+use crate::graphics::{Color, Transformation, WindowSettings};
 use crate::{Error, Result};
 
 #[allow(missing_debug_implementations)]
@@ -27,9 +27,11 @@ pub struct Gpu {
 
 impl Gpu {
     pub(super) fn for_window(
-        builder: winit::window::WindowBuilder,
+        settings: WindowSettings,
         event_loop: &winit::event_loop::EventLoop<()>,
     ) -> Result<(Gpu, Surface)> {
+        let vsync = settings.vsync;
+        let builder = settings.into_builder(event_loop);
         let window = builder
             .build(event_loop)
             .map_err(|error| Error::WindowCreation(error.to_string()))?;
@@ -57,7 +59,7 @@ impl Gpu {
             (device, queue)
         });
 
-        let surface = Surface::new(window, &device);
+        let surface = Surface::new(window, &device, vsync);
 
         let quad_pipeline = quad::Pipeline::new(&mut device);
         let triangle_pipeline = triangle::Pipeline::new(&mut device);

src/graphics/backend_wgpu/surface.rs

@@ -6,24 +6,28 @@ pub struct Surface {
     swap_chain: wgpu::SwapChain,
     extent: wgpu::Extent3d,
     output: Option<wgpu::SwapChainOutput>,
+    vsync: bool,
 }
 
 impl Surface {
     pub fn new(
         window: winit::window::Window,
         device: &wgpu::Device,
+        vsync: bool,
     ) -> Surface {
         let surface = wgpu::Surface::create(&window);
         let size = window.inner_size();
 
-        let (swap_chain, extent) = new_swap_chain(device, &surface, size);
+        let (swap_chain, extent) =
+            new_swap_chain(device, &surface, size, vsync);
 
         Surface {
             window,
             surface,
             swap_chain,
             extent,
             output: None,
+            vsync,
         }
     }
 
@@ -50,7 +54,7 @@ impl Surface {
         size: winit::dpi::PhysicalSize<u32>,
     ) {
         let (swap_chain, extent) =
-            new_swap_chain(&gpu.device, &self.surface, size);
+            new_swap_chain(&gpu.device, &self.surface, size, self.vsync);
 
         self.swap_chain = swap_chain;
         self.extent = extent;
@@ -82,15 +86,22 @@ fn new_swap_chain(
     device: &wgpu::Device,
     surface: &wgpu::Surface,
     size: winit::dpi::PhysicalSize<u32>,
+    vsync: bool,
 ) -> (wgpu::SwapChain, wgpu::Extent3d) {
+    let present_mode = if vsync {
+        wgpu::PresentMode::Mailbox
+    } else {
+        wgpu::PresentMode::Fifo
+    };
+
     let swap_chain = device.create_swap_chain(
         surface,
         &wgpu::SwapChainDescriptor {
             usage: wgpu::TextureUsage::OUTPUT_ATTACHMENT,
             format: wgpu::TextureFormat::Bgra8UnormSrgb,
             width: size.width,
             height: size.height,
-            present_mode: wgpu::PresentMode::Mailbox,
+            present_mode,
         },
     );
 

src/graphics/window.rs

@@ -33,8 +33,7 @@ impl Window {
         let (width, height) = settings.size;
         let is_fullscreen = settings.fullscreen;
 
-        let (gpu, surface) =
-            Gpu::for_window(settings.into_builder(event_loop), event_loop)?;
+        let (gpu, surface) = Gpu::for_window(settings, event_loop)?;
 
         Ok(Window {
             is_fullscreen,

src/graphics/window/settings.rs

@@ -17,10 +17,13 @@ pub struct Settings {
 
     /// Defines whether or not the window should start maximized.
     pub maximized: bool,
+
+    /// Defines whether or not to enable vsync.
+    pub vsync: bool,
 }
 
 impl Settings {
-    pub(super) fn into_builder(
+    pub(crate) fn into_builder(
         self,
         events_loop: &winit::event_loop::EventLoop<()>,
     ) -> winit::window::WindowBuilder {

src/lib.rs

@@ -42,6 +42,7 @@
 //!         resizable: true,
 //!         fullscreen: false,
 //!         maximized: false,
+//!         vsync: false,
 //!     })
 //! }
 //!

tests/graphics.rs

@@ -23,6 +23,7 @@ fn graphics() -> Result<()> {
         resizable: false,
         fullscreen: false,
         maximized: false,
+        vsync: false,
     })
 }