Struct naga::Module

source ·
pub struct Module {
    pub types: UniqueArena<Type>,
    pub special_types: SpecialTypes,
    pub constants: Arena<Constant>,
    pub overrides: Arena<Override>,
    pub global_variables: Arena<GlobalVariable>,
    pub global_expressions: Arena<Expression>,
    pub functions: Arena<Function>,
    pub entry_points: Vec<EntryPoint>,
}
Expand description

Shader module.

A module is a set of constants, global variables and functions, as well as the types required to define them.

Some functions are marked as entry points, to be used in a certain shader stage.

To create a new module, use the Default implementation. Alternatively, you can load an existing shader using one of the available front ends.

When finished, you can export modules using one of the available backends.

Fields§

§types: UniqueArena<Type>

Arena for the types defined in this module.

§special_types: SpecialTypes

Dictionary of special type handles.

§constants: Arena<Constant>

Arena for the constants defined in this module.

§overrides: Arena<Override>

Arena for the pipeline-overridable constants defined in this module.

§global_variables: Arena<GlobalVariable>

Arena for the global variables defined in this module.

§global_expressions: Arena<Expression>

Constant expressions and override expressions used by this module.

Each Expression must occur in the arena before any Expression that uses its value.

§functions: Arena<Function>

Arena for the functions defined in this module.

Each function must appear in this arena strictly before all its callers. Recursion is not supported.

§entry_points: Vec<EntryPoint>

Entry points.

Implementations§

source§

impl Module

source

pub fn generate_ray_desc_type(&mut self) -> Handle<Type>

Populate this module’s SpecialTypes::ray_desc type.

SpecialTypes::ray_desc is the type of the descriptor operand of an Initialize RayQuery statement. In WGSL, it is a struct type referred to as RayDesc.

Backends consume values of this type to drive platform APIs, so if you change any its fields, you must update the backends to match. Look for backend code dealing with RayQueryFunction::Initialize.

source

pub fn generate_ray_intersection_type(&mut self) -> Handle<Type>

Populate this module’s SpecialTypes::ray_intersection type.

SpecialTypes::ray_intersection is the type of a RayQueryGetIntersection expression. In WGSL, it is a struct type referred to as RayIntersection.

Backends construct values of this type based on platform APIs, so if you change any its fields, you must update the backends to match. Look for the backend’s handling for Expression::RayQueryGetIntersection.

source

pub fn generate_predeclared_type( &mut self, special_type: PredeclaredType ) -> Handle<Type>

Populate this module’s SpecialTypes::predeclared_types type and return the handle.

source§

impl Module

source

pub const fn to_ctx(&self) -> GlobalCtx<'_>

Trait Implementations§

source§

impl<'arbitrary> Arbitrary<'arbitrary> for Module

source§

fn arbitrary(u: &mut Unstructured<'arbitrary>) -> Result<Self>

Generate an arbitrary value of Self from the given unstructured data. Read more
source§

fn arbitrary_take_rest(u: Unstructured<'arbitrary>) -> Result<Self>

Generate an arbitrary value of Self from the entirety of the given unstructured data. Read more
source§

fn size_hint(depth: usize) -> (usize, Option<usize>)

Get a size hint for how many bytes out of an Unstructured this type needs to construct itself. Read more
source§

impl Clone for Module

source§

fn clone(&self) -> Module

Returns a copy 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 Module

source§

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

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

impl Default for Module

source§

fn default() -> Module

Returns the “default value” for a type. Read more
source§

impl<'de> Deserialize<'de> for Module

source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
source§

impl Serialize for Module

source§

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

Serialize this value into the given Serde serializer. Read more

Auto Trait Implementations§

§

impl Freeze for Module

§

impl RefUnwindSafe for Module

§

impl Send for Module

§

impl Sync for Module

§

impl Unpin for Module

§

impl UnwindSafe for Module

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

§

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

§

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> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,