#########
BStream.h
#########

.. default-domain:: cpp

Macro Definitions
=================

=== ===================================
..  :c:macro:`~__wchar_t`              
..  :c:macro:`~BBINFILETK_API2`        
..  :c:macro:`~BBINFILETK_API`         
..  :c:macro:`~TK_File_Format_Version` 
..  :c:macro:`~TK_DEFAULT_BUFFER_SIZE` 
..  :c:macro:`~ID_Key`                 
..  :c:macro:`~alter`                  
=== ===================================

Types
=====

=== ============================================
..  :cpp:enumerator:`~TK_Status`                
..  :cpp:enumerator:`~TK_File_Write_Options`    
..  :cpp:enumerator:`~TK_Dictionary_Options`    
..  :cpp:enumerator:`~TK_File_Read_Options`     
..  :cpp:enumerator:`~TK_Debug_Logging_Options` 
..  :cpp:enumerator:`~TK_General_Flags`         
=== ============================================

Fields
======

==== =============================================
..   :cpp:enum:`~TK_Normal`                       
..   :cpp:enum:`~TK_Error`                        
..   :cpp:enum:`~TK_Pause`                        
..   :cpp:enum:`~TK_Single`                       
..   :cpp:enum:`~TK_Pending`                      
..   :cpp:enum:`~TK_Revisit`                      
..   :cpp:enum:`~TK_Complete`                     
..   :cpp:enum:`~TK_Version`                      
..   :cpp:enum:`~TK_NotFound`                     
..   :cpp:enum:`~TK_Abort`                        
..   :cpp:enum:`~TK_LibraryNotFound`              
..   :cpp:enum:`~TK_Suppress_LOD`                 
..   :cpp:enum:`~TK_Full_Resolution_Vertices`     
..   :cpp:enum:`~TK_Full_Resolution_Normals`      
..   :cpp:enum:`~TK_First_LOD_Is_Bounding_Box`    
..   :cpp:enum:`~TK_Force_Tags`                   
..   :cpp:enum:`~TK_Disable_Priority_Heuristic`   
..   :cpp:enum:`~TK_Disable_Global_Compression`   
..   :cpp:enum:`~TK_Disable_Instancing`           
..   :cpp:enum:`~TK_Generate_Dictionary`          
..   :cpp:enum:`~TK_Connectivity_Compression`     
..   :cpp:enum:`~TK_Disable_Tristrips`            
..   :cpp:enum:`~TK_Disable_Compound_Primitives`  
..   :cpp:enum:`~TK_Global_Quantization`          
..   :cpp:enum:`~TK_Full_Resolution_Parameters`   
..   :cpp:enum:`~TK_Full_Resolution_Colors`       
..   :cpp:enum:`~TK_Full_Resolution_Index_Colors` 
..   :cpp:enum:`~TK_Communicator_Mode`            
..   :cpp:enum:`~TK_Disable_Custom_Shader`        
..   :cpp:enum:`~TK_All_Global_Textures`          
..   :cpp:enum:`~TK_No_Global_Textures`           
..   :cpp:enum:`~TK_Full_Resolution`              
..   :cpp:enum:`~TK_Dictionary_Bounding_Volumes`  
..   :cpp:enum:`~TK_Flag_Unhandled_Opcodes`       
..   :cpp:enum:`~TK_Ignore_Version`               
..   :cpp:enum:`~TK_Skip_External_References`     
..   :cpp:enum:`~TK_Ignore_Bounding_LODs`         
..   :cpp:enum:`~TK_Disable_Deferal`              
..   :cpp:enum:`~TK_Logging_Sequence`             
..   :cpp:enum:`~TK_Logging_Tagging`              
..   :cpp:enum:`~TK_Logging_Segment_Names`        
..   :cpp:enum:`~TK_Double_Precision`             
..   :cpp:enum:`~TK_Has_Condition`                
..   :cpp:enum:`~TK_Has_Filter`                   
..   :cpp:enum:`~TK_Has_Custody`                  
..   :cpp:enum:`~TK_UTF8_Strings`                 
int  :cpp:var:`~TK_File_Format_History`           
==== =============================================

Functions
=========

============================= =============================================================================================================================
typename T                    :cpp:func:`Swap <void Swap(T &a, T &b)>`                                                                                     
:cpp:enumerator:`~TK_Status`  :cpp:func:`TK_Read_Stream_File <TK_Status BBINFILETK_API TK_Read_Stream_File(char const *filename, BStreamFileToolkit *tk)>` 
:cpp:enumerator:`~TK_Status`  :cpp:func:`TK_Read_Stream_File <TK_Status TK_Read_Stream_File(char const *filename, int flags=0)>`                           
:cpp:enumerator:`~TK_Status`  :cpp:func:`TK_Read_Stream_File <TK_Status TK_Read_Stream_File(wchar_t const *filename, BStreamFileToolkit *tk)>`             
:cpp:enumerator:`~TK_Status`  :cpp:func:`TK_Read_Stream_File <TK_Status TK_Read_Stream_File(wchar_t const *filename, int flags=0)>`                        
:cpp:enumerator:`~TK_Status`  :cpp:func:`TK_Read_Stream_File <TK_Status TK_Read_Stream_File(char const *filename, int flags, BStreamFileToolkit *tk)>`     
============================= =============================================================================================================================

Detailed Description
====================

.. doxygenfile:: BStream.h
   :project: base_stream
   :sections: detaileddescription

Macro Definition
================

.. doxygendefine:: __wchar_t
   :project: base_stream

.. doxygendefine:: BBINFILETK_API2
   :project: base_stream

.. doxygendefine:: BBINFILETK_API
   :project: base_stream

.. doxygendefine:: TK_File_Format_Version
   :project: base_stream

.. doxygendefine:: TK_DEFAULT_BUFFER_SIZE
   :project: base_stream

.. doxygendefine:: ID_Key
   :project: base_stream

.. doxygendefine:: alter
   :project: base_stream

Type Documentation
==================

.. doxygenenum:: TK_File_Write_Options
   :project: base_stream

.. doxygenenum:: TK_Dictionary_Options
   :project: base_stream

.. doxygenenum:: TK_File_Read_Options
   :project: base_stream

.. doxygenenum:: TK_Debug_Logging_Options
   :project: base_stream

.. doxygenenum:: TK_General_Flags
   :project: base_stream

Field Documentation
===================

.. doxygenvariable:: TK_File_Format_History
   :project: base_stream

Function Documentation
======================

.. doxygenfunction:: Swap
   :project: base_stream



