Struct ShaderFile 

pub struct ShaderFile {
    pub v_src: String,
    pub f_src: String,
    pub is_compute: bool,
}

A shader loaded from disk (or cache), ready to compile.

Loading

use optic_render::asset::{ShaderFile, ShaderType};

let sf = ShaderFile::from_disk("shaders/example.glsl", ShaderType::Pipeline)?;
let shader = sf.compile()?; // returns a Shader handle

Shader format

Pipeline shaders use comment markers to separate vertex and fragment stages within a single .glsl file:

// V
void main() {
    gl_Position = vec4(0.0);
}
// F
void main() {
    outColor = vec4(1.0);
}

Fields

v_src: String

f_src: String

is_compute: bool

Implementations

impl ShaderFile

pub fn from_src(src: &str, typ: ShaderType) -> OpticResult<Self>

Creates a ShaderFile by parsing a combined GLSL source string.

pub fn from_vert_frag(v_src: &str, f_src: &str) -> Self

Creates a pipeline shader from separate vertex and fragment source strings.

pub fn compile(&self) -> OpticResult<Shader>

Compiles this shader and returns a Shader handle.

impl ShaderFile

pub fn from_disk(path: &str, typ: ShaderType) -> OpticResult<Self>

Loads a shader from disk, caching it for release builds.

impl ShaderFile

pub fn save_cached(&self, path: &str) -> OpticResult<()>

Saves this shader to a binary cache file.

impl ShaderFile

pub fn default_3d() -> OpticResult<Self>

Loads the default 3D pipeline shader from optic/assets/shdr/fallback3d.glsl.

pub fn default_2d() -> OpticResult<Self>

Loads the default 2D pipeline shader from optic/assets/shdr/fallback2d.glsl.