.TH "lib/filestream.c" 3 "Sun Jun 14 2026 18:00:57" "Version 0.0.0" "libktx Reference" \" -*- nroff -*-
.ad l
.nh
.SH NAME
lib/filestream.c \- Implementation of \fBktxStream\fP for FILE\&.  

.SH SYNOPSIS
.br
.PP
\fR#include <assert\&.h>\fP
.br
\fR#include <errno\&.h>\fP
.br
\fR#include <inttypes\&.h>\fP
.br
\fR#include <string\&.h>\fP
.br
\fR#include <stdio\&.h>\fP
.br
\fR#include <stdlib\&.h>\fP
.br
\fR#include <sys/types\&.h>\fP
.br
\fR#include <sys/stat\&.h>\fP
.br
\fR#include 'ktx\&.h'\fP
.br
\fR#include 'ktxint\&.h'\fP
.br
\fR#include 'filestream\&.h'\fP
.br

.SS "Functions"

.in +1c
.ti -1c
.RI "\fBKTX_error_code\fP \fBktxFileStream_construct\fP (\fBktxStream\fP *str, FILE *file, ktx_bool_t closeFileOnDestruct)"
.br
.RI "Initialize a ktxFileStream\&. "
.ti -1c
.RI "void \fBktxFileStream_destruct\fP (\fBktxStream\fP *str)"
.br
.RI "Destruct the stream, potentially closing the underlying FILE\&. "
.in -1c
.SH "Detailed Description"
.PP 
Implementation of \fBktxStream\fP for FILE\&. 


.PP
\fBAuthor\fP
.RS 4
Maksim Kolesin, Under Development 

.PP
Georg Kolling, Imagination Technology 

.PP
Mark Callow, HI Corporation 
.RE
.PP

.SH "Function Documentation"
.PP 
.SS "\fBKTX_error_code\fP ktxFileStream_construct (\fBktxStream\fP * str, FILE * file, ktx_bool_t closeFileOnDestruct)"

.PP
Initialize a ktxFileStream\&. 
.PP
\fBParameters\fP
.RS 4
\fIstr\fP pointer to the \fBktxStream\fP to initialize\&. 
.br
\fIfile\fP pointer to the underlying FILE object\&. 
.br
\fIcloseFileOnDestruct\fP if not false, stdio file pointer will be closed when \fBktxStream\fP is destructed\&.
.RE
.PP
\fBReturns\fP
.RS 4
KTX_SUCCESS on success, KTX_INVALID_VALUE on error\&.
.RE
.PP
\fBExceptions\fP
.RS 4
\fI\fBKTX_INVALID_VALUE\fP\fP \fRstream\fP is \fRNULL\fP or \fRfile\fP is \fRNULL\fP\&. 
.RE
.PP

.SS "void ktxFileStream_destruct (\fBktxStream\fP * str)"

.PP
Destruct the stream, potentially closing the underlying FILE\&. This only closes the underyling FILE if the \fRcloseOnDestruct\fP parameter to \fBktxFileStream_construct()\fP was not \fRKTX_FALSE\fP\&.

.PP
\fBParameters\fP
.RS 4
\fIstr\fP pointer to the \fBktxStream\fP whose FILE is to potentially be closed\&. 
.RE
.PP

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