Struct sfml::graphics::Shader

pub struct Shader<'texture> { /* fields omitted */ }

Shader type (vertex, geometry and fragment).

Shaders are programs written using a specific language, executed directly by the graphics card and allowing to apply real-time operations to the rendered entities.

There are three kinds of shaders:

• Vertex shaders, that process vertices
• Geometry shaders, that process primitives
• Fragment (pixel) shaders, that process pixels

A Shader can be composed of either a vertex shader alone, a geometry shader alone, a fragment shader alone, or any combination of them. (see the variants of the load functions).

Shaders are written in GLSL, which is a C-like language dedicated to OpenGL shaders. You'll probably need to learn its basics before writing your own shaders for SFML.

Like any Rust program, a GLSL shader has its own variables called uniforms that you can set from your Rust application. Shader handles different types of uniforms:

• scalars: float, int, bool
• vectors (2, 3 or 4 components)
• matrices (3x3 or 4x4)
• samplers (textures)

Some SFML-specific types can be converted:

• Color as a 4D vector (vec4)
• Transform as matrices (mat3 or mat4) Every uniform variable in a shader can be set through one of the set_uniform_*() or set_uniform_array_*() methods. For example, if you have a shader with the following uniforms:

uniform float offset;
uniform vec3 point;
uniform vec4 color;
uniform mat4 matrix;
uniform sampler2D overlay;
uniform sampler2D current;

You can set their values from Rust code as follows, using the types defined in the glsl module:

let texture: SfBox<Texture> = unimplemented!();
let mut shader: Shader = unimplemented!();
let color: Color = unimplemented!();
let transform: Transform = unimplemented!();
shader.set_uniform_float("offset", 2.);
shader.set_uniform_vec3("point", Vector3f::new(0.5, 0.8, 0.3));
shader.set_uniform_vec4("color", color);
shader.set_uniform_mat4("matrix", transform);
shader.set_uniform_texture("overlay", &texture);
shader.set_uniform_current_texture("current");

To apply a shader to a drawable, you must set the shader field of a RenderStates instance, and use RenderTarget::draw_with_renderstates. Example:

let mut states = RenderStates::default();;
states.shader = Some(&shader);
window.draw_with_renderstates(&sprite, states);

Shaders can be used on any drawable, but some combinations are not interesting. For example, using a vertex shader on a Sprite is limited because there are only 4 vertices, the sprite would have to be subdivided in order to apply wave effects. Another bad example is a fragment shader with Text: the texture of the text is not the actual text that you see on screen, it is a big texture containing all the characters of the font in an arbitrary order; thus, texture lookups on pixels other than the current one may not give you the expected result.

Shaders can also be used to apply global post-effects to the current contents of the target (like the old sf::PostFx class in SFML 1). This can be done in two different ways:

• draw everything to a RenderTexture, then draw it to the main target using the shader

• draw everything directly to the main target, then use Texture::update_from_window to copy its contents to a texture and draw it to the main target using the shader.

The first technique is more optimized because it doesn't involve retrieving the target's pixels to system memory, but the second one doesn't impact the rendering process and can be easily inserted anywhere without impacting all the code.

Like Texture that can be used as a raw OpenGL texture, Shader can also be used directly as a raw shader for custom OpenGL geometry.

use sfml::graphics::*;
Shader::bind(Some(&shader));
// ... render OpenGL geometry ...
Shader::bind(None);

Methods

impl<'texture> Shader<'texture>

pub fn from_file(
    vertex: Option<&str>,
    geometry: Option<&str>,
    fragment: Option<&str>
) -> Option<Self>

Load both the vertex and fragment shaders from files

This function can load both the vertex and the fragment shaders, or only one of them: pass None if you don't want to load either the vertex shader or the fragment shader. The sources must be text files containing valid shaders in GLSL language. GLSL is a C-like language dedicated to OpenGL shaders; you'll probably need to read a good documentation for it before writing your own shaders.

Arguments

• vertexShaderFilename - Some(Path) of the vertex shader file to load, or None to skip this shader
• fragmentShaderFilename - Some(Path) of the fragment shader file to load, or None to skip this shader

Return Some(Shader) or None

pub fn from_stream<T: Read + Seek>(
    vertex_shader_stream: Option<&mut T>,
    geometry_shader_stream: Option<&mut T>,
    fragment_shader_stream: Option<&mut T>
) -> Option<Self>

Load both the vertex and fragment shaders from streams

This function can load both the vertex and the fragment shaders, or only one of them: pass None if you don't want to load either the vertex shader or the fragment shader. The sources must be text files containing valid shaders in GLSL language. GLSL is a C-like language dedicated to OpenGL shaders; you'll probably need to read a good documentation for it before writing your own shaders.

Arguments

• vertexShaderStream - Some(T: Read + Seek) of the vertex shader stream to load, or None to skip this shader
• fragmentShaderStream - Some(T: Read + Seek) of the fragment shader stream to load, or None to skip this shader

Return Some(Shader) or None

pub fn from_memory(
    vertex: Option<&str>,
    geometry: Option<&str>,
    fragment: Option<&str>
) -> Option<Self>

Load both the vertex and fragment shaders from source codes in memory

