VSync option

Author: Muhtasim-Rasheed

docs/project-setup.md

@@ -49,6 +49,7 @@ All paths mentioned are relative to the `project.toml` file.
 - `debug_options`: A list of debug options to enable. Only available options are `show_fps` and `show_mouse_pos`
     - `show_fps`: Shows the current frames per second (FPS)
     - `show_mouse_pos`: Shows the current mouse position on the screen (World coordinates, not screen coordinates)
+- `vsync`: Whether to enable vertical synchronization (VSync). Defaults to `true`. If set to `false`, the game will run as fast as possible, which may cause screen tearing.
 - `[font]`: The font configuration. Defaults to the default Crust font.
     - `file`: The path to the bitmap font file. The file must be an image file.
     - `first_char`: The first character in the font.

src/main.rs

@@ -79,7 +79,15 @@ async fn main() {
     window.set_cursor_pos_polling(true);
     window.make_current();
     gl::load_with(|symbol| window.get_proc_address(symbol) as *const std::os::raw::c_void);
-    glfw.set_swap_interval(glfw::SwapInterval::Sync(1));
+
+    let mut runtime = utils::Runtime::new(&project_file, args.additional_args, &window);
+    println!("Loaded project: {}", project_file);
+
+    glfw.set_swap_interval(if runtime.vsync {
+        glfw::SwapInterval::Sync(1)
+    } else {
+        glfw::SwapInterval::None
+    });
     unsafe {
         gl::Enable(gl::CULL_FACE);
         gl::CullFace(gl::BACK);
@@ -111,8 +119,6 @@ async fn main() {
         }]);
     }
 
-    let mut runtime = utils::Runtime::new(&project_file, args.additional_args, &window);
-    println!("Loaded project: {}", project_file);
     let shader_program = ShaderProgram::new(VERT_SHADER, FRAG_SHADER);
     runtime
         .run(&mut window, &events, &shader_program, &mut glfw)

src/utils/runtime.rs

@@ -56,6 +56,7 @@ struct TagConfig {
 #[derive(Deserialize, Debug)]
 struct ProjectConfig {
     debug_options: Option<Vec<String>>,
+    vsync: Option<bool>,
     font: Option<FontConfig>,
     stage: Option<StageConfig>,
     sprites: Vec<SpriteConfig>,
@@ -175,6 +176,7 @@ pub struct Runtime {
     pub project: Project,
     pub audio_manager: AudioManager<DefaultBackend>,
     pub font: BitmapFont,
+    pub vsync: bool,
     debug_options: Vec<String>,
 }
 
@@ -349,6 +351,7 @@ impl Runtime {
             project,
             audio_manager,
             font,
+            vsync: config.vsync.unwrap_or(true),
             debug_options: config.debug_options.unwrap_or(vec![]),
         }
     }