Bevy Framepace

https://docs.rs/bevy_framepace/0.21.0/bevy_framepace/
Admin
This Bevy plugin adds framepacing and framelimiting to improve input latency and power use by...
Tokens:3,620
Snippets:61
Trust Score:9.7
Update:3 months ago
Show doc for...
Tokens:
Raw
### CloneToUninit Implementation

Source: https://docs.rs/bevy_framepace/0.21.0/bevy_framepace/struct.FramepaceSettings.html?search=std%3A%3Avec

Experimental nightly API for performing copy-assignment to uninitialized memory.

```rust
unsafe fn clone_to_uninit(&self, dest: *mut u8)
```

--------------------------------

### FramepaceSettings::with_limiter

Source: https://docs.rs/bevy_framepace/0.21.0/bevy_framepace/struct.FramepaceSettings.html

Builds plugin settings with the specified Limiter configuration.

```APIDOC
## pub fn with_limiter(self, limiter: Limiter) -> Self

### Description
Builds plugin settings with the specified `Limiter` configuration.

### Parameters
- **limiter** (Limiter) - Required - The framerate limiting strategy to apply.
```

--------------------------------

### with_limiter

Source: https://docs.rs/bevy_framepace/0.21.0/bevy_framepace/struct.FramepaceSettings.html?search=Option%3CT%3E%2C+%28T+-%3E+U%29+-%3E+Option%3CU%3E

Builds plugin settings with the specified Limiter configuration.

```APIDOC
## pub fn with_limiter(self, limiter: Limiter) -> Self

### Description
Builds plugin settings with the specified Limiter configuration.

### Parameters
- **limiter** (Limiter) - Required - The framerate limiting strategy to apply.
```

--------------------------------

### Limited Framerate Latency Comparison

Source: https://docs.rs/bevy_framepace/0.21.0/bevy_framepace/index.html

Comparison showing consistent input latency between 60fps and 10fps when using framepacing.

```text
               same                                              same
          /-- latency --\                                   /-- latency --\
 sleep -> input -> render -> sleeeeeeeeeeeeeeeeeeeeeeeep -> input -> render
 \----- event loop -----/    \---------------- event loop ----------------/
          60 fps                           limited to 10 fps
```

--------------------------------

### Framepacing Latency Visualization

Source: https://docs.rs/bevy_framepace/0.21.0/bevy_framepace/index.html

Visual representation of how sleeping before the event loop minimizes input latency.

```text
          /-- latency --\             /-- latency --\
 sleep -> input -> render -> sleep -> input -> render
 \----- event loop -----/    \----- event loop -----/
```

--------------------------------

### Limiter::from_framerate

Source: https://docs.rs/bevy_framepace/0.21.0/bevy_framepace/enum.Limiter.html

Constructs a new Limiter instance based on a target framerate.

```APIDOC
## fn from_framerate(framerate: f64) -> Self

### Description
Constructs a new Limiter from the provided framerate value.

### Parameters
- **framerate** (f64) - The target framerate to set.

### Returns
- **Self** - A new Limiter instance.
```

--------------------------------

### Limiter::from_framerate

Source: https://docs.rs/bevy_framepace/0.21.0/bevy_framepace/enum.Limiter.html?search=u32+-%3E+bool

Constructs a new Limiter instance based on a target framerate.

```APIDOC
## pub fn from_framerate(framerate: f64) -> Self

### Description
Constructs a new Limiter from the provided framerate.

### Parameters
- **framerate** (f64) - The target framerate to set the limiter to.

### Returns
- **Self** - A new Limiter instance.
```

--------------------------------

### FramepaceSettings Struct Definition

Source: https://docs.rs/bevy_framepace/0.21.0/bevy_framepace/struct.FramepaceSettings.html?search=Option%3CT%3E%2C+%28T+-%3E+U%29+-%3E+Option%3CU%3E

The core configuration structure for the framepacing plugin.

```rust
pub struct FramepaceSettings {
    pub limiter: Limiter,
}
```

--------------------------------

### Borrow and BorrowMut Implementations

Source: https://docs.rs/bevy_framepace/0.21.0/bevy_framepace/struct.FramepaceSettings.html?search=std%3A%3Avec

Standard library borrowing traits for immutable and mutable access.

