Add ktx

2026-06-14 19:09:18 +01:00
parent 14bd1a9271
commit 13fa90a0e9
3958 changed files with 999286 additions and 4 deletions
@@ -0,0 +1,125 @@
+.TH "ktxStream" 3 "Sun Jun 14 2026 18:00:57" "Version 0.0.0" "libktx Reference" \" -*- nroff -*-
+.ad l
+.nh
+.SH NAME
+ktxStream \- Interface of \fBktxStream\fP\&.  
+
+.SH SYNOPSIS
+.br
+.PP
+.PP
+\fR#include <ktx\&.h>\fP
+.SS "Data Fields"
+
+.in +1c
+.ti -1c
+.RI "\fBktxStream_read\fP \fBread\fP"
+.br
+.ti -1c
+.RI "\fBktxStream_skip\fP \fBskip\fP"
+.br
+.ti -1c
+.RI "\fBktxStream_write\fP \fBwrite\fP"
+.br
+.ti -1c
+.RI "\fBktxStream_getpos\fP \fBgetpos\fP"
+.br
+.ti -1c
+.RI "\fBktxStream_setpos\fP \fBsetpos\fP"
+.br
+.ti -1c
+.RI "\fBktxStream_getsize\fP \fBgetsize\fP"
+.br
+.ti -1c
+.RI "\fBktxStream_destruct\fP \fBdestruct\fP"
+.br
+.ti -1c
+.RI "union {"
+.br
+.ti -1c
+.RI "   FILE * \fBfile\fP"
+.br
+.ti -1c
+.RI "   ktxMem * \fBmem\fP"
+.br
+.ti -1c
+.RI "   struct {"
+.br
+.ti -1c
+.RI "      void * \fBaddress\fP"
+.br
+.ti -1c
+.RI "      void * \fBallocatorAddress\fP"
+.br
+.ti -1c
+.RI "      ktx_size_t \fBsize\fP"
+.br
+.ti -1c
+.RI "   } \fBcustom_ptr\fP"
+.br
+.ti -1c
+.RI "} \fBdata\fP"
+.br
+.ti -1c
+.RI "ktx_off_t \fBreadpos\fP"
+.br
+.ti -1c
+.RI "ktx_bool_t \fBcloseOnDestruct\fP"
+.br
+.in -1c
+.SH "Detailed Description"
+.PP 
+Interface of \fBktxStream\fP\&. 
+
+
+.PP
+\fBAuthor\fP
+.RS 4
+Maksim Kolesin 
+
+.PP
+Georg Kolling, Imagination Technology 
+
+.PP
+Mark Callow, HI Corporation 
+.RE
+.PP
+
+.SH "Field Documentation"
+.PP 
+.SS "void* address"
+pointer to the data\&. 
+.SS "void* allocatorAddress"
+pointer to a memory allocator\&. 
+.SS "ktx_bool_t closeOnDestruct"
+Close FILE* or dispose of memory on destruct\&. 
+.SS "struct  { \&.\&.\&. }  custom_ptr"
+pointer to a struct for custom streams\&. 
+.SS "union  { \&.\&.\&. }  data"
+pointer to the stream data\&. 
+.SS "\fBktxStream_destruct\fP destruct"
+destruct the stream\&. 
+.SS "FILE* file"
+a stdio FILE pointer for a ktxFileStream\&. 
+.SS "\fBktxStream_getpos\fP getpos"
+pointer to function for getting current position in stream\&. 
+.SS "\fBktxStream_getsize\fP getsize"
+pointer to function for querying size\&. 
+.SS "ktxMem* mem"
+a pointer to a ktxMem struct for a ktxMemStream\&. 
+.SS "\fBktxStream_read\fP read"
+pointer to function for reading bytes\&. 
+.SS "ktx_off_t readpos"
+used by FileStream for stdin\&. 
+.SS "\fBktxStream_setpos\fP setpos"
+pointer to function for setting current position in stream\&. 
+.SS "ktx_size_t size"
+size of the data\&. 
+.SS "\fBktxStream_skip\fP skip"
+pointer to function for skipping bytes\&. 
+.SS "\fBktxStream_write\fP write"
+pointer to function for writing bytes\&. 
+
+.SH "Author"
+.PP 
+Generated automatically by Doxygen for libktx Reference from the source code\&.