Skip to main content

Shader

Struct Shader 

Source
pub struct Shader {
    pub workers: Workers,
    pub id: u32,
    pub is_compute: bool,
    pub tex_ids: Vec<Option<u32>>,
    pub sbo_ids: Vec<Option<u32>>,
}
Expand description

A handle to an OpenGL shader program.

Supports both pipeline (vertex+fragment) and compute shaders. Manages texture and storage-buffer bindings for automatic binding during rendering or compute dispatch.

§Uniform setters

The set_* family of methods sets uniform variables by name. They will panic if the uniform does not exist (use uniform_location for optional lookups).

Fields§

§workers: Workers§id: u32§is_compute: bool§tex_ids: Vec<Option<u32>>§sbo_ids: Vec<Option<u32>>

Implementations§

Source§

impl Shader

Source

pub fn new(id: u32, is_compute: bool) -> Self

Wraps an existing GL program ID.

is_compute controls whether textures are bound via BindImageTexture (compute) or glActiveTexture / glBindTexture (render).

Source

pub fn attach_tex(&mut self, tex: &Texture2D)

Attaches a texture to the first available (empty) texture slot.

Source

pub fn attach_sbo(&mut self, sbo: &StorageBuffer)

Attaches a storage buffer to the first available (empty) SSBO slot.

Source

pub fn set_tex_at_slot(&mut self, tex: &Texture2D, slot: Slot)

Binds a texture to a specific slot.

Source

pub fn set_sbo_at_slot(&mut self, sbo: &StorageBuffer, slot: Slot)

Binds a storage buffer to a specific slot.

Source

pub fn delete(self)

Deletes the underlying GL program.

Source

pub fn bind(&self)

Binds this shader program (glUseProgram).

Source

pub fn unbind(&self)

Unbinds the current shader (binds program 0).

Source

pub fn compute(&self)

Dispatches compute with the currently bound textures and SSBOs.

Calls glDispatchCompute(workers) followed by a memory barrier for shader image access and shader storage access.

Source

pub fn uniform_location(&self, name: &str) -> Option<u32>

Looks up a uniform location by name, returning None if not found.

Source

pub fn texture_binds(&self) -> Vec<(u32, u32)>

Returns all (slot, tex_id) pairs for currently bound textures.

Source

pub fn storage_binds(&self) -> Vec<(u32, u32)>

Returns all (slot, sbo_id) pairs for currently bound storage buffers.

Source

pub fn bind_textures(&self)

Binds all attached textures (image uniforms for compute, sampler2D for pipeline).

Source

pub fn bind_storages(&self)

Binds all attached storage buffers to their slots.

Source

pub fn set_i32(&self, name: &str, v: i32)

Sets an int uniform.

Source

pub fn set_u32(&self, name: &str, v: u32)

Sets a uint uniform.

Source

pub fn set_f32(&self, name: &str, v: f32)

Sets a float uniform.

Source

pub fn set_vec2_f32(&self, name: &str, v: Vector2<f32>)

Sets a vec2 uniform.

Source

pub fn set_vec3_f32(&self, name: &str, v: Vector3<f32>)

Sets a vec3 uniform.

Source

pub fn set_vec4_f32(&self, name: &str, v: Vector4<f32>)

Sets a vec4 uniform.

Source

pub fn set_vec2_i32(&self, name: &str, v: Vector2<i32>)

Sets an ivec2 uniform.

Source

pub fn set_vec3_i32(&self, name: &str, v: Vector3<i32>)

Sets an ivec3 uniform.

Source

pub fn set_vec4_i32(&self, name: &str, v: Vector4<i32>)

Sets an ivec4 uniform.

Source

pub fn set_vec2_u32(&self, name: &str, v: Vector2<u32>)

Sets a uvec2 uniform.

Source

pub fn set_vec3_u32(&self, name: &str, v: Vector3<u32>)

Sets a uvec3 uniform.

Source

pub fn set_vec4_u32(&self, name: &str, v: Vector4<u32>)

Sets a uvec4 uniform.

Source

pub fn set_m2_f32(&self, name: &str, m: Matrix2<f32>)

Sets a mat2 uniform.

Source

pub fn set_m3_f32(&self, name: &str, m: Matrix3<f32>)

Sets a mat3 uniform.

Source

pub fn set_m4_f32(&self, name: &str, m: Matrix4<f32>)

Sets a mat4 uniform.

Trait Implementations§

Source§

impl Clone for Shader

Source§

fn clone(&self) -> Shader

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for Shader

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

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

Mutably borrows from an owned value. Read more
Source§

impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> Downcast<T> for T

Source§

fn downcast(&self) -> &T

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> Upcast<T> for T

Source§

fn upcast(&self) -> Option<&T>