Struct draw2d::graphics::vulkan::texture::TextureImage

pub struct TextureImage { /* fields omitted */ }

The TextureImage maintains the image, view, and memory, which are required when rendering with a texture.

Implementations

impl TextureImage

pub unsafe fn raw_image(&self) -> Image

The raw image handle used by this texture.

Unsafe because it is up to the caller to synchronize access to the image.

pub unsafe fn raw_view(&self) -> ImageView

The raw image view used by this texture.

Unsafe because it is up to the caller to synchronize access to the view.

pub fn new(
    device: Arc<Device>,
    image_create_info: ImageCreateInfo,
    memory_property_flags: MemoryPropertyFlags,
    bytes_per_pixel: u64
) -> Result<Self>

Create the image, allocate memory, create a view for the texture.

Bytes per pixel is used by the various upload_* methods when copying data from a buffer into the image. For example, if the image format is R8G8B8A8_SRGB then the bytes per pixel is 4.

pub unsafe fn upload_from_buffer<Buf>(&mut self, src: &Buf) -> Result<()> where
    Buf: Buffer, 

Upload a texture’s data from a buffer.

This method is just an alias to Self::upload_mipmaps_from_buffer which only updates the first mipmap. It’s particularly convenient for textures which only have a single mipmap level.

pub unsafe fn upload_mipmaps_from_buffer(
    &mut self,
    src: &impl Buffer,
    mipmap_sizes: &[MipmapExtent]
) -> Result<()>

Upload a texture’s mipmaps from a buffer.

• This method assumes that each mipmap has the same bytes_per_pixel as the texture image.
• Order is super important. The first entry in mipmap_sizes corresponds to the first region of memory in the src bufer. The mipmap extents are used to compute the byte offset and size of each mipmap region.

pub unsafe fn write_barrier(
    &self,
    command_buffer: CommandBuffer,
    mip_level: u32
)

Transition the image memory layout such that it is an optimal transfer target.

Trait Implementations

impl Drop for TextureImage

fn drop(&mut self)

Executes the destructor for this type.