Skip to main content

MetalFunction

Struct MetalFunction 

Source
pub struct MetalFunction {
    pub name: String,
    pub stage: MetalStage,
    pub params: Vec<MetalParam>,
    pub return_type: MetalType,
    pub body: Vec<MetalStmt>,
    pub is_inline: bool,
}
Expand description

A Metal shader function (vertex / fragment / kernel / mesh / device).

Fields§

§name: String

Function name

§stage: MetalStage

Shader stage

§params: Vec<MetalParam>

Parameter list

§return_type: MetalType

Return type

§body: Vec<MetalStmt>

Function body

§is_inline: bool

Whether the function is inline

Implementations§

Source§

impl MetalFunction

Source

pub fn new( name: impl Into<String>, stage: MetalStage, return_type: MetalType, ) -> Self

Create a new function with the given stage.

Source

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

Create a compute (kernel) function returning void.

Source

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

Create a vertex shader.

Source

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

Create a fragment shader.

Source

pub fn device_fn(name: impl Into<String>, return_type: MetalType) -> Self

Create a device helper function.

Source

pub fn with_inline(self) -> Self

Mark as inline.

Source

pub fn add_param(self, p: MetalParam) -> Self

Append a parameter.

Source

pub fn add_stmt(self, s: MetalStmt) -> Self

Append a body statement.

Trait Implementations§

Source§

impl Clone for MetalFunction

Source§

fn clone(&self) -> MetalFunction

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 MetalFunction

Source§

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

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

impl PartialEq for MetalFunction

Source§

fn eq(&self, other: &MetalFunction) -> bool

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl StructuralPartialEq for MetalFunction

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.