Struct ggez::graphics::ShaderParams

source · [−]

pub struct ShaderParams<Uniforms: AsStd140> { /* private fields */ }

Expand description

Parameters that can be passed to a custom shader, including uniforms, images, and samplers.

These parameters are bound to group 4. With WGSL, for example,

ggez::graphics::ShaderParams::new(ctx, &my_uniforms, &[&image1, &image2], &[sampler1])

Corresponds to…

@group(4) @binding(0)
var<uniform> my_uniforms: MyUniforms;
@group(4) @binding(1)
var image1: texture_2d<f32>;
@group(4) @binding(2)
var image2: texture_2d<f32>;
@group(4) @binding(3)
var sampler1: sampler;

Implementations

source

impl<Uniforms: AsStd140> ShaderParams<Uniforms>

source

pub fn new(
 gfx: &mut impl HasMut<GraphicsContext>,
 uniforms: &Uniforms,
 images: &[&Image],
 samplers: &[Sampler]
) -> Self

Creates a new ShaderParams, initialized with the given uniforms, images, and samplers.

source

pub fn set_uniforms(&self, gfx: &impl Has<GraphicsContext>, uniforms: &Uniforms)

Updates the uniform data.

Trait Implementations

source

impl<Uniforms: AsStd140> Clone for ShaderParams<Uniforms>

source

fn clone(&self) -> Self

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<Uniforms: Debug + AsStd140> Debug for ShaderParams<Uniforms>

source

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

Formats the value using the given formatter. Read more

source

impl<Uniforms: PartialEq + AsStd140> PartialEq<ShaderParams<Uniforms>> for ShaderParams<Uniforms>

source

fn eq(&self, other: &ShaderParams<Uniforms>) -> bool

This method tests for self and other values to be equal, and is used by ==. Read more

1.0.0 · source

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason. Read more

source

impl<Uniforms: Eq + AsStd140> Eq for ShaderParams<Uniforms>

source

impl<Uniforms: AsStd140> StructuralEq for ShaderParams<Uniforms>

source

impl<Uniforms: AsStd140> StructuralPartialEq for ShaderParams<Uniforms>

Auto Trait Implementations

impl<Uniforms> !RefUnwindSafe for ShaderParams<Uniforms>

impl<Uniforms> Send for ShaderParams<Uniforms>where
Uniforms: Send,

impl<Uniforms> Sync for ShaderParams<Uniforms>where
Uniforms: Sync,

impl<Uniforms> Unpin for ShaderParams<Uniforms>where
Uniforms: Unpin,

impl<Uniforms> !UnwindSafe for ShaderParams<Uniforms>

Blanket Implementations

source

impl<T> Any for Twhere
T: 'static + ?Sized,

source

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

source

impl<T> Borrow<T> for Twhere
T: ?Sized,

const: unstable · source

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

source

impl<T> BorrowMut<T> for Twhere
T: ?Sized,

const: unstable · source

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

impl<T> Downcast<T> for T

fn downcast(&self) -> &T

source

impl<Q, K> Equivalent<K> for Qwhere
Q: Eq + ?Sized,
K: Borrow<Q> + ?Sized,

source

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.

source

impl<T> From<T> for T

const: unstable · source

fn from(t: T) -> T

Returns the argument unchanged.

source

impl<T> Has<T> for T

source

fn retrieve(&self) -> &T

Method to retrieve the context type.

source

impl<T> HasMut<T> for T

source

fn retrieve_mut(&mut self) -> &mut T

Method to retrieve the context type as mutable.

source

impl<T, U> Into for Twhere
U: From<T>,

const: unstable · 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.

impl<T> Pointable for T

const ALIGN: usize = mem::align_of::<T>()

The alignment of pointer.

type Init = T

The type for initializers.

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more

source

impl<T> ToOwned for Twhere
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 for Twhere
U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

fn try_from(value: U) -> Result<T, <T as TryFrom>::Error>

Performs the conversion.

source

impl<T, U> TryInto for Twhere
U: TryFrom<T>,

type Error = >::Error

The type returned in the event of a conversion error.

const: unstable · source

fn try_into(self) -> Result<U, >::Error>

Performs the conversion.

Struct ggez::graphics::ShaderParams

Implementations

impl<Uniforms: AsStd140> ShaderParams<Uniforms>

