beamterm-core 1.0.0

Platform-agnostic OpenGL terminal renderer using glow
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35

use crate::gl::context::GlState;

/// Rendering context that provides access to GL state.
pub struct RenderContext<'a> {
    /// GL context reference.
    pub gl: &'a glow::Context,
    /// Mutable GL state tracker for call deduplication.
    pub state: &'a mut GlState,
}

/// Trait for objects that can be rendered.
pub trait Drawable {
    /// Prepares the object for rendering.
    ///
    /// This method should set up all necessary OpenGL state, bind shaders,
    /// textures, and vertex data required for rendering.
    ///
    /// # Errors
    /// May return an error if GPU resource preparation fails (e.g., dynamic
    /// atlas glyph upload).
    fn prepare(&self, context: &mut RenderContext) -> Result<(), crate::Error>;

    /// Performs the actual rendering.
    ///
    /// This method should issue draw calls to render the object. All necessary
    /// state should already be set up from the `prepare()` call.
    fn draw(&self, context: &mut RenderContext);

    /// Cleans up after rendering.
    ///
    /// This method should restore OpenGL state and unbind any resources
    /// that were bound during `prepare()`. This ensures proper cleanup
    /// for subsequent rendering operations.
    fn cleanup(&self, context: &mut RenderContext);
}