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.

Create with ShaderParamsBuilder.

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

ggez::graphics::ShaderParamsBuilder::new(&my_uniforms)
    .images(&[&image1, &image2], &[sampler1], false)
    .build(&mut ctx.gfx)

Corresponds to…

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

Implementations§

source§

impl<Uniforms: AsStd140> ShaderParams<Uniforms>

source

pub fn set_uniforms(&mut self, ctx: &mut Context, uniforms: &Uniforms)

Updates the uniform data.

When called, [Canvas::set_shader_params] (or [Canvas::set_text_shader_params]) needs to be called again for the new uniforms to take effect.

Trait Implementations§

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

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,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

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

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<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<S> FromSample<S> for S

§

fn from_sample_(s: S) -> S

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<U> for Twhere 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.

§

impl<F, T> IntoSample<T> for Fwhere T: FromSample<F>,

§

fn into_sample(self) -> T

§

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
§

impl<T, U> ToSample<U> for Twhere U: FromSample<T>,

§

fn to_sample_(self) -> U

source§

impl<T, U> TryFrom<U> for Twhere 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 Twhere 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.
§

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

§

impl<S, T> Duplex<S> for Twhere T: FromSample<S> + ToSample<S>,