EAGL.Shader (eagl v0.4.0)
View SourceOpenGL shader compilation and program management.
Handles the complex multi-step process of shader compilation, linking, and uniform management with Wings3D-inspired error handling.
Original Source
Uniform helper functions (uloc/2
, set_uloc/3
) are inspired by Wings3D's
wings_gl.erl
module:
https://github.com/dgud/wings/blob/master/src/wings_gl.erl
Usage
import EAGL.Shader
import EAGL.Math
# Compile and link shaders with typed parameters
{:ok, vertex} = create_shader(:vertex, "vertex.glsl")
{:ok, fragment} = create_shader(:fragment, "fragment.glsl")
{:ok, program} = create_attach_link([vertex, fragment])
# Set uniforms with automatic type detection
set_uniform(program, "model_matrix", model_matrix)
set_uniform(program, "light_position", vec3(10.0, 10.0, 5.0))
# Set multiple uniforms efficiently
set_uniforms(program, [
model: model_matrix,
view: view_matrix,
projection: projection_matrix
])
# Use OpenGL directly for program binding
:gl.useProgram(program)
# Clean up when done
cleanup_program(program)
Summary
Functions
Convenience function to cache uniform locations for repeated use. Returns a map of uniform names to their locations.
Checks if a shader compiled successfully.
Cleans up a shader program and all its attached shaders.
Cleans up a shader.
Creates a program, attaches shaders, links, and returns the link status.
Creates and compiles a shader of the specified type with the given source code. Returns the shader ID.
Get uniform location for a program. Similar to wings_gl:uloc/2. Returns the uniform location or -1 if not found.
Set uniform value with automatic type detection. Similar to wings_gl:set_uloc/3. Supports various EAGL.Math types and basic values.
Set uniform value at a specific location with automatic type detection.
Convenience function to set multiple uniforms at once. Takes a program and a list of {name, value} tuples where name can be atom or string.
Types
@type mat2() :: EAGL.Math.mat2()
@type mat3() :: EAGL.Math.mat3()
@type mat4() :: EAGL.Math.mat4()
@type program_id() :: non_neg_integer()
@type quat() :: EAGL.Math.quat()
@type shader_id() :: non_neg_integer()
@type shader_type() ::
:vertex | :fragment | :geometry | :tess_control | :tess_evaluation | :compute
@type vec2() :: EAGL.Math.vec2()
@type vec3() :: EAGL.Math.vec3()
@type vec4() :: EAGL.Math.vec4()
Functions
@spec cache_uniform_locations(program_id(), [String.t() | atom()]) :: %{ required(String.t()) => integer() }
Convenience function to cache uniform locations for repeated use. Returns a map of uniform names to their locations.
Checks if a shader compiled successfully.
Cleans up a shader program and all its attached shaders.
Cleans up a shader.
@spec create_attach_link([shader_id()]) :: {:ok, program_id()} | {:error, String.t()}
Creates a program, attaches shaders, links, and returns the link status.
@spec create_shader(shader_type(), String.t()) :: {:ok, shader_id()} | {:error, String.t()}
Creates and compiles a shader of the specified type with the given source code. Returns the shader ID.
@spec get_uniform_location(program_id(), String.t() | charlist()) :: integer()
Get uniform location for a program. Similar to wings_gl:uloc/2. Returns the uniform location or -1 if not found.
@spec set_uniform(program_id(), String.t() | charlist(), uniform_value()) :: :ok
Set uniform value with automatic type detection. Similar to wings_gl:set_uloc/3. Supports various EAGL.Math types and basic values.
@spec set_uniform_at_location(integer(), uniform_value()) :: :ok | {:error, String.t()}
@spec set_uniform_at_location(integer(), vec3()) :: :ok
@spec set_uniform_at_location(integer(), vec2()) :: :ok
@spec set_uniform_at_location(integer(), vec4() | quat()) :: :ok
@spec set_uniform_at_location(integer(), mat4()) :: :ok
@spec set_uniform_at_location(integer(), mat3()) :: :ok
@spec set_uniform_at_location(integer(), mat2()) :: :ok
@spec set_uniform_at_location(integer(), integer()) :: :ok
@spec set_uniform_at_location(integer(), float()) :: :ok
@spec set_uniform_at_location(integer(), boolean()) :: :ok
Set uniform value at a specific location with automatic type detection.
@spec set_uniforms(program_id(), [{atom() | String.t(), uniform_value()}]) :: :ok
Convenience function to set multiple uniforms at once. Takes a program and a list of {name, value} tuples where name can be atom or string.