Struct spirq::EntryPoint

pub struct EntryPoint {
    pub exec_model: ExecutionModel,
    pub name: String,
    pub manifest: Manifest,
    pub spec: Specialization,
}

Representing an entry point described in a SPIR-V.

Fields

exec_model: ExecutionModel

Entry point execution model.

name: String

Name of the entry point.

manifest: Manifest

Manifest object that contains input, output and descriptor type information.

spec: Specialization

Specialization description of the entry point.

Methods from Deref<Target = Manifest>

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_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 access pattern of the descriptor at the given descriptor binding.

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

fn clone(&self) -> EntryPoint

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for EntryPoint

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

Formats the value using the given formatter.

impl Deref for EntryPoint

type Target = Manifest

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.