Skip to main content

OutputLayer

Struct OutputLayer 

Source
#[non_exhaustive]
pub struct OutputLayer {
Show 13 fields pub handle: String, pub variable_name: Option<String>, pub variable_source: String, pub layer_name: Option<String>, pub layer_type: String, pub scalar_format: String, pub with_alpha: bool, pub dithering: bool, pub filter: String, pub filter_width: f64, pub color_profile: Option<String>, pub sort_key: Option<i32>, pub drivers: Vec<String>,
}
Expand description

One AOV, resolved: what to output, how to encode it, and where it goes.

Every field but handle and drivers is an outputlayer attribute, with the specification’s default already applied – variablesource “shader”, layertype “color”, scalarformat “uint8”, filter “blackman-harris”, filterwidth 3.0, withalpha and dithering off. A backend that re-derives these gets them subtly wrong: the defaults are stated once in the specification and nowhere in the scene, so a layer that sets none of them still means “a uint8 colour from a shader closure”.

Fields (Non-exhaustive)§

This struct is marked as non-exhaustive
Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.
§handle: String

The outputlayer node’s handle.

§variable_name: Option<String>

The variable to output. None when the layer does not name one, which is a scene error rather than a default.

§variable_source: String

Where the variable is read from: "shader", "attribute" or "builtin". Defaults to "shader".

§layer_name: Option<String>

The layer’s name as the driver writes it – the layer name inside an EXR, say. None when unset; ɴsɪ gives no default, so a driver picks its own.

§layer_type: String

"scalar", "color", "vector" or "quad". Defaults to "color".

§scalar_format: String

The quantisation: "uint8" through "float". Defaults to "uint8", which surprises a backend expecting float AOVs.

§with_alpha: bool

Whether an alpha channel is included. Defaults to false.

§dithering: bool

Whether integer scalars are dithered. Defaults to false.

§filter: String

The reconstruction filter. Defaults to "blackman-harris".

§filter_width: f64

The filter’s diameter in pixels. Defaults to 3.0, and ɴsɪ says it is not applied for "box" or "zmin".

§color_profile: Option<String>

An ᴏᴄɪᴏ colour profile to apply before quantisation, if set.

§sort_key: Option<i32>

The ordering key among layers on one driver, if set.

See drivers: this crate applies it rather than leaving it to the backend.

§drivers: Vec<String>

A layer may fan out to several drivers – a file and a display, say.

In connection order. ɴsɪ orders layers on a driver by sortkey, not drivers on a layer, so this stays as connected.

Trait Implementations§

Source§

impl Clone for OutputLayer

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 OutputLayer

Source§

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

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

impl PartialEq for OutputLayer

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 OutputLayer

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<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

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> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

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.