```rust
fn borrow(&self) -> &T
```

```rust
fn borrow_mut(&mut self) -> &mut T
```

--------------------------------

### Limiter::from_framerate

Source: https://docs.rs/bevy_framepace/0.21.0/bevy_framepace/enum.Limiter.html?search=Option%3CT%3E%2C+%28T+-%3E+U%29+-%3E+Option%3CU%3E

Constructs a new Limiter instance based on a specified framerate.

```APIDOC
## pub fn from_framerate(framerate: f64) -> Self

### Description
Constructs a new Limiter from the provided framerate value.

### Parameters
- **framerate** (f64) - Required - The target framerate to set.

### Returns
- **Self** - A new Limiter instance.
```

--------------------------------

### FramepacePlugin

Source: https://docs.rs/bevy_framepace/0.21.0/bevy_framepace/struct.FramepacePlugin.html?search=std%3A%3Avec

The FramepacePlugin struct is used to integrate frame-pacing and frame-limiting features into a Bevy App.

```APIDOC
## FramepacePlugin

### Description
Adds frame-pacing and frame-limiting functionality to your Bevy `App`.

### Usage
Add this plugin to your Bevy `App` instance during the initialization phase to enable frame-pacing features.
```

--------------------------------

### From Trait Implementation

Source: https://docs.rs/bevy_framepace/0.21.0/bevy_framepace/struct.FramepaceSettings.html?search=std%3A%3Avec

Identity conversion implementation.

```rust
fn from(t: T) -> T
```

--------------------------------

### WithSubscriber::with_subscriber

Source: https://docs.rs/bevy_framepace/0.21.0/bevy_framepace/debug/struct.DiagnosticsPlugin.html?search=

Attaches the provided Subscriber to the type, returning a WithDispatch wrapper.

```APIDOC
## fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>

### Description
Attaches the provided `Subscriber` to this type, returning a `WithDispatch` wrapper.

### Parameters
- **subscriber** (S) - Required - The subscriber to attach, which must implement `Into<Dispatch>`.
```

--------------------------------

### WithSubscriber::with_subscriber

Source: https://docs.rs/bevy_framepace/0.21.0/bevy_framepace/debug/struct.DiagnosticsPlugin.html

Attaches the provided Subscriber to the type, returning a WithDispatch wrapper.

```APIDOC
## fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>

### Description
Attaches the provided `Subscriber` to this type, returning a `WithDispatch` wrapper.

### Parameters
- **subscriber** (S) - Required - The subscriber to attach, which must implement Into<Dispatch>.
```

--------------------------------

### FromWorld Trait Implementation

Source: https://docs.rs/bevy_framepace/0.21.0/bevy_framepace/struct.FramepaceSettings.html?search=std%3A%3Avec

Creates an instance from the World using the default implementation.

```rust
fn from_world(_world: &mut World) -> T
```

--------------------------------

### WithSubscriber Trait Methods

Source: https://docs.rs/bevy_framepace/0.21.0/bevy_framepace/debug/struct.DiagnosticsPlugin.html?search=Option%3CT%3E%2C+%28T+-%3E+U%29+-%3E+Option%3CU%3E

Methods for attaching subscribers to types to manage dispatching.

```APIDOC
## fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>

### Description
Attaches the provided `Subscriber` to this type, returning a `WithDispatch` wrapper.

### Parameters
- **subscriber** (S) - Required - The subscriber to attach, must implement Into<Dispatch>.

## fn with_current_subscriber(self) -> WithDispatch<Self>

### Description
Attaches the current default `Subscriber` to this type, returning a `WithDispatch` wrapper.
```

--------------------------------

### DynamicTypePath Trait Methods

Source: https://docs.rs/bevy_framepace/0.21.0/bevy_framepace/struct.FramepaceSettings.html?search=std%3A%3Avec

Methods for retrieving type path information dynamically.

```rust
fn reflect_type_path(&self) -> &str
```

```rust
fn reflect_short_type_path(&self) -> &str
```

```rust
fn reflect_type_ident(&self) -> Option<&str>
```

```rust
fn reflect_crate_name(&self) -> Option<&str>
```

```rust
fn reflect_module_path(&self) -> Option<&str>
```

--------------------------------

### Define FramepacePlugin

