notan_graphics/

device.rs

use crate::buffer::*;
use crate::commands::*;
use crate::crevice::std140::{AsStd140, Std140};
use crate::limits::Limits;
use crate::pipeline::*;
use crate::render_texture::*;
use crate::renderer::Renderer;
use crate::shader::*;
use crate::texture::*;
use parking_lot::RwLock;
use std::sync::Arc;

/// Device resource ID, used to know which resource was dropped
#[derive(Debug)]
pub enum ResourceId {
    Buffer(u64),
    Texture(u64),
    Pipeline(u64),
    RenderTexture(u64),
}

/// Represents what the GPU did in the last frame
#[derive(Clone, Copy, Default, Debug)]
pub struct GpuStats {
    /// Number of draw calls
    pub draw_calls: usize,
    /// Number of read_pixels callas
    pub read_pixels: usize,
    /// Number of textures updated
    pub texture_updates: usize,
    /// Number of textures created
    pub texture_creation: usize,
    /// Number of buffers updated
    pub buffer_updates: usize,
    /// Number of buffers created
    pub buffer_creation: usize,
    /// Any other interaction with the GPU
    pub misc: usize,
}

impl GpuStats {
    pub fn total(&self) -> usize {
        self.draw_calls + self.read_pixels + self.misc
    }
}

/// Represents a the implementation graphics backend like glow, wgpu or another
pub trait DeviceBackend {
    /// Returns the name of the api used (like webgl, wgpu, etc...)
    fn api_name(&self) -> &str;

    /// Return the device limits
    fn limits(&self) -> Limits {
        Default::default()
    }

    /// Return the GPU stats
    fn stats(&self) -> GpuStats;

    /// Reset the GPU stats
    fn reset_stats(&mut self);

    /// Create a new pipeline and returns the id
    fn create_pipeline(
        &mut self,
        vertex_source: &[u8],
        fragment_source: &[u8],
        vertex_attrs: &[VertexAttr],
        texture_locations: &[(u32, String)],
        options: PipelineOptions,
    ) -> Result<u64, String>;

    /// Create a new vertex buffer object and returns the id
    fn create_vertex_buffer(
        &mut self,
        attrs: &[VertexAttr],
        step_mode: VertexStepMode,
    ) -> Result<u64, String>;

    /// Create a new index buffer object and returns the id
    fn create_index_buffer(&mut self, format: IndexFormat) -> Result<u64, String>;

    /// Create a new uniform buffer and returns the id
    fn create_uniform_buffer(&mut self, slot: u32, name: &str) -> Result<u64, String>;

    /// Upload to the GPU the buffer data slice
    fn set_buffer_data(&mut self, buffer: u64, data: &[u8]);

    /// Create a new renderer using the size of the graphics
    fn render(&mut self, commands: &[Commands], target: Option<u64>);

    /// Clean all the dropped resources
    fn clean(&mut self, to_clean: &[ResourceId]);

    /// Sets the render size
    fn set_size(&mut self, width: u32, height: u32);

    /// Sets the screen dpi
    fn set_dpi(&mut self, scale_factor: f64);

    /// Create a new texture and returns the id
    fn create_texture(
        &mut self,
        source: TextureSourceKind,
        info: TextureInfo,
    ) -> Result<(u64, TextureInfo), String>;

    /// Create a new render target and returns the id
    fn create_render_texture(&mut self, texture_id: u64, info: &TextureInfo)
        -> Result<u64, String>;

    /// Update texture data
    fn update_texture(
        &mut self,
        texture: u64,
        source: TextureUpdaterSourceKind,
        opts: TextureUpdate,
    ) -> Result<(), String>;

    /// Read texture pixels
    fn read_pixels(
        &mut self,
        texture: u64,
        bytes: &mut [u8],
        opts: &TextureRead,
    ) -> Result<(), String>;

    fn as_any_mut(&mut self) -> &mut dyn std::any::Any;
}

/// Helper to drop resources on the backend
/// Like pipelines, textures, buffers
#[derive(Debug, Default)]
pub(crate) struct DropManager {
    dropped: RwLock<Vec<ResourceId>>,
}

