Struct SpirvBuilder

pub struct SpirvBuilder {

    pub path_to_crate: Option<PathBuf>,
    pub print_metadata: MetadataPrintout,
    pub release: bool,
    pub target: Option<String>,
    pub shader_crate_features: ShaderCrateFeatures,
    pub deny_warnings: bool,
    pub multimodule: bool,
    pub spirv_metadata: SpirvMetadata,
    pub capabilities: Vec<Capability>,
    pub extensions: Vec<String>,
    pub extra_args: Vec<String>,
    pub rustc_codegen_spirv_location: Option<PathBuf>,
    pub toolchain_overwrite: Option<String>,
    pub toolchain_rustc_version: Option<Version>,
    pub path_to_target_spec: Option<PathBuf>,
    pub target_dir_path: Option<String>,
    pub shader_panic_strategy: ShaderPanicStrategy,
    pub validator: ValidatorOptions,
    pub optimizer: OptimizerOptions,
}

Fields

path_to_crate: Option<PathBuf>

print_metadata: MetadataPrintout

Whether to print build.rs cargo metadata (e.g. cargo:rustc-env=var=val). Defaults to MetadataPrintout::None. Within build scripts, set it to MetadataPrintout::DependencyOnly or MetadataPrintout::Full to ensure the build script is rerun on code changes.

release: bool

Build in release. Defaults to true.

target: Option<String>

The target triple, eg. spirv-unknown-vulkan1.2

shader_crate_features: ShaderCrateFeatures

Cargo features specification for building the shader crate.

deny_warnings: bool

Deny any warnings, as they may never be printed when building within a build script. Defaults to false.

multimodule: bool

Splits the resulting SPIR-V file into one module per entry point. This is useful in cases where ecosystem tooling has bugs around multiple entry points per module - having all entry points bundled into a single file is the preferred system.

spirv_metadata: SpirvMetadata

Sets the level of metadata (primarily OpName and OpLine) included in the SPIR-V binary. Including metadata significantly increases binary size.

capabilities: Vec<Capability>

Adds a capability to the SPIR-V module. Checking if a capability is enabled in code can be done via #[cfg(target_feature = "TheCapability")].

extensions: Vec<String>

Adds an extension to the SPIR-V module. Checking if an extension is enabled in code can be done via #[cfg(target_feature = "ext:the_extension")].

extra_args: Vec<String>

Set additional “codegen arg”. Note: the RUSTGPU_CODEGEN_ARGS environment variable takes precedence over any set arguments using this function.

rustc_codegen_spirv_location: Option<PathBuf>

toolchain_overwrite: Option<String>

toolchain_rustc_version: Option<Version>

path_to_target_spec: Option<PathBuf>

The path of the “target specification” file.

For more info on “target specification” see this RFC.

target_dir_path: Option<String>

Set the target dir path within ./target to use for building shaders. Defaults to spirv-builder, resulting in the path ./target/spirv-builder.

shader_panic_strategy: ShaderPanicStrategy

Change the shader panic! handling strategy (see ShaderPanicStrategy).

validator: ValidatorOptions

spirv-val flags

optimizer: OptimizerOptions

spirv-opt flags

Implementations

impl SpirvBuilder

pub fn new(path_to_crate: impl AsRef<Path>, target: impl Into<String>) -> Self

pub fn target_spec(self, p: impl AsRef<Path>) -> Self

Sets the path of the “target specification” file.

For more info on “target specification” see this RFC.

pub fn print_metadata(self, v: MetadataPrintout) -> Self

Whether to print build.rs cargo metadata (e.g. cargo:rustc-env=var=val). Defaults to MetadataPrintout::Full.

pub fn deny_warnings(self, v: bool) -> Self

pub fn release(self, v: bool) -> Self

Build in release. Defaults to true.

pub fn multimodule(self, v: bool) -> Self

Splits the resulting SPIR-V file into one module per entry point. This is useful in cases where ecosystem tooling has bugs around multiple entry points per module - having all entry points bundled into a single file is the preferred system.

pub fn spirv_metadata(self, v: SpirvMetadata) -> Self

Sets the level of metadata (primarily OpName and OpLine) included in the SPIR-V binary. Including metadata significantly increases binary size.

pub fn capability(self, capability: Capability) -> Self

Adds a capability to the SPIR-V module. Checking if a capability is enabled in code can be done via #[cfg(target_feature = "TheCapability")].

pub fn extension(self, extension: impl Into<String>) -> Self

Adds an extension to the SPIR-V module. Checking if an extension is enabled in code can be done via #[cfg(target_feature = "ext:the_extension")].

pub fn shader_panic_strategy( self, shader_panic_strategy: ShaderPanicStrategy, ) -> Self

Change the shader panic! handling strategy (see ShaderPanicStrategy).

pub fn relax_struct_store(self, v: bool) -> Self

Allow store from one struct type to a different type with compatible layout and members.

pub fn relax_logical_pointer(self, v: bool) -> Self

Allow allocating an object of a pointer type and returning a pointer value from a function in logical addressing mode

pub fn relax_block_layout(self, v: bool) -> Self

Enable VK_KHR_relaxed_block_layout when checking standard uniform, storage buffer, and push constant layouts. This is the default when targeting Vulkan 1.1 or later.

pub fn uniform_buffer_standard_layout(self, v: bool) -> Self

Enable VK_KHR_uniform_buffer_standard_layout when checking standard uniform buffer layouts.

pub fn scalar_block_layout(self, v: bool) -> Self

Enable VK_EXT_scalar_block_layout when checking standard uniform, storage buffer, and push constant layouts. Scalar layout rules are more permissive than relaxed block layout so in effect this will override the –relax-block-layout option.

pub fn skip_block_layout(self, v: bool) -> Self

Skip checking standard uniform/storage buffer layout. Overrides any –relax-block-layout or –scalar-block-layout option.

pub fn preserve_bindings(self, v: bool) -> Self

Preserve unused descriptor bindings. Useful for reflection.

pub fn extra_arg(self, arg: impl Into<String>) -> Self

Set additional “codegen arg”. Note: the RUSTGPU_CODEGEN_ARGS environment variable takes precedence over any set arguments using this function.

pub fn shader_crate_default_features(self, default_features: bool) -> Self

Set –default-features for the target shader crate.

pub fn shader_crate_features( self, features: impl IntoIterator<Item = String>, ) -> Self

Set –features for the target shader crate.

pub fn rustc_codegen_spirv_location( self, path_to_dylib: impl AsRef<Path>, ) -> Self

pub fn target_dir_path(self, name: impl Into<String>) -> Self

Set the target dir path within ./target to use for building shaders. Defaults to spirv-builder, resulting in the path ./target/spirv-builder.

pub fn build(&self) -> Result<CompileResult, SpirvBuilderError>

Builds the module. If print_metadata is MetadataPrintout::Full, you usually don’t have to inspect the path in the result, as the environment variable for the path to the module will already be set.

Trait Implementations

impl Clone for SpirvBuilder

fn clone(&self) -> SpirvBuilder

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for SpirvBuilder

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

Formats the value using the given formatter.

impl Default for SpirvBuilder

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for SpirvBuilder

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for SpirvBuilder

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.