Struct rafx_framework::PooledResourceAllocator
source · pub struct PooledResourceAllocator<T: PooledResourceImpl> { /* private fields */ }
Expand description
This handles waiting for N frames to pass before resetting the pool. “Restting” could mean different things depending on the resource. This allocator also has a callback for allocating new pools for use. A maximum pool count should be provided so that an unbounded leak of pools can be detected.
Implementations§
source§impl<T: PooledResourceImpl> PooledResourceAllocator<T>
impl<T: PooledResourceImpl> PooledResourceAllocator<T>
sourcepub fn new<F: Fn(&RafxDeviceContext, u32) -> RafxResult<T> + Send + Sync + 'static>(
device_context: &RafxDeviceContext,
max_in_flight_frames: u32,
max_pool_count: u32,
allocate_fn: F
) -> Self
pub fn new<F: Fn(&RafxDeviceContext, u32) -> RafxResult<T> + Send + Sync + 'static>( device_context: &RafxDeviceContext, max_in_flight_frames: u32, max_pool_count: u32, allocate_fn: F ) -> Self
Create a pool allocator that will reset resources after N frames. Keep in mind that if for example you want to push a single resource per frame, up to N+1 resources will exist in the sink. If max_in_flight_frames is 2, then you would have a resource that has likely not been submitted to the GPU yet, plus a resource per the N frames that have been submitted
sourcepub fn allocate_pool(&mut self) -> RafxResult<T>
pub fn allocate_pool(&mut self) -> RafxResult<T>
Allocate a pool - either reusing an old one that has been reset or creating a new one. Will assert that we do not exceed max_pool_count. The pool is allowed to exist until retire_pool is called. After this point, we will wait for N frames before restting it.
sourcepub fn retire_pool(&mut self, pool: T)
pub fn retire_pool(&mut self, pool: T)
Schedule the pool to reset after we complete N frames
sourcepub fn update(&mut self) -> RafxResult<()>
pub fn update(&mut self) -> RafxResult<()>
Call when we are ready to reset another set of resources, most likely when a frame is presented or a new frame begins
sourcepub fn destroy(&mut self) -> RafxResult<()>
pub fn destroy(&mut self) -> RafxResult<()>
Immediately destroy everything. We assume the device is idle and nothing is in flight. Calling this function when the device is not idle could result in a deadlock
Trait Implementations§
source§impl<T: PooledResourceImpl> Drop for PooledResourceAllocator<T>
impl<T: PooledResourceImpl> Drop for PooledResourceAllocator<T>
Auto Trait Implementations§
impl<T> !RefUnwindSafe for PooledResourceAllocator<T>
impl<T> Send for PooledResourceAllocator<T>where
T: Send,
impl<T> Sync for PooledResourceAllocator<T>where
T: Sync,
impl<T> Unpin for PooledResourceAllocator<T>where
T: Unpin,
impl<T> !UnwindSafe for PooledResourceAllocator<T>
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
source§impl<T> Downcast for Twhere
T: Any,
impl<T> Downcast for Twhere
T: Any,
source§fn into_any(self: Box<T>) -> Box<dyn Any>
fn into_any(self: Box<T>) -> Box<dyn Any>
Box<dyn Trait>
(where Trait: Downcast
) to Box<dyn Any>
. Box<dyn Any>
can
then be further downcast
into Box<ConcreteType>
where ConcreteType
implements Trait
.source§fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>
fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>
Rc<Trait>
(where Trait: Downcast
) to Rc<Any>
. Rc<Any>
can then be
further downcast
into Rc<ConcreteType>
where ConcreteType
implements Trait
.source§fn as_any(&self) -> &(dyn Any + 'static)
fn as_any(&self) -> &(dyn Any + 'static)
&Trait
(where Trait: Downcast
) to &Any
. This is needed since Rust cannot
generate &Any
’s vtable from &Trait
’s.source§fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
&mut Trait
(where Trait: Downcast
) to &Any
. This is needed since Rust cannot
generate &mut Any
’s vtable from &mut Trait
’s.