rafx-api 0.0.16

#[cfg(feature = "rafx-dx12")]
use crate::dx12::RafxBufferDx12;
#[cfg(any(
    feature = "rafx-empty",
    not(any(
        feature = "rafx-dx12",
        feature = "rafx-metal",
        feature = "rafx-vulkan",
        feature = "rafx-gles2",
        feature = "rafx-gles3"
    ))
))]
use crate::empty::RafxBufferEmpty;
#[cfg(feature = "rafx-gles2")]
use crate::gles2::RafxBufferGles2;
#[cfg(feature = "rafx-gles3")]
use crate::gles3::RafxBufferGles3;
#[cfg(feature = "rafx-metal")]
use crate::metal::RafxBufferMetal;
#[cfg(feature = "rafx-vulkan")]
use crate::vulkan::RafxBufferVulkan;
use crate::{RafxBufferDef, RafxResult};

/// Memory that can be accessed by the rendering API. It may reside in CPU or GPU memory.
///
/// Buffers must not be dropped if they are in use by the GPU.
#[derive(Debug)]
pub enum RafxBuffer {
    #[cfg(feature = "rafx-dx12")]
    Dx12(RafxBufferDx12),
    #[cfg(feature = "rafx-vulkan")]
    Vk(RafxBufferVulkan),
    #[cfg(feature = "rafx-metal")]
    Metal(RafxBufferMetal),
    #[cfg(feature = "rafx-gles2")]
    Gles2(RafxBufferGles2),
    #[cfg(feature = "rafx-gles3")]
    Gles3(RafxBufferGles3),
    #[cfg(any(
        feature = "rafx-empty",
        not(any(
            feature = "rafx-dx12",
            feature = "rafx-metal",
            feature = "rafx-vulkan",
            feature = "rafx-gles2",
            feature = "rafx-gles3"
        ))
    ))]
    Empty(RafxBufferEmpty),
}

