Struct SpirVModule 

pub struct SpirVModule {

    pub version: u32,
    pub generator: u32,
    pub bound: u32,
    pub capabilities: Vec<SpirVCapability>,
    pub extensions: Vec<String>,
    pub ext_inst_imports: HashMap<String, u32>,
    pub memory_model: (AddressingModel, MemoryModel),
    pub entry_points: Vec<(ExecutionModel, u32, String, Vec<u32>)>,
    pub execution_modes: Vec<(u32, ExecutionMode)>,
    pub debug_names: HashMap<u32, String>,
    pub decorations: HashMap<u32, Vec<Decoration>>,
    pub types: Vec<SpirVInstruction>,
    pub constants: Vec<SpirVInstruction>,
    pub global_vars: Vec<SpirVInstruction>,
    pub functions: Vec<SpirVFunction>,
}

A complete SPIR-V module.

Contains all declarations required to produce a valid SPIR-V binary: capabilities, extensions, memory model, entry points, type declarations, global variables, constants, and function bodies.

Fields

version: u32

SPIR-V version (encoded as major<<16 | minor<<8)

generator: u32

Generator magic number

bound: u32

Bound (next available ID)

capabilities: Vec<SpirVCapability>

Declared capabilities

extensions: Vec<String>

Extension strings

ext_inst_imports: HashMap<String, u32>

Extended instruction set imports (name -> id)

memory_model: (AddressingModel, MemoryModel)

Addressing and memory model

entry_points: Vec<(ExecutionModel, u32, String, Vec<u32>)>

Entry points: (execution_model, function_id, name, interface_vars)

execution_modes: Vec<(u32, ExecutionMode)>

Execution modes per entry point

debug_names: HashMap<u32, String>

Debug names (id -> name)

decorations: HashMap<u32, Vec<Decoration>>

Decorations (id -> list of decorations)

types: Vec<SpirVInstruction>

Type instructions (ordered by dependency)

constants: Vec<SpirVInstruction>

Constants

global_vars: Vec<SpirVInstruction>

Global variables

functions: Vec<SpirVFunction>

Function definitions

Implementations

impl SpirVModule

pub fn new() -> Self

Create a new empty SPIR-V module targeting SPIR-V 1.6.

pub fn fresh_id(&mut self) -> u32

Allocate a fresh ID.

pub fn add_capability(&mut self, cap: SpirVCapability)

Add a capability.

pub fn add_extension(&mut self, ext: impl Into<String>)

Add an extension.

pub fn import_ext_inst(&mut self, name: impl Into<String>) -> u32

Import an extended instruction set and return its ID.

pub fn add_entry_point( &mut self, model: ExecutionModel, func_id: u32, name: impl Into<String>, interface_vars: Vec<u32>, )

Add an entry point.

pub fn add_execution_mode(&mut self, func_id: u32, mode: ExecutionMode)

Add an execution mode for an entry point function.

pub fn set_name(&mut self, id: u32, name: impl Into<String>)

Assign a debug name to an ID.

pub fn decorate(&mut self, id: u32, decoration: Decoration)

Add a decoration to an ID.

pub fn add_type(&mut self, instr: SpirVInstruction)

Add a type instruction.

pub fn add_constant(&mut self, instr: SpirVInstruction)

Add a constant instruction.

pub fn add_global_var(&mut self, instr: SpirVInstruction)

Add a global variable.

pub fn add_function(&mut self, func: SpirVFunction)

Add a function definition.

pub fn emit_text(&self) -> String

Emit the module as SPIR-V assembly text.

pub fn estimate_word_count(&self) -> u32

Estimate the total word count of the module binary.

Trait Implementations

impl Clone for SpirVModule

fn clone(&self) -> SpirVModule

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SpirVModule

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

Formats the value using the given formatter.

impl Default for SpirVModule

fn default() -> Self

Returns the “default value” for a type.