Struct DoubleBufferedSubmitter

Source

pub struct DoubleBufferedSubmitter { /* private fields */ }

Expand description

Double-buffered GPU command submission.

Maintains two independent CommandBuffer slots (A and B). While the GPU executes the commands in slot B, the CPU records new work into slot A, and vice-versa. This overlaps CPU recording with GPU execution to maximise throughput.

§Typical cycle (one frame)

1. begin_record(recording_slot)   → SlotState::Recording
2. … record commands …
3. finish_record(recording_slot)  → SlotState::ReadyToSubmit
4. submit(recording_slot)         → SlotState::Inflight
5. mark_retired(other_slot)       → SlotState::Retired (after GPU fence)
6. reset(retired_slot)            → SlotState::Idle

Implementations§

Source §

impl DoubleBufferedSubmitter

Source

pub fn new() -> Self

Create a new double-buffered submitter with both slots idle.

Source

pub fn state(&self, slot: BufferSlot) -> SlotState

Current state of slot.

Source

pub fn active_slot(&self) -> BufferSlot

The slot the CPU is currently (or will next) record into.

Source

pub fn frame_count(&self) -> u64

Total number of complete double-buffer cycles (frames) submitted.

Source

pub fn begin_record(&mut self, slot: BufferSlot) -> bool

Begin recording commands into slot.

Returns false if slot is not currently Idle.

Source

pub fn record(&mut self, slot: BufferSlot, entry: CommandEntry) -> bool

Record a command entry into the active recording slot.

Returns false if slot is not in Recording state.

Source

pub fn finish_record(&mut self, slot: BufferSlot) -> bool

Finish recording for slot.

Returns false if slot is not in Recording state.

Source

pub fn submit(&mut self, slot: BufferSlot) -> Option<Vec<CommandEntry>>

Submit the commands in slot to the (simulated) GPU queue.

Returns the submitted commands on success, or None if slot is not ReadyToSubmit.

Source

pub fn mark_retired(&mut self, slot: BufferSlot) -> bool

Mark slot as retired (GPU execution complete).

Returns false if slot is not Inflight.

Source

pub fn reset_slot(&mut self, slot: BufferSlot) -> bool

Reset slot to Idle so it can be recorded into again.

Returns false if slot is not Retired.

Source

pub fn command_count(&self, slot: BufferSlot) -> usize

Number of commands recorded in slot.

Trait Implementations§

Source §

impl Default for DoubleBufferedSubmitter

Source §

fn default() -> Self

Returns the “default value” for a type. Read more

Auto Trait Implementations§

§

impl UnwindSafe for DoubleBufferedSubmitter

Blanket Implementations§

Source §

impl<T> Any for T
where T: 'static + ?Sized,

Source §

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

Source §

impl<T> Borrow<T> for T
where T: ?Sized,

Source §

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

Source §

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source §

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

Mutably borrows from an owned value. Read more

Source §

impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source §

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source §

impl<T> Downcast<T> for T

Source §

fn downcast(&self) -> &T

Source §

impl<T> From<T> for T

Source §

fn from(t: T) -> T

Returns the argument unchanged.

Source §

impl<T> Instrument for T

Source §

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

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more

Source §

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more

Source §

impl<T, U> Into for T
where U: From<T>,

Source §

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source §

impl<T> IntoEither for T

Source §

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

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more

Source §

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

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more

Source §