Struct RaylibShaderMode 

pub struct RaylibShaderMode<'a, 'b, T: 'a>(/* private fields */);

RAII draw handle for custom shader mode — calls EndShaderMode on drop.

While alive, the borrowed Shader is bound as the active fragment / vertex program for subsequent draw calls. Drop runs EndShaderMode, restoring raylib’s default shader. Implements RaylibDraw and RaylibDraw3D via deref, so the guard accepts both 2D and 3D draw calls — the shader applies to whichever the parent surface supports.

Examples

use raylib::prelude::*;

let (mut rl, thread) = raylib::init().size(800, 600).title("demo").build();
let mut shader = rl.load_shader(&thread, None, Some("grayscale.fs"));
while !rl.window_should_close() {
    let mut d = rl.begin_drawing(&thread);
    d.clear_background(Color::RAYWHITE);
    {
        let mut s = d.begin_shader_mode(&mut shader);
        s.draw_rectangle(10, 10, 100, 50, Color::WHITE);
        // Drop ends shader mode automatically.
    }
}

See also

• RaylibShaderModeExt::begin_shader_mode — constructor for this guard.
• Shader — the shader the guard borrows.

Trait Implementations

impl<'a, T: 'a> Deref for RaylibShaderMode<'a, '_, T>

type Target = T

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl<'a, T: 'a> DerefMut for RaylibShaderMode<'a, '_, T>

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

Mutably dereferences the value.

impl<'a, T: 'a> Drop for RaylibShaderMode<'a, '_, T>

fn drop(&mut self)

Executes the destructor for this type.

fn pin_drop(self: Pin<&mut Self>)

🔬This is a nightly-only experimental API. (pin_ergonomics)

Execute the destructor for this type, but different to Drop::drop, it requires self to be pinned.

impl<'a, T: 'a> RaylibDraw for RaylibShaderMode<'a, '_, T>

fn clear_background(&mut self, color: impl Into<Color>)

Sets background color (framebuffer clear color.into()).

fn get_shapes_texture(&self) -> Texture2D

Get texture that is used for shapes drawing

fn get_shapes_texture_rectangle(&self) -> Rectangle

Get texture source rectangle that is used for shapes drawing

fn set_shapes_texture( &mut self, texture: impl AsRef<Texture2D>, source: impl Into<Rectangle>, )

Define default texture used to draw shapes

fn draw_pixel(&mut self, x: i32, y: i32, color: impl Into<Color>)

Draws a pixel.

fn draw_pixel_v( &mut self, position: impl Into<Vector2>, color: impl Into<Color>, )

Draws a pixel (Vector version).

fn draw_line( &mut self, start_pos_x: i32, start_pos_y: i32, end_pos_x: i32, end_pos_y: i32, color: impl Into<Color>, )

Draws a line.

fn draw_line_v( &mut self, start_pos: impl Into<Vector2>, end_pos: impl Into<Vector2>, color: impl Into<Color>, )

Draws a line (Vector version).

fn draw_line_ex( &mut self, start_pos: impl Into<Vector2>, end_pos: impl Into<Vector2>, thick: f32, color: impl Into<Color>, )

Draws a line with thickness.

fn draw_line_bezier( &mut self, start_pos: impl Into<Vector2>, end_pos: impl Into<Vector2>, thick: f32, color: impl Into<Color>, )

Draws a line using cubic-bezier curves in-out.

fn draw_line_dashed( &mut self, start: impl Into<Vector2>, end: impl Into<Vector2>, dash_size: i32, space_size: i32, color: impl Into<Color>, )

Draw a dashed line.

fn draw_line_strip(&mut self, points: &[Vector2], color: impl Into<Color>)

Draw lines sequence

fn draw_circle( &mut self, center_x: i32, center_y: i32, radius: f32, color: impl Into<Color>, )

Draws a color-filled circle.

fn draw_circle_sector( &mut self, center: impl Into<Vector2>, radius: f32, start_angle: f32, end_angle: f32, segments: i32, color: impl Into<Color>, )

Draw a piece of a circle

fn draw_circle_sector_lines( &mut self, center: impl Into<Vector2>, radius: f32, start_angle: f32, end_angle: f32, segments: i32, color: impl Into<Color>, )

Draw circle sector outline

fn draw_circle_gradient( &mut self, center_x: i32, center_y: i32, radius: f32, inner: impl Into<Color>, outer: impl Into<Color>, )

Draws a gradient-filled circle.

fn draw_circle_v( &mut self, center: impl Into<Vector2>, radius: f32, color: impl Into<Color>, )

Draws a color-filled circle (Vector version).

