Struct naga_oil::compose::Composer

source ·
pub struct Composer {
    pub validate: bool,
    pub module_sets: HashMap<String, ComposableModuleDefinition>,
    pub module_index: HashMap<usize, String>,
    pub capabilities: Capabilities,
    pub subgroup_stages: ShaderStages,
    /* private fields */
}
Expand description

module composer. stores any modules that can be imported into a shader and builds the final shader

Fields§

§validate: bool§module_sets: HashMap<String, ComposableModuleDefinition>§module_index: HashMap<usize, String>§capabilities: Capabilities§subgroup_stages: ShaderStages

The shader stages that the subgroup operations are valid for. Used when creating a validator for the module. See https://github.com/gfx-rs/wgpu/blob/d9c054c645af0ea9ef81617c3e762fbf0f3fecda/wgpu-core/src/device/mod.rs#L515 for how to set this for proper subgroup ops support.

Implementations§

source§

impl Composer

source

pub fn decorated_name(module_name: Option<&str>, item_name: &str) -> String

source§

impl Composer

source

pub fn non_validating() -> Self

create a non-validating composer. validation errors in the final shader will not be caught, and errors resulting from their use will have bad span data, so codespan reporting will fail. use default() to create a validating composer.

source

pub fn with_capabilities( self, capabilities: Capabilities, subgroup_stages: ShaderStages ) -> Self

specify capabilities to be used for naga module generation. purges any existing modules See https://github.com/gfx-rs/wgpu/blob/d9c054c645af0ea9ef81617c3e762fbf0f3fecda/wgpu-core/src/device/mod.rs#L515 for how to set the subgroup_stages value.

source

pub fn contains_module(&self, module_name: &str) -> bool

check if a module with the given name has been added

source

pub fn add_composable_module( &mut self, desc: ComposableModuleDescriptor<'_> ) -> Result<&ComposableModuleDefinition, ComposerError>

add a composable module to the composer. all modules imported by this module must already have been added

source

pub fn remove_composable_module(&mut self, module_name: &str)

remove a composable module. also removes modules that depend on this module, as we cannot be sure about the completeness of their effective shader defs any more…

source

pub fn make_naga_module( &mut self, desc: NagaModuleDescriptor<'_> ) -> Result<Module, ComposerError>

build a naga shader module

Trait Implementations§

source§

impl Debug for Composer

source§

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

Formats the value using the given formatter. Read more
source§

impl Default for Composer

source§

fn default() -> Self

Returns the “default value” for a type. 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> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T> Instrument for T

source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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, U> TryFrom<U> for T
where U: Into<T>,

§

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

§

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.
source§

impl<T> WithSubscriber for T

source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more