Struct Poller

pub(crate) struct Poller {
    work_count: Arc<AtomicUsize>,
    is_done: Arc<AtomicBool>,
    handle: Option<JoinHandle<()>>,
    lock: Arc<Mutex<()>>,
}

Polls devices while there is something to poll.

This objects corresponds to a thread that parks itself when there is no work, waiting on it, and then calls poll_all_devices repeatedly to block.

The thread dies when this object is dropped, and all work in submission is done.

Example

let token = self.poller.token(); // create a new token
let callback = SubmittedWorkDoneClosure::from_rust(Box::from(move || {
   drop(token); // drop token as closure has been fired
   // ...
}));
let result = gfx_select!(queue_id => global.queue_on_submitted_work_done(queue_id, callback));
self.poller.wake(); // wake poller thread to actually poll

Fields

work_count: Arc<AtomicUsize>

The number of closures that still needs to be fired. When this is 0, the thread can park itself.

is_done: Arc<AtomicBool>

True if thread should die after all work in submission is done

handle: Option<JoinHandle<()>>

Handle to the WGPU poller thread (to be used for unparking the thread)

lock: Arc<Mutex<()>>

Lock for device maintain calls (in poll_all_devices and queue_submit)

This is workaround for wgpu deadlocks: https://github.com/gfx-rs/wgpu/issues/5572

Implementations

impl Poller

pub(crate) fn new(global: Arc<Global>) -> Self

pub(crate) fn token(&self) -> WorkToken

Creates a token of work

pub(crate) fn wake(&self)

Wakes the poller thread to start polling.

pub(crate) fn lock(&self) -> MutexGuard<'_, ()>

Lock for device maintain calls (in poll_all_devices and queue_submit)

Trait Implementations

impl Debug for Poller

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Drop for Poller

fn drop(&mut self)

Executes the destructor for this type.