Source: https://docs.rs/bevy_framepace/0.21.0/bevy_framepace/struct.FramepacePlugin.html?search=

The definition of the FramepacePlugin struct.

```rust
pub struct FramepacePlugin;
```

--------------------------------

### Instrument Trait Methods

Source: https://docs.rs/bevy_framepace/0.21.0/bevy_framepace/debug/struct.DiagnosticsPlugin.html?search=

Wraps types with tracing spans for instrumentation.

```rust
fn instrument(self, span: Span) -> Instrumented<Self>
```

```rust
fn in_current_span(self) -> Instrumented<Self>
```

--------------------------------

### TryFrom Trait Implementation

Source: https://docs.rs/bevy_framepace/0.21.0/bevy_framepace/debug/struct.DiagnosticsPlugin.html?search=std%3A%3Avec

Implementation of TryFrom for types that implement Into.

```rust
type Error = Infallible
```

```rust
fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>
```

--------------------------------

### Limiter::is_enabled

Source: https://docs.rs/bevy_framepace/0.21.0/bevy_framepace/enum.Limiter.html

Checks if the current Limiter configuration is enabled.

```APIDOC
## fn is_enabled(&self) -> bool

### Description
Returns true if the Limiter is currently enabled.

### Returns
- **bool** - True if enabled, false otherwise.
```

--------------------------------

### Limiter::is_enabled

Source: https://docs.rs/bevy_framepace/0.21.0/bevy_framepace/enum.Limiter.html?search=Option%3CT%3E%2C+%28T+-%3E+U%29+-%3E+Option%3CU%3E

Checks if the current Limiter configuration is enabled.

```APIDOC
## pub fn is_enabled(&self) -> bool

### Description
Returns true if the Limiter is currently enabled.

### Returns
- **bool** - Returns true if enabled, false otherwise.
```

--------------------------------

### Limiter::is_enabled

Source: https://docs.rs/bevy_framepace/0.21.0/bevy_framepace/enum.Limiter.html?search=u32+-%3E+bool

Checks if the current Limiter configuration is enabled.

```APIDOC
## pub fn is_enabled(&self) -> bool

### Description
Returns true if the Limiter is currently enabled.

### Returns
- **bool** - True if enabled, false otherwise.
```

--------------------------------

### Any Trait Implementation

Source: https://docs.rs/bevy_framepace/0.21.0/bevy_framepace/struct.FramepaceSettings.html?search=std%3A%3Avec

Provides the type_id method for static types.

```rust
fn type_id(&self) -> TypeId
```

--------------------------------

### WithSubscriber::with_current_subscriber

Source: https://docs.rs/bevy_framepace/0.21.0/bevy_framepace/debug/struct.DiagnosticsPlugin.html?search=

Attaches the current default Subscriber to the type, returning a WithDispatch wrapper.

```APIDOC
## fn with_current_subscriber(self) -> WithDispatch<Self>

### Description
Attaches the current default `Subscriber` to this type, returning a `WithDispatch` wrapper.
```

--------------------------------

### Downcast Trait Methods

Source: https://docs.rs/bevy_framepace/0.21.0/bevy_framepace/debug/struct.DiagnosticsPlugin.html?search=

Provides methods to convert trait objects into Any or Any + Send for downcasting to concrete types.

```rust
fn into_any(self: Box<T>) -> Box<dyn Any>
```

```rust
fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>
```

```rust
fn as_any(&self) -> &(dyn Any + 'static)
```

```rust
fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
```

--------------------------------

### Define DiagnosticsPlugin

Source: https://docs.rs/bevy_framepace/0.21.0/bevy_framepace/debug/struct.DiagnosticsPlugin.html?search=u32+-%3E+bool

The struct definition for the DiagnosticsPlugin.

```rust
pub struct DiagnosticsPlugin;
```

--------------------------------

### GetPath Trait Methods

Source: https://docs.rs/bevy_framepace/0.21.0/bevy_framepace/struct.FramepaceSettings.html?search=std%3A%3Avec

Accesses nested values using reflection paths.

```rust
fn reflect_path<'p>( &self, path: impl ReflectPath<'p>, ) -> Result<&(dyn PartialReflect + 'static), ReflectPathError<'p>>
```

