render_engine 0.1.0-alpha.3

A Metal-based 3D rendering engine for macOS
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
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61

//! Graphics backend module for the renderer.
//!
//! This module defines the `GraphicsBackend` trait, which provides an interface
//! for different graphics APIs (such as Metal and Vulkan) to implement. It also
//! re-exports the specific backend implementations.
//!
//! The `GraphicsBackend` trait defines methods for:
//! - Rendering operations
//! - Buffer management (vertex, index, uniform, and instance buffers)
//! - Texture creation and updates
//! - Render pipeline state creation
//!
//! Implementations of this trait allow the renderer to work with different
//! graphics APIs in a unified manner.

pub mod metal;
pub mod vulkan;

use super::{
    common::{BackendDrawCommand, RendererError, TextureId, Uniforms, Vertex},
    render_queue::InstanceData,
};
use ::metal::{MTLRegion, RenderPassDescriptorRef, RenderPipelineDescriptor, TextureDescriptor};

/// Trait defining the interface for graphics backends.
///
/// Implementations of this trait provide the necessary methods for rendering,
/// buffer management, and pipeline state creation for specific graphics APIs
/// and allows for proper abstraction of the backend and renderer.
pub trait GraphicsBackend {
    #[allow(dead_code)]
    fn render_pass(&mut self, descriptor: &RenderPassDescriptorRef) -> Result<(), RendererError>;
    fn draw(&mut self, draw_command: BackendDrawCommand) -> Result<(), RendererError>;

    fn update_vertex_buffer(&mut self, vertices: &[Vertex]) -> Result<(), RendererError>;
    fn update_index_buffer(&mut self, indices: &[u32]) -> Result<(), RendererError>;
    fn update_uniform_buffer(&mut self, uniforms: &Uniforms) -> Result<(), RendererError>;
    fn update_instance_buffer(&mut self, instances: &[InstanceData]) -> Result<(), RendererError>;

    #[allow(dead_code)]
    fn create_texture(&mut self, descriptor: &TextureDescriptor) -> TextureId;

    #[allow(dead_code)]
    #[allow(clippy::too_many_arguments)]
    fn update_texture(
        &mut self,
        id: TextureId,
        region: MTLRegion,
        mipmap_level: u64,
        slice: u64,
        bytes: &[u8],
        bytes_per_row: u64,
        bytes_per_image: u64,
    ) -> Result<(), RendererError>;

    #[allow(dead_code)]
    fn create_render_pipeline_state(
        &mut self,
        descriptor: &RenderPipelineDescriptor,
    ) -> Result<(), RendererError>;
}