impl RafxBuffer {
    /// Copy all the data in the given slice into the buffer. This function will fail if the buffer
    /// is not writable by the CPU. This function will assert/panic if the buffer is too small to
    /// hold the data.
    pub fn copy_to_host_visible_buffer<T: Copy>(
        &self,
        data: &[T],
    ) -> RafxResult<()> {
        match self {
            #[cfg(feature = "rafx-dx12")]
            RafxBuffer::Dx12(inner) => inner.copy_to_host_visible_buffer(data),
            #[cfg(feature = "rafx-vulkan")]
            RafxBuffer::Vk(inner) => inner.copy_to_host_visible_buffer(data),
            #[cfg(feature = "rafx-metal")]
            RafxBuffer::Metal(inner) => inner.copy_to_host_visible_buffer(data),
            #[cfg(feature = "rafx-gles2")]
            RafxBuffer::Gles2(inner) => inner.copy_to_host_visible_buffer(data),
            #[cfg(feature = "rafx-gles3")]
            RafxBuffer::Gles3(inner) => inner.copy_to_host_visible_buffer(data),
            #[cfg(any(
                feature = "rafx-empty",
                not(any(
                    feature = "rafx-dx12",
                    feature = "rafx-metal",
                    feature = "rafx-vulkan",
                    feature = "rafx-gles2",
                    feature = "rafx-gles3"
                ))
            ))]
            RafxBuffer::Empty(inner) => inner.copy_to_host_visible_buffer(data),
        }
    }

    /// Copy all the data in the given slice into the buffer with a given offset. The offset is in
    /// bytes. This function will assert/panic if the size of the buffer <= size of data + offset
    pub fn copy_to_host_visible_buffer_with_offset<T: Copy>(
        &self,
        data: &[T],
        buffer_byte_offset: u64,
    ) -> RafxResult<()> {
        match self {
            #[cfg(feature = "rafx-dx12")]
            RafxBuffer::Dx12(inner) => {
                inner.copy_to_host_visible_buffer_with_offset(data, buffer_byte_offset)
            }
            #[cfg(feature = "rafx-vulkan")]
            RafxBuffer::Vk(inner) => {
                inner.copy_to_host_visible_buffer_with_offset(data, buffer_byte_offset)
            }
            #[cfg(feature = "rafx-metal")]
            RafxBuffer::Metal(inner) => {
                inner.copy_to_host_visible_buffer_with_offset(data, buffer_byte_offset)
            }
            #[cfg(feature = "rafx-gles2")]
            RafxBuffer::Gles2(inner) => {
                inner.copy_to_host_visible_buffer_with_offset(data, buffer_byte_offset)
            }
            #[cfg(feature = "rafx-gles3")]
            RafxBuffer::Gles3(inner) => {
                inner.copy_to_host_visible_buffer_with_offset(data, buffer_byte_offset)
            }
            #[cfg(any(
                feature = "rafx-empty",
                not(any(
                    feature = "rafx-dx12",
                    feature = "rafx-metal",
                    feature = "rafx-vulkan",
                    feature = "rafx-gles2",
                    feature = "rafx-gles3"
                ))
            ))]
            RafxBuffer::Empty(inner) => {
                inner.copy_to_host_visible_buffer_with_offset(data, buffer_byte_offset)
            }
        }
    }

    /// Return the definition used to create the buffer
    pub fn buffer_def(&self) -> &RafxBufferDef {
        match self {
            #[cfg(feature = "rafx-dx12")]
            RafxBuffer::Dx12(inner) => inner.buffer_def(),
            #[cfg(feature = "rafx-vulkan")]
            RafxBuffer::Vk(inner) => inner.buffer_def(),
            #[cfg(feature = "rafx-metal")]
            RafxBuffer::Metal(inner) => inner.buffer_def(),
            #[cfg(feature = "rafx-gles2")]
            RafxBuffer::Gles2(inner) => inner.buffer_def(),
            #[cfg(feature = "rafx-gles3")]
            RafxBuffer::Gles3(inner) => inner.buffer_def(),
            #[cfg(any(
                feature = "rafx-empty",
                not(any(
                    feature = "rafx-dx12",
                    feature = "rafx-metal",
                    feature = "rafx-vulkan",
                    feature = "rafx-gles2",
                    feature = "rafx-gles3"
                ))
            ))]
            RafxBuffer::Empty(inner) => inner.buffer_def(),
        }
    }

    /// Map the contents of the buffer into CPU memory. This function will fail if the buffer is not
    /// possible to map into CPU memory (i.e. it's GPU-only).
    ///
    /// The mappings are "ref-counted". Repeated calls to map the same buffer are permitted and the
    /// buffer will remain mapped until an equal number of calls to unmap_buffer are made.
    ///
    /// Generally speaking, keeping a buffer mapped for its entire lifetime is acceptable.
    pub fn map_buffer(&self) -> RafxResult<*mut u8> {
        match self {
            #[cfg(feature = "rafx-dx12")]
            RafxBuffer::Dx12(inner) => inner.map_buffer(),
            #[cfg(feature = "rafx-vulkan")]
            RafxBuffer::Vk(inner) => inner.map_buffer(),
            #[cfg(feature = "rafx-metal")]
            RafxBuffer::Metal(inner) => inner.map_buffer(),
            #[cfg(feature = "rafx-gles2")]
            RafxBuffer::Gles2(inner) => inner.map_buffer(),
            #[cfg(feature = "rafx-gles3")]
            RafxBuffer::Gles3(inner) => inner.map_buffer(),
            #[cfg(any(
                feature = "rafx-empty",
                not(any(
                    feature = "rafx-dx12",
                    feature = "rafx-metal",
                    feature = "rafx-vulkan",
                    feature = "rafx-gles2",
                    feature = "rafx-gles3"
                ))
            ))]
            RafxBuffer::Empty(inner) => inner.map_buffer(),
        }
    }

    /// Unmap the contents of the buffer from CPU memory. This function will fail if the buffer is
    /// not possible to map into CPU memory (i.e. it's GPU-only). It will also fail if the buffer
    /// is not currently mapped.
    ///
    /// The mappings are "ref-counted". Repeated calls to map the same buffer are permitted and the
    /// buffer will remain mapped until an equal number of calls to unmap_buffer are made.
    pub fn unmap_buffer(&self) -> RafxResult<()> {
        match self {
            #[cfg(feature = "rafx-dx12")]
            RafxBuffer::Dx12(inner) => inner.unmap_buffer(),
            #[cfg(feature = "rafx-vulkan")]
            RafxBuffer::Vk(inner) => inner.unmap_buffer(),
            #[cfg(feature = "rafx-metal")]
            RafxBuffer::Metal(inner) => inner.unmap_buffer(),
            #[cfg(feature = "rafx-gles2")]
            RafxBuffer::Gles2(inner) => inner.unmap_buffer(),
            #[cfg(feature = "rafx-gles3")]
            RafxBuffer::Gles3(inner) => inner.unmap_buffer(),
            #[cfg(any(
                feature = "rafx-empty",
                not(any(
                    feature = "rafx-dx12",
                    feature = "rafx-metal",
                    feature = "rafx-vulkan",
                    feature = "rafx-gles2",
                    feature = "rafx-gles3"
                ))
            ))]
            RafxBuffer::Empty(inner) => inner.unmap_buffer(),
        }
    }

    /// Obtain a pointer to the mapped memory. If the buffer is not mapped, None is returned.
    pub fn mapped_memory(&self) -> Option<*mut u8> {
        match self {
            #[cfg(feature = "rafx-dx12")]
            RafxBuffer::Dx12(inner) => inner.mapped_memory(),
            #[cfg(feature = "rafx-vulkan")]
            RafxBuffer::Vk(inner) => inner.mapped_memory(),
            #[cfg(feature = "rafx-metal")]
            RafxBuffer::Metal(inner) => inner.mapped_memory(),
            #[cfg(feature = "rafx-gles2")]
            RafxBuffer::Gles2(inner) => inner.mapped_memory(),
            #[cfg(feature = "rafx-gles3")]
            RafxBuffer::Gles3(inner) => inner.mapped_memory(),
            #[cfg(any(
                feature = "rafx-empty",
                not(any(
                    feature = "rafx-dx12",
                    feature = "rafx-metal",
                    feature = "rafx-vulkan",
                    feature = "rafx-gles2",
                    feature = "rafx-gles3"
                ))
            ))]
            RafxBuffer::Empty(inner) => inner.mapped_memory(),
        }
    }

    /// Sets a name for this buffer. This is useful for debugging, graphics debuggers/profilers such
    /// as nsight graphics or renderdoc will display this buffer with the given name in the list of resources.
    pub fn set_debug_name(
        &self,
        _name: impl AsRef<str>,
    ) {
        match self {
            #[cfg(feature = "rafx-dx12")]
            RafxBuffer::Dx12(inner) => inner.set_debug_name(_name),
            #[cfg(feature = "rafx-vulkan")]
            RafxBuffer::Vk(inner) => inner.set_debug_name(_name),
            #[cfg(feature = "rafx-metal")]
            RafxBuffer::Metal(inner) => inner.set_debug_name(_name),
            #[cfg(feature = "rafx-gles2")]
            RafxBuffer::Gles2(_) => {}
            #[cfg(feature = "rafx-gles3")]
            RafxBuffer::Gles3(_) => {}
            #[cfg(any(
                feature = "rafx-empty",
                not(any(
                    feature = "rafx-dx12",
                    feature = "rafx-metal",
                    feature = "rafx-vulkan",
                    feature = "rafx-gles2",
                    feature = "rafx-gles3"
                ))
            ))]
            RafxBuffer::Empty(inner) => inner.set_debug_name(_name),
        }
    }

    /// Get the underlying dx12 API object. This provides access to any internally created
    /// vulkan objects.
    #[cfg(feature = "rafx-dx12")]
    pub fn dx12_buffer(&self) -> Option<&RafxBufferDx12> {
        match self {
            #[cfg(feature = "rafx-dx12")]
            RafxBuffer::Dx12(inner) => Some(inner),
            #[cfg(feature = "rafx-vulkan")]
            RafxBuffer::Vk(_) => None,
            #[cfg(feature = "rafx-metal")]
            RafxBuffer::Metal(_) => None,
            #[cfg(feature = "rafx-gles2")]
            RafxBuffer::Gles2(_) => None,
            #[cfg(feature = "rafx-gles3")]
            RafxBuffer::Gles3(_) => None,
            #[cfg(any(
                feature = "rafx-empty",
                not(any(
                    feature = "rafx-dx12",
                    feature = "rafx-metal",
                    feature = "rafx-vulkan",
                    feature = "rafx-gles2",
                    feature = "rafx-gles3"
                ))
            ))]
            RafxBuffer::Empty(_) => None,
        }
    }

    /// Get the underlying vulkan API object. This provides access to any internally created
    /// vulkan objects.
    #[cfg(feature = "rafx-vulkan")]
    pub fn vk_buffer(&self) -> Option<&RafxBufferVulkan> {
        match self {
            #[cfg(feature = "rafx-dx12")]
            RafxBuffer::Dx12(_) => None,
            #[cfg(feature = "rafx-vulkan")]
            RafxBuffer::Vk(inner) => Some(inner),
            #[cfg(feature = "rafx-metal")]
            RafxBuffer::Metal(_) => None,
            #[cfg(feature = "rafx-gles2")]
            RafxBuffer::Gles2(_) => None,
            #[cfg(feature = "rafx-gles3")]
            RafxBuffer::Gles3(_) => None,
            #[cfg(any(
                feature = "rafx-empty",
                not(any(
                    feature = "rafx-dx12",
                    feature = "rafx-metal",
                    feature = "rafx-vulkan",
                    feature = "rafx-gles2",
                    feature = "rafx-gles3"
                ))
            ))]
            RafxBuffer::Empty(_) => None,
        }
    }

    /// Get the underlying metal API object. This provides access to any internally created
    /// metal objects.
    #[cfg(feature = "rafx-metal")]
    pub fn metal_buffer(&self) -> Option<&RafxBufferMetal> {
        match self {
            #[cfg(feature = "rafx-dx12")]
            RafxBuffer::Dx12(_) => None,
            #[cfg(feature = "rafx-vulkan")]
            RafxBuffer::Vk(_) => None,
            #[cfg(feature = "rafx-metal")]
            RafxBuffer::Metal(inner) => Some(inner),
            #[cfg(feature = "rafx-gles2")]
            RafxBuffer::Gles2(_) => None,
            #[cfg(feature = "rafx-gles3")]
            RafxBuffer::Gles3(_) => None,
            #[cfg(any(
                feature = "rafx-empty",
                not(any(
                    feature = "rafx-dx12",
                    feature = "rafx-metal",
                    feature = "rafx-vulkan",
                    feature = "rafx-gles2",
                    feature = "rafx-gles3"
                ))
            ))]
            RafxBuffer::Empty(_) => None,
        }
    }

    /// Get the underlying gl API object. This provides access to any internally created
    /// metal objects.
    #[cfg(feature = "rafx-gles2")]
    pub fn gles2_buffer(&self) -> Option<&RafxBufferGles2> {
        match self {
            #[cfg(feature = "rafx-dx12")]
            RafxBuffer::Dx12(_) => None,
            #[cfg(feature = "rafx-vulkan")]
            RafxBuffer::Vk(_) => None,
            #[cfg(feature = "rafx-metal")]
            RafxBuffer::Metal(_) => None,
            #[cfg(feature = "rafx-gles2")]
            RafxBuffer::Gles2(inner) => Some(inner),
            #[cfg(feature = "rafx-gles3")]
            RafxBuffer::Gles3(_) => None,
            #[cfg(any(
                feature = "rafx-empty",
                not(any(
                    feature = "rafx-dx12",
                    feature = "rafx-metal",
                    feature = "rafx-vulkan",
                    feature = "rafx-gles2",
                    feature = "rafx-gles3"
                ))
            ))]
            RafxBuffer::Empty(_) => None,
        }
    }

    /// Get the underlying gl API object. This provides access to any internally created
    /// metal objects.
    #[cfg(feature = "rafx-gles3")]
    pub fn gles3_buffer(&self) -> Option<&RafxBufferGles3> {
        match self {
            #[cfg(feature = "rafx-dx12")]
            RafxBuffer::Dx12(_) => None,
            #[cfg(feature = "rafx-vulkan")]
            RafxBuffer::Vk(_) => None,
            #[cfg(feature = "rafx-metal")]
            RafxBuffer::Metal(_) => None,
            #[cfg(feature = "rafx-gles2")]
            RafxBuffer::Gles2(_) => None,
            #[cfg(feature = "rafx-gles3")]
            RafxBuffer::Gles3(inner) => Some(inner),
            #[cfg(any(
                feature = "rafx-empty",
                not(any(
                    feature = "rafx-dx12",
                    feature = "rafx-metal",
                    feature = "rafx-vulkan",
                    feature = "rafx-gles2",
                    feature = "rafx-gles3"
                ))
            ))]
            RafxBuffer::Empty(_) => None,
        }
    }

    /// Get the underlying metal API object. This provides access to any internally created
    /// metal objects.
    #[cfg(any(
        feature = "rafx-empty",
        not(any(
            feature = "rafx-dx12",
            feature = "rafx-metal",
            feature = "rafx-vulkan",
            feature = "rafx-gles2",
            feature = "rafx-gles3"
        ))
    ))]
    pub fn empty_buffer(&self) -> Option<&RafxBufferEmpty> {
        match self {
            #[cfg(feature = "rafx-dx12")]
            RafxBuffer::Dx12(_) => None,
            #[cfg(feature = "rafx-vulkan")]
            RafxBuffer::Vk(_) => None,
            #[cfg(feature = "rafx-metal")]
            RafxBuffer::Metal(_) => None,
            #[cfg(feature = "rafx-gles2")]
            RafxBuffer::Gles2(_) => None,
            #[cfg(feature = "rafx-gles3")]
            RafxBuffer::Gles3(_) => None,
            #[cfg(any(
                feature = "rafx-empty",
                not(any(
                    feature = "rafx-dx12",
                    feature = "rafx-metal",
                    feature = "rafx-vulkan",
                    feature = "rafx-gles2",
                    feature = "rafx-gles3"
                ))
            ))]
            RafxBuffer::Empty(inner) => Some(inner),
        }
    }
}