Struct spirq::Manifest

pub struct Manifest { /* fields omitted */ }

A set of information used to describe variable typing and routing.

Implementations

impl Manifest

pub fn merge(&mut self, other: &Manifest) -> Result<()>

Merge metadata records in another manifest into the current one. If the type bound to a interface location, a descriptor binding point or an offset position in push constant block mismatches, the merge will fail and the self manifest will be corrupted.

pub fn merge_pipe(
    &mut self,
    other: &Manifest,
    replace_in: bool,
    replace_out: bool
) -> Result<()>

Similar to merge but optionally the current input interface variables can be kept alive, and the output interface variables can be cleared and replaced with entries in other; and names are all discarded. This can be used to merge pipeline stages.

pub fn get_var<'a>(&'a self, locator: Locator) -> Option<&'a Variable>

pub fn get_push_const<'a>(&'a self) -> Option<&'a Type>

Get the push constant type.

pub fn get_input<'a>(&'a self, location: InterfaceLocation) -> Option<&'a Type>

Get the input interface variable type.

pub fn get_output<'a>(&'a self, location: InterfaceLocation) -> Option<&'a Type>

Get the output interface variable type.

pub fn get_desc<'a>(
    &'a self,
    desc_bind: DescriptorBinding
) -> Option<&'a DescriptorType>

Get the descriptor type at the given descriptor binding point.

pub fn get_var_name<'a>(&'a self, locator: Locator) -> Option<&'a str>

pub fn get_push_const_name<'a>(&'a self) -> Option<&'a str>

Get the name that also refers to the push constant block.

pub fn get_input_name<'a>(
    &'a self,
    location: InterfaceLocation
) -> Option<&'a str>

Get the name that also refers to the input at the given location.

pub fn get_output_name<'a>(
    &'a self,
    location: InterfaceLocation
) -> Option<&'a str>

Get the name that also refers to the output at the given location.

pub fn get_desc_name<'a>(
    &'a self,
    desc_bind: DescriptorBinding
) -> Option<&'a str>

Get the name that also refers to the descriptor at the given descriptor binding.

pub fn get_desc_access(
    &self,
    desc_bind: DescriptorBinding
) -> Option<AccessType>

Get the valid access patterns of the descriptor at the given binding point. Currently only storage buffers and storage images can be accessed by write.

Note that the returned access type is the nominal access type declared in SPIR-V. If a storage image is declared as ReadWrite but is only accessed by write, it is still considered a ReadWrite descriptor.

pub fn resolve_input<S: AsRef<Sym>>(
    &self,
    sym: S
) -> Option<InterfaceVariableResolution<'_>>

Get the metadata of a input variable identified by a symbol.

pub fn resolve_output<S: AsRef<Sym>>(
    &self,
    sym: S
) -> Option<InterfaceVariableResolution<'_>>

Get the metadata of a output variable identified by a symbol.

pub fn resolve_desc<S: AsRef<Sym>>(
    &self,
    sym: S
) -> Option<DescriptorResolution<'_>>

Get the metadata of a descriptor variable identified by a symbol. If the exact variable cannot be resolved, the descriptor part of the resolution will still be returned, if possible.

pub fn resolve_push_const<S: AsRef<Sym>>(
    &self,
    sym: S
) -> Option<PushConstantResolution<'_>>

Get the metadata of a descriptor variable identified by a symbol. If the exact variable cannot be resolved, the descriptor part of the resolution will still be returned, if possible.

pub fn vars<'a>(&'a self) -> impl Iterator<Item = &'a Variable>

pub fn inputs<'a>(
    &'a self
) -> impl Iterator<Item = InterfaceVariableResolution<'a>>

List all input locations.

pub fn outputs<'a>(
    &'a self
) -> impl Iterator<Item = InterfaceVariableResolution<'a>>

List all output locations in this manifest.

pub fn descs<'a>(&'a self) -> impl Iterator<Item = DescriptorResolution<'a>>

List all descriptors in this manifest. In case of a descriptor pointing to a buffer block, the outermost structure type will be filled in member_var_res.

Trait Implementations

impl Clone for Manifest

fn clone(&self) -> Manifest

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Default for Manifest

fn default() -> Manifest

Returns the “default value” for a type.