.TH "lib/strings.c" 3 "Sun Jun 14 2026 18:00:57" "Version 0.0.0" "libktx Reference" \" -*- nroff -*-
.ad l
.nh
.SH NAME
lib/strings.c \- Functions to return a string corresponding to various enumerations\&.  

.SH SYNOPSIS
.br
.PP
\fR#include 'ktx\&.h'\fP
.br
\fR#include 'basis_sgd\&.h'\fP
.br

.SS "Functions"

.in +1c
.ti -1c
.RI "const char * \fBktxErrorString\fP (\fBKTX_error_code\fP error)"
.br
.RI "Return a string corresponding to a KTX error code\&. "
.ti -1c
.RI "const char * \fBktxTranscodeFormatString\fP (\fBktx_transcode_fmt_e\fP format)"
.br
.RI "Return a string corresponding to a transcode format enumeration\&. "
.ti -1c
.RI "const char * \fBktxSupercompressionSchemeString\fP (\fBktxSupercmpScheme\fP scheme)"
.br
.RI "Return a string corresponding to a supercompressionScheme enumeration\&. "
.ti -1c
.RI "const char * \fBktxBUImageFlagsBitString\fP (ktx_uint32_t bit_index, bool bit_value)"
.br
.RI "Return a string corresponding to a bu_image_flags bit\&. "
.in -1c
.SH "Detailed Description"
.PP 
Functions to return a string corresponding to various enumerations\&. 


.PP
\fBAuthor\fP
.RS 4
Mark Callow, HI Corporation 
.RE
.PP

.SH "Function Documentation"
.PP 
.SS "const char * ktxBUImageFlagsBitString (ktx_uint32_t bit_index, bool bit_value)"

.PP
Return a string corresponding to a bu_image_flags bit\&. 
.PP
\fBParameters\fP
.RS 4
\fIbit_index\fP the bu_image_flag bit to test\&. 
.br
\fIbit_value\fP the bu_image_flag bit value\&.
.RE
.PP
\fBReturns\fP
.RS 4
pointer to the message string or NULL otherwise\&. 
.RE
.PP

.SS "const char * ktxErrorString (\fBKTX_error_code\fP error)"

.PP
Return a string corresponding to a KTX error code\&. 
.PP
\fBParameters\fP
.RS 4
\fIerror\fP the error code for which to return a string
.RE
.PP
\fBReturns\fP
.RS 4
pointer to the message string\&. 
.RE
.PP

.SS "const char * ktxSupercompressionSchemeString (\fBktxSupercmpScheme\fP scheme)"

.PP
Return a string corresponding to a supercompressionScheme enumeration\&. 
.PP
\fBParameters\fP
.RS 4
\fIscheme\fP the supercompression scheme for which to return a string\&.
.RE
.PP
\fBReturns\fP
.RS 4
pointer to the message string\&. 
.RE
.PP

.SS "const char * ktxTranscodeFormatString (\fBktx_transcode_fmt_e\fP format)"

.PP
Return a string corresponding to a transcode format enumeration\&. 
.PP
\fBParameters\fP
.RS 4
\fIformat\fP the transcode format for which to return a string\&.
.RE
.PP
\fBReturns\fP
.RS 4
pointer to the message string\&. 
.RE
.PP

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