impl DropManager {
    pub fn push(&self, id: ResourceId) {
        self.dropped.write().push(id);
    }

    pub fn clean(&self) {
        self.dropped.write().clear();
    }
}

pub struct Device {
    size: (u32, u32),
    dpi: f64,
    backend: Box<dyn DeviceBackend>, //TODO generic?
    drop_manager: Arc<DropManager>,
}

impl Device {
    pub fn new(backend: Box<dyn DeviceBackend>) -> Result<Self, String> {
        Ok(Self {
            backend,
            size: (1, 1),
            dpi: 1.0,
            drop_manager: Arc::new(Default::default()),
        })
    }

    #[inline]
    pub fn limits(&self) -> Limits {
        self.backend.limits()
    }

    #[inline]
    pub fn stats(&self) -> GpuStats {
        self.backend.stats()
    }

    #[inline]
    pub fn size(&self) -> (u32, u32) {
        self.size
    }

    #[inline]
    pub fn set_size(&mut self, width: u32, height: u32) {
        self.size = (width, height);
        self.backend.set_size(width, height);
    }

    #[inline]
    pub fn dpi(&self) -> f64 {
        self.dpi
    }

    #[inline]
    pub fn set_dpi(&mut self, scale_factor: f64) {
        self.dpi = scale_factor;
        self.backend.set_dpi(scale_factor);
    }

    #[inline]
    pub fn api_name(&self) -> &str {
        self.backend.api_name()
    }

    #[inline]
    pub fn create_renderer(&self) -> Renderer {
        Renderer::new(self.size.0, self.size.1)
    }

    /// Creates a Pipeline builder
    #[inline]
    pub fn create_pipeline(&mut self) -> PipelineBuilder {
        PipelineBuilder::new(self)
    }

    /// Creates a texture builder
    #[inline]
    pub fn create_texture(&mut self) -> TextureBuilder {
        TextureBuilder::new(self)
    }

    /// Creates a render texture builder
    #[inline]
    pub fn create_render_texture(&mut self, width: u32, height: u32) -> RenderTextureBuilder {
        RenderTextureBuilder::new(self, width, height)
    }

    /// Creates a vertex buffer builder
    #[inline]
    pub fn create_vertex_buffer(&mut self) -> VertexBufferBuilder {
        VertexBufferBuilder::new(self)
    }

    /// Creates a index buffer builder
    #[inline]
    pub fn create_index_buffer(&mut self) -> IndexBufferBuilder {
        IndexBufferBuilder::new(self)
    }

    /// Creates a uniform buffer builder
    #[inline]
    pub fn create_uniform_buffer(&mut self, slot: u32, name: &str) -> UniformBufferBuilder {
        UniformBufferBuilder::new(self, slot, name)
    }

    /// Update the texture data
    #[inline]
    pub fn update_texture<'a>(&'a mut self, texture: &'a mut Texture) -> TextureUpdater<'a> {
        TextureUpdater::new(self, texture)
    }

    /// Read pixels from a texture
    #[inline]
    pub fn read_pixels<'a>(&'a mut self, texture: &'a Texture) -> TextureReader<'a> {
        TextureReader::new(self, texture)
    }

    #[inline]
    pub(crate) fn inner_create_pipeline_from_raw(
        &mut self,
        vertex_source: &[u8],
        fragment_source: &[u8],
        vertex_attrs: &[VertexAttr],
        texture_locations: &[(u32, String)],
        options: PipelineOptions,
    ) -> Result<Pipeline, String> {
        let stride = vertex_attrs
            .iter()
            .fold(0, |acc, data| acc + data.format.bytes()) as usize;

        let id = self.backend.create_pipeline(
            vertex_source,
            fragment_source,
            vertex_attrs,
            texture_locations,
            options,
        )?;

        Ok(Pipeline::new(
            id,
            stride,
            options,
            self.drop_manager.clone(),
        ))
    }

