Skip to main content

PassDescriptor

Struct PassDescriptor 

Source
pub struct PassDescriptor {
    pub clear: Option<[f32; 4]>,
    pub samples: u32,
    pub viewport: Option<PassViewport>,
}
Expand description

How a pass is configured, beyond the draws themselves.

Grouped rather than passed as loose parameters so later pass-level state — stencil, depth, damage regions — extends this without changing every backend’s signature.

Fields§

§clear: Option<[f32; 4]>

Clear to this color first, or preserve the target’s contents.

§samples: u32

MSAA sample count. 1 disables multisampling.

Rendering is multisampled and resolved into the target, so the target itself stays single-sampled and directly readable.

§viewport: Option<PassViewport>

Where this pass’s clip space lands in the target, if not the whole of it.

None maps clip space onto the target exactly, which is what every pass wants whose geometry was recorded against the target it renders into. A pass whose geometry was recorded against a larger space sets this to crop instead of scale — see PassViewport.

Implementations§

Source§

impl PassDescriptor

Source

pub fn clear(color: [f32; 4]) -> Self

Source

pub fn with_viewport(self, viewport: PassViewport) -> Self

Land this pass’s clip space on part of the target rather than all of it.

Source

pub fn preserve() -> Self

Source

pub fn with_samples(self, samples: u32) -> Self

Source

pub fn is_multisampled(&self) -> bool

Trait Implementations§

Source§

impl Clone for PassDescriptor

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 PassDescriptor

Source§

impl Debug for PassDescriptor

Source§

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

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

impl Default for PassDescriptor

Source§

fn default() -> Self

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

impl PartialEq for PassDescriptor

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 PassDescriptor

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.