\hypertarget{class_ogre_1_1_stream_serialiser}{}\doxysection{Ogre\+::Stream\+Serialiser Class Reference}
\label{class_ogre_1_1_stream_serialiser}\index{Ogre::StreamSerialiser@{Ogre::StreamSerialiser}}


Utility class providing helper methods for reading / writing structured data held in a \mbox{\hyperlink{class_ogre_1_1_data_stream}{Data\+Stream}}.  




{\ttfamily \#include $<$Ogre\+Stream\+Serialiser.\+h$>$}



Inheritance diagram for Ogre\+::Stream\+Serialiser\+:
\nopagebreak
\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[width=207pt]{class_ogre_1_1_stream_serialiser__inherit__graph}
\end{center}
\end{figure}
\doxysubsection*{Classes}
\begin{DoxyCompactItemize}
\item 
struct \mbox{\hyperlink{struct_ogre_1_1_stream_serialiser_1_1_chunk}{Chunk}}
\begin{DoxyCompactList}\small\item\em Definition of a chunk of data in a file. \end{DoxyCompactList}\end{DoxyCompactItemize}
\doxysubsection*{Public Types}
\begin{DoxyCompactItemize}
\item 
enum \mbox{\hyperlink{class_ogre_1_1_stream_serialiser_a072077ff56678e964608a7451db7c3f0}{Endian}} \{ \mbox{\hyperlink{class_ogre_1_1_stream_serialiser_a072077ff56678e964608a7451db7c3f0a921fa6c4bf1316b54e0877ad1e983c9c}{E\+N\+D\+I\+A\+N\+\_\+\+A\+U\+TO}}, 
\mbox{\hyperlink{class_ogre_1_1_stream_serialiser_a072077ff56678e964608a7451db7c3f0afa17cf3b68b6464762f03423afc83d6e}{E\+N\+D\+I\+A\+N\+\_\+\+B\+IG}}, 
\mbox{\hyperlink{class_ogre_1_1_stream_serialiser_a072077ff56678e964608a7451db7c3f0a344ebede556d120f89fbfd35b544a0fb}{E\+N\+D\+I\+A\+N\+\_\+\+L\+I\+T\+T\+LE}}
 \}
\begin{DoxyCompactList}\small\item\em The endianness of files. \end{DoxyCompactList}\item 
enum \mbox{\hyperlink{class_ogre_1_1_stream_serialiser_a6cf4285399b89b088f2f297dda10fc91}{Real\+Storage\+Format}} \{ \mbox{\hyperlink{class_ogre_1_1_stream_serialiser_a6cf4285399b89b088f2f297dda10fc91ae3bcbc915c3187091bf95f1e7426a837}{R\+E\+A\+L\+\_\+\+F\+L\+O\+AT}}, 
\mbox{\hyperlink{class_ogre_1_1_stream_serialiser_a6cf4285399b89b088f2f297dda10fc91a2b594a33ac97bd7a0cc2d9047e2b1912}{R\+E\+A\+L\+\_\+\+D\+O\+U\+B\+LE}}
 \}
\begin{DoxyCompactList}\small\item\em The storage format of Real values. \end{DoxyCompactList}\end{DoxyCompactItemize}
\doxysubsection*{Public Member Functions}
\begin{DoxyCompactItemize}
\item 
\mbox{\hyperlink{class_ogre_1_1_stream_serialiser_a6f33fe43504c631349b4a4c6244525b1}{Stream\+Serialiser}} (const \mbox{\hyperlink{namespace_ogre_a8a2a961b4205aacff9c01e81e08d7781}{Data\+Stream\+Ptr}} \&stream, \mbox{\hyperlink{class_ogre_1_1_stream_serialiser_a072077ff56678e964608a7451db7c3f0}{Endian}} endian\+Mode=\mbox{\hyperlink{class_ogre_1_1_stream_serialiser_a072077ff56678e964608a7451db7c3f0a921fa6c4bf1316b54e0877ad1e983c9c}{E\+N\+D\+I\+A\+N\+\_\+\+A\+U\+TO}}, bool auto\+Header=true, \mbox{\hyperlink{class_ogre_1_1_stream_serialiser_a6cf4285399b89b088f2f297dda10fc91}{Real\+Storage\+Format}} real\+Format=\mbox{\hyperlink{class_ogre_1_1_stream_serialiser_a6cf4285399b89b088f2f297dda10fc91ae3bcbc915c3187091bf95f1e7426a837}{R\+E\+A\+L\+\_\+\+F\+L\+O\+AT}})
\begin{DoxyCompactList}\small\item\em Constructor. \end{DoxyCompactList}\item 
virtual \mbox{\hyperlink{class_ogre_1_1_stream_serialiser_a6469d16380285e935ad31ab9c1807f43}{$\sim$\+Stream\+Serialiser}} ()
\item 
virtual bool \mbox{\hyperlink{class_ogre_1_1_stream_serialiser_aa0fa5f5b426eecb48246039f397befab}{eof}} () const
\begin{DoxyCompactList}\small\item\em Reports whether the stream is at the end of file. \end{DoxyCompactList}\item 
virtual const \mbox{\hyperlink{struct_ogre_1_1_stream_serialiser_1_1_chunk}{Chunk}} $\ast$ \mbox{\hyperlink{class_ogre_1_1_stream_serialiser_a7cedd2f27a62ade17c9d9829c72329cd}{get\+Current\+Chunk}} () const
\begin{DoxyCompactList}\small\item\em Get the definition of the current chunk being read (if any). \end{DoxyCompactList}\item 
size\+\_\+t \mbox{\hyperlink{class_ogre_1_1_stream_serialiser_ae287158dbf1c109012cb165bfc0cf1e8}{get\+Current\+Chunk\+Depth}} () const
\begin{DoxyCompactList}\small\item\em Report the current depth of the chunk nesting, whether reading or writing. \end{DoxyCompactList}\item 
\mbox{\hyperlink{namespace_ogre_adf2a0cf2e77143b5ee1d38a75e289545}{uint32}} \mbox{\hyperlink{class_ogre_1_1_stream_serialiser_a517e99ed59380c90a1d29caf5d34df67}{get\+Current\+Chunk\+ID}} () const
\begin{DoxyCompactList}\small\item\em Get the ID of the chunk that\textquotesingle{}s currently being read/written, if any. \end{DoxyCompactList}\item 
virtual \mbox{\hyperlink{class_ogre_1_1_stream_serialiser_a072077ff56678e964608a7451db7c3f0}{Endian}} \mbox{\hyperlink{class_ogre_1_1_stream_serialiser_a771fae398bd7b30a02ce9343d3de0792}{get\+Endian}} () const
\begin{DoxyCompactList}\small\item\em Get the endian mode. \end{DoxyCompactList}\item 
size\+\_\+t \mbox{\hyperlink{class_ogre_1_1_stream_serialiser_aa63f3833de85040c420f1d9355b2bb52}{get\+Offset\+From\+Chunk\+Start}} () const
\begin{DoxyCompactList}\small\item\em Get the current byte position relative to the start of the data section of the last chunk that was read or written. \end{DoxyCompactList}\item 
virtual bool \mbox{\hyperlink{class_ogre_1_1_stream_serialiser_ad81be1455eacc97d5fcd1df06cbe1b93}{is\+End\+Of\+Chunk}} (\mbox{\hyperlink{namespace_ogre_adf2a0cf2e77143b5ee1d38a75e289545}{uint32}} id)
\begin{DoxyCompactList}\small\item\em Return whether the current data pointer is at the end of the current chunk. \end{DoxyCompactList}\item 
virtual \mbox{\hyperlink{namespace_ogre_adf2a0cf2e77143b5ee1d38a75e289545}{uint32}} \mbox{\hyperlink{class_ogre_1_1_stream_serialiser_aa5e27e1fff17725bb9970d9ad81cfb39}{peek\+Next\+Chunk\+ID}} ()
\begin{DoxyCompactList}\small\item\em Call this to \textquotesingle{}peek\textquotesingle{} at the next chunk ID without permanently moving the stream pointer. \end{DoxyCompactList}\item 
virtual void \mbox{\hyperlink{class_ogre_1_1_stream_serialiser_a32788255718a172dd040cf6766e8e32a}{read}} (\mbox{\hyperlink{class_ogre_1_1_axis_aligned_box}{Axis\+Aligned\+Box}} $\ast$aabb, size\+\_\+t count=1)
\item 
virtual void \mbox{\hyperlink{class_ogre_1_1_stream_serialiser_af8fe1551fa5a1dc26317c9b57b8ef1f6}{read}} (bool $\ast$val, size\+\_\+t count=1)
\item 
virtual void \mbox{\hyperlink{class_ogre_1_1_stream_serialiser_a9a3af44ad9ac9d841ec5e15d4c6856f3}{read}} (\mbox{\hyperlink{class_ogre_1_1_matrix3}{Matrix3}} $\ast$m, size\+\_\+t count=1)
\item 
virtual void \mbox{\hyperlink{class_ogre_1_1_stream_serialiser_a28eec6a458dd2f02a8849a51dc107dcf}{read}} (\mbox{\hyperlink{class_ogre_1_1_matrix4}{Matrix4}} $\ast$m, size\+\_\+t count=1)
\item 
virtual void \mbox{\hyperlink{class_ogre_1_1_stream_serialiser_a5e45523a0409077bbcab706ef0a58f64}{read}} (\mbox{\hyperlink{class_ogre_1_1_node}{Node}} $\ast$node, size\+\_\+t count=1)
\item 
virtual void \mbox{\hyperlink{class_ogre_1_1_stream_serialiser_a85a44458396fa2170fa8858a0328fa97}{read}} (\mbox{\hyperlink{class_ogre_1_1_plane}{Plane}} $\ast$plane, size\+\_\+t count=1)
\item 
virtual void \mbox{\hyperlink{class_ogre_1_1_stream_serialiser_a3173c30a36415d10b4daf6e130953e0e}{read}} (\mbox{\hyperlink{class_ogre_1_1_quaternion}{Quaternion}} $\ast$q, size\+\_\+t count=1)
\item 
virtual void \mbox{\hyperlink{class_ogre_1_1_stream_serialiser_a8da61d9cfea11fa94aef4b3ea1a81eae}{read}} (\mbox{\hyperlink{class_ogre_1_1_radian}{Radian}} $\ast$angle, size\+\_\+t count=1)
\item 
virtual void \mbox{\hyperlink{class_ogre_1_1_stream_serialiser_a838c7aea842143bcf54d82d3fe085efe}{read}} (\mbox{\hyperlink{class_ogre_1_1_ray}{Ray}} $\ast$ray, size\+\_\+t count=1)
\item 
virtual void \mbox{\hyperlink{class_ogre_1_1_stream_serialiser_a46bcb952e488697f41786e1156c00979}{read}} (\mbox{\hyperlink{namespace_ogre_aa3a7b6dfb905e6572d62f0dfa3d4274d}{Real}} $\ast$val, size\+\_\+t count=1)
\item 
virtual void \mbox{\hyperlink{class_ogre_1_1_stream_serialiser_a242f3491c47852b53b0b689edfc25e4c}{read}} (\mbox{\hyperlink{class_ogre_1_1_sphere}{Sphere}} $\ast$sphere, size\+\_\+t count=1)
\item 
virtual void \mbox{\hyperlink{class_ogre_1_1_stream_serialiser_aa930c1889b253433b459176426795627}{read}} (\mbox{\hyperlink{namespace_ogre_af73bbdc8bed8a3e6fcd56bb8fa188c45}{String}} $\ast$string)
\item 
{\footnotesize template$<$typename T $>$ }\\void \mbox{\hyperlink{class_ogre_1_1_stream_serialiser_a72a8e8540b453b8428992c0c6c599995}{read}} (T $\ast$pT, size\+\_\+t count=1)
\begin{DoxyCompactList}\small\item\em Catch-\/all method to read primitive types. \end{DoxyCompactList}\item 
virtual void \mbox{\hyperlink{class_ogre_1_1_stream_serialiser_a273eb21bd429c3a1dc4ac6981bea7c6b}{read}} (\mbox{\hyperlink{namespace_ogre_a8542e5da4c0e0bda0d0bf5745329ea88}{Vector2}} $\ast$vec, size\+\_\+t count=1)
\begin{DoxyCompactList}\small\item\em read a Vector3 \end{DoxyCompactList}\item 
virtual void \mbox{\hyperlink{class_ogre_1_1_stream_serialiser_a5f557c549a65a20e76e605f9bf9fe4c9}{read}} (\mbox{\hyperlink{namespace_ogre_ac94fc4008c1165dea017263fee56b273}{Vector3}} $\ast$vec, size\+\_\+t count=1)
\item 
virtual void \mbox{\hyperlink{class_ogre_1_1_stream_serialiser_aee0e00b95f550cc324cbb5fef1a3766b}{read}} (\mbox{\hyperlink{namespace_ogre_a739a289a4d5235f5f509a1795f5ffd5b}{Vector4}} $\ast$vec, size\+\_\+t count=1)
\item 
virtual const \mbox{\hyperlink{struct_ogre_1_1_stream_serialiser_1_1_chunk}{Chunk}} $\ast$ \mbox{\hyperlink{class_ogre_1_1_stream_serialiser_a4e88223124b49f1471ccd06600a7a2d4}{read\+Chunk\+Begin}} ()
\begin{DoxyCompactList}\small\item\em Reads the start of the next chunk in the file. \end{DoxyCompactList}\item 
virtual const \mbox{\hyperlink{struct_ogre_1_1_stream_serialiser_1_1_chunk}{Chunk}} $\ast$ \mbox{\hyperlink{class_ogre_1_1_stream_serialiser_a68cd39709f764a8a4e43ca8d70cc1e3d}{read\+Chunk\+Begin}} (\mbox{\hyperlink{namespace_ogre_adf2a0cf2e77143b5ee1d38a75e289545}{uint32}} id, \mbox{\hyperlink{namespace_ogre_aa8263b218e7d187ad5ef03a73a6ad7fd}{uint16}} max\+Version, const \mbox{\hyperlink{namespace_ogre_af73bbdc8bed8a3e6fcd56bb8fa188c45}{String}} \&msg=\mbox{\hyperlink{group___general_gad842a4b416bd2f3245d2b44826a0aedc}{B\+L\+A\+N\+K\+S\+T\+R\+I\+NG}})
\begin{DoxyCompactList}\small\item\em Reads the start of the next chunk so long as it\textquotesingle{}s of a given ID and version. \end{DoxyCompactList}\item 
virtual void \mbox{\hyperlink{class_ogre_1_1_stream_serialiser_a97b3a9ad5caea2da65b36a07816f968e}{read\+Chunk\+End}} (\mbox{\hyperlink{namespace_ogre_adf2a0cf2e77143b5ee1d38a75e289545}{uint32}} id)
\begin{DoxyCompactList}\small\item\em Finish the reading of a chunk. \end{DoxyCompactList}\item 
virtual void \mbox{\hyperlink{class_ogre_1_1_stream_serialiser_a2d9cd8abb22fbd17c795aa62765b4a59}{read\+Data}} (void $\ast$buf, size\+\_\+t size, size\+\_\+t count)
\begin{DoxyCompactList}\small\item\em Read arbitrary data from a stream. \end{DoxyCompactList}\item 
virtual void \mbox{\hyperlink{class_ogre_1_1_stream_serialiser_aa9c4b6be63560e6f2ab0b647fe797175}{start\+Deflate}} (size\+\_\+t avail\+\_\+in=0)
\begin{DoxyCompactList}\small\item\em Start (un)compressing data. \end{DoxyCompactList}\item 
virtual void \mbox{\hyperlink{class_ogre_1_1_stream_serialiser_ac16f0772431b3939250062d61957189d}{stop\+Deflate}} ()
\begin{DoxyCompactList}\small\item\em Stop (un)compressing data. \end{DoxyCompactList}\item 
virtual void \mbox{\hyperlink{class_ogre_1_1_stream_serialiser_aac94278ebfddb581f5e73838f573c9cd}{undo\+Read\+Chunk}} (\mbox{\hyperlink{namespace_ogre_adf2a0cf2e77143b5ee1d38a75e289545}{uint32}} id)
\begin{DoxyCompactList}\small\item\em Call this to \textquotesingle{}rewind\textquotesingle{} the stream to just before the start of the current chunk. \end{DoxyCompactList}\item 
virtual void \mbox{\hyperlink{class_ogre_1_1_stream_serialiser_a6731deffcb48fa5b78422e4f955f5f93}{write}} (const \mbox{\hyperlink{class_ogre_1_1_axis_aligned_box}{Axis\+Aligned\+Box}} $\ast$aabb, size\+\_\+t count=1)
\item 
virtual void \mbox{\hyperlink{class_ogre_1_1_stream_serialiser_a4397c12bc7f970bd559d0d24a0116b36}{write}} (const bool $\ast$boolean, size\+\_\+t count=1)
\item 
virtual void \mbox{\hyperlink{class_ogre_1_1_stream_serialiser_a6430b8559a0b559d3eefaebef786759e}{write}} (const \mbox{\hyperlink{class_ogre_1_1_matrix3}{Matrix3}} $\ast$m, size\+\_\+t count=1)
\item 
virtual void \mbox{\hyperlink{class_ogre_1_1_stream_serialiser_a0ffe90cc7b051f0f56faccc739988cea}{write}} (const \mbox{\hyperlink{class_ogre_1_1_matrix4}{Matrix4}} $\ast$m, size\+\_\+t count=1)
\item 
virtual void \mbox{\hyperlink{class_ogre_1_1_stream_serialiser_a456b335842b528abb03c953049cac7ad}{write}} (const \mbox{\hyperlink{class_ogre_1_1_node}{Node}} $\ast$node, size\+\_\+t count=1)
\item 
virtual void \mbox{\hyperlink{class_ogre_1_1_stream_serialiser_a0d289d76cc669fd1ade3ef05fa48bd21}{write}} (const \mbox{\hyperlink{class_ogre_1_1_plane}{Plane}} $\ast$plane, size\+\_\+t count=1)
\item 
virtual void \mbox{\hyperlink{class_ogre_1_1_stream_serialiser_a53163836004961bea4bb7ab73819b322}{write}} (const \mbox{\hyperlink{class_ogre_1_1_quaternion}{Quaternion}} $\ast$q, size\+\_\+t count=1)
\item 
virtual void \mbox{\hyperlink{class_ogre_1_1_stream_serialiser_a79d03ff4a8aedc9e28412dc25fa48027}{write}} (const \mbox{\hyperlink{class_ogre_1_1_radian}{Radian}} $\ast$angle, size\+\_\+t count=1)
\item 
virtual void \mbox{\hyperlink{class_ogre_1_1_stream_serialiser_ad453d94c2cc1ebd6a13d2571ee8d5456}{write}} (const \mbox{\hyperlink{class_ogre_1_1_ray}{Ray}} $\ast$ray, size\+\_\+t count=1)
\item 
virtual void \mbox{\hyperlink{class_ogre_1_1_stream_serialiser_a596a55c0496333afcfa6af3e51e36e64}{write}} (const \mbox{\hyperlink{namespace_ogre_aa3a7b6dfb905e6572d62f0dfa3d4274d}{Real}} $\ast$val, size\+\_\+t count=1)
\item 
virtual void \mbox{\hyperlink{class_ogre_1_1_stream_serialiser_a5435ad86ff5851f9012191d3b5179a55}{write}} (const \mbox{\hyperlink{class_ogre_1_1_sphere}{Sphere}} $\ast$sphere, size\+\_\+t count=1)
\item 
virtual void \mbox{\hyperlink{class_ogre_1_1_stream_serialiser_a82759066f35c8cb08e24ce4357c747c7}{write}} (const \mbox{\hyperlink{namespace_ogre_af73bbdc8bed8a3e6fcd56bb8fa188c45}{String}} $\ast$string)
\item 
{\footnotesize template$<$typename T $>$ }\\void \mbox{\hyperlink{class_ogre_1_1_stream_serialiser_a2aae82219abe1e37ea5f1c1adf8bdd1c}{write}} (const T $\ast$pT, size\+\_\+t count=1)
\begin{DoxyCompactList}\small\item\em Catch-\/all method to write primitive types. \end{DoxyCompactList}\item 
virtual void \mbox{\hyperlink{class_ogre_1_1_stream_serialiser_a60ac46edf43d39927816e34b1a0d983c}{write}} (const \mbox{\hyperlink{namespace_ogre_a8542e5da4c0e0bda0d0bf5745329ea88}{Vector2}} $\ast$vec, size\+\_\+t count=1)
\item 
virtual void \mbox{\hyperlink{class_ogre_1_1_stream_serialiser_ada08984a52a07febc6ddd531c60adbd6}{write}} (const \mbox{\hyperlink{namespace_ogre_ac94fc4008c1165dea017263fee56b273}{Vector3}} $\ast$vec, size\+\_\+t count=1)
\item 
virtual void \mbox{\hyperlink{class_ogre_1_1_stream_serialiser_a994f2de1f0d13f674b6946b2490c225a}{write}} (const \mbox{\hyperlink{namespace_ogre_a739a289a4d5235f5f509a1795f5ffd5b}{Vector4}} $\ast$vec, size\+\_\+t count=1)
\item 
virtual void \mbox{\hyperlink{class_ogre_1_1_stream_serialiser_a49f031773228cdd832db5c52e7e0ea72}{write\+Chunk\+Begin}} (\mbox{\hyperlink{namespace_ogre_adf2a0cf2e77143b5ee1d38a75e289545}{uint32}} id, \mbox{\hyperlink{namespace_ogre_aa8263b218e7d187ad5ef03a73a6ad7fd}{uint16}} version=1)
\begin{DoxyCompactList}\small\item\em Begin writing a new chunk. \end{DoxyCompactList}\item 
virtual void \mbox{\hyperlink{class_ogre_1_1_stream_serialiser_ad7dbda6a8b282814f3eabcaed6f86abc}{write\+Chunk\+End}} (\mbox{\hyperlink{namespace_ogre_adf2a0cf2e77143b5ee1d38a75e289545}{uint32}} id)
\begin{DoxyCompactList}\small\item\em End writing a chunk. \end{DoxyCompactList}\item 
virtual void \mbox{\hyperlink{class_ogre_1_1_stream_serialiser_a192b4339d7d5ba458824751e01575d92}{write\+Data}} (const void $\ast$buf, size\+\_\+t size, size\+\_\+t count)
\begin{DoxyCompactList}\small\item\em Write arbitrary data to a stream. \end{DoxyCompactList}\end{DoxyCompactItemize}
\doxysubsection*{Static Public Member Functions}
\begin{DoxyCompactItemize}
\item 
static \mbox{\hyperlink{namespace_ogre_adf2a0cf2e77143b5ee1d38a75e289545}{uint32}} \mbox{\hyperlink{class_ogre_1_1_stream_serialiser_ad1ba4ab9614504d8028c4d2754ca3315}{make\+Identifier}} (const char(\&code)\mbox{[}5\mbox{]})
\begin{DoxyCompactList}\small\item\em Pack a 4-\/character code into a 32-\/bit identifier. \end{DoxyCompactList}\end{DoxyCompactItemize}


\doxysubsection{Detailed Description}
Utility class providing helper methods for reading / writing structured data held in a \mbox{\hyperlink{class_ogre_1_1_data_stream}{Data\+Stream}}. 

\begin{DoxyRemark}{Remarks}
The structure of a file read / written by this class is a series of \textquotesingle{}chunks\textquotesingle{}. A chunk-\/based format has the advantage of being extensible later, and it\textquotesingle{}s robust, in that a reader can skip chunks that they are not able (or willing) to process. 
\end{DoxyRemark}
\begin{DoxyParagraph}{}
Chunks are contained serially in the file, but they can also be nested in order both to provide context, and to group chunks together for potential skipping. 
\end{DoxyParagraph}
\begin{DoxyParagraph}{}
The data format of a chunk is as follows\+:
\begin{DoxyEnumerate}
\item \mbox{\hyperlink{struct_ogre_1_1_stream_serialiser_1_1_chunk}{Chunk}} ID (32-\/bit uint). This can be any number unique in a context, except the numbers 0x0000, 0x0001 and 0x1000, which are reserved for \mbox{\hyperlink{namespace_ogre}{Ogre}}\textquotesingle{}s use
\item \mbox{\hyperlink{struct_ogre_1_1_stream_serialiser_1_1_chunk}{Chunk}} version (16-\/bit uint). Chunks can change over time so this version number reflects that
\item Length (32-\/bit uint). The length of the chunk data section, including nested chunks. Note that this length excludes this header, but includes the header of any nested chunks.
\item Checksum (32-\/bit uint). Checksum value generated from the above -\/ basically lets us check this is a valid chunk.
\item \mbox{\hyperlink{struct_ogre_1_1_stream_serialiser_1_1_chunk}{Chunk}} data The \textquotesingle{}\mbox{\hyperlink{struct_ogre_1_1_stream_serialiser_1_1_chunk}{Chunk}} data\textquotesingle{} section will contain chunk-\/specific data, which may include other nested chunks. 
\end{DoxyEnumerate}
\end{DoxyParagraph}


\doxysubsection{Member Enumeration Documentation}
\mbox{\Hypertarget{class_ogre_1_1_stream_serialiser_a072077ff56678e964608a7451db7c3f0}\label{class_ogre_1_1_stream_serialiser_a072077ff56678e964608a7451db7c3f0}} 
\index{Ogre::StreamSerialiser@{Ogre::StreamSerialiser}!Endian@{Endian}}
\index{Endian@{Endian}!Ogre::StreamSerialiser@{Ogre::StreamSerialiser}}
\doxysubsubsection{\texorpdfstring{Endian}{Endian}}
{\footnotesize\ttfamily enum \mbox{\hyperlink{class_ogre_1_1_stream_serialiser_a072077ff56678e964608a7451db7c3f0}{Ogre\+::\+Stream\+Serialiser\+::\+Endian}}}



The endianness of files. 

\begin{DoxyEnumFields}{Enumerator}
\raisebox{\heightof{T}}[0pt][0pt]{\index{ENDIAN\_AUTO@{ENDIAN\_AUTO}!Ogre::StreamSerialiser@{Ogre::StreamSerialiser}}\index{Ogre::StreamSerialiser@{Ogre::StreamSerialiser}!ENDIAN\_AUTO@{ENDIAN\_AUTO}}}\mbox{\Hypertarget{class_ogre_1_1_stream_serialiser_a072077ff56678e964608a7451db7c3f0a921fa6c4bf1316b54e0877ad1e983c9c}\label{class_ogre_1_1_stream_serialiser_a072077ff56678e964608a7451db7c3f0a921fa6c4bf1316b54e0877ad1e983c9c}} 
E\+N\+D\+I\+A\+N\+\_\+\+A\+U\+TO&Automatically determine endianness. \\
\hline

\raisebox{\heightof{T}}[0pt][0pt]{\index{ENDIAN\_BIG@{ENDIAN\_BIG}!Ogre::StreamSerialiser@{Ogre::StreamSerialiser}}\index{Ogre::StreamSerialiser@{Ogre::StreamSerialiser}!ENDIAN\_BIG@{ENDIAN\_BIG}}}\mbox{\Hypertarget{class_ogre_1_1_stream_serialiser_a072077ff56678e964608a7451db7c3f0afa17cf3b68b6464762f03423afc83d6e}\label{class_ogre_1_1_stream_serialiser_a072077ff56678e964608a7451db7c3f0afa17cf3b68b6464762f03423afc83d6e}} 
E\+N\+D\+I\+A\+N\+\_\+\+B\+IG&Use big endian (0x1000 is serialised as 0x10 0x00) \\
\hline

\raisebox{\heightof{T}}[0pt][0pt]{\index{ENDIAN\_LITTLE@{ENDIAN\_LITTLE}!Ogre::StreamSerialiser@{Ogre::StreamSerialiser}}\index{Ogre::StreamSerialiser@{Ogre::StreamSerialiser}!ENDIAN\_LITTLE@{ENDIAN\_LITTLE}}}\mbox{\Hypertarget{class_ogre_1_1_stream_serialiser_a072077ff56678e964608a7451db7c3f0a344ebede556d120f89fbfd35b544a0fb}\label{class_ogre_1_1_stream_serialiser_a072077ff56678e964608a7451db7c3f0a344ebede556d120f89fbfd35b544a0fb}} 
E\+N\+D\+I\+A\+N\+\_\+\+L\+I\+T\+T\+LE&Use little endian (0x1000 is serialised as 0x00 0x10) \\
\hline

\end{DoxyEnumFields}
\mbox{\Hypertarget{class_ogre_1_1_stream_serialiser_a6cf4285399b89b088f2f297dda10fc91}\label{class_ogre_1_1_stream_serialiser_a6cf4285399b89b088f2f297dda10fc91}} 
\index{Ogre::StreamSerialiser@{Ogre::StreamSerialiser}!RealStorageFormat@{RealStorageFormat}}
\index{RealStorageFormat@{RealStorageFormat}!Ogre::StreamSerialiser@{Ogre::StreamSerialiser}}
\doxysubsubsection{\texorpdfstring{RealStorageFormat}{RealStorageFormat}}
{\footnotesize\ttfamily enum \mbox{\hyperlink{class_ogre_1_1_stream_serialiser_a6cf4285399b89b088f2f297dda10fc91}{Ogre\+::\+Stream\+Serialiser\+::\+Real\+Storage\+Format}}}



The storage format of Real values. 

\begin{DoxyEnumFields}{Enumerator}
\raisebox{\heightof{T}}[0pt][0pt]{\index{REAL\_FLOAT@{REAL\_FLOAT}!Ogre::StreamSerialiser@{Ogre::StreamSerialiser}}\index{Ogre::StreamSerialiser@{Ogre::StreamSerialiser}!REAL\_FLOAT@{REAL\_FLOAT}}}\mbox{\Hypertarget{class_ogre_1_1_stream_serialiser_a6cf4285399b89b088f2f297dda10fc91ae3bcbc915c3187091bf95f1e7426a837}\label{class_ogre_1_1_stream_serialiser_a6cf4285399b89b088f2f297dda10fc91ae3bcbc915c3187091bf95f1e7426a837}} 
R\+E\+A\+L\+\_\+\+F\+L\+O\+AT&Real is stored as float, reducing precision if you\textquotesingle{}re using O\+G\+R\+E\+\_\+\+D\+O\+U\+B\+L\+E\+\_\+\+P\+R\+E\+C\+I\+S\+I\+ON. \\
\hline

\raisebox{\heightof{T}}[0pt][0pt]{\index{REAL\_DOUBLE@{REAL\_DOUBLE}!Ogre::StreamSerialiser@{Ogre::StreamSerialiser}}\index{Ogre::StreamSerialiser@{Ogre::StreamSerialiser}!REAL\_DOUBLE@{REAL\_DOUBLE}}}\mbox{\Hypertarget{class_ogre_1_1_stream_serialiser_a6cf4285399b89b088f2f297dda10fc91a2b594a33ac97bd7a0cc2d9047e2b1912}\label{class_ogre_1_1_stream_serialiser_a6cf4285399b89b088f2f297dda10fc91a2b594a33ac97bd7a0cc2d9047e2b1912}} 
R\+E\+A\+L\+\_\+\+D\+O\+U\+B\+LE&Real as stored as double, not useful unless you\textquotesingle{}re using O\+G\+R\+E\+\_\+\+D\+O\+U\+B\+L\+E\+\_\+\+P\+R\+E\+C\+I\+S\+I\+ON. \\
\hline

\end{DoxyEnumFields}


\doxysubsection{Constructor \& Destructor Documentation}
\mbox{\Hypertarget{class_ogre_1_1_stream_serialiser_a6f33fe43504c631349b4a4c6244525b1}\label{class_ogre_1_1_stream_serialiser_a6f33fe43504c631349b4a4c6244525b1}} 
\index{Ogre::StreamSerialiser@{Ogre::StreamSerialiser}!StreamSerialiser@{StreamSerialiser}}
\index{StreamSerialiser@{StreamSerialiser}!Ogre::StreamSerialiser@{Ogre::StreamSerialiser}}
\doxysubsubsection{\texorpdfstring{StreamSerialiser()}{StreamSerialiser()}}
{\footnotesize\ttfamily Ogre\+::\+Stream\+Serialiser\+::\+Stream\+Serialiser (\begin{DoxyParamCaption}\item[{const \mbox{\hyperlink{namespace_ogre_a8a2a961b4205aacff9c01e81e08d7781}{Data\+Stream\+Ptr}} \&}]{stream,  }\item[{\mbox{\hyperlink{class_ogre_1_1_stream_serialiser_a072077ff56678e964608a7451db7c3f0}{Endian}}}]{endian\+Mode = {\ttfamily \mbox{\hyperlink{class_ogre_1_1_stream_serialiser_a072077ff56678e964608a7451db7c3f0a921fa6c4bf1316b54e0877ad1e983c9c}{E\+N\+D\+I\+A\+N\+\_\+\+A\+U\+TO}}},  }\item[{bool}]{auto\+Header = {\ttfamily true},  }\item[{\mbox{\hyperlink{class_ogre_1_1_stream_serialiser_a6cf4285399b89b088f2f297dda10fc91}{Real\+Storage\+Format}}}]{real\+Format = {\ttfamily \mbox{\hyperlink{class_ogre_1_1_stream_serialiser_a6cf4285399b89b088f2f297dda10fc91ae3bcbc915c3187091bf95f1e7426a837}{R\+E\+A\+L\+\_\+\+F\+L\+O\+AT}}} }\end{DoxyParamCaption})}



Constructor. 


\begin{DoxyParams}{Parameters}
{\em stream} & The stream on which you will read / write data. \\
\hline
{\em endian\+Mode} & The endian mode in which to read / writedata. If left at the default, when writing the endian mode will be the native platform mode, and when reading it\textquotesingle{}s expected that the first chunk encountered will be the header chunk, which will determine the endian mode. \\
\hline
{\em auto\+Header} & If true, the first write or read to this stream will automatically read / write the header too. This is required if you set endian\+Mode to E\+N\+D\+I\+A\+N\+\_\+\+A\+U\+TO, but if you manually set the endian mode, then you can skip writing / reading the header if you wish, if for example this stream is midway through a file which has already included header information. \\
\hline
{\em real\+Format} & Set the format you want to write reals in. Only useful for files that you\textquotesingle{}re writing (since when reading this is picked up from the file), and can only be changed if auto\+Header is true, since real format is stored in the header. Defaults to float unless you\textquotesingle{}re using O\+G\+R\+E\+\_\+\+D\+O\+U\+B\+L\+E\+\_\+\+P\+R\+E\+C\+I\+S\+I\+ON. \\
\hline
\end{DoxyParams}
\mbox{\Hypertarget{class_ogre_1_1_stream_serialiser_a6469d16380285e935ad31ab9c1807f43}\label{class_ogre_1_1_stream_serialiser_a6469d16380285e935ad31ab9c1807f43}} 
\index{Ogre::StreamSerialiser@{Ogre::StreamSerialiser}!````~StreamSerialiser@{$\sim$StreamSerialiser}}
\index{````~StreamSerialiser@{$\sim$StreamSerialiser}!Ogre::StreamSerialiser@{Ogre::StreamSerialiser}}
\doxysubsubsection{\texorpdfstring{$\sim$StreamSerialiser()}{~StreamSerialiser()}}
{\footnotesize\ttfamily virtual Ogre\+::\+Stream\+Serialiser\+::$\sim$\+Stream\+Serialiser (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [virtual]}}



\doxysubsection{Member Function Documentation}
\mbox{\Hypertarget{class_ogre_1_1_stream_serialiser_a771fae398bd7b30a02ce9343d3de0792}\label{class_ogre_1_1_stream_serialiser_a771fae398bd7b30a02ce9343d3de0792}} 
\index{Ogre::StreamSerialiser@{Ogre::StreamSerialiser}!getEndian@{getEndian}}
\index{getEndian@{getEndian}!Ogre::StreamSerialiser@{Ogre::StreamSerialiser}}
\doxysubsubsection{\texorpdfstring{getEndian()}{getEndian()}}
{\footnotesize\ttfamily virtual \mbox{\hyperlink{class_ogre_1_1_stream_serialiser_a072077ff56678e964608a7451db7c3f0}{Endian}} Ogre\+::\+Stream\+Serialiser\+::get\+Endian (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption}) const\hspace{0.3cm}{\ttfamily [inline]}, {\ttfamily [virtual]}}