```rust
fn reflect_path_mut<'p>( &mut self, path: impl ReflectPath<'p>, ) -> Result<&mut (dyn PartialReflect + 'static), ReflectPathError<'p>>
```

```rust
fn path<'p, T>( &self, path: impl ReflectPath<'p>, ) -> Result<&T, ReflectPathError<'p>>
where T: Reflect,
```

```rust
fn path_mut<'p, T>( &mut self, path: impl ReflectPath<'p>, ) -> Result<&mut T, ReflectPathError<'p>>
where T: Reflect,
```

--------------------------------

### Define FrameTimer struct

Source: https://docs.rs/bevy_framepace/0.21.0/bevy_framepace/struct.FrameTimer.html?search=Option%3CT%3E%2C+%28T+-%3E+U%29+-%3E+Option%3CU%3E

The definition of the FrameTimer struct, which contains private fields.

```rust
pub struct FrameTimer { /* private fields */ }
```

--------------------------------

### FramePaceStats Struct Definition

Source: https://docs.rs/bevy_framepace/0.21.0/bevy_framepace/struct.FramePaceStats.html?search=std%3A%3Avec

The definition of the FramePaceStats struct, which contains private fields for internal state management.

```rust
pub struct FramePaceStats { /* private fields */ }
```

--------------------------------

### FrametimeLimit Definition

Source: https://docs.rs/bevy_framepace/0.21.0/bevy_framepace/struct.FrametimeLimit.html

The definition of the FrametimeLimit struct, which wraps a thread-safe Duration.

```rust
pub struct FrametimeLimit(pub Arc<Mutex<Duration>>);
```

--------------------------------

### DynamicTyped Trait Method

Source: https://docs.rs/bevy_framepace/0.21.0/bevy_framepace/struct.FramepaceSettings.html?search=std%3A%3Avec

Retrieves type information dynamically.

```rust
fn reflect_type_info(&self) -> &'static TypeInfo
```

--------------------------------

### AsBindGroupShaderType Trait Method

Source: https://docs.rs/bevy_framepace/0.21.0/bevy_framepace/debug/struct.DiagnosticsPlugin.html?search=

Returns the shader type representation for a given type.

```rust
fn as_bind_group_shader_type(&self, _images: &RenderAssets<GpuImage>) -> U
```

--------------------------------

### Is Trait Method

Source: https://docs.rs/bevy_framepace/0.21.0/bevy_framepace/debug/struct.DiagnosticsPlugin.html?search=

Checks type equality using TypeId.

```rust
fn is<T>() -> bool
where T: Any,
```

--------------------------------

### IntoEither Trait Methods

Source: https://docs.rs/bevy_framepace/0.21.0/bevy_framepace/debug/struct.DiagnosticsPlugin.html?search=

Converts a value into an Either variant based on a boolean condition or a predicate.

```rust
fn into_either(self, into_left: bool) -> Either<Self, Self>
```

```rust
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,
```

--------------------------------

### Limiter Enum Definition

Source: https://docs.rs/bevy_framepace/0.21.0/bevy_framepace/enum.Limiter.html?search=std%3A%3Avec

The core enum structure defining the available framelimiting modes.

```rust
pub enum Limiter {
    Auto,
    Manual(Duration),
    Off,
}
```

--------------------------------

### GetField Trait Methods

Source: https://docs.rs/bevy_framepace/0.21.0/bevy_framepace/struct.FramepaceSettings.html?search=std%3A%3Avec

Accesses struct fields by name with downcasting.

```rust
fn get_field<T>(&self, name: &str) -> Option<&T>
where T: Reflect,
```

```rust
fn get_field_mut<T>(&mut self, name: &str) -> Option<&mut T>
where T: Reflect,
```

--------------------------------

### HasTypeWitness Trait Constant

Source: https://docs.rs/bevy_framepace/0.21.0/bevy_framepace/struct.FramepaceSettings.html?search=std%3A%3Avec

Provides a constant type witness.

```rust
const WITNESS: W = W::MAKE
```

--------------------------------

### DowncastSend Trait Method

Source: https://docs.rs/bevy_framepace/0.21.0/bevy_framepace/debug/struct.DiagnosticsPlugin.html?search=

Converts a trait object into a Send-safe Any type.

```rust
fn into_any_send(self: Box<T>) -> Box<dyn Any + Send>
```
Tokens:
Raw