Struct tetra::graphics::shader::Shader

pub struct Shader { /* fields omitted */ }

A shader program, consisting of a vertex shader and a fragment shader.

This type acts as a lightweight handle to the associated graphics hardware data, and so can be cloned with little overhead.

Vertex Shaders

Vertex shaders take in data via three attributes:

• a_position - A vec2 representing the position of the vertex in world space.
• a_uv - A vec2 representing the texture co-ordinates that are associated with the vertex.
• a_color - A vec4 representing a color to multiply the output by.

Fragment Shaders

Fragment shaders have a single vec4 output called o_color - this should be set to the desired output color for the fragment.

Uniforms

By default, the shader is provided with two uniform variables:

• u_projection - A mat4 which can be used to translate world space co-ordinates into screen space.
• u_texture - A sampler2D which can be used to access color data from the currently active texture.

You can also set data into your own uniform variables via the set_uniform method.

Methods

impl Shader

pub fn new<P>(
    ctx: &mut Context,
    vertex_path: P,
    fragment_path: P
) -> Result<Shader> where
    P: AsRef<Path>, 

Creates a new shader program from the given files.

Errors

If the file could not be read, a TetraError::Io will be returned.

If the shader could not be compiled, a TetraError::OpenGl will be returned.

pub fn vertex<P>(ctx: &mut Context, path: P) -> Result<Shader> where
    P: AsRef<Path>, 

Creates a new shader program from the given vertex shader file.

The default fragment shader will be used.

Errors

If the file could not be read, a TetraError::Io will be returned.

If the shader could not be compiled, a TetraError::OpenGl will be returned.

pub fn fragment<P>(ctx: &mut Context, path: P) -> Result<Shader> where
    P: AsRef<Path>, 

Creates a new shader program from the given fragment shader file.

The default vertex shader will be used.

Errors

If the file could not be read, a TetraError::Io will be returned.

If the shader could not be compiled, a TetraError::OpenGl will be returned.

pub fn from_string(
    ctx: &mut Context,
    vertex_shader: &str,
    fragment_shader: &str
) -> Result<Shader>

Creates a new shader program from the given strings.

Errors

If the shader could not be compiled, a TetraError::OpenGl will be returned.

pub fn set_uniform<V>(&mut self, ctx: &mut Context, name: &str, value: V) where
    V: UniformValue, 

Sets the value of the specifed uniform parameter.

Trait Implementations

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: &Shader) -> bool

This method tests for !=.

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.