Struct LayeredMaterial 

pub struct LayeredMaterial {
    pub layers: Vec<Option<Layer>>,
    pub weights: LayerWeights,
}

One to four ordered material slots. A null slot contributes black without redistributing its weight. Referenced materials must not themselves be layered. Consumers validate each referenced entity’s material dialect; core checks entity existence and disallows nested blends independently of dialect.

A pbr.material on the same entity is its host, as for pbr.detail: it states the material’s alpha mode and sidedness, which the blend does not, and it is the complete material for every target that does not draw the blend. A consumer that draws the blend draws the layers with the host’s alpha mode and sidedness. A layered material without a host is not drawn with a default a writer picks: the writer leaves it out and reports it, and a program that wants it drawn states a pass that gives it a pbr.material.

Fields

layers: Vec<Option<Layer>>

weights: LayerWeights

Implementations

impl LayeredMaterial

pub fn per_pixel(&self) -> bool

Whether a consumer must evaluate anything per pixel beyond interpolating one vertex attribute and summing the layers’ colours as their materials give them: its weights’ (LayerWeights::per_pixel), or a layer’s colour (Layer::color).

pub fn vertex_weight_blocker(&self) -> Option<&'static str>

What of it a consumer that blends by vertex weights alone (one interpolated attribute, the layers’ colours summed as their materials give them) cannot draw, named; None where it can draw all of it. A bake of the weights to a vertex stream (bake-layer-channels) removes the first two; a saturated blend and a layer’s colour have no vertex-weight form.

pub fn reads(&self, semantic: Semantic) -> bool

Whether its weights read vertex stream semantic: the attribute, or with per-pixel channels a vertex source; or a height a vertex source.

pub fn mask_textures(&self) -> impl Iterator<Item = &TextureRef>

The mask textures its channels and heights sample.

Trait Implementations

impl Clone for LayeredMaterial

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Component for LayeredMaterial

const VERSION: u32 = 7

2: per-pixel channels and the composition; 3: each mask texture’s filters; 4: the height composition and its heights; 5: bounded product channels; 6: expression channels, and a threshold saturating NaN to 0; 7: a layer’s color and the weights’ saturate.

const NAME: &'static str = "core.layered"

const GEOMETRY: Geometry = crate::Geometry::None

What the value holds of its entity’s mesh primitives and vertices (Geometry). Stated by every component, with no default, so data that describes a mesh can’t be left behind by an edit of it unawares: the World’s edit paths take it from there.

fn references(&self, out: &mut Vec<Entity>)

The entities this component refers to (a prototype, materials, textures), appended to out: the edges World::closure follows. A component holding entity references must declare every one of them.

fn to_json(&self) -> Result<Option<Value>, JsonError>

The component as JSON, for glTF extras, the debug text form and golden tests; Ok(None) for components that are not shown (bulk data, handles). The view must never lose a value: components that can be shown derive serde::Serialize and return crate::json::to_value(self).map(Some), which refuses non-finite floats instead of writing them as null.

fn verify(&self, entity: Entity, world: &World) -> Result<(), String>

The component’s own invariants on entity e (indices in range, stream lengths equal, …). The pass manager runs it on every component after the reader, after every pass and before the writer, together with the world’s own check that every entity of Component::references is alive. World-wide rules (one name -> one payload) are pass::Validators instead.

fn payload_bytes(&self) -> u64

The bytes of bulk payload the value holds (vertex streams and indices, texture levels, triangle soups), for memory reports: element counts times element sizes, not allocated capacity. 0 for small components.

fn remap_primitives(&self, _from: &[usize]) -> Option<Result<Self, String>>

The component after its entity’s mesh primitives were rebuilt, for a component that holds something per primitive (Geometry::PerPrimitive, Geometry::PerVertex): new primitive i comes from old primitive from[i] (a source may repeat, when a primitive is split, or be absent, when one is dropped). Such a component always answers (a value holding nothing per primitive answers with itself); None, the default, is for components of Geometry::None, and World::remap_primitives refuses a dependent component that gives it. An index the component does not have is an error. remap_list does the work for a list with one entry per primitive.

fn remap_vertices( &self, _primitive: usize, _from: &[u32], ) -> Option<Result<Self, String>>

The component after the vertices of its entity’s mesh primitive primitive were compacted or reordered, for a component that holds something per vertex (Geometry::PerVertex): new vertex i of that primitive is old vertex from[i] (a source may repeat or be absent). Such a component always answers (with itself when it holds nothing for that primitive); None, the default, is for the others, and World::remap_vertices refuses a per-vertex component that gives it. An index the component does not have is an error. Every pass that compacts or reorders a primitive’s vertices calls World::remap_vertices. After a rebuild of the primitive list (World::rebuild_primitives, Component::remap_primitives) a primitive’s per-vertex data is its source primitive’s, and the vertex map is relative to that source.

fn blend_vertices( &self, _primitive: usize, _from: &[VertexBlend], ) -> Option<Result<Self, String>>

The component after the vertices of its entity’s mesh primitive primitive were rebuilt as blends of old ones (VertexBlend), for a component that holds something per vertex (Geometry::PerVertex): new vertex i is the combination from[i] of old vertices, in whatever way the component’s data combines (a morph target’s delta is interpolated, the way the surface it moves is). It answers as Component::remap_vertices does: with itself when it holds nothing for that primitive; None, the default, is for a component that does not know how to combine its data, and World::blend_vertices refuses a per-vertex component that gives it. An index the component does not have is an error. A vertex that is a copy of one old vertex (VertexBlend::copy) is the case Component::remap_vertices states, and a component answering one answers the other alike.

fn apply_linear(&self, _l: &Linear) -> Linearity<Self>

The component after its entity’s local space was mapped by l (a pass that bakes a placement’s mirror or shear into a copy of its geometry, so transforms stay rigid). World::apply_linear calls it for every component of the entity. The default is Linearity::Unsupported: a component that holds local-space geometry and does not say how it follows is never silently left behind; one without geometry says Linearity::Invariant.

fn restate(&self, _resolved: &Resolved<'_>) -> Restated<Self>

The component after resolve-state (crate::state::ResolveState) gave the axes in resolved their values: a component that holds crate::state::Clauses of its own (a record of parts each present in some states) reduces them as core.condition is reduced (crate::state::Resolved::reduce: a clause that fails is dropped, a clause left with no literal holds whatever the other axes are). Restated::Absent says the entity is not present in this state (every clause failed): it is despawned as one whose core.condition fails is. The default holds no clause: Restated::Unchanged.

impl Debug for LayeredMaterial

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

Formats the value using the given formatter.

impl PartialEq for LayeredMaterial

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for LayeredMaterial

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for LayeredMaterial