pub fn new( gfx: &mut impl HasMut<GraphicsContext>, uniforms: &Uniforms, images: &[&Image], samplers: &[Sampler]) -> Self

pub fn set_uniforms(&self, gfx: &impl Has<GraphicsContext>, uniforms: &Uniforms)

Trait Implementations

impl<Uniforms: AsStd140> Clone for ShaderParams<Uniforms>

fn clone(&self) -> Self

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

impl<Uniforms: Debug + AsStd140> Debug for ShaderParams<Uniforms>

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

impl<Uniforms: PartialEq + AsStd140> PartialEq<ShaderParams<Uniforms>> for ShaderParams<Uniforms>

fn eq(&self, other: &ShaderParams<Uniforms>) -> bool

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

impl<Uniforms: Eq + AsStd140> Eq for ShaderParams<Uniforms>

impl<Uniforms: AsStd140> StructuralEq for ShaderParams<Uniforms>

impl<Uniforms: AsStd140> StructuralPartialEq for ShaderParams<Uniforms>

Auto Trait Implementations

impl<Uniforms> !RefUnwindSafe for ShaderParams<Uniforms>

impl<Uniforms> Send for ShaderParams<Uniforms>where Uniforms: Send,

impl<Uniforms> Sync for ShaderParams<Uniforms>where Uniforms: Sync,

impl<Uniforms> Unpin for ShaderParams<Uniforms>where Uniforms: Unpin,

impl<Uniforms> !UnwindSafe for ShaderParams<Uniforms>

Blanket Implementations

impl<T> Any for Twhere T: 'static + ?Sized,

fn type_id(&self) -> TypeId

impl<T> Borrow<T> for Twhere T: ?Sized,

fn borrow(&self) -> &T

impl<T> BorrowMut<T> for Twhere T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

impl<T> Downcast<T> for T

fn downcast(&self) -> &T

impl<Q, K> Equivalent<K> for Qwhere Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

fn equivalent(&self, key: &K) -> bool

impl<T> From<T> for T

fn from(t: T) -> T

impl<T> Has<T> for T

fn retrieve(&self) -> &T

impl<T> HasMut<T> for T

fn retrieve_mut(&mut self) -> &mut T

impl<T, U> Into<U> for Twhere U: From<T>,

fn into(self) -> U

impl<T> Pointable for T

const ALIGN: usize = mem::align_of::<T>()

type Init = T

unsafe fn init(init: <T as Pointable>::Init) -> usize

unsafe fn deref<'a>(ptr: usize) -> &'a T

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

unsafe fn drop(ptr: usize)

impl<T> ToOwned for Twhere T: Clone,

type Owned = T

fn to_owned(&self) -> T

fn clone_into(&self, target: &mut T)

impl<T, U> TryFrom<U> for Twhere U: Into<T>,

type Error = Infallible

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

impl<T, U> TryInto<U> for Twhere U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

impl<T> Upcast<T> for T

fn upcast(&self) -> Option<&T>

impl<V, T> VZip<V> for Twhere V: MultiLane<T>,

fn vzip(self) -> V

pub fn new(
gfx: &mut impl HasMut<GraphicsContext>,
uniforms: &Uniforms,
images: &[&Image],
samplers: &[Sampler]
) -> Self

impl<Uniforms> Send for ShaderParams<Uniforms>where
Uniforms: Send,

impl<Uniforms> Sync for ShaderParams<Uniforms>where
Uniforms: Sync,

impl<Uniforms> Unpin for ShaderParams<Uniforms>where
Uniforms: Unpin,

impl<T> Any for Twhere
T: 'static + ?Sized,

impl<T> Borrow<T> for Twhere
T: ?Sized,

impl<T> BorrowMut<T> for Twhere
T: ?Sized,

impl<Q, K> Equivalent<K> for Qwhere
Q: Eq + ?Sized,
K: Borrow<Q> + ?Sized,

impl<T, U> Into<U> for Twhere
U: From<T>,

impl<T> ToOwned for Twhere
T: Clone,

impl<T, U> TryFrom<U> for Twhere
U: Into<T>,

impl<T, U> TryInto<U> for Twhere
U: TryFrom<T>,

impl<V, T> VZip<V> for Twhere
V: MultiLane<T>,