Struct Shader

pub struct Shader(/* private fields */);

A raw handle to the underlying Shader object.

Implementations

impl Shader

pub fn new(shader: ShaderKind) -> Self

Creates a new shader handle.

pub fn new_checked(shader: ShaderKind) -> Result<Self>

Creates a new shader with full checking for errors.

pub fn shader_source_cstr(&mut self, source: &CStr)

Adds the specified shader source to the shader. This is just a thin wrapper around glShaderSource

Parameters

• source - The source code as a null-terminated CStr

pub fn shader_source(&mut self, source: &str)

Adds the specified shader source to the shader. This is just a thin wrapper around glShaderSource

Parameters

• source - The source code of the shader

pub fn shader_sources(&mut self, sources: &[&str])

Adds the specified shader sources to the shader.

This function is optimized to handle up to 8 sources without requiring using dynamic memory allocation.

Parameters

• sources - a collection of sources

pub fn compile(&mut self) -> Result<()>

Attempts to compile the shader.

This must be called after adding shader source(s).

pub fn compile_status(&self) -> bool

Gets the compile status for the shader. This is a thin wrapper around glGetShaderiv

Returns true if the shader was compiled successfully.

pub fn delete_status(&self) -> bool

Checks if this shader is flagged for deletion. This is a thin wrapper around glGetShaderiv

Returns true if the shader is flagged for deletion.

pub fn info_log(&self) -> String

Gets the info log for the shader.

pub unsafe fn release(self) -> GLuint

Takes ownership of the underlying shader object. It becomes the responsibility of the caller to call glDeleteShader on the returned shader object.

Safety

The caller must ensure that the shader object is deleted after calling this function, otherwise there will be a resource-leak.

Trait Implementations

impl Drop for Shader

fn drop(&mut self)

Executes the destructor for this type.