.TH "ktxVulkanTexture" 3 "Sun Jun 14 2026 18:00:57" "Version 0.0.0" "libktx Reference" \" -*- nroff -*-
.ad l
.nh
.SH NAME
ktxVulkanTexture \- Struct for returning information about the Vulkan texture image created by the ktxTexture_VkUpload* functions\&.  

.SH SYNOPSIS
.br
.PP
.PP
\fR#include <ktxvulkan\&.h>\fP
.SS "Public Member Functions"

.in +1c
.ti -1c
.RI "\fBktx_error_code_e\fP \fBktxVulkanTexture_Destruct_WithSuballocator\fP (\fBktxVulkanTexture\fP *vkTexture, VkDevice device, const VkAllocationCallbacks *pAllocator, \fBktxVulkanTexture_subAllocatorCallbacks\fP *subAllocatorCallbacks)"
.br
.RI "Destructor for the object returned when loading a texture image\&. "
.ti -1c
.RI "void \fBktxVulkanTexture_Destruct\fP (\fBktxVulkanTexture\fP *vkTexture, VkDevice device, const VkAllocationCallbacks *pAllocator)"
.br
.RI "Destructor for the object returned when loading a texture image\&. "
.in -1c
.SS "Data Fields"

.in +1c
.ti -1c
.RI "PFN_vkDestroyImage \fBvkDestroyImage\fP"
.br
.ti -1c
.RI "PFN_vkFreeMemory \fBvkFreeMemory\fP"
.br
.ti -1c
.RI "VkImage \fBimage\fP"
.br
.ti -1c
.RI "VkFormat \fBimageFormat\fP"
.br
.ti -1c
.RI "VkImageLayout \fBimageLayout\fP"
.br
.ti -1c
.RI "VkDeviceMemory \fBdeviceMemory\fP"
.br
.ti -1c
.RI "VkImageViewType \fBviewType\fP"
.br
.ti -1c
.RI "uint32_t \fBwidth\fP"
.br
.ti -1c
.RI "uint32_t \fBheight\fP"
.br
.ti -1c
.RI "uint32_t \fBdepth\fP"
.br
.ti -1c
.RI "uint32_t \fBlevelCount\fP"
.br
.ti -1c
.RI "uint32_t \fBlayerCount\fP"
.br
.ti -1c
.RI "uint64_t \fBallocationId\fP"
.br
.in -1c
.SH "Detailed Description"
.PP 
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\&. 
.PP
\fBExamples\fP
.in +1c
\fBvkload\&.cpp\fP\&.
.SH "Field Documentation"
.PP 
.SS "uint64_t allocationId"
An id referencing suballocation(s)\&. 
.SS "uint32_t depth"
The depth of the image\&. 
.SS "VkDeviceMemory deviceMemory"
The memory (sub)allocation for the image on the Vulkan device\&. Will not be used with suballocators\&. 
.SS "uint32_t height"
The height of the image\&. 
.SS "VkImage image"
Handle to the Vulkan image created by the loader\&. 
.SS "VkFormat imageFormat"
Format of the image data\&. 
.SS "VkImageLayout imageLayout"
Layout of the created image\&. Has the same value as \fRlayout\fP parameter passed to the loader\&. 
.SS "uint32_t layerCount"
The number of array layers in the image\&. 
.SS "uint32_t levelCount"
The number of MIP levels in the image\&. 
.SS "VkImageViewType viewType"
ViewType corresponding to \fRimage\fP\&. Reflects the dimensionality, cubeness and arrayness of the image\&. 
.SS "PFN_vkDestroyImage vkDestroyImage"
Pointer to vkDestroyImage function 
.SS "PFN_vkFreeMemory vkFreeMemory"
Pointer to vkFreeMemory function 
.SS "uint32_t width"
The width of the image\&. 

.SH "Author"
.PP 
Generated automatically by Doxygen for libktx Reference from the source code\&.