Struct ProgramFacts 

pub struct ProgramFacts {
    pub name: String,
    pub hash: Option<String>,
    pub stage: Stage,
    pub shader: Option<Entity>,
    pub instruction_count: Option<InstructionCount>,
    pub inputs: Vec<Varying>,
    pub resources: Vec<ProgramResourceFacts>,
    pub outputs: Vec<OutputBinding>,
    pub surface: Surface,
    pub not_lifted: Option<String>,
}

core.program_facts: a resolver’s measured facts about one program, what it reads and writes and how large it is, also stored on the program entity for reuse across materials.

Fields

name: String

The name the consumer knows the program by.

hash: Option<String>

The sha256: hash of the program’s bytes, as Provenance::source_hash gives it; None when the program was not read.

stage: Stage

The stage the program runs in.

shader: Option<Entity>

The consumer’s handle to the program; None until ProgramFacts::bound is called.

instruction_count: Option<InstructionCount>

The program’s size, or None for a program that was not lifted or whose lifter does not count.

inputs: Vec<Varying>

Used signature elements, including the original register/mask provenance. Not a guess from semantic names.

resources: Vec<ProgramResourceFacts>

Resource declarations retain names/register/space, not layouts or bytecode. Not a resource liveness claim.

outputs: Vec<OutputBinding>

The roles of the program’s outputs; empty until ProgramFacts::bound is called.

surface: Surface

The outputs read by their roles as a lit surface; the default surface until ProgramFacts::bound is called.

not_lifted: Option<String>

A program that was not found/selected/lifted has a reason, never a zero instruction count.

Implementations

impl ProgramFacts

pub fn lifted( name: impl Into<String>, stage: Stage, hash: Option<String>, instruction_count: Option<InstructionCount>, interface: &Interface, ) -> Self

The facts of a lifted program, named name, of its stage, the hash of its bytes, its instruction count and its interface (the inputs it uses and the source address of each resource); no output roles until ProgramFacts::bound. Nothing is parsed or lifted again.

pub fn unavailable( name: impl Into<String>, stage: Stage, hash: Option<String>, reason: impl Into<String>, ) -> Self

The facts of a program that has none: no inputs, resources, outputs or instruction count, and reason in not_lifted.

pub fn bound(self, shader: Entity, outputs: &[OutputBinding]) -> Self

Output roles are resolved after the lift; the surface is always the shared reading (Surface::read).

Trait Implementations

impl Clone for ProgramFacts

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 ProgramFacts

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

const GEOMETRY: Geometry = 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 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 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 verify(&self, _e: Entity, _w: &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 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.

const VERSION: u32 = 1

Schema version of the component’s content. Bump it when the meaning or layout of a field changes.

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 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 ProgramFacts

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

Formats the value using the given formatter.

impl PartialEq for ProgramFacts

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for ProgramFacts

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 ProgramFacts