#######
IStream
#######

.. cpp:namespace:: RED::IStream

.. default-domain:: cpp

Functions
=========

================================== =========================================================================================================================================================================================================================================================
:doc:`classRED_1_1CID`             :cpp:func:`GetClassID <static RED::CID RED::IStream::GetClassID()>`                                                                                                                                                                                      
:cpp:enumerator:`~RED_RC`          :cpp:func:`Open <virtual RED_RC RED::IStream::Open(ACCESS_MODE iAccessMode)=0>`                                                                                                                                                                          
bool                               :cpp:func:`IsOpen <virtual bool RED::IStream::IsOpen() const =0>`                                                                                                                                                                                        
:cpp:enumerator:`~RED_RC`          :cpp:func:`Close <virtual RED_RC RED::IStream::Close()=0>`                                                                                                                                                                                               
:cpp:enumerator:`~RED_RC`          :cpp:func:`Size <virtual RED_RC RED::IStream::Size(RED::uint64 &oSize) const =0>`                                                                                                                                                                        
:cpp:enumerator:`~RED_RC`          :cpp:func:`MemorySize <virtual RED_RC RED::IStream::MemorySize(RED::uint64 &oSize) const =0>`                                                                                                                                                            
:cpp:enumerator:`~RED_RC`          :cpp:func:`IsEnd <virtual RED_RC RED::IStream::IsEnd(bool &oEnd) const =0>`                                                                                                                                                                              
const :doc:`classRED_1_1String` &  :cpp:func:`GetPath <virtual const RED::String & RED::IStream::GetPath() const =0>`                                                                                                                                                                       
const void *                       :cpp:func:`GetAddress <virtual const void * RED::IStream::GetAddress() const =0>`                                                                                                                                                                        
:cpp:enumerator:`~RED_RC`          :cpp:func:`Move <virtual RED_RC RED::IStream::Move(RED::int64 iPosition, bool iRelative=false)=0>`                                                                                                                                                       
:cpp:enumerator:`~RED_RC`          :cpp:func:`GetCurrentPosition <virtual RED_RC RED::IStream::GetCurrentPosition(RED::uint64 &oPosition) const =0>`                                                                                                                                        
:cpp:enumerator:`~RED_RC`          :cpp:func:`SaveChunk <virtual RED_RC RED::IStream::SaveChunk(RED::Object *iObject, RED::StreamingPolicy &iPolicy)=0>`                                                                                                                                    
:cpp:enumerator:`~RED_RC`          :cpp:func:`LoadChunk <virtual RED_RC RED::IStream::LoadChunk(RED::IReferenceManager *iReferenceManager, const RED::StreamingPolicy &iPolicy, const RED::State &iState, RED::Object **oChunk, unsigned int *oSignature=NULL, RED::uint64 *oSize=NULL)=0>` 
:cpp:enumerator:`~RED_RC`          :cpp:func:`JumpToNextChunk <virtual RED_RC RED::IStream::JumpToNextChunk()=0>`                                                                                                                                                                           
void                               :cpp:func:`SetLoadChunkNotificationCallback <virtual void RED::IStream::SetLoadChunkNotificationCallback(LoadChunkNotificationCallback iCallback, void *iParameter=NULL)=0>`                                                                             
LoadChunkNotificationCallback      :cpp:func:`GetLoadChunkNotificationCallback <virtual LoadChunkNotificationCallback RED::IStream::GetLoadChunkNotificationCallback() const =0>`                                                                                                           
:cpp:enumerator:`~RED_RC`          :cpp:func:`WriteByte <virtual RED_RC RED::IStream::WriteByte(unsigned char iByte)=0>`                                                                                                                                                                    
:cpp:enumerator:`~RED_RC`          :cpp:func:`ReadByte <virtual RED_RC RED::IStream::ReadByte(unsigned char &oByte)=0>`                                                                                                                                                                     
:cpp:enumerator:`~RED_RC`          :cpp:func:`WriteWord <virtual RED_RC RED::IStream::WriteWord(unsigned short iWord)=0>`                                                                                                                                                                   
:cpp:enumerator:`~RED_RC`          :cpp:func:`ReadWord <virtual RED_RC RED::IStream::ReadWord(unsigned short &oWord)=0>`                                                                                                                                                                    
:cpp:enumerator:`~RED_RC`          :cpp:func:`WriteDWord <virtual RED_RC RED::IStream::WriteDWord(unsigned int iDWord)=0>`                                                                                                                                                                  
:cpp:enumerator:`~RED_RC`          :cpp:func:`ReadDWord <virtual RED_RC RED::IStream::ReadDWord(unsigned int &oDWord)=0>`                                                                                                                                                                   
:cpp:enumerator:`~RED_RC`          :cpp:func:`ReadDWord <virtual RED_RC RED::IStream::ReadDWord(RED::uint64 &oDWord)=0>`                                                                                                                                                                    
:cpp:enumerator:`~RED_RC`          :cpp:func:`WriteDDWord <virtual RED_RC RED::IStream::WriteDDWord(RED::uint64 iDDWord)=0>`                                                                                                                                                                
:cpp:enumerator:`~RED_RC`          :cpp:func:`ReadDDWord <virtual RED_RC RED::IStream::ReadDDWord(RED::uint64 &oDDWord)=0>`                                                                                                                                                                 
:cpp:enumerator:`~RED_RC`          :cpp:func:`WriteFloat <virtual RED_RC RED::IStream::WriteFloat(float iFloat)=0>`                                                                                                                                                                         
:cpp:enumerator:`~RED_RC`          :cpp:func:`ReadFloat <virtual RED_RC RED::IStream::ReadFloat(float &oFloat)=0>`                                                                                                                                                                          
:cpp:enumerator:`~RED_RC`          :cpp:func:`WriteDFloat <virtual RED_RC RED::IStream::WriteDFloat(double iDFloat)=0>`                                                                                                                                                                     
:cpp:enumerator:`~RED_RC`          :cpp:func:`ReadDFloat <virtual RED_RC RED::IStream::ReadDFloat(double &oDFloat)=0>`                                                                                                                                                                      
:cpp:enumerator:`~RED_RC`          :cpp:func:`WriteString <virtual RED_RC RED::IStream::WriteString(const RED::String &iString, bool iBinaryMode=true)=0>`                                                                                                                                  
:cpp:enumerator:`~RED_RC`          :cpp:func:`ReadString <virtual RED_RC RED::IStream::ReadString(RED::String &oString)=0>`                                                                                                                                                                 
:cpp:enumerator:`~RED_RC`          :cpp:func:`ReadLine <virtual RED_RC RED::IStream::ReadLine(RED::String &oString)=0>`                                                                                                                                                                     
:cpp:enumerator:`~RED_RC`          :cpp:func:`WriteVector3 <virtual RED_RC RED::IStream::WriteVector3(const RED::Vector3 &iVector3, bool iDoublePrecision)=0>`                                                                                                                              
:cpp:enumerator:`~RED_RC`          :cpp:func:`ReadVector3 <virtual RED_RC RED::IStream::ReadVector3(RED::Vector3 &oVector3, bool iDoublePrecision)=0>`                                                                                                                                      
:cpp:enumerator:`~RED_RC`          :cpp:func:`WriteVector4 <virtual RED_RC RED::IStream::WriteVector4(const RED::Vector4 &iVector4, bool iDoublePrecision)=0>`                                                                                                                              
:cpp:enumerator:`~RED_RC`          :cpp:func:`ReadVector4 <virtual RED_RC RED::IStream::ReadVector4(RED::Vector4 &oVector4, bool iDoublePrecision)=0>`                                                                                                                                      
:cpp:enumerator:`~RED_RC`          :cpp:func:`WriteMatrix <virtual RED_RC RED::IStream::WriteMatrix(const RED::Matrix &iMatrix, bool iDoublePrecision)=0>`                                                                                                                                  
:cpp:enumerator:`~RED_RC`          :cpp:func:`ReadMatrix <virtual RED_RC RED::IStream::ReadMatrix(RED::Matrix &oMatrix, bool iDoublePrecision)=0>`                                                                                                                                          
:cpp:enumerator:`~RED_RC`          :cpp:func:`WriteColor <virtual RED_RC RED::IStream::WriteColor(const RED::Color &iColor)=0>`                                                                                                                                                             
:cpp:enumerator:`~RED_RC`          :cpp:func:`ReadColor <virtual RED_RC RED::IStream::ReadColor(RED::Color &oColor)=0>`                                                                                                                                                                     
:cpp:enumerator:`~RED_RC`          :cpp:func:`WriteData <virtual RED_RC RED::IStream::WriteData(const unsigned char *iData, RED::uint64 iDataLength)=0>`                                                                                                                                    
:cpp:enumerator:`~RED_RC`          :cpp:func:`WriteData <virtual RED_RC RED::IStream::WriteData(RED::IStream *iStream, RED::uint64 iSize=0)=0>`                                                                                                                                             
:cpp:enumerator:`~RED_RC`          :cpp:func:`ReadData <virtual RED_RC RED::IStream::ReadData(unsigned char *oData, RED::uint64 iDataLength)=0>`                                                                                                                                            
:cpp:enumerator:`~RED_RC`          :cpp:func:`ReadData <virtual RED_RC RED::IStream::ReadData(unsigned char *oData, RED::uint64 &oReadDataLength, RED::uint64 iDataLength)=0>`                                                                                                              
void                               :cpp:func:`SetEncryptionKey <virtual void RED::IStream::SetEncryptionKey(const RED::String &iEncryptionKey)=0>`                                                                                                                                          
================================== =========================================================================================================================================================================================================================================================

.. cpp:namespace:: nullptr

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

.. doxygenclass:: RED::IStream
   :project: RED
   :members:
   :undoc-members:



