Struct VulkanTexture 

pub struct VulkanTexture {
    pub device: Arc<VulkanDevice>,
    pub staging_buffer: Option<StagingBuffer>,
    /* private fields */
}

The wrapper for the Vulkan texture images

Fields

device: Arc<VulkanDevice>

The device holds all of the resource

staging_buffer: Option<StagingBuffer>

The staging buffer for the texture

Implementations

impl VulkanTexture

pub fn new( device: Arc<VulkanDevice>, type_size: VulkanTextureType, with_mipmap: bool, format: VkFormat, usage: VkImageUsageFlags, ) -> Result<Self, VulkanError>

Create the VulkanTexture

pub fn new_from_image<P, Container>( device: Arc<VulkanDevice>, cmdbuf: VkCommandBuffer, image: &ImageBuffer<P, Container>, channel_is_normalized: bool, with_mipmap: bool, usage: VkImageUsageFlags, ) -> Result<Self, VulkanError>

where P: Pixel, Container: Deref<Target = [P::Subpixel]>, <P as Pixel>::Subpixel: 'static,

Create a texture from image right away

pub fn get_size(&self) -> Result<VkDeviceSize, VulkanError>

Get the size of the image

pub fn get_pitch(&self) -> Result<usize, VulkanError>

Get the pitch, the bytes per row of the texture

pub fn get_mipmap_levels(&self) -> u32

Get the mipmap levels

pub fn ensure_staging_buffer(&mut self) -> Result<(), VulkanError>

Create the staging buffer if it not exists

pub fn get_staging_buffer_address(&mut self) -> Result<*mut c_void, VulkanError>

Get the data pointer of the staging buffer

pub fn discard_staging_buffer(&mut self)

Discard the staging buffer to save memory

pub fn set_staging_data( &mut self, data: *const c_void, offset: VkDeviceSize, size: usize, ) -> Result<(), VulkanError>

Update new data to the staging buffer

pub unsafe fn set_staging_data_from_compact_pixels( &mut self, offset: usize, src_ptr: *const c_void, src_stride: usize, num_rows: u32, ) -> Result<(), VulkanError>

Copy image data from a compactly packed pixels to the 32-bit aligned staging buffer

Safety

This function is unsafe due to these factors:

• The purpose of offset is for modifying each layer of the 3D texture, and is unchecked.
• The src_stride is unchecked. The caller calculates the stride.
• The num_rows is unchecked.

pub fn set_staging_data_from_image<P, Container>( &mut self, image: &ImageBuffer<P, Container>, z_layer: u32, ) -> Result<(), VulkanError>

where P: Pixel, Container: Deref<Target = [P::Subpixel]>,

Update new data to the staging buffer from a RgbImage

pub fn upload_staging_buffer( &self, cmdbuf: VkCommandBuffer, offset: &VkOffset3D, extent: &VkExtent3D, ) -> Result<(), VulkanError>

Upload the staging buffer data to the texture

pub fn upload_staging_buffer_multi( &self, cmdbuf: VkCommandBuffer, regions: &[TextureRegion], ) -> Result<(), VulkanError>

Upload the staging buffer data to the texture

pub fn get_type_size(&self) -> VulkanTextureType

Get the type and size of the texture

pub fn is_cube(&self) -> bool

Get if the image is cubemap

pub fn is_depth_stencil(&self) -> bool

Get if the image is depth stencil

pub fn get_image_type(&self) -> VkImageType

Get the VkImageType

pub fn get_extent(&self) -> VkExtent3D

Get the extent of the image

pub fn generate_mipmaps( &mut self, cmdbuf: VkCommandBuffer, filter: VkFilter, ) -> Result<(), VulkanError>

Generate mipmaps for the texture

Trait Implementations

impl Debug for VulkanTexture

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Drop for VulkanTexture

fn drop(&mut self)

Executes the destructor for this type.

impl Send for VulkanTexture

impl Sync for VulkanTexture