This function can load both the vertex and the fragment shaders, or only one of them: pass None if you don't want to load either the vertex shader or the fragment shader. The sources must be valid shaders in GLSL language. GLSL is a C-like language dedicated to OpenGL shaders; you'll probably need to read a good documentation for it before writing your own shaders.

Arguments

• vertexShader - Some(String) containing the source code of the vertex shader, or None to skip this shader
• fragmentShader - Some(String) containing the source code of the fragment shader, or None to skip this shader

Return Some(Shader) or None

pub fn bind(shader: Option<&Self>)

Bind a shader for rendering.

This function is not part of the graphics API, it mustn't be used when drawing SFML entities. It must be used only if you mix Shader with OpenGL code.

pub fn is_available() -> bool

Tell whether or not the system supports shaders

This function should always be called before using the shader features. If it returns false, then any attempt to use Shader will fail.

pub fn is_geometry_available() -> bool

Tell whether or not the system supports geometry shaders.

This function should always be called before using the geometry shader features. If it returns false, then any attempt to use Shader geometry shader features will fail.

This function can only return true if Shader::is_available would also return true, since shaders in general have to be supported in order for geometry shaders to be supported as well.

Note: The first call to this function, whether by your code or SFML will result in a context switch.

pub fn set_uniform_float(&mut self, name: &str, value: f32)

Specify value for float uniform.

pub fn set_uniform_vec2(&mut self, name: &str, value: Vec2)

Specify value for vec2 uniform.

pub fn set_uniform_vec3(&mut self, name: &str, value: Vec3)

Specify value for vec3 uniform.

pub fn set_uniform_vec4<V>(&mut self, name: &str, value: V) where
    V: Into<Vec4>, 

Specify value for vec4 uniform.

This function can also be called with Color objects that are converted to glsl::Vec4.

It is important to note that the components of the color are normalized before being passed to the shader. Therefore, they are converted from range [0 .. 255] to range [0 .. 1]. For example, a Color{r: 255, g: 127, b: 0, a: 255} will be transformed to a Vec4{x: 1.0, y: 0.5, z: 0.0, w: 1.0} in the shader.

pub fn set_uniform_int(&mut self, name: &str, value: i32)

Specify value for int uniform.

pub fn set_uniform_ivec2(&mut self, name: &str, value: IVec2)

Specify value for ivec2 uniform.

pub fn set_uniform_ivec3(&mut self, name: &str, value: IVec3)

Specify value for ivec3 uniform.

pub fn set_uniform_ivec4<V>(&mut self, name: &str, value: V) where
    V: Into<IVec4>, 

Specify value for ivec4 uniform.

This overload can also be called with Color objects that are converted to glsl::IVec4.

If color conversions are used, the ivec4 uniform in GLSL will hold the same values as the original Color instance. For example, Color{r: 255, g: 127, b: 0, a: 255} is mapped to IVec4{x: 255, y: 127, z: 0, w: 255}.

pub fn set_uniform_bool(&mut self, name: &str, value: bool)

Specify value for bool uniform.

pub fn set_uniform_bvec2(&mut self, name: &str, value: BVec2)

Specify value for bvec2 uniform.

pub fn set_uniform_bvec3(&mut self, name: &str, value: BVec3)

Specify value for bvec3 uniform.

pub fn set_uniform_bvec4(&mut self, name: &str, value: BVec4)

Specify value for bvec4 uniform.

pub fn set_uniform_mat3<V>(&mut self, name: &str, value: V) where
    V: Into<Mat3>, 

Specify value for mat3 matrix.

pub fn set_uniform_mat4<V>(&mut self, name: &str, value: V) where
    V: Into<Mat4>, 

Specify value for mat4 matrix.

pub fn set_uniform_texture(&mut self, name: &str, value: &'texture Texture)

Specify a texture as sampler2D uniform.

name is the name of the variable to change in the shader. The corresponding parameter in the shader must be a 2D texture (sampler2D GLSL type).

To use the texture of the object being drawn, which cannot be known in advance, use Shader::set_uniform_current_texture.

pub fn set_uniform_current_texture(&mut self, name: &str)

Specify current texture as sampler2D uniform.

This function maps a shader texture variable to the texture of the object being drawn, which cannot be known in advance. The corresponding parameter in the shader must be a 2D texture (sampler2D GLSL type).

pub fn set_uniform_array_float(&mut self, name: &str, array: &[f32])

Specify values for float[] array uniform.

pub fn set_uniform_array_vec2(&mut self, name: &str, array: &[Vec2])

Specify values for vec2[] array uniform.

pub fn set_uniform_array_vec3(&mut self, name: &str, array: &[Vec3])

Specify values for vec3[] array uniform.

pub fn set_uniform_array_vec4(&mut self, name: &str, array: &[Vec4])

Specify values for vec4[] array uniform.

pub fn set_uniform_array_mat3(&mut self, name: &str, array: &[Mat3])

Specify values for mat3[] array uniform.

pub fn set_uniform_array_mat4(&mut self, name: &str, array: &[Mat4])

Specify values for mat4[] array uniform.

Trait Implementations

impl<'texture> Drop for Shader<'texture>

fn drop(&mut self)

Executes the destructor for this type.

impl<'texture> Debug for Shader<'texture>

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

Formats the value using the given formatter.