libktx - The KTX Library 4.1.0
Libraries and tools to create and read KTX image texture files.
ktxVulkanTexture Class Reference

Struct for returning information about the Vulkan texture image created by the ktxTexture_VkUpload* functions. More...

#include <ktxvulkan.h>

Public Member Functions

void ktxVulkanTexture_Destruct (ktxVulkanTexture *vkTexture, VkDevice device, const VkAllocationCallbacks *pAllocator)
 Destructor for the object returned when loading a texture image. More...
 

Data Fields

PFN_vkDestroyImage vkDestroyImage
 
PFN_vkFreeMemory vkFreeMemory
 
VkImage image
 
VkFormat imageFormat
 
VkImageLayout imageLayout
 
VkDeviceMemory deviceMemory
 
VkImageViewType viewType
 
uint32_t width
 
uint32_t height
 
uint32_t depth
 
uint32_t levelCount
 
uint32_t layerCount
 

Detailed Description

Struct for returning information about the Vulkan texture image created by the ktxTexture_VkUpload* functions.

Creation of these objects is internal to the upload functions.

Examples
vkload.cpp.

Field Documentation

◆ depth

uint32_t ktxVulkanTexture::depth

The depth of the image.

◆ deviceMemory

VkDeviceMemory ktxVulkanTexture::deviceMemory

The memory allocated for the image on the Vulkan device.

◆ height

uint32_t ktxVulkanTexture::height

The height of the image.

◆ image

VkImage ktxVulkanTexture::image

Handle to the Vulkan image created by the loader.

◆ imageFormat

VkFormat ktxVulkanTexture::imageFormat

Format of the image data.

◆ imageLayout

VkImageLayout ktxVulkanTexture::imageLayout

Layout of the created image. Has the same value as layout parameter passed to the loader.

◆ layerCount

uint32_t ktxVulkanTexture::layerCount

The number of array layers in the image.

◆ levelCount

uint32_t ktxVulkanTexture::levelCount

The number of MIP levels in the image.

◆ viewType

VkImageViewType ktxVulkanTexture::viewType

ViewType corresponding to image. Reflects the dimensionality, cubeness and arrayness of the image.

◆ vkDestroyImage

PFN_vkDestroyImage ktxVulkanTexture::vkDestroyImage

Pointer to vkDestroyImage function

◆ vkFreeMemory

PFN_vkFreeMemory ktxVulkanTexture::vkFreeMemory

Pointer to vkFreeMemory function

◆ width

uint32_t ktxVulkanTexture::width

The width of the image.