Struct PwStream 

pub struct PwStream {
    core: Arc<PwCore>,
    stream: *mut c_void,
    shared: Arc<Shared>,
    _events: Box<PwStreamEvents>,
    _hook: Box<[u64; 8]>,
}

One output’s stream: the consumer end of a portal monitor stream.

Fields

core: Arc<PwCore>

stream: *mut c_void

shared: Arc<Shared>

_events: Box<PwStreamEvents>

_hook: Box<[u64; 8]>

Implementations

impl PwStream

pub(crate) fn connect( core: &Arc<PwCore>, node_id: u32, sink: FrameSink, cursor_tx: Sender<CursorJob>, cfg: StreamConfig, ) -> Result<Self, String>

Connect to the stream node node_id and start negotiating cfg; frames reach sink, cursor sprites cursor_tx.

pub fn reconfigure(&self, cfg: StreamConfig)

Offer a new configuration; unchanged asks cost nothing, a change renegotiates. A monitor stream’s size is its monitor’s whatever the consumer prefers, so once a format stands, a new preferred size alone is kept for later offers without renegotiating: a renegotiation drops the buffers in flight, and with them the cursor bitmap KWin sends once per change.

pub fn release(&self, generation: u64, slot: usize)

Return a published frame’s buffer to the compositor.

pub fn release_all(&self)

Return every held buffer (an idled output has no consumer for them).

pub fn set_active(&self, active: bool)

pub fn negotiated(&self) -> Option<Negotiated>

pub fn errored(&self) -> bool

pub fn frames(&self) -> u64

pub fn cursor_position(&self) -> Option<(i32, i32)>

The host cursor position the last cursor meta carried, in stream pixels.

pub fn wait_negotiated(&self, timeout: Duration) -> bool

Block up to timeout for the stream to reach a state where frames may flow.

Trait Implementations

impl Drop for PwStream

fn drop(&mut self)

Executes the destructor for this type.

fn pin_drop(self: Pin<&mut Self>)

🔬This is a nightly-only experimental API. (pin_ergonomics)

Execute the destructor for this type, but different to Drop::drop, it requires self to be pinned.

impl Send for PwStream