Skip to main content

WlFramePool

Struct WlFramePool 

Source
pub struct WlFramePool<B = Vec<u8>> {
    pub(crate) inner: Mutex<WlPoolInner<B>>,
    pub(crate) cv: Condvar,
    pub(crate) stop: AtomicBool,
}
Expand description

Render->encode handoff for the Wayland readback paths, mirroring the X11 FramePool’s single-slot non-dropping design with one deliberate difference: the calloop thread is also the compositor + input dispatcher, so it must NEVER block on the pool. try_begin hands out a buffer only while the publish slot is empty, so publish cannot block, and a saturated encoder throttles capture by SKIPPING ticks (compositor damage accumulates via buffer age, so nothing is lost). Every published frame is encoded, in order: the H.264 reference chain stays contiguous exactly as on X11.

The zero-copy session runs the same split on GPU buffers: the calloop composites into one of the pool’s render targets and publishes it, and the encode thread encodes it in place, so the compositor thread is free again as soon as the composite is.

Fields§

§inner: Mutex<WlPoolInner<B>>§cv: Condvar§stop: AtomicBool

Implementations§

Source§

impl WlFramePool<Vec<u8>>

Source

pub(crate) fn new(n: usize, buf_len: usize) -> Self

Pre-allocate all n capture buffers up front (each buf_len bytes, all initially free) so the steady-state render/encode loop hands buffers around without ever allocating on the hot path.

Source§

impl<B> WlFramePool<B>

Source

pub(crate) fn of(buffers: Vec<B>) -> Self

A pool of the buffers given, all initially free, numbered in order.

Source

pub(crate) fn try_begin(&self) -> Option<(usize, B)>

Calloop: reserve a buffer for the next render/readback, NON-blocking. None means the encoder is still behind (slot full or every buffer in flight) – skip this tick. Because the calloop is the only producer, a successful reservation guarantees the following publish finds the slot empty (the consumer only ever drains it).

Source

pub(crate) fn publish(&self, frame: WlFrame<B>)

Calloop: hand the filled buffer to the encode thread. Never blocks (see try_begin).

Source

pub(crate) fn cancel(&self, id: usize, buf: B)

Calloop: return an unused reservation (render failed, readback skipped).

Source

pub(crate) fn take(&self) -> Option<WlFrame<B>>

Encode: block until a frame is published (Some) or the pool shuts down (None). The wait is bounded, re-checking stop as defense-in-depth against a lost wakeup.

Source

pub(crate) fn recycle(&self, id: usize, buf: B)

Encode: return an encoded frame’s buffer so the calloop can capture into it again. No notify: the only waiter (take) waits on the slot, and try_begin never blocks.

Source

pub(crate) fn shutdown(&self)

Store stop under the lock so take() can’t check stop==false and then park after the notify already fired (lost wakeup); notify after unlocking.

Auto Trait Implementations§

§

impl<B = Vec<u8>> !Freeze for WlFramePool<B>

§

impl<B> RefUnwindSafe for WlFramePool<B>

§

impl<B> Send for WlFramePool<B>
where B: Send,

§

impl<B> Sync for WlFramePool<B>
where B: Send,

§

impl<B> Unpin for WlFramePool<B>
where B: Unpin,

§

impl<B> UnsafeUnpin for WlFramePool<B>
where B: UnsafeUnpin,

§

impl<B> UnwindSafe for WlFramePool<B>

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
§

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

§

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

§

impl<T> Downcast for T
where T: Any,

§

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

Convert 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.
§

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

Convert Rc<Trait> (where Trait: Downcast) to Rc<Any>. Rc<Any> can then be further downcast into Rc<ConcreteType> where ConcreteType implements Trait.
§

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

Convert &Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &Any’s vtable from &Trait’s.
§

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

Convert &mut Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &mut Any’s vtable from &mut Trait’s.
§

impl<T> DowncastSync for T
where T: Any + Send + Sync,

§

fn into_any_arc(self: Arc<T>) -> Arc<dyn Any + Send + Sync> ⓘ

Convert Arc<Trait> (where Trait: Downcast) to Arc<Any>. Arc<Any> can then be further downcast into Arc<ConcreteType> where ConcreteType implements Trait.
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<T> Instrument for T

§

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

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

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<U> 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
§

impl<T> Pointable for T

§

const ALIGN: usize

The alignment of pointer.
§

type Init = T

The type for initializers.
§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

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

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
§

impl<T> WithSubscriber for T

§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> ⓘ
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a [WithDispatch] wrapper. Read more
§

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

Attaches the current default Subscriber to this type, returning a [WithDispatch] wrapper. Read more