fn draw_circle_lines( &mut self, center_x: i32, center_y: i32, radius: f32, color: impl Into<Color>, )

Draws circle outline.

fn draw_circle_lines_v( &mut self, center: impl Into<Vector2>, radius: f32, color: impl Into<Color>, )

Draws circle outline. (Vector Version)

fn draw_ellipse( &mut self, center_x: i32, center_y: i32, radius_h: f32, radius_v: f32, color: impl Into<Color>, )

Draws ellipse.

fn draw_ellipse_v( &mut self, center: impl Into<Vector2>, radius_h: f32, radius_v: f32, color: impl Into<Color>, )

Draws ellipse using a Vector2 center.

fn draw_ellipse_lines( &mut self, center_x: i32, center_y: i32, radius_h: f32, radius_v: f32, color: impl Into<Color>, )

Draws ellipse.

fn draw_ellipse_lines_v( &mut self, center: impl Into<Vector2>, radius_h: f32, radius_v: f32, color: impl Into<Color>, )

Draws ellipse outline using a Vector2 center.

fn draw_ring( &mut self, center: impl Into<Vector2>, inner_radius: f32, outer_radius: f32, start_angle: f32, end_angle: f32, segments: i32, color: impl Into<Color>, )

Draw ring

fn draw_ring_lines( &mut self, center: impl Into<Vector2>, inner_radius: f32, outer_radius: f32, start_angle: f32, end_angle: f32, segments: i32, color: impl Into<Color>, )

Draw ring lines

fn draw_rectangle( &mut self, x: i32, y: i32, width: i32, height: i32, color: impl Into<Color>, )

Draws a color-filled rectangle.

fn draw_rectangle_v( &mut self, position: impl Into<Vector2>, size: impl Into<Vector2>, color: impl Into<Color>, )

Draws a color-filled rectangle (Vector version).

fn draw_rectangle_rec( &mut self, rec: impl Into<Rectangle>, color: impl Into<Color>, )

Draws a color-filled rectangle from rec.

fn draw_rectangle_pro( &mut self, rec: impl Into<Rectangle>, origin: impl Into<Vector2>, rotation: f32, color: impl Into<Color>, )

Draws a color-filled rectangle with pro parameters.

fn draw_rectangle_gradient_v( &mut self, x: i32, y: i32, width: i32, height: i32, color1: impl Into<Color>, color2: impl Into<Color>, )

Draws a vertical-gradient-filled rectangle.

fn draw_rectangle_gradient_h( &mut self, x: i32, y: i32, width: i32, height: i32, color1: impl Into<Color>, color2: impl Into<Color>, )

Draws a horizontal-gradient-filled rectangle.

fn draw_rectangle_gradient_ex( &mut self, rec: impl Into<Rectangle>, col1: impl Into<Color>, col2: impl Into<Color>, col3: impl Into<Color>, col4: impl Into<Color>, )

Draws a gradient-filled rectangle with custom vertex colors.

fn draw_rectangle_lines( &mut self, x: i32, y: i32, width: i32, height: i32, color: impl Into<Color>, )

Draws rectangle outline.

fn draw_rectangle_lines_ex( &mut self, rec: impl Into<Rectangle>, line_thick: f32, color: impl Into<Color>, )

Draws rectangle outline with extended parameters.

fn draw_rectangle_rounded( &mut self, rec: impl Into<Rectangle>, roundness: f32, segments: i32, color: impl Into<Color>, )

Draws rectangle with rounded edges.

fn draw_rectangle_rounded_lines( &mut self, rec: impl Into<Rectangle>, roundness: f32, segments: i32, color: impl Into<Color>, )

Draws rectangle outline with rounded edges included.

fn draw_rectangle_rounded_lines_ex( &mut self, rec: impl Into<Rectangle>, roundness: f32, segments: i32, line_thickness: f32, color: impl Into<Color>, )

Draw rectangle with rounded edges outline

fn draw_triangle( &mut self, v1: impl Into<Vector2>, v2: impl Into<Vector2>, v3: impl Into<Vector2>, color: impl Into<Color>, )

Draws a triangle.

fn draw_triangle_lines( &mut self, v1: impl Into<Vector2>, v2: impl Into<Vector2>, v3: impl Into<Vector2>, color: impl Into<Color>, )

Draws a triangle using lines.

fn draw_triangle_fan(&mut self, points: &[Vector2], color: impl Into<Color>)

Draw a triangle fan defined by points.

fn draw_triangle_strip(&mut self, points: &[Vector2], color: impl Into<Color>)

Draw a triangle strip defined by points

