Skip to main content

OutputParamsWatch

Struct OutputParamsWatch 

Source
pub struct OutputParamsWatch { /* private fields */ }
Expand description

Consumer-side helper for the Decoder::output_params / Decoder::output_params_generation contract: folds the decoder’s output description into a stream’s CodecParameters once, and again only when the decoder signals a mid-stream change — one integer compare per frame otherwise.

Call observe after every successful receive_frame (the first call always reads the description; later calls re-read only when the generation moved). Call prime before the first frame when the shape is needed up front (to size a renderer, pick a converter); it merges whatever the decoder already knows without consuming the first-frame read, since the description may still be refined up to the first frame.

fn pump(dec: &mut dyn Decoder, stream: &mut CodecParameters) -> oxideav_core::Result<()> {
    let mut watch = OutputParamsWatch::new();
    while let Ok(_frame) = dec.receive_frame() {
        if watch.observe(&*dec, stream) {
            // shape changed (or was first resolved): reconfigure
            // the converter / renderer from `stream` here.
        }
    }
    Ok(())
}

Implementations§

Source§

impl OutputParamsWatch

Source

pub const fn new() -> Self

A watch that has not read the decoder yet.

Source

pub fn observe<D: Decoder + ?Sized>( &mut self, decoder: &D, stream: &mut CodecParameters, ) -> bool

Call after a successful receive_frame. Re-reads Decoder::output_params on the first call and whenever Decoder::output_params_generation differs from the value of the last read, merging it into stream through CodecParameters::merge_output_params. Returns true when that changed an output-describing field of stream.

A decoder that still answers None leaves stream untouched and is asked again on the next call.

Source

pub fn prime<D: Decoder + ?Sized>( &self, decoder: &D, stream: &mut CodecParameters, ) -> bool

Merge what the decoder already knows into stream without recording a read — for use before the first frame. Returns true when an output-describing field of stream changed.

Source

pub fn reset(&mut self)

Forget the last read so the next observe re-reads unconditionally (e.g. after swapping the decoder).

Trait Implementations§

Source§

impl Clone for OutputParamsWatch

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl Copy for OutputParamsWatch

Source§

impl Debug for OutputParamsWatch

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for OutputParamsWatch

Source§

fn default() -> Self

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

impl Eq for OutputParamsWatch

Source§

impl PartialEq for OutputParamsWatch

Source§

fn eq(&self, other: &Self) -> bool

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for OutputParamsWatch

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

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

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> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

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

Source§

type Error = !

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

fn try_from(value: U) -> Result<T, !>

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.