Get the endian mode. 

\begin{DoxyRemark}{Remarks}
If the result is E\+N\+D\+I\+A\+N\+\_\+\+A\+U\+TO, this mode will change when the first piece of data is read / written. 
\end{DoxyRemark}
\mbox{\Hypertarget{class_ogre_1_1_stream_serialiser_ad1ba4ab9614504d8028c4d2754ca3315}\label{class_ogre_1_1_stream_serialiser_ad1ba4ab9614504d8028c4d2754ca3315}} 
\index{Ogre::StreamSerialiser@{Ogre::StreamSerialiser}!makeIdentifier@{makeIdentifier}}
\index{makeIdentifier@{makeIdentifier}!Ogre::StreamSerialiser@{Ogre::StreamSerialiser}}
\doxysubsubsection{\texorpdfstring{makeIdentifier()}{makeIdentifier()}}
{\footnotesize\ttfamily static \mbox{\hyperlink{namespace_ogre_adf2a0cf2e77143b5ee1d38a75e289545}{uint32}} Ogre\+::\+Stream\+Serialiser\+::make\+Identifier (\begin{DoxyParamCaption}\item[{const char(\&)}]{code\mbox{[}5\mbox{]} }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [static]}}



Pack a 4-\/character code into a 32-\/bit identifier. 