    #[inline]
    pub(crate) fn inner_create_pipeline(
        &mut self,
        vertex_source: &ShaderSource,
        fragment_source: &ShaderSource,
        vertex_attrs: &[VertexAttr],
        texture_locations: &[(u32, String)],
        options: PipelineOptions,
    ) -> Result<Pipeline, String> {
        let api = self.backend.api_name();
        let vertex = match vertex_source.get_source(api) {
            Some(v) => v,
            None => {
                log::warn!("Vertex shader for api '{api}' not available.");
                &[]
            }
        };
        let fragment = match fragment_source.get_source(api) {
            Some(f) => f,
            None => {
                log::warn!("Fragment shader for api '{api}' not available.");
                &[]
            }
        };
        self.inner_create_pipeline_from_raw(
            vertex,
            fragment,
            vertex_attrs,
            texture_locations,
            options,
        )
    }

    #[inline(always)]
    pub(crate) fn inner_create_vertex_buffer(
        &mut self,
        data: Option<&[f32]>,
        attrs: &[VertexAttr],
        step_mode: VertexStepMode,
    ) -> Result<Buffer, String> {
        let id = self.backend.create_vertex_buffer(attrs, step_mode)?;

        let buffer = Buffer::new(id, BufferUsage::Vertex, None, self.drop_manager.clone());

        if let Some(d) = data {
            self.set_buffer_data(&buffer, d);
        }

        Ok(buffer)
    }

    #[inline]
    pub(crate) fn inner_create_index_buffer(
        &mut self,
        data: Option<IndexBufferWrapper>,
        format: IndexFormat,
    ) -> Result<Buffer, String> {
        let id = self.backend.create_index_buffer(format)?;
        let buffer = Buffer::new(id, BufferUsage::Index, None, self.drop_manager.clone());
        if let Some(d) = data {
            match d {
                IndexBufferWrapper::Uint16(s) => self.set_buffer_data(&buffer, s),
                IndexBufferWrapper::Uint32(s) => self.set_buffer_data(&buffer, s),
            }
        }
        Ok(buffer)
    }

    #[inline]
    pub(crate) fn inner_create_uniform_buffer(
        &mut self,
        slot: u32,
        name: &str,
        data: Option<Vec<u8>>,
    ) -> Result<Buffer, String> {
        //debug_assert!(current_pipeline.is_some()) //pipeline should be already binded
        let id = self.backend.create_uniform_buffer(slot, name)?;
        let buffer = Buffer::new(
            id,
            BufferUsage::Uniform(slot),
            None,
            self.drop_manager.clone(),
        );

        if let Some(d) = data {
            self.set_buffer_data(&buffer, &d);
        }

        Ok(buffer)
    }

    #[inline]
    pub(crate) fn inner_create_texture(
        &mut self,
        source: TextureSourceKind,
        info: TextureInfo,
    ) -> Result<Texture, String> {
        let (id, info) = self.backend.create_texture(source, info)?;
        Ok(Texture::new(id, info, self.drop_manager.clone()))
    }

    #[inline]
    pub(crate) fn inner_create_render_texture(
        &mut self,
        info: TextureInfo,
    ) -> Result<RenderTexture, String> {
        let (tex_id, info) = self
            .backend
            .create_texture(TextureSourceKind::Empty, info)?;

        let id = self.backend.create_render_texture(tex_id, &info)?;
        let mut texture = Texture::new(tex_id, info, self.drop_manager.clone());
        texture.is_render_texture = true;
        Ok(RenderTexture::new(id, texture, self.drop_manager.clone()))
    }

    #[inline]
    pub fn render(&mut self, commands: &[Commands]) {
        self.backend.render(commands, None);
    }

    #[inline]
    pub fn render_to(&mut self, target: &RenderTexture, commands: &[Commands]) {
        self.backend.render(commands, Some(target.id()));
    }

    #[inline]
    pub(crate) fn inner_update_texture(
        &mut self,
        texture: &mut Texture,
        source: TextureUpdaterSourceKind,
        opts: TextureUpdate,
    ) -> Result<(), String> {
        self.backend.update_texture(texture.id(), source, opts)
    }