fn draw_poly( &mut self, center: impl Into<Vector2>, sides: i32, radius: f32, rotation: f32, color: impl Into<Color>, )

Draws a regular polygon of n sides (Vector version).

fn draw_poly_lines( &mut self, center: impl Into<Vector2>, sides: i32, radius: f32, rotation: f32, color: impl Into<Color>, )

Draws a regular polygon of n sides (Vector version).

fn draw_texture( &mut self, texture: impl AsRef<Texture2D>, x: i32, y: i32, tint: impl Into<Color>, )

Draws a texture using specified position and tint color.

fn draw_texture_v( &mut self, texture: impl AsRef<Texture2D>, position: impl Into<Vector2>, tint: impl Into<Color>, )

Draws a texture using specified position vector and tint color.

fn draw_texture_ex( &mut self, texture: impl AsRef<Texture2D>, position: impl Into<Vector2>, rotation: f32, scale: f32, tint: impl Into<Color>, )

Draws a texture with extended parameters.

fn draw_texture_rec( &mut self, texture: impl AsRef<Texture2D>, source_rec: impl Into<Rectangle>, position: impl Into<Vector2>, tint: impl Into<Color>, )

Draws from a region of texture defined by the source_rec rectangle.

fn draw_texture_pro( &mut self, texture: impl AsRef<Texture2D>, source_rec: impl Into<Rectangle>, dest_rec: impl Into<Rectangle>, origin: impl Into<Vector2>, rotation: f32, tint: impl Into<Color>, )

Draw from a region of texture defined by the source_rec rectangle with pro parameters.

fn draw_texture_n_patch( &mut self, texture: impl AsRef<Texture2D>, n_patch_info: impl Into<NPatchInfo>, dest_rec: impl Into<Rectangle>, origin: impl Into<Vector2>, rotation: f32, tint: impl Into<Color>, )

Draws a texture (or part of it) that stretches or shrinks nicely

fn draw_fps(&mut self, x: i32, y: i32)

Shows current FPS.

fn draw_text( &mut self, text: &str, x: i32, y: i32, font_size: i32, color: impl Into<Color>, )

Draws text (using default font). This does not support UTF-8. Use [RaylibDrawHandle::draw_text_codepoints] for that.

fn draw_text_codepoints( &mut self, font: impl AsRef<Font>, text: &str, position: impl Into<Vector2>, font_size: f32, spacing: f32, tint: impl Into<Color>, )

Draws text (using default font) with support for UTF-8. If you do not need UTF-8, use [RaylibDrawHandle::draw_text].

fn draw_text_ex( &mut self, font: impl AsRef<Font>, text: &str, position: impl Into<Vector2>, font_size: f32, spacing: f32, tint: impl Into<Color>, )

Draws text using font and additional parameters.

fn draw_text_pro( &mut self, font: impl AsRef<Font>, text: &str, position: impl Into<Vector2>, origin: impl Into<Vector2>, rotation: f32, font_size: f32, spacing: f32, tint: impl Into<Color>, )

Draw text using Font and pro parameters (rotation)

fn draw_text_codepoint( &mut self, font: impl AsRef<Font>, codepoint: i32, position: impl Into<Vector2>, scale: f32, tint: impl Into<Color>, )

Draw one character (codepoint)

fn enable_event_waiting(&self)

Enable waiting for events when the handle is dropped, no automatic event polling

fn disable_event_waiting(&self)

Disable waiting for events when the handle is dropped, no automatic event polling

fn draw_poly_lines_ex( &mut self, center: impl Into<Vector2>, sides: i32, radius: f32, rotation: f32, line_thick: f32, color: impl Into<Color>, )

Draw a polygon outline of n sides with extended parameters

fn draw_spline_linear( &mut self, points: &[Vector2], thick: f32, color: impl Into<Color>, )

Draw spline: Linear, minimum 2 points

fn draw_spline_basis( &mut self, points: &[Vector2], thick: f32, color: impl Into<Color>, )

Draw spline: B-Spline, minimum 4 points

fn draw_spline_catmull_rom( &mut self, points: &[Vector2], thick: f32, color: impl Into<Color>, )

Draw spline: Catmull-Rom, minimum 4 points

fn draw_spline_bezier_quadratic( &mut self, points: &[Vector2], thick: f32, color: impl Into<Color>, )

Draw spline: Quadratic Bezier, minimum 3 points (1 control point): [p1, c2, p3, c4…]

fn draw_spline_bezier_cubic( &mut self, points: &[Vector2], thick: f32, color: impl Into<Color>, )

Draw spline: Cubic Bezier, minimum 4 points (2 control points): [p1, c2, c3, p4, c5, c6…]