\begin{DoxyRemark}{Remarks}
You can use this to generate id\textquotesingle{}s for your chunks based on friendlier 4-\/character codes rather than assigning numerical I\+Ds, if you like. 
\end{DoxyRemark}

\begin{DoxyParams}{Parameters}
{\em code} & String to pack -\/ must be 4 characters and \textquotesingle{}\textbackslash{}0\textquotesingle{} \\
\hline
\end{DoxyParams}
\mbox{\Hypertarget{class_ogre_1_1_stream_serialiser_ae287158dbf1c109012cb165bfc0cf1e8}\label{class_ogre_1_1_stream_serialiser_ae287158dbf1c109012cb165bfc0cf1e8}} 
\index{Ogre::StreamSerialiser@{Ogre::StreamSerialiser}!getCurrentChunkDepth@{getCurrentChunkDepth}}
\index{getCurrentChunkDepth@{getCurrentChunkDepth}!Ogre::StreamSerialiser@{Ogre::StreamSerialiser}}
\doxysubsubsection{\texorpdfstring{getCurrentChunkDepth()}{getCurrentChunkDepth()}}
{\footnotesize\ttfamily size\+\_\+t Ogre\+::\+Stream\+Serialiser\+::get\+Current\+Chunk\+Depth (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption}) const\hspace{0.3cm}{\ttfamily [inline]}}



