Skip to main content

WGSLFunction

Struct WGSLFunction 

Source
pub struct WGSLFunction {
    pub name: String,
    pub entry_point: WGSLEntryPoint,
    pub params: Vec<WGSLParam>,
    pub return_type: Option<WGSLType>,
    pub return_attrib: WGSLReturnAttrib,
    pub body: Vec<String>,
}
Expand description

A WGSL function (helper or entry point).

Fields§

§name: String

Function name.

§entry_point: WGSLEntryPoint

Entry-point kind (or None for helpers).

§params: Vec<WGSLParam>

Ordered parameters.

§return_type: Option<WGSLType>

Return type (None means no return value / void).

§return_attrib: WGSLReturnAttrib

Optional attribute on the return type.

§body: Vec<String>

Body statements.

Implementations§

Source§

impl WGSLFunction

Source

pub fn helper(name: impl Into<String>) -> Self

Create a helper function with no entry-point annotation.

Source

pub fn vertex(name: impl Into<String>) -> Self

Create a @vertex entry-point function.

Source

pub fn fragment(name: impl Into<String>) -> Self

Create a @fragment entry-point function.

Source

pub fn compute(name: impl Into<String>, x: u32, y: u32, z: u32) -> Self

Create a @compute @workgroup_size(x, y, z) entry-point function.

Source

pub fn add_param(&mut self, param: WGSLParam)

Add a parameter.

Source

pub fn set_return_type(&mut self, ty: WGSLType)

Set the return type.

Source

pub fn set_return_type_with_attrib( &mut self, ty: WGSLType, attrib: WGSLReturnAttrib, )

Set the return type with an attribute.

Source

pub fn add_statement(&mut self, stmt: impl Into<String>)

Append a body statement (without trailing semicolon — the emitter adds it).

Source

pub fn emit(&self) -> String

Emit the complete function definition.

Trait Implementations§

Source§

impl Clone for WGSLFunction

Source§

fn clone(&self) -> WGSLFunction

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 WGSLFunction

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.