fn draw_spline_segment_linear( &mut self, p1: impl Into<Vector2>, p2: impl Into<Vector2>, thick: f32, color: impl Into<Color>, )

Draw spline segment: Linear, 2 points

fn draw_spline_segment_basis( &mut self, p1: impl Into<Vector2>, p2: impl Into<Vector2>, p3: impl Into<Vector2>, p4: impl Into<Vector2>, thick: f32, color: impl Into<Color>, )

Draw spline segment: B-Spline, 4 points

fn draw_spline_segment_catmull_rom( &mut self, p1: impl Into<Vector2>, p2: impl Into<Vector2>, p3: impl Into<Vector2>, p4: impl Into<Vector2>, thick: f32, color: impl Into<Color>, )

Draw spline segment: Catmull-Rom, 4 points

fn draw_spline_segment_bezier_quadratic( &mut self, p1: impl Into<Vector2>, c2: impl Into<Vector2>, p3: impl Into<Vector2>, thick: f32, color: impl Into<Color>, )

Draw spline segment: Quadratic Bezier, 2 points, 1 control point

fn draw_spline_segment_bezier_cubic( &mut self, p1: impl Into<Vector2>, c2: impl Into<Vector2>, c3: impl Into<Vector2>, p4: impl Into<Vector2>, thick: f32, color: impl Into<Color>, )

Draw spline segment: Cubic Bezier, 2 points, 2 control points

fn get_spline_point_linear( &mut self, start_pos: impl Into<Vector2>, end_pos: impl Into<Vector2>, t: f32, ) -> Vector2

Get (evaluate) spline point: Linear

fn get_spline_point_basis( &mut self, p1: impl Into<Vector2>, p2: impl Into<Vector2>, p3: impl Into<Vector2>, p4: impl Into<Vector2>, t: f32, ) -> Vector2

Get (evaluate) spline point: B-Spline

fn get_spline_point_catmull_rom( &mut self, p1: impl Into<Vector2>, p2: impl Into<Vector2>, p3: impl Into<Vector2>, p4: impl Into<Vector2>, t: f32, ) -> Vector2

Get (evaluate) spline point: Catmull-Rom

fn get_spline_point_bezier_quad( &mut self, p1: impl Into<Vector2>, c2: impl Into<Vector2>, p3: impl Into<Vector2>, t: f32, ) -> Vector2

Get (evaluate) spline point: Quadratic Bezier

fn get_spline_point_bezier_cubic( &mut self, p1: impl Into<Vector2>, c2: impl Into<Vector2>, c3: impl Into<Vector2>, p4: impl Into<Vector2>, t: f32, ) -> Vector2

Get (evaluate) spline point: Cubic Bezier

impl<'a, T: 'a> RaylibDraw3D for RaylibShaderMode<'a, '_, T>

fn draw_point3D( &mut self, position: impl Into<Vector3>, color: impl Into<Color>, )

Draw a point in 3D space, actually a small line

fn draw_triangle3D( &mut self, v1: impl Into<Vector3>, v2: impl Into<Vector3>, v3: impl Into<Vector3>, color: impl Into<Color>, )

Draw a color-filled triangle (vertex in counter-clockwise order!)

fn draw_triangle_strip3D(&mut self, points: &[Vector3], color: impl Into<Color>)

Draw a triangle strip defined by points

fn draw_line3D( &mut self, start_pos: impl Into<Vector3>, end_pos: impl Into<Vector3>, color: impl Into<Color>, )

Draws a line in 3D world space.

fn draw_circle3D( &mut self, center: impl Into<Vector3>, radius: f32, rotation_axis: impl Into<Vector3>, rotation_angle: f32, color: impl Into<Color>, )

Draws a circle in 3D world space.

fn draw_cube( &mut self, position: impl Into<Vector3>, width: f32, height: f32, length: f32, color: impl Into<Color>, )

Draws a cube.

fn draw_cube_v( &mut self, position: impl Into<Vector3>, size: impl Into<Vector3>, color: impl Into<Color>, )

Draws a cube (Vector version).

fn draw_cube_wires( &mut self, position: impl Into<Vector3>, width: f32, height: f32, length: f32, color: impl Into<Color>, )

Draws a cube in wireframe.

fn draw_cube_wires_v( &mut self, position: impl Into<Vector3>, size: impl Into<Vector3>, color: impl Into<Color>, )

Draws a cube in wireframe. (Vector Version)

fn draw_mesh( &mut self, mesh: impl AsRef<Mesh>, material: WeakMaterial, transform: impl Into<Matrix>, )

