Skip to main content

SpirVFunction

Struct SpirVFunction 

Source
pub struct SpirVFunction {
    pub id: u32,
    pub return_type_id: u32,
    pub function_type_id: u32,
    pub name: Option<String>,
    pub params: Vec<(u32, u32)>,
    pub blocks: Vec<SpirVBasicBlock>,
    pub is_entry_point: bool,
    pub execution_model: Option<ExecutionModel>,
}
Expand description

A SPIR-V function definition.

Fields§

§id: u32

Function result ID

§return_type_id: u32

Function return type ID

§function_type_id: u32

Function type ID (full signature)

§name: Option<String>

Debug name (from OpName)

§params: Vec<(u32, u32)>

Parameter IDs (one per OpFunctionParameter)

§blocks: Vec<SpirVBasicBlock>

Basic blocks (first is entry block)

§is_entry_point: bool

Whether this is an entry point

§execution_model: Option<ExecutionModel>

Execution model (if entry point)

Implementations§

Source§

impl SpirVFunction

Source

pub fn new( id: u32, name: Option<String>, return_type_id: u32, function_type_id: u32, ) -> Self

Create a new function.

Source

pub fn add_param(&mut self, param_id: u32, type_id: u32)

Add a parameter (param_id, type_id).

Source

pub fn add_block(&mut self, block: SpirVBasicBlock)

Add a basic block.

Source

pub fn set_entry_point(&mut self, model: ExecutionModel)

Mark as an entry point.

Source

pub fn emit_text(&self) -> String

Emit the function as SPIR-V assembly text.

Source

pub fn total_instrs(&self) -> usize

Get the number of instructions across all blocks.

Trait Implementations§

Source§

impl Clone for SpirVFunction

Source§

fn clone(&self) -> SpirVFunction

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for SpirVFunction

Source§

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

Formats the value using the given formatter. Read more

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<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> 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 = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

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.