Report the current depth of the chunk nesting, whether reading or writing. 

\begin{DoxyRemark}{Remarks}
Returns how many levels of nested chunks are currently being processed, either writing or reading. In order to tidily finish, you must call read/write\+Chunk\+End this many times. 
\end{DoxyRemark}
\mbox{\Hypertarget{class_ogre_1_1_stream_serialiser_a517e99ed59380c90a1d29caf5d34df67}\label{class_ogre_1_1_stream_serialiser_a517e99ed59380c90a1d29caf5d34df67}} 
\index{Ogre::StreamSerialiser@{Ogre::StreamSerialiser}!getCurrentChunkID@{getCurrentChunkID}}
\index{getCurrentChunkID@{getCurrentChunkID}!Ogre::StreamSerialiser@{Ogre::StreamSerialiser}}
\doxysubsubsection{\texorpdfstring{getCurrentChunkID()}{getCurrentChunkID()}}
{\footnotesize\ttfamily \mbox{\hyperlink{namespace_ogre_adf2a0cf2e77143b5ee1d38a75e289545}{uint32}} Ogre\+::\+Stream\+Serialiser\+::get\+Current\+Chunk\+ID (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption}) const}



Get the ID of the chunk that\textquotesingle{}s currently being read/written, if any. 

\begin{DoxyReturn}{Returns}
The id of the current chunk being read / written (at the tightest level of nesting), or zero if no chunk is being processed. 
\end{DoxyReturn}
\mbox{\Hypertarget{class_ogre_1_1_stream_serialiser_aa63f3833de85040c420f1d9355b2bb52}\label{class_ogre_1_1_stream_serialiser_aa63f3833de85040c420f1d9355b2bb52}} 
\index{Ogre::StreamSerialiser@{Ogre::StreamSerialiser}!getOffsetFromChunkStart@{getOffsetFromChunkStart}}
\index{getOffsetFromChunkStart@{getOffsetFromChunkStart}!Ogre::StreamSerialiser@{Ogre::StreamSerialiser}}
\doxysubsubsection{\texorpdfstring{getOffsetFromChunkStart()}{getOffsetFromChunkStart()}}
{\footnotesize\ttfamily size\+\_\+t Ogre\+::\+Stream\+Serialiser\+::get\+Offset\+From\+Chunk\+Start (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption}) const}



Get the current byte position relative to the start of the data section of the last chunk that was read or written. 

\begin{DoxyReturn}{Returns}
the offset. Note that a return value of 0 means that either the position is at the start of the chunk data section (ie right after the header), or that no chunk is currently active. Use get\+Current\+Chunk\+ID or get\+Current\+Chunk\+Depth to determine if a chunk is active. 
\end{DoxyReturn}
\mbox{\Hypertarget{class_ogre_1_1_stream_serialiser_a4e88223124b49f1471ccd06600a7a2d4}\label{class_ogre_1_1_stream_serialiser_a4e88223124b49f1471ccd06600a7a2d4}} 
\index{Ogre::StreamSerialiser@{Ogre::StreamSerialiser}!readChunkBegin@{readChunkBegin}}
\index{readChunkBegin@{readChunkBegin}!Ogre::StreamSerialiser@{Ogre::StreamSerialiser}}
\doxysubsubsection{\texorpdfstring{readChunkBegin()}{readChunkBegin()}\hspace{0.1cm}{\footnotesize\ttfamily [1/2]}}
{\footnotesize\ttfamily virtual const \mbox{\hyperlink{struct_ogre_1_1_stream_serialiser_1_1_chunk}{Chunk}}$\ast$ Ogre\+::\+Stream\+Serialiser\+::read\+Chunk\+Begin (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [virtual]}}



Reads the start of the next chunk in the file. 

\begin{DoxyRemark}{Remarks}
Files are serialised in a chunk-\/based manner, meaning that each section of data is prepended by a chunk header. After reading this chunk header, the next set of data is available directly afterwards. 
\end{DoxyRemark}
\begin{DoxyNote}{Note}
When you have finished with this chunk, you should call read\+Chunk\+End. This will perform a bit of validation and clear the chunk from the stack. 
\end{DoxyNote}
\begin{DoxyReturn}{Returns}
The \mbox{\hyperlink{struct_ogre_1_1_stream_serialiser_1_1_chunk}{Chunk}} that comes next 
\end{DoxyReturn}
\mbox{\Hypertarget{class_ogre_1_1_stream_serialiser_a68cd39709f764a8a4e43ca8d70cc1e3d}\label{class_ogre_1_1_stream_serialiser_a68cd39709f764a8a4e43ca8d70cc1e3d}} 
\index{Ogre::StreamSerialiser@{Ogre::StreamSerialiser}!readChunkBegin@{readChunkBegin}}
\index{readChunkBegin@{readChunkBegin}!Ogre::StreamSerialiser@{Ogre::StreamSerialiser}}
\doxysubsubsection{\texorpdfstring{readChunkBegin()}{readChunkBegin()}\hspace{0.1cm}{\footnotesize\ttfamily [2/2]}}
{\footnotesize\ttfamily virtual const \mbox{\hyperlink{struct_ogre_1_1_stream_serialiser_1_1_chunk}{Chunk}}$\ast$ Ogre\+::\+Stream\+Serialiser\+::read\+Chunk\+Begin (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{namespace_ogre_adf2a0cf2e77143b5ee1d38a75e289545}{uint32}}}]{id,  }\item[{\mbox{\hyperlink{namespace_ogre_aa8263b218e7d187ad5ef03a73a6ad7fd}{uint16}}}]{max\+Version,  }\item[{const \mbox{\hyperlink{namespace_ogre_af73bbdc8bed8a3e6fcd56bb8fa188c45}{String}} \&}]{msg = {\ttfamily \mbox{\hyperlink{group___general_gad842a4b416bd2f3245d2b44826a0aedc}{B\+L\+A\+N\+K\+S\+T\+R\+I\+NG}}} }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [virtual]}}



