97 lines
2.4 KiB
Plaintext
97 lines
2.4 KiB
Plaintext
.TH "ktxTextureCreateInfo" 3 "Sun Jun 14 2026 18:00:57" "Version 0.0.0" "libktx Reference" \" -*- nroff -*-
|
|
.ad l
|
|
.nh
|
|
.SH NAME
|
|
ktxTextureCreateInfo \- Structure for passing texture information to ktxTexture1_Create() and ktxTexture2_Create()\&.
|
|
|
|
.SH SYNOPSIS
|
|
.br
|
|
.PP
|
|
.PP
|
|
\fR#include <ktx\&.h>\fP
|
|
.SS "Data Fields"
|
|
|
|
.in +1c
|
|
.ti -1c
|
|
.RI "ktx_uint32_t \fBglInternalformat\fP"
|
|
.br
|
|
.ti -1c
|
|
.RI "ktx_uint32_t \fBvkFormat\fP"
|
|
.br
|
|
.ti -1c
|
|
.RI "ktx_uint32_t * \fBpDfd\fP"
|
|
.br
|
|
.ti -1c
|
|
.RI "ktx_uint32_t \fBbaseWidth\fP"
|
|
.br
|
|
.ti -1c
|
|
.RI "ktx_uint32_t \fBbaseHeight\fP"
|
|
.br
|
|
.ti -1c
|
|
.RI "ktx_uint32_t \fBbaseDepth\fP"
|
|
.br
|
|
.ti -1c
|
|
.RI "ktx_uint32_t \fBnumDimensions\fP"
|
|
.br
|
|
.ti -1c
|
|
.RI "ktx_uint32_t \fBnumLevels\fP"
|
|
.br
|
|
.ti -1c
|
|
.RI "ktx_uint32_t \fBnumLayers\fP"
|
|
.br
|
|
.ti -1c
|
|
.RI "ktx_uint32_t \fBnumFaces\fP"
|
|
.br
|
|
.ti -1c
|
|
.RI "ktx_bool_t \fBisArray\fP"
|
|
.br
|
|
.ti -1c
|
|
.RI "ktx_bool_t \fBgenerateMipmaps\fP"
|
|
.br
|
|
.in -1c
|
|
.SH "Detailed Description"
|
|
.PP
|
|
Structure for passing texture information to ktxTexture1_Create() and ktxTexture2_Create()\&.
|
|
|
|
|
|
.PP
|
|
\fBSee also\fP
|
|
.RS 4
|
|
\fBktxTexture1_Create()\fP
|
|
|
|
.PP
|
|
\fBktxTexture2_Create()\fP
|
|
.RE
|
|
.PP
|
|
|
|
.SH "Field Documentation"
|
|
.PP
|
|
.SS "ktx_uint32_t baseDepth"
|
|
Depth of the base level of the texture\&.
|
|
.SS "ktx_uint32_t baseHeight"
|
|
Height of the base level of the texture\&.
|
|
.SS "ktx_uint32_t baseWidth"
|
|
Width of the base level of the texture\&.
|
|
.SS "ktx_bool_t generateMipmaps"
|
|
Set to KTX_TRUE if mipmaps should be generated for the texture when loading into a 3D API\&.
|
|
.SS "ktx_uint32_t glInternalformat"
|
|
Internal format for the texture, e\&.g\&., GL_RGB8\&. Ignored when creating a \fBktxTexture2\fP\&.
|
|
.SS "ktx_bool_t isArray"
|
|
Set to KTX_TRUE if the texture is to be an array texture\&. Means OpenGL will use a GL_TEXTURE_*_ARRAY target\&.
|
|
.SS "ktx_uint32_t numDimensions"
|
|
Number of dimensions in the texture, 1, 2 or 3\&.
|
|
.SS "ktx_uint32_t numFaces"
|
|
Number of faces: 6 for cube maps, 1 otherwise\&.
|
|
.SS "ktx_uint32_t numLayers"
|
|
Number of array layers in the texture\&.
|
|
.SS "ktx_uint32_t numLevels"
|
|
Number of mip levels in the texture\&. Should be 1 if \fRgenerateMipmaps\fP is KTX_TRUE;
|
|
.SS "ktx_uint32_t* pDfd"
|
|
Pointer to DFD\&. Used only when creating a \fBktxTexture2\fP and only if vkFormat is VK_FORMAT_UNDEFINED\&.
|
|
.SS "ktx_uint32_t vkFormat"
|
|
VkFormat for texture\&. Ignored when creating a \fBktxTexture1\fP\&.
|
|
|
|
.SH "Author"
|
|
.PP
|
|
Generated automatically by Doxygen for libktx Reference from the source code\&.
|