├── .github ├── FUNDING.yml └── workflows │ └── rust.yml ├── .gitignore ├── Cargo.toml ├── LICENSE-APACHE ├── LICENSE-MIT ├── README.md ├── examples ├── demo.rs └── minimal.rs └── src ├── debug.rs └── lib.rs /.github/FUNDING.yml: -------------------------------------------------------------------------------- 1 | # These are supported funding model platforms 2 | 3 | github: aevyrie 4 | -------------------------------------------------------------------------------- /.github/workflows/rust.yml: -------------------------------------------------------------------------------- 1 | name: CI 2 | on: 3 | pull_request: 4 | push: 5 | branches: 6 | - main 7 | jobs: 8 | setup: 9 | runs-on: ubuntu-latest 10 | steps: 11 | - name: Update Packages 12 | run: sudo apt-get update -yq 13 | - name: Install dependencies 14 | run: sudo apt-get install -yq --no-install-recommends libudev-dev libasound2-dev libxcb-composite0-dev 15 | 16 | format: 17 | runs-on: ubuntu-latest 18 | needs: [setup] 19 | steps: 20 | - uses: actions/checkout@v3 21 | - uses: dtolnay/rust-toolchain@stable 22 | - uses: Swatinem/rust-cache@v2.7.0 23 | - run: rustup component add rustfmt 24 | - run: cargo fmt --all -- --check 25 | 26 | check: 27 | runs-on: ubuntu-latest 28 | needs: [setup] 29 | steps: 30 | - uses: actions/checkout@v3 31 | - uses: dtolnay/rust-toolchain@stable 32 | - uses: Swatinem/rust-cache@v2.7.0 33 | - run: cargo check --features=bevy_winit/x11 34 | 35 | clippy: 36 | runs-on: ubuntu-latest 37 | needs: [setup] 38 | steps: 39 | - uses: actions/checkout@v3 40 | - uses: dtolnay/rust-toolchain@stable 41 | - uses: Swatinem/rust-cache@v2.7.0 42 | - run: rustup component add clippy 43 | - run: cargo clippy --features=bevy_winit/x11 -- -D warnings 44 | 45 | doc: 46 | runs-on: ubuntu-latest 47 | needs: [setup] 48 | steps: 49 | - uses: actions/checkout@v3 50 | - uses: dtolnay/rust-toolchain@stable 51 | - uses: Swatinem/rust-cache@v2.7.0 52 | - run: cargo doc --features=bevy_winit/x11 --no-deps --workspace 53 | env: 54 | RUSTDOCFLAGS: -D warnings 55 | 56 | test: 57 | runs-on: ubuntu-latest 58 | needs: [setup] 59 | steps: 60 | - uses: actions/checkout@v3 61 | - uses: dtolnay/rust-toolchain@stable 62 | - uses: Swatinem/rust-cache@v2.7.0 63 | - run: cargo test --features=bevy_winit/x11 64 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | /target 2 | Cargo.lock 3 | trace*.json 4 | .idea 5 | .vscode -------------------------------------------------------------------------------- /Cargo.toml: -------------------------------------------------------------------------------- 1 | [package] 2 | name = "bevy_framepace" 3 | version = "0.19.1" 4 | edition = "2024" 5 | resolver = "2" 6 | description = "Frame pacing and frame limiting for Bevy" 7 | license = "MIT OR Apache-2.0" 8 | repository = "https://github.com/aevyrie/bevy_framepace" 9 | documentation = "https://docs.rs/bevy_framepace" 10 | 11 | # See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html 12 | 13 | [dependencies] 14 | bevy_app = { version = "0.16.0", default-features = false } 15 | bevy_ecs = { version = "0.16.0", default-features = false } 16 | bevy_diagnostic = { version = "0.16.0", default-features = false } 17 | bevy_log = { version = "0.16.0", default-features = false } 18 | bevy_render = { version = "0.16.0", default-features = false } 19 | bevy_reflect = { version = "0.16.0", default-features = false } 20 | bevy_time = { version = "0.16.0", default-features = false } 21 | bevy_platform = { version = "0.16.0", default-features = false } 22 | bevy_window = { version = "0.16.0", default-features = false } 23 | bevy_winit = { version = "0.16.0", default-features = false } 24 | # Non-bevy 25 | spin_sleep = "1.0" 26 | 27 | # Winit will explode in docs.rs otherwise 28 | [package.metadata.docs.rs] 29 | features = ["bevy_winit/x11"] 30 | 31 | [features] 32 | default = ["framepace_debug"] 33 | framepace_debug = [] 34 | 35 | [dev-dependencies] 36 | bevy = { version = "0.16.0-rc.3", default-features = false, features = [ 37 | "bevy_color", 38 | "bevy_ui", 39 | "bevy_gizmos", 40 | "bevy_winit", 41 | "bevy_window", 42 | "default_font", 43 | "x11", 44 | ] } 45 | 46 | [[example]] 47 | name = "demo" 48 | path = "examples/demo.rs" 49 | required-features = ["default"] 50 | 51 | [[example]] 52 | name = "minimal" 53 | path = "examples/minimal.rs" 54 | required-features = ["default"] 55 | -------------------------------------------------------------------------------- /LICENSE-APACHE: -------------------------------------------------------------------------------- 1 | Apache License 2 | Version 2.0, January 2004 3 | http://www.apache.org/licenses/ 4 | 5 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 6 | 7 | 1. Definitions. 8 | 9 | "License" shall mean the terms and conditions for use, reproduction, 10 | and distribution as defined by Sections 1 through 9 of this document. 11 | 12 | "Licensor" shall mean the copyright owner or entity authorized by 13 | the copyright owner that is granting the License. 14 | 15 | "Legal Entity" shall mean the union of the acting entity and all 16 | other entities that control, are controlled by, or are under common 17 | control with that entity. For the purposes of this definition, 18 | "control" means (i) the power, direct or indirect, to cause the 19 | direction or management of such entity, whether by contract or 20 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 21 | outstanding shares, or (iii) beneficial ownership of such entity. 22 | 23 | "You" (or "Your") shall mean an individual or Legal Entity 24 | exercising permissions granted by this License. 25 | 26 | "Source" form shall mean the preferred form for making modifications, 27 | including but not limited to software source code, documentation 28 | source, and configuration files. 29 | 30 | "Object" form shall mean any form resulting from mechanical 31 | transformation or translation of a Source form, including but 32 | not limited to compiled object code, generated documentation, 33 | and conversions to other media types. 34 | 35 | "Work" shall mean the work of authorship, whether in Source or 36 | Object form, made available under the License, as indicated by a 37 | copyright notice that is included in or attached to the work 38 | (an example is provided in the Appendix below). 39 | 40 | "Derivative Works" shall mean any work, whether in Source or Object 41 | form, that is based on (or derived from) the Work and for which the 42 | editorial revisions, annotations, elaborations, or other modifications 43 | represent, as a whole, an original work of authorship. For the purposes 44 | of this License, Derivative Works shall not include works that remain 45 | separable from, or merely link (or bind by name) to the interfaces of, 46 | the Work and Derivative Works thereof. 47 | 48 | "Contribution" shall mean any work of authorship, including 49 | the original version of the Work and any modifications or additions 50 | to that Work or Derivative Works thereof, that is intentionally 51 | submitted to Licensor for inclusion in the Work by the copyright owner 52 | or by an individual or Legal Entity authorized to submit on behalf of 53 | the copyright owner. For the purposes of this definition, "submitted" 54 | means any form of electronic, verbal, or written communication sent 55 | to the Licensor or its representatives, including but not limited to 56 | communication on electronic mailing lists, source code control systems, 57 | and issue tracking systems that are managed by, or on behalf of, the 58 | Licensor for the purpose of discussing and improving the Work, but 59 | excluding communication that is conspicuously marked or otherwise 60 | designated in writing by the copyright owner as "Not a Contribution." 61 | 62 | "Contributor" shall mean Licensor and any individual or Legal Entity 63 | on behalf of whom a Contribution has been received by Licensor and 64 | subsequently incorporated within the Work. 65 | 66 | 2. Grant of Copyright License. Subject to the terms and conditions of 67 | this License, each Contributor hereby grants to You a perpetual, 68 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 69 | copyright license to reproduce, prepare Derivative Works of, 70 | publicly display, publicly perform, sublicense, and distribute the 71 | Work and such Derivative Works in Source or Object form. 72 | 73 | 3. Grant of Patent License. Subject to the terms and conditions of 74 | this License, each Contributor hereby grants to You a perpetual, 75 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 76 | (except as stated in this section) patent license to make, have made, 77 | use, offer to sell, sell, import, and otherwise transfer the Work, 78 | where such license applies only to those patent claims licensable 79 | by such Contributor that are necessarily infringed by their 80 | Contribution(s) alone or by combination of their Contribution(s) 81 | with the Work to which such Contribution(s) was submitted. If You 82 | institute patent litigation against any entity (including a 83 | cross-claim or counterclaim in a lawsuit) alleging that the Work 84 | or a Contribution incorporated within the Work constitutes direct 85 | or contributory patent infringement, then any patent licenses 86 | granted to You under this License for that Work shall terminate 87 | as of the date such litigation is filed. 88 | 89 | 4. Redistribution. You may reproduce and distribute copies of the 90 | Work or Derivative Works thereof in any medium, with or without 91 | modifications, and in Source or Object form, provided that You 92 | meet the following conditions: 93 | 94 | (a) You must give any other recipients of the Work or 95 | Derivative Works a copy of this License; and 96 | 97 | (b) You must cause any modified files to carry prominent notices 98 | stating that You changed the files; and 99 | 100 | (c) You must retain, in the Source form of any Derivative Works 101 | that You distribute, all copyright, patent, trademark, and 102 | attribution notices from the Source form of the Work, 103 | excluding those notices that do not pertain to any part of 104 | the Derivative Works; and 105 | 106 | (d) If the Work includes a "NOTICE" text file as part of its 107 | distribution, then any Derivative Works that You distribute must 108 | include a readable copy of the attribution notices contained 109 | within such NOTICE file, excluding those notices that do not 110 | pertain to any part of the Derivative Works, in at least one 111 | of the following places: within a NOTICE text file distributed 112 | as part of the Derivative Works; within the Source form or 113 | documentation, if provided along with the Derivative Works; or, 114 | within a display generated by the Derivative Works, if and 115 | wherever such third-party notices normally appear. The contents 116 | of the NOTICE file are for informational purposes only and 117 | do not modify the License. You may add Your own attribution 118 | notices within Derivative Works that You distribute, alongside 119 | or as an addendum to the NOTICE text from the Work, provided 120 | that such additional attribution notices cannot be construed 121 | as modifying the License. 122 | 123 | You may add Your own copyright statement to Your modifications and 124 | may provide additional or different license terms and conditions 125 | for use, reproduction, or distribution of Your modifications, or 126 | for any such Derivative Works as a whole, provided Your use, 127 | reproduction, and distribution of the Work otherwise complies with 128 | the conditions stated in this License. 129 | 130 | 5. Submission of Contributions. Unless You explicitly state otherwise, 131 | any Contribution intentionally submitted for inclusion in the Work 132 | by You to the Licensor shall be under the terms and conditions of 133 | this License, without any additional terms or conditions. 134 | Notwithstanding the above, nothing herein shall supersede or modify 135 | the terms of any separate license agreement you may have executed 136 | with Licensor regarding such Contributions. 137 | 138 | 6. Trademarks. This License does not grant permission to use the trade 139 | names, trademarks, service marks, or product names of the Licensor, 140 | except as required for reasonable and customary use in describing the 141 | origin of the Work and reproducing the content of the NOTICE file. 142 | 143 | 7. Disclaimer of Warranty. Unless required by applicable law or 144 | agreed to in writing, Licensor provides the Work (and each 145 | Contributor provides its Contributions) on an "AS IS" BASIS, 146 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 147 | implied, including, without limitation, any warranties or conditions 148 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 149 | PARTICULAR PURPOSE. You are solely responsible for determining the 150 | appropriateness of using or redistributing the Work and assume any 151 | risks associated with Your exercise of permissions under this License. 152 | 153 | 8. Limitation of Liability. In no event and under no legal theory, 154 | whether in tort (including negligence), contract, or otherwise, 155 | unless required by applicable law (such as deliberate and grossly 156 | negligent acts) or agreed to in writing, shall any Contributor be 157 | liable to You for damages, including any direct, indirect, special, 158 | incidental, or consequential damages of any character arising as a 159 | result of this License or out of the use or inability to use the 160 | Work (including but not limited to damages for loss of goodwill, 161 | work stoppage, computer failure or malfunction, or any and all 162 | other commercial damages or losses), even if such Contributor 163 | has been advised of the possibility of such damages. 164 | 165 | 9. Accepting Warranty or Additional Liability. While redistributing 166 | the Work or Derivative Works thereof, You may choose to offer, 167 | and charge a fee for, acceptance of support, warranty, indemnity, 168 | or other liability obligations and/or rights consistent with this 169 | License. However, in accepting such obligations, You may act only 170 | on Your own behalf and on Your sole responsibility, not on behalf 171 | of any other Contributor, and only if You agree to indemnify, 172 | defend, and hold each Contributor harmless for any liability 173 | incurred by, or claims asserted against, such Contributor by reason 174 | of your accepting any such warranty or additional liability. 175 | 176 | END OF TERMS AND CONDITIONS 177 | -------------------------------------------------------------------------------- /LICENSE-MIT: -------------------------------------------------------------------------------- 1 | MIT License 2 | 3 | Permission is hereby granted, free of charge, to any person obtaining a copy 4 | of this software and associated documentation files (the "Software"), to deal 5 | in the Software without restriction, including without limitation the rights 6 | to use, copy, modify, merge, publish, distribute, sublicense, and/or sell 7 | copies of the Software, and to permit persons to whom the Software is 8 | furnished to do so, subject to the following conditions: 9 | 10 | The above copyright notice and this permission notice shall be included in all 11 | copies or substantial portions of the Software. 12 | 13 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR 14 | IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, 15 | FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE 16 | AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER 17 | LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, 18 | OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE 19 | SOFTWARE. 20 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 |
2 | 3 | # bevy_framepace⏱️ 4 | 5 | **Framepacing and framelimiting for Bevy** 6 | 7 | [![crates.io](https://img.shields.io/crates/v/bevy_framepace)](https://crates.io/crates/bevy_framepace) 8 | [![docs.rs](https://docs.rs/bevy_framepace/badge.svg)](https://docs.rs/bevy_framepace) 9 | [![CI](https://github.com/aevyrie/bevy_framepace/workflows/CI/badge.svg?branch=main)](https://github.com/aevyrie/bevy_framepace/actions?query=workflow%3A%22CI%22+branch%3Amain) 10 | [![Bevy](https://img.shields.io/badge/Bevy%20tracking-main-lightblue)](https://github.com/bevyengine/bevy/blob/main/docs/plugins_guidelines.md#main-branch-tracking) 11 | 12 | 13 | 14 |
15 | 16 | ### Usage 17 | 18 | It's as simple as adding the plugin to your app: 19 | 20 | ```rs 21 | app.add_plugins(bevy_framepace::FramepacePlugin); 22 | ``` 23 | 24 | By default, the plugin will automatically measure your framerate and use this for framepacing. 25 | 26 | You can adjust the framerate limit at runtime by modifying the`FramepaceSettings` resource. For 27 | example, to set the framerate limit to 30fps: 28 | 29 | ```rs 30 | settings.limiter = Limiter::from_framerate(30.0), 31 | ``` 32 | 33 | See `demo.rs` in the examples folder, or run with: 34 | 35 | ```console 36 | cargo run --release --example demo 37 | ``` 38 | 39 | ## How it works 40 | 41 | The plugin works by recording how long it takes to render each frame, and sleeping the main thread 42 | until the desired frametime is reached. This ensures the next frame isn't started until the very 43 | last moment, delaying the event loop from restarting. By delaying the event loop, and thus input 44 | collection, this reduces motion-to-photon latency by moving reading input closer to rendering the 45 | frame. 46 | 47 | The `spin_sleep` dependency is needed for precise sleep times. The sleep function in the standard 48 | library is not accurate enough for this application, especially on Windows. 49 | 50 | ## Bevy Version Support 51 | 52 | I intend to track the `main` branch of Bevy. PRs supporting this are welcome! 53 | 54 | | bevy | bevy_framepace | 55 | | ---- | ------------------- | 56 | | 0.16 | 0.19 | 57 | | 0.15 | 0.18 | 58 | | 0.14 | 0.17 | 59 | | 0.13 | 0.15, 0.16 | 60 | | 0.12 | 0.14 | 61 | | 0.11 | 0.13 | 62 | | 0.10 | 0.12 | 63 | | 0.9 | 0.7, 0.8, 0.9, 0.10, 0.11 | 64 | | 0.8 | 0.5, 0.6 | 65 | | 0.7 | 0.4 | 66 | | 0.6 | 0.3 | 67 | 68 | ## License 69 | 70 | `bevy_framepace` is free, open source and permissively licensed! Except where noted (below and/or in 71 | individual files), all code in this repository is dual-licensed under either: 72 | 73 | * MIT License ([LICENSE-MIT](LICENSE-MIT) or 74 | [http://opensource.org/licenses/MIT](http://opensource.org/licenses/MIT)) 75 | * Apache License, Version 2.0 ([LICENSE-APACHE](LICENSE-APACHE) or 76 | [http://www.apache.org/licenses/LICENSE-2.0](http://www.apache.org/licenses/LICENSE-2.0)) 77 | 78 | at your option. This means you can select the license you prefer! This dual-licensing approach is 79 | the de-facto standard in the Rust ecosystem and there are very good reasons to include both. 80 | 81 | ### Your contributions 82 | 83 | Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the 84 | work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any 85 | additional terms or conditions. 86 | -------------------------------------------------------------------------------- /examples/demo.rs: -------------------------------------------------------------------------------- 1 | use bevy::{color::palettes, prelude::*}; 2 | use bevy_window::{SystemCursorIcon, Window}; 3 | use bevy_winit::cursor::CursorIcon; 4 | 5 | fn main() { 6 | App::new() 7 | .add_plugins(( 8 | DefaultPlugins, 9 | bevy::diagnostic::LogDiagnosticsPlugin::default(), 10 | bevy_framepace::FramepacePlugin, 11 | bevy_framepace::debug::DiagnosticsPlugin, 12 | )) 13 | .add_systems(Startup, setup) 14 | .add_systems(Update, (toggle_plugin, update_ui, update_cursor)) 15 | .run(); 16 | } 17 | 18 | #[derive(Component)] 19 | struct EnableText; 20 | 21 | fn toggle_plugin( 22 | mut settings: ResMut, 23 | input: Res>, 24 | ) { 25 | if input.just_pressed(KeyCode::Space) { 26 | use bevy_framepace::Limiter; 27 | settings.limiter = match settings.limiter { 28 | Limiter::Auto => Limiter::Off, 29 | Limiter::Off => Limiter::from_framerate(30.0), 30 | Limiter::Manual(_) => Limiter::Auto, 31 | } 32 | } 33 | } 34 | 35 | fn update_ui( 36 | mut text: Single<&mut TextSpan, With>, 37 | settings: Res, 38 | ) { 39 | text.0 = format!("{}", settings.limiter); 40 | } 41 | 42 | pub fn update_cursor(window: Single<&Window>, mut gizmos: Gizmos) { 43 | if let Some(pos) = window.cursor_position() { 44 | let pos = Vec2::new(pos.x - window.width() / 2.0, window.height() / 2.0 - pos.y); 45 | gizmos.circle_2d(pos, 10.0, palettes::basic::GREEN); 46 | } 47 | } 48 | 49 | /// set up the scene 50 | fn setup(mut commands: Commands, window: Single>) { 51 | commands 52 | .entity(*window) 53 | .insert(CursorIcon::System(SystemCursorIcon::Crosshair)); 54 | commands.spawn(( 55 | Camera2d, 56 | Camera { 57 | order: 10, 58 | ..default() 59 | }, 60 | )); 61 | commands.spawn(Camera3d::default()); 62 | 63 | // UI 64 | let text_font = TextFont { 65 | font_size: 50., 66 | ..default() 67 | }; 68 | commands 69 | .spawn(Text::default()) 70 | .with_child((TextSpan::new("Frame pacing: "), text_font.clone())) 71 | .with_child((TextSpan::new(""), text_font.clone(), EnableText)) 72 | .with_child((TextSpan::new("\n[press space]"), text_font)); 73 | } 74 | -------------------------------------------------------------------------------- /examples/minimal.rs: -------------------------------------------------------------------------------- 1 | use bevy::prelude::*; 2 | 3 | fn main() { 4 | App::new() 5 | .add_plugins((DefaultPlugins, bevy_framepace::FramepacePlugin)) 6 | .run(); 7 | } 8 | -------------------------------------------------------------------------------- /src/debug.rs: -------------------------------------------------------------------------------- 1 | //! Adds diagnostic logging and a cursor for debugging. 2 | 3 | use bevy_app::prelude::*; 4 | use bevy_diagnostic::{Diagnostic, DiagnosticPath, Diagnostics, RegisterDiagnostic}; 5 | use bevy_ecs::prelude::*; 6 | use bevy_time::prelude::*; 7 | 8 | /// Adds [`Diagnostics`] data from `bevy_framepace` 9 | pub struct DiagnosticsPlugin; 10 | 11 | impl Plugin for DiagnosticsPlugin { 12 | fn build(&self, app: &mut App) { 13 | app.add_systems(Update, Self::diagnostic_system); 14 | 15 | app.register_diagnostic(Diagnostic::new(Self::FRAMEPACE_FRAMETIME).with_suffix("ms")); 16 | app.register_diagnostic(Diagnostic::new(Self::FRAMEPACE_OVERSLEEP).with_suffix("µs")); 17 | } 18 | } 19 | 20 | impl DiagnosticsPlugin { 21 | /// [`DiagnosticPath`] for the frametime 22 | pub const FRAMEPACE_FRAMETIME: DiagnosticPath = 23 | DiagnosticPath::const_new("framepace/frametime"); 24 | /// [`DiagnosticPath`] for failures to meet frame time target 25 | pub const FRAMEPACE_OVERSLEEP: DiagnosticPath = 26 | DiagnosticPath::const_new("framepace/oversleep"); 27 | 28 | /// Updates diagnostic data from measurements 29 | pub fn diagnostic_system( 30 | mut diagnostics: Diagnostics, 31 | time: Res