123 lines
4.2 KiB
Plaintext
123 lines
4.2 KiB
Plaintext
.TH "ktxVulkanDeviceInfo" 3 "Sun Jun 14 2026 18:00:57" "Version 0.0.0" "libktx Reference" \" -*- nroff -*-
|
|
.ad l
|
|
.nh
|
|
.SH NAME
|
|
ktxVulkanDeviceInfo \- Struct for passing information about the Vulkan device on which to create images to the texture image loading functions\&.
|
|
|
|
.SH SYNOPSIS
|
|
.br
|
|
.PP
|
|
.PP
|
|
\fR#include <ktxvulkan\&.h>\fP
|
|
.SS "Public Member Functions"
|
|
|
|
.in +1c
|
|
.ti -1c
|
|
.RI "\fBktxVulkanDeviceInfo\fP * \fBktxVulkanDeviceInfo_Create\fP (VkPhysicalDevice \fBphysicalDevice\fP, VkDevice \fBdevice\fP, VkQueue \fBqueue\fP, VkCommandPool \fBcmdPool\fP, const VkAllocationCallbacks *\fBpAllocator\fP)"
|
|
.br
|
|
.RI "Create a \fBktxVulkanDeviceInfo\fP object\&. "
|
|
.ti -1c
|
|
.RI "\fBktxVulkanDeviceInfo\fP * \fBktxVulkanDeviceInfo_CreateEx\fP (VkInstance \fBinstance\fP, VkPhysicalDevice \fBphysicalDevice\fP, VkDevice \fBdevice\fP, VkQueue \fBqueue\fP, VkCommandPool \fBcmdPool\fP, const VkAllocationCallbacks *\fBpAllocator\fP, const \fBktxVulkanFunctions\fP *pFuncs)"
|
|
.br
|
|
.RI "Create a \fBktxVulkanDeviceInfo\fP object\&. "
|
|
.ti -1c
|
|
.RI "\fBKTX_error_code\fP \fBktxVulkanDeviceInfo_Construct\fP (\fBktxVulkanDeviceInfo\fP *This, VkPhysicalDevice \fBphysicalDevice\fP, VkDevice \fBdevice\fP, VkQueue \fBqueue\fP, VkCommandPool \fBcmdPool\fP, const VkAllocationCallbacks *\fBpAllocator\fP)"
|
|
.br
|
|
.RI "Construct a \fBktxVulkanDeviceInfo\fP object\&. "
|
|
.ti -1c
|
|
.RI "\fBKTX_error_code\fP \fBktxVulkanDeviceInfo_ConstructEx\fP (\fBktxVulkanDeviceInfo\fP *This, VkInstance \fBinstance\fP, VkPhysicalDevice \fBphysicalDevice\fP, VkDevice \fBdevice\fP, VkQueue \fBqueue\fP, VkCommandPool \fBcmdPool\fP, const VkAllocationCallbacks *\fBpAllocator\fP, const \fBktxVulkanFunctions\fP *pFunctions)"
|
|
.br
|
|
.RI "Construct a \fBktxVulkanDeviceInfo\fP object\&. "
|
|
.ti -1c
|
|
.RI "void \fBktxVulkanDeviceInfo_Destruct\fP (\fBktxVulkanDeviceInfo\fP *This)"
|
|
.br
|
|
.RI "Destruct a \fBktxVulkanDeviceInfo\fP object\&. "
|
|
.ti -1c
|
|
.RI "void \fBktxVulkanDeviceInfo_Destroy\fP (\fBktxVulkanDeviceInfo\fP *This)"
|
|
.br
|
|
.RI "Destroy a \fBktxVulkanDeviceInfo\fP object\&. "
|
|
.in -1c
|
|
.SS "Data Fields"
|
|
|
|
.in +1c
|
|
.ti -1c
|
|
.RI "VkInstance \fBinstance\fP"
|
|
.br
|
|
.ti -1c
|
|
.RI "VkPhysicalDevice \fBphysicalDevice\fP"
|
|
.br
|
|
.ti -1c
|
|
.RI "VkDevice \fBdevice\fP"
|
|
.br
|
|
.ti -1c
|
|
.RI "VkQueue \fBqueue\fP"
|
|
.br
|
|
.ti -1c
|
|
.RI "VkCommandBuffer \fBcmdBuffer\fP"
|
|
.br
|
|
.ti -1c
|
|
.RI "VkCommandPool \fBcmdPool\fP"
|
|
.br
|
|
.ti -1c
|
|
.RI "const VkAllocationCallbacks * \fBpAllocator\fP"
|
|
.br
|
|
.ti -1c
|
|
.RI "VkPhysicalDeviceMemoryProperties \fBdeviceMemoryProperties\fP"
|
|
.br
|
|
.ti -1c
|
|
.RI "\fBktxVulkanFunctions\fP \fBvkFuncs\fP"
|
|
.br
|
|
.in -1c
|
|
.SH "Detailed Description"
|
|
.PP
|
|
Struct for passing information about the Vulkan device on which to create images to the texture image loading functions\&.
|
|
|
|
Avoids passing a large number of parameters to each loading function\&. Use of ktxVulkanDeviceInfo_create() or ktxVulkanDeviceInfo_construct() to populate this structure is highly recommended\&.
|
|
|
|
.PP
|
|
.PP
|
|
.nf
|
|
ktxVulkanDeviceInfo vdi;
|
|
ktxVulkanTexture texture;
|
|
|
|
vdi = ktxVulkanDeviceInfo_create(physicalDevice,
|
|
device,
|
|
queue,
|
|
cmdPool,
|
|
&allocator);
|
|
ktxLoadVkTextureN("texture_1\&.ktx", vdi, &texture, NULL, NULL);
|
|
// \&.\&.\&.
|
|
ktxLoadVkTextureN("texture_n\&.ktx", vdi, &texture, NULL, NULL);
|
|
ktxVulkanDeviceInfo_destroy(vdi);
|
|
.fi
|
|
.PP
|
|
|
|
.PP
|
|
\fBExamples\fP
|
|
.in +1c
|
|
\fBvkload\&.cpp\fP\&.
|
|
.SH "Field Documentation"
|
|
.PP
|
|
.SS "VkCommandBuffer cmdBuffer"
|
|
Handle of the cmdBuffer to use\&.
|
|
.SS "VkCommandPool cmdPool"
|
|
Handle of the command pool from which to allocate the command buffer\&.
|
|
.SS "VkDevice device"
|
|
Handle of the logical device\&.
|
|
.SS "VkPhysicalDeviceMemoryProperties deviceMemoryProperties"
|
|
Memory properties of the Vulkan physical device\&.
|
|
.SS "VkInstance instance"
|
|
Instance used to communicate with vulkan\&.
|
|
.SS "const VkAllocationCallbacks* pAllocator"
|
|
Pointer to the allocator to use for the command buffer and created images\&.
|
|
.SS "VkPhysicalDevice physicalDevice"
|
|
Handle of the physical device\&.
|
|
.SS "VkQueue queue"
|
|
Handle to the queue to which to submit commands\&.
|
|
.SS "\fBktxVulkanFunctions\fP vkFuncs"
|
|
The functions needed to operate functions
|
|
|
|
.SH "Author"
|
|
.PP
|
|
Generated automatically by Doxygen for libktx Reference from the source code\&.
|