Draw a 3d mesh with material and transform

fn draw_mesh_instanced( &mut self, mesh: impl AsRef<Mesh>, material: WeakMaterial, transforms: &[Matrix], )

Draw multiple mesh instances with material and different transforms

fn draw_sphere( &mut self, center_pos: impl Into<Vector3>, radius: f32, color: impl Into<Color>, )

Draws a sphere.

fn draw_sphere_ex( &mut self, center_pos: impl Into<Vector3>, radius: f32, rings: i32, slices: i32, color: impl Into<Color>, )

Draws a sphere with extended parameters.

fn draw_sphere_wires( &mut self, center_pos: impl Into<Vector3>, radius: f32, rings: i32, slices: i32, color: impl Into<Color>, )

Draws a sphere in wireframe.

fn draw_cylinder( &mut self, position: impl Into<Vector3>, radius_top: f32, radius_bottom: f32, height: f32, slices: i32, color: impl Into<Color>, )

Draws a cylinder.

fn draw_cylinder_ex( &mut self, start_position: impl Into<Vector3>, end_position: impl Into<Vector3>, radius_start: f32, radius_end: f32, slices: i32, color: impl Into<Color>, )

Draws a cylinder with extended parameters.

fn draw_cylinder_wires( &mut self, position: impl Into<Vector3>, radius_top: f32, radius_bottom: f32, height: f32, slices: i32, color: impl Into<Color>, )

Draws a cylinder in wireframe.

fn draw_cylinder_wires_ex( &mut self, start_position: impl Into<Vector3>, end_position: impl Into<Vector3>, radius_start: f32, radius_end: f32, slices: i32, color: impl Into<Color>, )

Draws a cylinder in wireframe with extended parameters.

fn draw_capsule( &mut self, start_pos: impl Into<Vector3>, end_pos: impl Into<Vector3>, radius: f32, slices: i32, rings: i32, color: impl Into<Color>, )

Draw capsule with the center of its sphere caps at startPos and endPos

fn draw_capsule_wires( &mut self, start_pos: impl Into<Vector3>, end_pos: impl Into<Vector3>, radius: f32, slices: i32, rings: i32, color: impl Into<Color>, )

Draw capsule wireframe with the center of its sphere caps at startPos and endPos

fn draw_plane( &mut self, center_pos: impl Into<Vector3>, size: impl Into<Vector2>, color: impl Into<Color>, )

Draws an X/Z plane.

fn draw_ray(&mut self, ray: impl Into<Ray>, color: impl Into<Color>)

Draws a ray line.

fn draw_grid(&mut self, slices: i32, spacing: f32)

Draws a grid (centered at (0, 0, 0)).

fn draw_model( &mut self, model: impl AsRef<Model>, position: impl Into<Vector3>, scale: f32, tint: impl Into<Color>, )

Draws a model (with texture if set).

fn draw_model_ex( &mut self, model: impl AsRef<Model>, position: impl Into<Vector3>, rotation_axis: impl Into<Vector3>, rotation_angle: f32, scale: impl Into<Vector3>, tint: impl Into<Color>, )

Draws a model with extended parameters.

fn draw_model_wires( &mut self, model: impl AsRef<Model>, position: impl Into<Vector3>, scale: f32, tint: impl Into<Color>, )

Draws a model with wires (with texture if set).

fn draw_model_wires_ex( &mut self, model: impl AsRef<Model>, position: impl Into<Vector3>, rotation_axis: impl Into<Vector3>, rotation_angle: f32, scale: impl Into<Vector3>, tint: impl Into<Color>, )

Draws a model with wires.

fn draw_bounding_box( &mut self, bbox: impl Into<BoundingBox>, color: impl Into<Color>, )

Draws a bounding box (wires).

fn draw_billboard( &mut self, camera: impl Into<Camera3D>, texture: &Texture2D, center: impl Into<Vector3>, size: f32, tint: impl Into<Color>, )

Draws a billboard texture.

fn draw_billboard_rec( &mut self, camera: impl Into<Camera3D>, texture: &Texture2D, source_rec: impl Into<Rectangle>, center: impl Into<Vector3>, size: impl Into<Vector2>, tint: impl Into<Color>, )

Draws a billboard texture defined by source_rec.

fn draw_billboard_pro( &mut self, camera: impl Into<Camera>, texture: impl Into<Texture2D>, source: impl Into<Rectangle>, position: impl Into<Vector3>, up: impl Into<Vector3>, size: impl Into<Vector2>, origin: impl Into<Vector2>, rotation: f32, tint: impl Into<Color>, )

Draw a billboard texture defined by source and rotation