Struct ggez::graphics::Shader

pub struct Shader { /* private fields */ }

A custom fragment shader that can be used to render with shader effects.

Adapted from the shader.rs example:

#[derive(AsStd140)]
struct Dim {
    rate: f32,
}

struct MainState {}

impl event::EventHandler for MainState {
    fn draw(&mut self, ctx: &mut Context) -> GameResult {
        let mut canvas = graphics::Canvas::from_frame(ctx, Color::BLACK);
        let dim = Dim { rate: 0.5 };
        // NOTE: This is for simplicity; do not recreate your shader every frame like this!
        //       For more info look at the full example.
        let shader = Shader::from_wgsl(
            ctx,
            include_str!("../../resources/dimmer.wgsl"),
            "main"
        );
        let params = ShaderParams::new(ctx, &dim, &[], &[]);
        params.set_uniforms(ctx, &dim);

        canvas.set_shader(shader);
        canvas.set_shader_params(params);
        // draw something...
        canvas.finish(ctx)
    }

    /* ... */
}

Implementations

impl Shader

pub fn from_wgsl(
    gfx: &impl Has<GraphicsContext>,
    wgsl: &str,
    fs_entry: &str
) -> Self

Creates a shader from a WGSL string.

Trait Implementations

impl Clone for Shader

fn clone(&self) -> Shader

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Shader

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

Formats the value using the given formatter.

impl Hash for Shader

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)where
    H: Hasher,

Feeds a slice of this type into the given Hasher.

impl PartialEq<Shader> for Shader

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

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

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.

impl Eq for Shader

impl StructuralEq for Shader

impl StructuralPartialEq for Shader