Reads the start of the next chunk so long as it\textquotesingle{}s of a given ID and version. 

\begin{DoxyRemark}{Remarks}
This method operates like read\+Chunk\+Begin, except it checks the ID and version. 
\end{DoxyRemark}

\begin{DoxyParams}{Parameters}
{\em id} & The ID you\textquotesingle{}re expecting. If the next chunk isn\textquotesingle{}t of this ID, then the chunk read is undone and the method returns null. \\
\hline
{\em max\+Version} & The maximum version you\textquotesingle{}re able to process. If the ID is correct but the version exceeds what is passed in here, the chunk is skipped over, the problem logged and null is returned. \\
\hline
{\em msg} & Descriptive text added to the log if versions are not compatible \\
\hline
\end{DoxyParams}
\begin{DoxyReturn}{Returns}
The chunk if it passes the validation. 
\end{DoxyReturn}
\mbox{\Hypertarget{class_ogre_1_1_stream_serialiser_aac94278ebfddb581f5e73838f573c9cd}\label{class_ogre_1_1_stream_serialiser_aac94278ebfddb581f5e73838f573c9cd}} 
\index{Ogre::StreamSerialiser@{Ogre::StreamSerialiser}!undoReadChunk@{undoReadChunk}}
\index{undoReadChunk@{undoReadChunk}!Ogre::StreamSerialiser@{Ogre::StreamSerialiser}}
\doxysubsubsection{\texorpdfstring{undoReadChunk()}{undoReadChunk()}}
{\footnotesize\ttfamily virtual void Ogre\+::\+Stream\+Serialiser\+::undo\+Read\+Chunk (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{namespace_ogre_adf2a0cf2e77143b5ee1d38a75e289545}{uint32}}}]{id }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [virtual]}}



Call this to \textquotesingle{}rewind\textquotesingle{} the stream to just before the start of the current chunk. 

\begin{DoxyRemark}{Remarks}
The most common case of wanting to use this is if you\textquotesingle{}d called\+Read\+Chunk\+Begin(), but the chunk you read wasn\textquotesingle{}t one you wanted to process, and rather than skipping over it (which \mbox{\hyperlink{class_ogre_1_1_stream_serialiser_a97b3a9ad5caea2da65b36a07816f968e}{read\+Chunk\+End()}} would do), you want to backtrack and give something else an opportunity to read it. 
\end{DoxyRemark}

\begin{DoxyParams}{Parameters}
{\em id} & The id of the chunk that you were reading (for validation purposes) \\
\hline
\end{DoxyParams}
\mbox{\Hypertarget{class_ogre_1_1_stream_serialiser_aa5e27e1fff17725bb9970d9ad81cfb39}\label{class_ogre_1_1_stream_serialiser_aa5e27e1fff17725bb9970d9ad81cfb39}} 
\index{Ogre::StreamSerialiser@{Ogre::StreamSerialiser}!peekNextChunkID@{peekNextChunkID}}
\index{peekNextChunkID@{peekNextChunkID}!Ogre::StreamSerialiser@{Ogre::StreamSerialiser}}
\doxysubsubsection{\texorpdfstring{peekNextChunkID()}{peekNextChunkID()}}
{\footnotesize\ttfamily virtual \mbox{\hyperlink{namespace_ogre_adf2a0cf2e77143b5ee1d38a75e289545}{uint32}} Ogre\+::\+Stream\+Serialiser\+::peek\+Next\+Chunk\+ID (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [virtual]}}



Call this to \textquotesingle{}peek\textquotesingle{} at the next chunk ID without permanently moving the stream pointer. 

\mbox{\Hypertarget{class_ogre_1_1_stream_serialiser_a97b3a9ad5caea2da65b36a07816f968e}\label{class_ogre_1_1_stream_serialiser_a97b3a9ad5caea2da65b36a07816f968e}} 
\index{Ogre::StreamSerialiser@{Ogre::StreamSerialiser}!readChunkEnd@{readChunkEnd}}
\index{readChunkEnd@{readChunkEnd}!Ogre::StreamSerialiser@{Ogre::StreamSerialiser}}
\doxysubsubsection{\texorpdfstring{readChunkEnd()}{readChunkEnd()}}
{\footnotesize\ttfamily virtual void Ogre\+::\+Stream\+Serialiser\+::read\+Chunk\+End (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{namespace_ogre_adf2a0cf2e77143b5ee1d38a75e289545}{uint32}}}]{id }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [virtual]}}



Finish the reading of a chunk. 

\begin{DoxyRemark}{Remarks}
You can call this method at any point after calling read\+Chunk\+Begin, even if you didn\textquotesingle{}t read all the rest of the data in the chunk. If you did not read to the end of a chunk, this method will automatically skip over the remainder of the chunk and position the stream just after it. 
\end{DoxyRemark}

\begin{DoxyParams}{Parameters}
{\em id} & The id of the chunk that you were reading (for validation purposes) \\
\hline
\end{DoxyParams}
\mbox{\Hypertarget{class_ogre_1_1_stream_serialiser_ad81be1455eacc97d5fcd1df06cbe1b93}\label{class_ogre_1_1_stream_serialiser_ad81be1455eacc97d5fcd1df06cbe1b93}} 
\index{Ogre::StreamSerialiser@{Ogre::StreamSerialiser}!isEndOfChunk@{isEndOfChunk}}
\index{isEndOfChunk@{isEndOfChunk}!Ogre::StreamSerialiser@{Ogre::StreamSerialiser}}
\doxysubsubsection{\texorpdfstring{isEndOfChunk()}{isEndOfChunk()}}
{\footnotesize\ttfamily virtual bool Ogre\+::\+Stream\+Serialiser\+::is\+End\+Of\+Chunk (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{namespace_ogre_adf2a0cf2e77143b5ee1d38a75e289545}{uint32}}}]{id }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [virtual]}}



Return whether the current data pointer is at the end of the current chunk. 


\begin{DoxyParams}{Parameters}
{\em id} & The id of the chunk that you were reading (for validation purposes) \\
\hline
\end{DoxyParams}
\mbox{\Hypertarget{class_ogre_1_1_stream_serialiser_aa0fa5f5b426eecb48246039f397befab}\label{class_ogre_1_1_stream_serialiser_aa0fa5f5b426eecb48246039f397befab}} 
\index{Ogre::StreamSerialiser@{Ogre::StreamSerialiser}!eof@{eof}}
\index{eof@{eof}!Ogre::StreamSerialiser@{Ogre::StreamSerialiser}}
\doxysubsubsection{\texorpdfstring{eof()}{eof()}}
{\footnotesize\ttfamily virtual bool Ogre\+::\+Stream\+Serialiser\+::eof (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption}) const\hspace{0.3cm}{\ttfamily [virtual]}}



Reports whether the stream is at the end of file. 

\mbox{\Hypertarget{class_ogre_1_1_stream_serialiser_a7cedd2f27a62ade17c9d9829c72329cd}\label{class_ogre_1_1_stream_serialiser_a7cedd2f27a62ade17c9d9829c72329cd}} 
\index{Ogre::StreamSerialiser@{Ogre::StreamSerialiser}!getCurrentChunk@{getCurrentChunk}}
\index{getCurrentChunk@{getCurrentChunk}!Ogre::StreamSerialiser@{Ogre::StreamSerialiser}}
\doxysubsubsection{\texorpdfstring{getCurrentChunk()}{getCurrentChunk()}}
{\footnotesize\ttfamily virtual const \mbox{\hyperlink{struct_ogre_1_1_stream_serialiser_1_1_chunk}{Chunk}}$\ast$ Ogre\+::\+Stream\+Serialiser\+::get\+Current\+Chunk (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption}) const\hspace{0.3cm}{\ttfamily [virtual]}}



Get the definition of the current chunk being read (if any). 

\mbox{\Hypertarget{class_ogre_1_1_stream_serialiser_a49f031773228cdd832db5c52e7e0ea72}\label{class_ogre_1_1_stream_serialiser_a49f031773228cdd832db5c52e7e0ea72}} 
\index{Ogre::StreamSerialiser@{Ogre::StreamSerialiser}!writeChunkBegin@{writeChunkBegin}}
\index{writeChunkBegin@{writeChunkBegin}!Ogre::StreamSerialiser@{Ogre::StreamSerialiser}}
\doxysubsubsection{\texorpdfstring{writeChunkBegin()}{writeChunkBegin()}}
{\footnotesize\ttfamily virtual void Ogre\+::\+Stream\+Serialiser\+::write\+Chunk\+Begin (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{namespace_ogre_adf2a0cf2e77143b5ee1d38a75e289545}{uint32}}}]{id,  }\item[{\mbox{\hyperlink{namespace_ogre_aa8263b218e7d187ad5ef03a73a6ad7fd}{uint16}}}]{version = {\ttfamily 1} }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [virtual]}}



Begin writing a new chunk. 

\begin{DoxyRemark}{Remarks}
This starts the process of writing a new chunk to the stream. This will write the chunk header for you, and store a pointer so that the class can automatically go back and fill in the size for you later should you need it to. If you have already begun a chunk without ending it, then this method will start a nested chunk within it. Once written, you can then start writing chunk-\/specific data into your stream. 
\end{DoxyRemark}
\begin{DoxyNote}{Note}
If this is the first chunk in the file 
\end{DoxyNote}

\begin{DoxyParams}{Parameters}
{\em id} & The identifier of the new chunk. \mbox{\hyperlink{class_ogre_1_1_any}{Any}} value that\textquotesingle{}s unique in the file context is valid, except for the numbers 0x0001 and 0x1000 which are reserved for internal header identification use. \\
\hline
{\em version} & The version of the chunk you\textquotesingle{}re writing \\
\hline
\end{DoxyParams}
\mbox{\Hypertarget{class_ogre_1_1_stream_serialiser_ad7dbda6a8b282814f3eabcaed6f86abc}\label{class_ogre_1_1_stream_serialiser_ad7dbda6a8b282814f3eabcaed6f86abc}} 
\index{Ogre::StreamSerialiser@{Ogre::StreamSerialiser}!writeChunkEnd@{writeChunkEnd}}
\index{writeChunkEnd@{writeChunkEnd}!Ogre::StreamSerialiser@{Ogre::StreamSerialiser}}
\doxysubsubsection{\texorpdfstring{writeChunkEnd()}{writeChunkEnd()}}
{\footnotesize\ttfamily virtual void Ogre\+::\+Stream\+Serialiser\+::write\+Chunk\+End (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{namespace_ogre_adf2a0cf2e77143b5ee1d38a75e289545}{uint32}}}]{id }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [virtual]}}



End writing a chunk. 


\begin{DoxyParams}{Parameters}
{\em id} & The identifier of the chunk -\/ this is really just a safety check, since you can only end the chunk you most recently started. \\
\hline
\end{DoxyParams}
\mbox{\Hypertarget{class_ogre_1_1_stream_serialiser_a192b4339d7d5ba458824751e01575d92}\label{class_ogre_1_1_stream_serialiser_a192b4339d7d5ba458824751e01575d92}} 
\index{Ogre::StreamSerialiser@{Ogre::StreamSerialiser}!writeData@{writeData}}
\index{writeData@{writeData}!Ogre::StreamSerialiser@{Ogre::StreamSerialiser}}
\doxysubsubsection{\texorpdfstring{writeData()}{writeData()}}
{\footnotesize\ttfamily virtual void Ogre\+::\+Stream\+Serialiser\+::write\+Data (\begin{DoxyParamCaption}\item[{const void $\ast$}]{buf,  }\item[{size\+\_\+t}]{size,  }\item[{size\+\_\+t}]{count }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [virtual]}}



Write arbitrary data to a stream. 


\begin{DoxyParams}{Parameters}
{\em buf} & Pointer to bytes \\
\hline
{\em size} & The size of each element to write; each will be endian-\/flipped if necessary \\
\hline
{\em count} & The number of elements to write \\
\hline
\end{DoxyParams}
\mbox{\Hypertarget{class_ogre_1_1_stream_serialiser_a2aae82219abe1e37ea5f1c1adf8bdd1c}\label{class_ogre_1_1_stream_serialiser_a2aae82219abe1e37ea5f1c1adf8bdd1c}} 
\index{Ogre::StreamSerialiser@{Ogre::StreamSerialiser}!write@{write}}
\index{write@{write}!Ogre::StreamSerialiser@{Ogre::StreamSerialiser}}
\doxysubsubsection{\texorpdfstring{write()}{write()}\hspace{0.1cm}{\footnotesize\ttfamily [1/16]}}
{\footnotesize\ttfamily template$<$typename T $>$ \\
void Ogre\+::\+Stream\+Serialiser\+::write (\begin{DoxyParamCaption}\item[{const T $\ast$}]{pT,  }\item[{size\+\_\+t}]{count = {\ttfamily 1} }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [inline]}}



Catch-\/all method to write primitive types. 

\mbox{\Hypertarget{class_ogre_1_1_stream_serialiser_a596a55c0496333afcfa6af3e51e36e64}\label{class_ogre_1_1_stream_serialiser_a596a55c0496333afcfa6af3e51e36e64}} 
\index{Ogre::StreamSerialiser@{Ogre::StreamSerialiser}!write@{write}}
\index{write@{write}!Ogre::StreamSerialiser@{Ogre::StreamSerialiser}}
\doxysubsubsection{\texorpdfstring{write()}{write()}\hspace{0.1cm}{\footnotesize\ttfamily [2/16]}}
{\footnotesize\ttfamily virtual void Ogre\+::\+Stream\+Serialiser\+::write (\begin{DoxyParamCaption}\item[{const \mbox{\hyperlink{namespace_ogre_aa3a7b6dfb905e6572d62f0dfa3d4274d}{Real}} $\ast$}]{val,  }\item[{size\+\_\+t}]{count = {\ttfamily 1} }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [virtual]}}

\mbox{\Hypertarget{class_ogre_1_1_stream_serialiser_a60ac46edf43d39927816e34b1a0d983c}\label{class_ogre_1_1_stream_serialiser_a60ac46edf43d39927816e34b1a0d983c}} 
\index{Ogre::StreamSerialiser@{Ogre::StreamSerialiser}!write@{write}}
\index{write@{write}!Ogre::StreamSerialiser@{Ogre::StreamSerialiser}}
\doxysubsubsection{\texorpdfstring{write()}{write()}\hspace{0.1cm}{\footnotesize\ttfamily [3/16]}}
{\footnotesize\ttfamily virtual void Ogre\+::\+Stream\+Serialiser\+::write (\begin{DoxyParamCaption}\item[{const \mbox{\hyperlink{namespace_ogre_a8542e5da4c0e0bda0d0bf5745329ea88}{Vector2}} $\ast$}]{vec,  }\item[{size\+\_\+t}]{count = {\ttfamily 1} }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [virtual]}}

\mbox{\Hypertarget{class_ogre_1_1_stream_serialiser_ada08984a52a07febc6ddd531c60adbd6}\label{class_ogre_1_1_stream_serialiser_ada08984a52a07febc6ddd531c60adbd6}} 
\index{Ogre::StreamSerialiser@{Ogre::StreamSerialiser}!write@{write}}
\index{write@{write}!Ogre::StreamSerialiser@{Ogre::StreamSerialiser}}
\doxysubsubsection{\texorpdfstring{write()}{write()}\hspace{0.1cm}{\footnotesize\ttfamily [4/16]}}
{\footnotesize\ttfamily virtual void Ogre\+::\+Stream\+Serialiser\+::write (\begin{DoxyParamCaption}\item[{const \mbox{\hyperlink{namespace_ogre_ac94fc4008c1165dea017263fee56b273}{Vector3}} $\ast$}]{vec,  }\item[{size\+\_\+t}]{count = {\ttfamily 1} }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [virtual]}}

\mbox{\Hypertarget{class_ogre_1_1_stream_serialiser_a994f2de1f0d13f674b6946b2490c225a}\label{class_ogre_1_1_stream_serialiser_a994f2de1f0d13f674b6946b2490c225a}} 
\index{Ogre::StreamSerialiser@{Ogre::StreamSerialiser}!write@{write}}
\index{write@{write}!Ogre::StreamSerialiser@{Ogre::StreamSerialiser}}
\doxysubsubsection{\texorpdfstring{write()}{write()}\hspace{0.1cm}{\footnotesize\ttfamily [5/16]}}
{\footnotesize\ttfamily virtual void Ogre\+::\+Stream\+Serialiser\+::write (\begin{DoxyParamCaption}\item[{const \mbox{\hyperlink{namespace_ogre_a739a289a4d5235f5f509a1795f5ffd5b}{Vector4}} $\ast$}]{vec,  }\item[{size\+\_\+t}]{count = {\ttfamily 1} }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [virtual]}}

\mbox{\Hypertarget{class_ogre_1_1_stream_serialiser_a53163836004961bea4bb7ab73819b322}\label{class_ogre_1_1_stream_serialiser_a53163836004961bea4bb7ab73819b322}} 
\index{Ogre::StreamSerialiser@{Ogre::StreamSerialiser}!write@{write}}
\index{write@{write}!Ogre::StreamSerialiser@{Ogre::StreamSerialiser}}
\doxysubsubsection{\texorpdfstring{write()}{write()}\hspace{0.1cm}{\footnotesize\ttfamily [6/16]}}
{\footnotesize\ttfamily virtual void Ogre\+::\+Stream\+Serialiser\+::write (\begin{DoxyParamCaption}\item[{const \mbox{\hyperlink{class_ogre_1_1_quaternion}{Quaternion}} $\ast$}]{q,  }\item[{size\+\_\+t}]{count = {\ttfamily 1} }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [virtual]}}

\mbox{\Hypertarget{class_ogre_1_1_stream_serialiser_a6430b8559a0b559d3eefaebef786759e}\label{class_ogre_1_1_stream_serialiser_a6430b8559a0b559d3eefaebef786759e}} 
\index{Ogre::StreamSerialiser@{Ogre::StreamSerialiser}!write@{write}}
\index{write@{write}!Ogre::StreamSerialiser@{Ogre::StreamSerialiser}}
\doxysubsubsection{\texorpdfstring{write()}{write()}\hspace{0.1cm}{\footnotesize\ttfamily [7/16]}}
{\footnotesize\ttfamily virtual void Ogre\+::\+Stream\+Serialiser\+::write (\begin{DoxyParamCaption}\item[{const \mbox{\hyperlink{class_ogre_1_1_matrix3}{Matrix3}} $\ast$}]{m,  }\item[{size\+\_\+t}]{count = {\ttfamily 1} }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [virtual]}}

\mbox{\Hypertarget{class_ogre_1_1_stream_serialiser_a0ffe90cc7b051f0f56faccc739988cea}\label{class_ogre_1_1_stream_serialiser_a0ffe90cc7b051f0f56faccc739988cea}} 
\index{Ogre::StreamSerialiser@{Ogre::StreamSerialiser}!write@{write}}
\index{write@{write}!Ogre::StreamSerialiser@{Ogre::StreamSerialiser}}
\doxysubsubsection{\texorpdfstring{write()}{write()}\hspace{0.1cm}{\footnotesize\ttfamily [8/16]}}
{\footnotesize\ttfamily virtual void Ogre\+::\+Stream\+Serialiser\+::write (\begin{DoxyParamCaption}\item[{const \mbox{\hyperlink{class_ogre_1_1_matrix4}{Matrix4}} $\ast$}]{m,  }\item[{size\+\_\+t}]{count = {\ttfamily 1} }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [virtual]}}

\mbox{\Hypertarget{class_ogre_1_1_stream_serialiser_a82759066f35c8cb08e24ce4357c747c7}\label{class_ogre_1_1_stream_serialiser_a82759066f35c8cb08e24ce4357c747c7}} 
\index{Ogre::StreamSerialiser@{Ogre::StreamSerialiser}!write@{write}}
\index{write@{write}!Ogre::StreamSerialiser@{Ogre::StreamSerialiser}}
\doxysubsubsection{\texorpdfstring{write()}{write()}\hspace{0.1cm}{\footnotesize\ttfamily [9/16]}}
{\footnotesize\ttfamily virtual void Ogre\+::\+Stream\+Serialiser\+::write (\begin{DoxyParamCaption}\item[{const \mbox{\hyperlink{namespace_ogre_af73bbdc8bed8a3e6fcd56bb8fa188c45}{String}} $\ast$}]{string }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [virtual]}}

\mbox{\Hypertarget{class_ogre_1_1_stream_serialiser_a6731deffcb48fa5b78422e4f955f5f93}\label{class_ogre_1_1_stream_serialiser_a6731deffcb48fa5b78422e4f955f5f93}} 
\index{Ogre::StreamSerialiser@{Ogre::StreamSerialiser}!write@{write}}
\index{write@{write}!Ogre::StreamSerialiser@{Ogre::StreamSerialiser}}
\doxysubsubsection{\texorpdfstring{write()}{write()}\hspace{0.1cm}{\footnotesize\ttfamily [10/16]}}
{\footnotesize\ttfamily virtual void Ogre\+::\+Stream\+Serialiser\+::write (\begin{DoxyParamCaption}\item[{const \mbox{\hyperlink{class_ogre_1_1_axis_aligned_box}{Axis\+Aligned\+Box}} $\ast$}]{aabb,  }\item[{size\+\_\+t}]{count = {\ttfamily 1} }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [virtual]}}

\mbox{\Hypertarget{class_ogre_1_1_stream_serialiser_a5435ad86ff5851f9012191d3b5179a55}\label{class_ogre_1_1_stream_serialiser_a5435ad86ff5851f9012191d3b5179a55}} 
\index{Ogre::StreamSerialiser@{Ogre::StreamSerialiser}!write@{write}}
\index{write@{write}!Ogre::StreamSerialiser@{Ogre::StreamSerialiser}}
\doxysubsubsection{\texorpdfstring{write()}{write()}\hspace{0.1cm}{\footnotesize\ttfamily [11/16]}}
{\footnotesize\ttfamily virtual void Ogre\+::\+Stream\+Serialiser\+::write (\begin{DoxyParamCaption}\item[{const \mbox{\hyperlink{class_ogre_1_1_sphere}{Sphere}} $\ast$}]{sphere,  }\item[{size\+\_\+t}]{count = {\ttfamily 1} }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [virtual]}}

\mbox{\Hypertarget{class_ogre_1_1_stream_serialiser_a0d289d76cc669fd1ade3ef05fa48bd21}\label{class_ogre_1_1_stream_serialiser_a0d289d76cc669fd1ade3ef05fa48bd21}} 
\index{Ogre::StreamSerialiser@{Ogre::StreamSerialiser}!write@{write}}
\index{write@{write}!Ogre::StreamSerialiser@{Ogre::StreamSerialiser}}
\doxysubsubsection{\texorpdfstring{write()}{write()}\hspace{0.1cm}{\footnotesize\ttfamily [12/16]}}
{\footnotesize\ttfamily virtual void Ogre\+::\+Stream\+Serialiser\+::write (\begin{DoxyParamCaption}\item[{const \mbox{\hyperlink{class_ogre_1_1_plane}{Plane}} $\ast$}]{plane,  }\item[{size\+\_\+t}]{count = {\ttfamily 1} }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [virtual]}}

\mbox{\Hypertarget{class_ogre_1_1_stream_serialiser_ad453d94c2cc1ebd6a13d2571ee8d5456}\label{class_ogre_1_1_stream_serialiser_ad453d94c2cc1ebd6a13d2571ee8d5456}} 
\index{Ogre::StreamSerialiser@{Ogre::StreamSerialiser}!write@{write}}
\index{write@{write}!Ogre::StreamSerialiser@{Ogre::StreamSerialiser}}
\doxysubsubsection{\texorpdfstring{write()}{write()}\hspace{0.1cm}{\footnotesize\ttfamily [13/16]}}
{\footnotesize\ttfamily virtual void Ogre\+::\+Stream\+Serialiser\+::write (\begin{DoxyParamCaption}\item[{const \mbox{\hyperlink{class_ogre_1_1_ray}{Ray}} $\ast$}]{ray,  }\item[{size\+\_\+t}]{count = {\ttfamily 1} }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [virtual]}}

\mbox{\Hypertarget{class_ogre_1_1_stream_serialiser_a79d03ff4a8aedc9e28412dc25fa48027}\label{class_ogre_1_1_stream_serialiser_a79d03ff4a8aedc9e28412dc25fa48027}} 
\index{Ogre::StreamSerialiser@{Ogre::StreamSerialiser}!write@{write}}
\index{write@{write}!Ogre::StreamSerialiser@{Ogre::StreamSerialiser}}
\doxysubsubsection{\texorpdfstring{write()}{write()}\hspace{0.1cm}{\footnotesize\ttfamily [14/16]}}
{\footnotesize\ttfamily virtual void Ogre\+::\+Stream\+Serialiser\+::write (\begin{DoxyParamCaption}\item[{const \mbox{\hyperlink{class_ogre_1_1_radian}{Radian}} $\ast$}]{angle,  }\item[{size\+\_\+t}]{count = {\ttfamily 1} }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [virtual]}}

\mbox{\Hypertarget{class_ogre_1_1_stream_serialiser_a456b335842b528abb03c953049cac7ad}\label{class_ogre_1_1_stream_serialiser_a456b335842b528abb03c953049cac7ad}} 
\index{Ogre::StreamSerialiser@{Ogre::StreamSerialiser}!write@{write}}
\index{write@{write}!Ogre::StreamSerialiser@{Ogre::StreamSerialiser}}
\doxysubsubsection{\texorpdfstring{write()}{write()}\hspace{0.1cm}{\footnotesize\ttfamily [15/16]}}
{\footnotesize\ttfamily virtual void Ogre\+::\+Stream\+Serialiser\+::write (\begin{DoxyParamCaption}\item[{const \mbox{\hyperlink{class_ogre_1_1_node}{Node}} $\ast$}]{node,  }\item[{size\+\_\+t}]{count = {\ttfamily 1} }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [virtual]}}

\mbox{\Hypertarget{class_ogre_1_1_stream_serialiser_a4397c12bc7f970bd559d0d24a0116b36}\label{class_ogre_1_1_stream_serialiser_a4397c12bc7f970bd559d0d24a0116b36}} 
\index{Ogre::StreamSerialiser@{Ogre::StreamSerialiser}!write@{write}}
\index{write@{write}!Ogre::StreamSerialiser@{Ogre::StreamSerialiser}}
\doxysubsubsection{\texorpdfstring{write()}{write()}\hspace{0.1cm}{\footnotesize\ttfamily [16/16]}}
{\footnotesize\ttfamily virtual void Ogre\+::\+Stream\+Serialiser\+::write (\begin{DoxyParamCaption}\item[{const bool $\ast$}]{boolean,  }\item[{size\+\_\+t}]{count = {\ttfamily 1} }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [virtual]}}

\mbox{\Hypertarget{class_ogre_1_1_stream_serialiser_a2d9cd8abb22fbd17c795aa62765b4a59}\label{class_ogre_1_1_stream_serialiser_a2d9cd8abb22fbd17c795aa62765b4a59}} 
\index{Ogre::StreamSerialiser@{Ogre::StreamSerialiser}!readData@{readData}}
\index{readData@{readData}!Ogre::StreamSerialiser@{Ogre::StreamSerialiser}}
\doxysubsubsection{\texorpdfstring{readData()}{readData()}}
{\footnotesize\ttfamily virtual void Ogre\+::\+Stream\+Serialiser\+::read\+Data (\begin{DoxyParamCaption}\item[{void $\ast$}]{buf,  }\item[{size\+\_\+t}]{size,  }\item[{size\+\_\+t}]{count }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [virtual]}}



Read arbitrary data from a stream. 


\begin{DoxyParams}{Parameters}
{\em buf} & Pointer to bytes \\
\hline
{\em size} & The size of each element to read; each will be endian-\/flipped if necessary \\
\hline
{\em count} & The number of elements to read \\
\hline
\end{DoxyParams}
\mbox{\Hypertarget{class_ogre_1_1_stream_serialiser_a72a8e8540b453b8428992c0c6c599995}\label{class_ogre_1_1_stream_serialiser_a72a8e8540b453b8428992c0c6c599995}} 
\index{Ogre::StreamSerialiser@{Ogre::StreamSerialiser}!read@{read}}
\index{read@{read}!Ogre::StreamSerialiser@{Ogre::StreamSerialiser}}
\doxysubsubsection{\texorpdfstring{read()}{read()}\hspace{0.1cm}{\footnotesize\ttfamily [1/16]}}
{\footnotesize\ttfamily template$<$typename T $>$ \\
void Ogre\+::\+Stream\+Serialiser\+::read (\begin{DoxyParamCaption}\item[{T $\ast$}]{pT,  }\item[{size\+\_\+t}]{count = {\ttfamily 1} }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [inline]}}



Catch-\/all method to read primitive types. 

\mbox{\Hypertarget{class_ogre_1_1_stream_serialiser_a46bcb952e488697f41786e1156c00979}\label{class_ogre_1_1_stream_serialiser_a46bcb952e488697f41786e1156c00979}} 
\index{Ogre::StreamSerialiser@{Ogre::StreamSerialiser}!read@{read}}
\index{read@{read}!Ogre::StreamSerialiser@{Ogre::StreamSerialiser}}
\doxysubsubsection{\texorpdfstring{read()}{read()}\hspace{0.1cm}{\footnotesize\ttfamily [2/16]}}
{\footnotesize\ttfamily virtual void Ogre\+::\+Stream\+Serialiser\+::read (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{namespace_ogre_aa3a7b6dfb905e6572d62f0dfa3d4274d}{Real}} $\ast$}]{val,  }\item[{size\+\_\+t}]{count = {\ttfamily 1} }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [virtual]}}

\mbox{\Hypertarget{class_ogre_1_1_stream_serialiser_a273eb21bd429c3a1dc4ac6981bea7c6b}\label{class_ogre_1_1_stream_serialiser_a273eb21bd429c3a1dc4ac6981bea7c6b}} 
\index{Ogre::StreamSerialiser@{Ogre::StreamSerialiser}!read@{read}}
\index{read@{read}!Ogre::StreamSerialiser@{Ogre::StreamSerialiser}}
\doxysubsubsection{\texorpdfstring{read()}{read()}\hspace{0.1cm}{\footnotesize\ttfamily [3/16]}}
{\footnotesize\ttfamily virtual void Ogre\+::\+Stream\+Serialiser\+::read (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{namespace_ogre_a8542e5da4c0e0bda0d0bf5745329ea88}{Vector2}} $\ast$}]{vec,  }\item[{size\+\_\+t}]{count = {\ttfamily 1} }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [virtual]}}



read a Vector3 

\mbox{\Hypertarget{class_ogre_1_1_stream_serialiser_a5f557c549a65a20e76e605f9bf9fe4c9}\label{class_ogre_1_1_stream_serialiser_a5f557c549a65a20e76e605f9bf9fe4c9}} 
\index{Ogre::StreamSerialiser@{Ogre::StreamSerialiser}!read@{read}}
\index{read@{read}!Ogre::StreamSerialiser@{Ogre::StreamSerialiser}}
\doxysubsubsection{\texorpdfstring{read()}{read()}\hspace{0.1cm}{\footnotesize\ttfamily [4/16]}}
{\footnotesize\ttfamily virtual void Ogre\+::\+Stream\+Serialiser\+::read (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{namespace_ogre_ac94fc4008c1165dea017263fee56b273}{Vector3}} $\ast$}]{vec,  }\item[{size\+\_\+t}]{count = {\ttfamily 1} }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [virtual]}}

\mbox{\Hypertarget{class_ogre_1_1_stream_serialiser_aee0e00b95f550cc324cbb5fef1a3766b}\label{class_ogre_1_1_stream_serialiser_aee0e00b95f550cc324cbb5fef1a3766b}} 
\index{Ogre::StreamSerialiser@{Ogre::StreamSerialiser}!read@{read}}
\index{read@{read}!Ogre::StreamSerialiser@{Ogre::StreamSerialiser}}
\doxysubsubsection{\texorpdfstring{read()}{read()}\hspace{0.1cm}{\footnotesize\ttfamily [5/16]}}
{\footnotesize\ttfamily virtual void Ogre\+::\+Stream\+Serialiser\+::read (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{namespace_ogre_a739a289a4d5235f5f509a1795f5ffd5b}{Vector4}} $\ast$}]{vec,  }\item[{size\+\_\+t}]{count = {\ttfamily 1} }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [virtual]}}

\mbox{\Hypertarget{class_ogre_1_1_stream_serialiser_a3173c30a36415d10b4daf6e130953e0e}\label{class_ogre_1_1_stream_serialiser_a3173c30a36415d10b4daf6e130953e0e}} 
\index{Ogre::StreamSerialiser@{Ogre::StreamSerialiser}!read@{read}}
\index{read@{read}!Ogre::StreamSerialiser@{Ogre::StreamSerialiser}}
\doxysubsubsection{\texorpdfstring{read()}{read()}\hspace{0.1cm}{\footnotesize\ttfamily [6/16]}}
{\footnotesize\ttfamily virtual void Ogre\+::\+Stream\+Serialiser\+::read (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{class_ogre_1_1_quaternion}{Quaternion}} $\ast$}]{q,  }\item[{size\+\_\+t}]{count = {\ttfamily 1} }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [virtual]}}

\mbox{\Hypertarget{class_ogre_1_1_stream_serialiser_a9a3af44ad9ac9d841ec5e15d4c6856f3}\label{class_ogre_1_1_stream_serialiser_a9a3af44ad9ac9d841ec5e15d4c6856f3}} 
\index{Ogre::StreamSerialiser@{Ogre::StreamSerialiser}!read@{read}}
\index{read@{read}!Ogre::StreamSerialiser@{Ogre::StreamSerialiser}}
\doxysubsubsection{\texorpdfstring{read()}{read()}\hspace{0.1cm}{\footnotesize\ttfamily [7/16]}}
{\footnotesize\ttfamily virtual void Ogre\+::\+Stream\+Serialiser\+::read (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{class_ogre_1_1_matrix3}{Matrix3}} $\ast$}]{m,  }\item[{size\+\_\+t}]{count = {\ttfamily 1} }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [virtual]}}

\mbox{\Hypertarget{class_ogre_1_1_stream_serialiser_a28eec6a458dd2f02a8849a51dc107dcf}\label{class_ogre_1_1_stream_serialiser_a28eec6a458dd2f02a8849a51dc107dcf}} 
\index{Ogre::StreamSerialiser@{Ogre::StreamSerialiser}!read@{read}}
\index{read@{read}!Ogre::StreamSerialiser@{Ogre::StreamSerialiser}}
\doxysubsubsection{\texorpdfstring{read()}{read()}\hspace{0.1cm}{\footnotesize\ttfamily [8/16]}}
{\footnotesize\ttfamily virtual void Ogre\+::\+Stream\+Serialiser\+::read (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{class_ogre_1_1_matrix4}{Matrix4}} $\ast$}]{m,  }\item[{size\+\_\+t}]{count = {\ttfamily 1} }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [virtual]}}

\mbox{\Hypertarget{class_ogre_1_1_stream_serialiser_aa930c1889b253433b459176426795627}\label{class_ogre_1_1_stream_serialiser_aa930c1889b253433b459176426795627}} 
\index{Ogre::StreamSerialiser@{Ogre::StreamSerialiser}!read@{read}}
\index{read@{read}!Ogre::StreamSerialiser@{Ogre::StreamSerialiser}}
\doxysubsubsection{\texorpdfstring{read()}{read()}\hspace{0.1cm}{\footnotesize\ttfamily [9/16]}}
{\footnotesize\ttfamily virtual void Ogre\+::\+Stream\+Serialiser\+::read (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{namespace_ogre_af73bbdc8bed8a3e6fcd56bb8fa188c45}{String}} $\ast$}]{string }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [virtual]}}

\mbox{\Hypertarget{class_ogre_1_1_stream_serialiser_a32788255718a172dd040cf6766e8e32a}\label{class_ogre_1_1_stream_serialiser_a32788255718a172dd040cf6766e8e32a}} 
\index{Ogre::StreamSerialiser@{Ogre::StreamSerialiser}!read@{read}}
\index{read@{read}!Ogre::StreamSerialiser@{Ogre::StreamSerialiser}}
\doxysubsubsection{\texorpdfstring{read()}{read()}\hspace{0.1cm}{\footnotesize\ttfamily [10/16]}}
{\footnotesize\ttfamily virtual void Ogre\+::\+Stream\+Serialiser\+::read (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{class_ogre_1_1_axis_aligned_box}{Axis\+Aligned\+Box}} $\ast$}]{aabb,  }\item[{size\+\_\+t}]{count = {\ttfamily 1} }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [virtual]}}

\mbox{\Hypertarget{class_ogre_1_1_stream_serialiser_a242f3491c47852b53b0b689edfc25e4c}\label{class_ogre_1_1_stream_serialiser_a242f3491c47852b53b0b689edfc25e4c}} 
\index{Ogre::StreamSerialiser@{Ogre::StreamSerialiser}!read@{read}}
\index{read@{read}!Ogre::StreamSerialiser@{Ogre::StreamSerialiser}}
\doxysubsubsection{\texorpdfstring{read()}{read()}\hspace{0.1cm}{\footnotesize\ttfamily [11/16]}}
{\footnotesize\ttfamily virtual void Ogre\+::\+Stream\+Serialiser\+::read (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{class_ogre_1_1_sphere}{Sphere}} $\ast$}]{sphere,  }\item[{size\+\_\+t}]{count = {\ttfamily 1} }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [virtual]}}

\mbox{\Hypertarget{class_ogre_1_1_stream_serialiser_a85a44458396fa2170fa8858a0328fa97}\label{class_ogre_1_1_stream_serialiser_a85a44458396fa2170fa8858a0328fa97}} 
\index{Ogre::StreamSerialiser@{Ogre::StreamSerialiser}!read@{read}}
\index{read@{read}!Ogre::StreamSerialiser@{Ogre::StreamSerialiser}}
\doxysubsubsection{\texorpdfstring{read()}{read()}\hspace{0.1cm}{\footnotesize\ttfamily [12/16]}}
{\footnotesize\ttfamily virtual void Ogre\+::\+Stream\+Serialiser\+::read (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{class_ogre_1_1_plane}{Plane}} $\ast$}]{plane,  }\item[{size\+\_\+t}]{count = {\ttfamily 1} }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [virtual]}}

\mbox{\Hypertarget{class_ogre_1_1_stream_serialiser_a838c7aea842143bcf54d82d3fe085efe}\label{class_ogre_1_1_stream_serialiser_a838c7aea842143bcf54d82d3fe085efe}} 
\index{Ogre::StreamSerialiser@{Ogre::StreamSerialiser}!read@{read}}
\index{read@{read}!Ogre::StreamSerialiser@{Ogre::StreamSerialiser}}
\doxysubsubsection{\texorpdfstring{read()}{read()}\hspace{0.1cm}{\footnotesize\ttfamily [13/16]}}
{\footnotesize\ttfamily virtual void Ogre\+::\+Stream\+Serialiser\+::read (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{class_ogre_1_1_ray}{Ray}} $\ast$}]{ray,  }\item[{size\+\_\+t}]{count = {\ttfamily 1} }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [virtual]}}

\mbox{\Hypertarget{class_ogre_1_1_stream_serialiser_a8da61d9cfea11fa94aef4b3ea1a81eae}\label{class_ogre_1_1_stream_serialiser_a8da61d9cfea11fa94aef4b3ea1a81eae}} 
\index{Ogre::StreamSerialiser@{Ogre::StreamSerialiser}!read@{read}}
\index{read@{read}!Ogre::StreamSerialiser@{Ogre::StreamSerialiser}}
\doxysubsubsection{\texorpdfstring{read()}{read()}\hspace{0.1cm}{\footnotesize\ttfamily [14/16]}}
{\footnotesize\ttfamily virtual void Ogre\+::\+Stream\+Serialiser\+::read (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{class_ogre_1_1_radian}{Radian}} $\ast$}]{angle,  }\item[{size\+\_\+t}]{count = {\ttfamily 1} }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [virtual]}}

\mbox{\Hypertarget{class_ogre_1_1_stream_serialiser_a5e45523a0409077bbcab706ef0a58f64}\label{class_ogre_1_1_stream_serialiser_a5e45523a0409077bbcab706ef0a58f64}} 
\index{Ogre::StreamSerialiser@{Ogre::StreamSerialiser}!read@{read}}
\index{read@{read}!Ogre::StreamSerialiser@{Ogre::StreamSerialiser}}
\doxysubsubsection{\texorpdfstring{read()}{read()}\hspace{0.1cm}{\footnotesize\ttfamily [15/16]}}
{\footnotesize\ttfamily virtual void Ogre\+::\+Stream\+Serialiser\+::read (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{class_ogre_1_1_node}{Node}} $\ast$}]{node,  }\item[{size\+\_\+t}]{count = {\ttfamily 1} }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [virtual]}}

\mbox{\Hypertarget{class_ogre_1_1_stream_serialiser_af8fe1551fa5a1dc26317c9b57b8ef1f6}\label{class_ogre_1_1_stream_serialiser_af8fe1551fa5a1dc26317c9b57b8ef1f6}} 
\index{Ogre::StreamSerialiser@{Ogre::StreamSerialiser}!read@{read}}
\index{read@{read}!Ogre::StreamSerialiser@{Ogre::StreamSerialiser}}
\doxysubsubsection{\texorpdfstring{read()}{read()}\hspace{0.1cm}{\footnotesize\ttfamily [16/16]}}
{\footnotesize\ttfamily virtual void Ogre\+::\+Stream\+Serialiser\+::read (\begin{DoxyParamCaption}\item[{bool $\ast$}]{val,  }\item[{size\+\_\+t}]{count = {\ttfamily 1} }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [virtual]}}

\mbox{\Hypertarget{class_ogre_1_1_stream_serialiser_aa9c4b6be63560e6f2ab0b647fe797175}\label{class_ogre_1_1_stream_serialiser_aa9c4b6be63560e6f2ab0b647fe797175}} 
\index{Ogre::StreamSerialiser@{Ogre::StreamSerialiser}!startDeflate@{startDeflate}}
\index{startDeflate@{startDeflate}!Ogre::StreamSerialiser@{Ogre::StreamSerialiser}}
\doxysubsubsection{\texorpdfstring{startDeflate()}{startDeflate()}}
{\footnotesize\ttfamily virtual void Ogre\+::\+Stream\+Serialiser\+::start\+Deflate (\begin{DoxyParamCaption}\item[{size\+\_\+t}]{avail\+\_\+in = {\ttfamily 0} }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [virtual]}}



Start (un)compressing data. 


\begin{DoxyParams}{Parameters}
{\em avail\+\_\+in} & Available bytes for uncompressing \\
\hline
\end{DoxyParams}
\mbox{\Hypertarget{class_ogre_1_1_stream_serialiser_ac16f0772431b3939250062d61957189d}\label{class_ogre_1_1_stream_serialiser_ac16f0772431b3939250062d61957189d}} 
\index{Ogre::StreamSerialiser@{Ogre::StreamSerialiser}!stopDeflate@{stopDeflate}}
\index{stopDeflate@{stopDeflate}!Ogre::StreamSerialiser@{Ogre::StreamSerialiser}}
\doxysubsubsection{\texorpdfstring{stopDeflate()}{stopDeflate()}}
{\footnotesize\ttfamily virtual void Ogre\+::\+Stream\+Serialiser\+::stop\+Deflate (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [virtual]}}



Stop (un)compressing data. 



The documentation for this class was generated from the following file\+:\begin{DoxyCompactItemize}
\item 
\mbox{\hyperlink{_ogre_stream_serialiser_8h}{Ogre\+Stream\+Serialiser.\+h}}\end{DoxyCompactItemize}
