Skip to main content

PassDesc

Struct PassDesc 

Source
pub struct PassDesc {
    pub name: String,
    pub reads: Vec<ResourceId>,
    pub writes: Vec<ResourceId>,
    pub param_hash: u64,
    pub frame_pts: Option<i64>,
}
Expand description

Declaration of a pass: what it reads, what it writes, and what makes its output vary.

Fields§

§name: String

Human-readable name, for diagnostics.

§reads: Vec<ResourceId>

Resources this pass samples/reads.

§writes: Vec<ResourceId>

Resources this pass renders to/writes.

§param_hash: u64

A caller-defined hash of everything outside the graph topology that can affect this pass’s output.

Include the operation identity, every operation parameter, and a content generation for imported inputs. Omitting any of these can incorrectly reuse a stale output. PassDesc::frame_pts can represent the common case of a time-varying imported frame.

§frame_pts: Option<i64>

The presentation timestamp of a time-varying input (e.g. a decoded clip frame), if any. A pass with a frame_pts re-evaluates whenever it changes.

Implementations§

Source§

impl PassDesc

Source

pub fn new(name: impl Into<String>) -> Self

Start describing a pass.

Source

pub fn read(self, resource: ResourceId) -> Self

Declare that this pass reads resource.

Source

pub fn write(self, resource: ResourceId) -> Self

Declare that this pass writes resource.

Source

pub fn param_hash(self, hash: u64) -> Self

Set the caller-defined output identity hash for this pass.

This must change whenever the operation, one of its parameters, or imported content that it reads can change.

Source

pub fn frame_pts(self, pts: i64) -> Self

Set the time-varying frame PTS for this pass.

Trait Implementations§

Source§

impl Clone for PassDesc

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 Debug for PassDesc

Source§

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

Formats the value using the given formatter. Read more

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.