Skip to main content

WlCapture

Struct WlCapture 

Source
pub struct WlCapture {
Show 24 fields pub settings: RustCaptureSettings, pub callback: Option<Arc<Py<PyAny>>>, pub video_encoder: Option<GpuEncoder>, pub vaapi_state: StripeState, pub recording_sink: Option<Arc<RecordingSink>>, pub deliver_tx: Option<SyncSender<Vec<EncodedStripe>>>, pub deliver_join: Option<JoinHandle<()>>, pub deliver_discard: Option<Arc<AtomicBool>>, pub pending_hw_delivery: Option<Vec<EncodedStripe>>, pub pending_hw_damage: bool, pub encode_pool: Option<Arc<WlFramePool>>, pub encode_join: Option<JoinHandle<Option<GpuEncoder>>>, pub encode_controls: Arc<WlEncodeControls>, pub encode_stats: Arc<WlEncodeStats>, pub pool_last_render: Vec<u64>, pub render_seq: u64, pub pool_content_gen: Vec<u64>, pub content_gen: u64, pub frame_counter: u16, pub pending_force_idr: bool, pub needs_full_render: bool, pub last_tick: Option<Instant>, pub hw_error_streak: u32, pub hw_rebuilt: bool,
}
Expand description

One capture pipeline bound to one output (display id): its settings, encoder set, frame pools, delivery thread, and per-stream bookkeeping. Exactly one capture may run per output; all fields mirror the pipeline strategy documented on AppState, instantiated per display.

Fields§

§settings: RustCaptureSettings§callback: Option<Arc<Py<PyAny>>>

The Python frame callback, shared with the delivery thread. Kept here so a reconfigure the calloop performs on its own (a host that kept a different mode) can respawn delivery with the same consumer; None for a recorder-owned capture.

§video_encoder: Option<GpuEncoder>

Zero-copy GPU session (GLES render + same-GPU dmabuf encode), calloop-affine; None whenever a readback path is active for this display.

§vaapi_state: StripeState§recording_sink: Option<Arc<RecordingSink>>§deliver_tx: Option<SyncSender<Vec<EncodedStripe>>>§deliver_join: Option<JoinHandle<()>>§deliver_discard: Option<Arc<AtomicBool>>

Raised at teardown so the deliver thread stops calling into Python and only drains: its exit is then bounded by the one in-flight callback.

§pending_hw_delivery: Option<Vec<EncodedStripe>>§pending_hw_damage: bool§encode_pool: Option<Arc<WlFramePool>>§encode_join: Option<JoinHandle<Option<GpuEncoder>>>§encode_controls: Arc<WlEncodeControls>§encode_stats: Arc<WlEncodeStats>§pool_last_render: Vec<u64>§render_seq: u64§pool_content_gen: Vec<u64>§content_gen: u64§frame_counter: u16§pending_force_idr: bool§needs_full_render: bool§last_tick: Option<Instant>

Last tick this capture actually rendered; paces per-display fps under the one shared render timer (which fires at the fastest active capture’s rate).

§hw_error_streak: u32

Consecutive zero-copy encode failures; reset by any frame that encodes cleanly. Reaching HW_ERROR_RECOVERY_THRESHOLD triggers recovery.

§hw_rebuilt: bool

Whether the zero-copy session has already been rebuilt without a clean frame since. Recovery rebuilds once and demotes to readback on the next streak, so a session that constructs but never encodes cannot loop rebuilding forever.

Implementations§

Source§

impl WlCapture

Source

pub fn request_idr(&mut self)

Arm a keyframe on whichever path is live, plus a full render so a static screen still produces the frame. Exactly ONE flag is set: the pool encode loop consumes the atomic, every other path consumes pending_force_idr — setting both would leave one armed forever (the host-mode idle gate polls them every tick, so a stuck flag disables idle skipping for the session).

Auto Trait Implementations§

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.
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> Same for T

Source§

type Output = T

Should always be Self
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> Ungil for T
where T: Send,

§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

§

fn vzip(self) -> V

§

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