    #[inline]
    pub(crate) fn inner_read_pixels(
        &mut self,
        texture: &Texture,
        bytes: &mut [u8],
        opts: &TextureRead,
    ) -> Result<(), String> {
        // Check if the buffer size is enough to read the pixels
        if cfg!(debug_assertions) {
            let size = (opts.width * opts.height) as usize;
            let bpp = opts.format.bytes_per_pixel() as usize;
            let len = size * bpp;
            debug_assert!(
                bytes.len() >= len,
                "The provided buffer len of {} is less than the required {} when reading pixels from texture {}",
                bytes.len(),
                len,
                texture.id()
            );
        }

        self.backend.read_pixels(texture.id(), bytes, opts)
    }

    #[inline]
    pub fn clean(&mut self) {
        self.backend.reset_stats();

        if self.drop_manager.dropped.read().is_empty() {
            return;
        }

        self.backend.clean(&self.drop_manager.dropped.read());
        self.drop_manager.clean();
    }

    #[inline]
    pub fn set_buffer_data<T: BufferData>(&mut self, buffer: &Buffer, data: T) {
        data.upload(self, buffer.id());
    }

    pub fn downcast_backend<B: DeviceBackend + 'static>(&mut self) -> Result<&mut B, String> {
        self.backend
            .as_any_mut()
            .downcast_mut()
            .ok_or_else(|| "Invalid backend type".to_string())
    }
}

pub trait Uniform: AsStd140 {}
pub trait BufferData {
    fn upload(&self, device: &mut Device, id: u64);
    fn save_as_bytes(&self, _data: &mut Vec<u8>) {}
}

impl<T> BufferData for &[T]
where
    T: bytemuck::Pod,
{
    #[inline]
    fn upload(&self, device: &mut Device, id: u64) {
        device
            .backend
            .set_buffer_data(id, bytemuck::cast_slice(self));
    }

    fn save_as_bytes(&self, data: &mut Vec<u8>) {
        data.extend_from_slice(bytemuck::cast_slice(self));
    }
}

impl<const N: usize, T> BufferData for &[T; N]
where
    T: bytemuck::Pod,
{
    #[inline]
    fn upload(&self, device: &mut Device, id: u64) {
        device
            .backend
            .set_buffer_data(id, bytemuck::cast_slice(self.as_slice()));
    }

    fn save_as_bytes(&self, data: &mut Vec<u8>) {
        data.extend_from_slice(bytemuck::cast_slice(self.as_slice()));
    }
}

impl<T> BufferData for &Vec<T>
where
    T: bytemuck::Pod,
{
    #[inline]
    fn upload(&self, device: &mut Device, id: u64) {
        device
            .backend
            .set_buffer_data(id, bytemuck::cast_slice(self.as_slice()));
    }

    fn save_as_bytes(&self, data: &mut Vec<u8>) {
        data.extend_from_slice(bytemuck::cast_slice(self.as_slice()));
    }
}

impl<T> BufferData for &T
where
    T: Uniform,
{
    #[inline]
    fn upload(&self, device: &mut Device, id: u64) {
        // TODO check opengl version or driver if it uses std140 to layout or not
        device
            .backend
            .set_buffer_data(id, self.as_std140().as_bytes());
    }

    fn save_as_bytes(&self, data: &mut Vec<u8>) {
        data.extend_from_slice(self.as_std140().as_bytes());
    }
}

macro_rules! uniform_impl {
    ( $( $typ:ty, )* ) => {
        $(
            impl Uniform for $typ {}
        )*
    }
}

uniform_impl! {
    notan_math::Vec2,
    notan_math::Vec3,
    notan_math::Vec4,

    notan_math::IVec2,
    notan_math::IVec3,
    notan_math::IVec4,

    notan_math::UVec2,
    notan_math::UVec3,
    notan_math::UVec4,

    notan_math::DVec2,
    notan_math::DVec3,
    notan_math::DVec4,

    notan_math::Mat2,
    notan_math::Mat3,
    notan_math::Mat4,

    notan_math::DMat2,
    notan_math::DMat3,
    notan_math::DMat4,
}