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

#include <ktxvulkan.h>

Public Member Functions
ktx_error_code_e	ktxVulkanTexture_Destruct_WithSuballocator (ktxVulkanTexture vkTexture, VkDevice device, const VkAllocationCallbacks pAllocator, ktxVulkanTexture_subAllocatorCallbacks *subAllocatorCallbacks)
	Destructor for the object returned when loading a texture image.

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

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

uint64_t	allocationId

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

◆ allocationId

uint64_t allocationId

An id referencing suballocation(s).

◆ depth

uint32_t depth

The depth of the image.

◆ deviceMemory

VkDeviceMemory deviceMemory

The memory (sub)allocation for the image on the Vulkan device. Will not be used with suballocators.

◆ height

uint32_t height

The height of the image.

◆ image

VkImage image

Handle to the Vulkan image created by the loader.

◆ imageFormat

VkFormat imageFormat

Format of the image data.

◆ imageLayout

VkImageLayout imageLayout

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

◆ layerCount

uint32_t layerCount

The number of array layers in the image.

◆ levelCount

uint32_t levelCount

The number of MIP levels in the image.

◆ viewType

VkImageViewType viewType

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

◆ vkDestroyImage

PFN_vkDestroyImage vkDestroyImage

Pointer to vkDestroyImage function

◆ vkFreeMemory

PFN_vkFreeMemory vkFreeMemory

Pointer to vkFreeMemory function

◆ width

uint32_t width

The width of the image.

Public Member Functions

Data Fields