9f7e61b819
# Objective - Pipeline compilation is slow and blocks the frame - Closes https://github.com/bevyengine/bevy/issues/8224 ## Solution - Compile pipelines in a Task on the AsyncComputeTaskPool --- ## Changelog - Render/compute pipeline compilation is now done asynchronously over multiple frames when the multi-threaded feature is enabled and on non-wasm and non-macOS platforms - Added `CachedPipelineState::Creating` - Added `PipelineCache::block_on_render_pipeline()` - Added `bevy_utils::futures::check_ready` - Added `bevy_render/multi-threaded` cargo feature ## Migration Guide - Match on the new `Creating` variant for exhaustive matches of `CachedPipelineState`
55 lines
1.7 KiB
Rust
55 lines
1.7 KiB
Rust
//! Utilities for working with [`Future`]s.
|
|
use std::{
|
|
future::Future,
|
|
pin::Pin,
|
|
task::{Context, Poll, RawWaker, RawWakerVTable, Waker},
|
|
};
|
|
|
|
/// Consumes a future, polls it once, and immediately returns the output
|
|
/// or returns `None` if it wasn't ready yet.
|
|
///
|
|
/// This will cancel the future if it's not ready.
|
|
pub fn now_or_never<F: Future>(mut future: F) -> Option<F::Output> {
|
|
let noop_waker = noop_waker();
|
|
let mut cx = Context::from_waker(&noop_waker);
|
|
|
|
// SAFETY: `future` is not moved and the original value is shadowed
|
|
let future = unsafe { Pin::new_unchecked(&mut future) };
|
|
|
|
match future.poll(&mut cx) {
|
|
Poll::Ready(x) => Some(x),
|
|
_ => None,
|
|
}
|
|
}
|
|
|
|
/// Polls a future once, and returns the output if ready
|
|
/// or returns `None` if it wasn't ready yet.
|
|
pub fn check_ready<F: Future + Unpin>(future: &mut F) -> Option<F::Output> {
|
|
let noop_waker = noop_waker();
|
|
let mut cx = Context::from_waker(&noop_waker);
|
|
|
|
let future = Pin::new(future);
|
|
|
|
match future.poll(&mut cx) {
|
|
Poll::Ready(x) => Some(x),
|
|
_ => None,
|
|
}
|
|
}
|
|
|
|
unsafe fn noop_clone(_data: *const ()) -> RawWaker {
|
|
noop_raw_waker()
|
|
}
|
|
unsafe fn noop(_data: *const ()) {}
|
|
|
|
const NOOP_WAKER_VTABLE: RawWakerVTable = RawWakerVTable::new(noop_clone, noop, noop, noop);
|
|
|
|
fn noop_raw_waker() -> RawWaker {
|
|
RawWaker::new(std::ptr::null(), &NOOP_WAKER_VTABLE)
|
|
}
|
|
|
|
fn noop_waker() -> Waker {
|
|
// SAFETY: the `RawWakerVTable` is just a big noop and doesn't violate any of the rules in `RawWakerVTable`s documentation
|
|
// (which talks about retaining and releasing any "resources", of which there are none in this case)
|
|
unsafe { Waker::from_raw(noop_raw_waker()) }
|
|
}
|