StreamIn Class Reference

Simple binary input stream. More...

#include <StreamIn.h>

Inheritance diagram for StreamIn:

Public Member Functions
virtual	~StreamIn ()=default
	Virtual destructor.
virtual void	ReadBytes (void *outData, size_t inNumBytes)=0
	Read a string of bytes from the binary stream.
virtual bool	IsEOF () const =0
virtual bool	IsFailed () const =0
	Returns true if there was an IO failure.
template<class T , std::enable_if_t< std::is_trivially_copyable_v< T >, bool > = true>
void	Read (T &outT)
	Read a primitive (e.g. float, int, etc.) from the binary stream.
template<class T , class A , std::enable_if_t< std::is_trivially_copyable_v< T >, bool > = true>
void	Read (Array< T, A > &outT)
	Read a vector of primitives from the binary stream.
template<class Type , class Traits , class Allocator >
void	Read (std::basic_string< Type, Traits, Allocator > &outString)
	Read a string from the binary stream (reads the number of characters and then the characters)
template<class T , class A , typename F >
void	Read (Array< T, A > &outT, const F &inReadElement)
	Read a vector of primitives from the binary stream using a custom function to read the elements.
void	Read (Vec3 &outVec)
	Read a Vec3 (don't read W)
void	Read (DVec3 &outVec)
	Read a DVec3 (don't read W)
void	Read (DMat44 &outVec)
	Read a DMat44 (don't read W component of translation)
Public Member Functions inherited from NonCopyable
	NonCopyable ()=default
	NonCopyable (const NonCopyable &)=delete
void	operator= (const NonCopyable &)=delete

Detailed Description

Simple binary input stream.

Constructor & Destructor Documentation

~StreamIn()

virtual StreamIn::~StreamIn ( )

virtualdefault

Virtual destructor.

Member Function Documentation

IsEOF()

virtual bool StreamIn::IsEOF ( ) const

pure virtual

Returns true when an attempt has been made to read past the end of the file. Note that this follows the convention of std::basic_ios::eof which only returns true when an attempt is made to read past the end, not when the read pointer is at the end.

Implemented in StateRecorderImpl, and StreamInWrapper.

IsFailed()

virtual bool StreamIn::IsFailed ( ) const

pure virtual

Returns true if there was an IO failure.

Implemented in StateRecorderImpl, and StreamInWrapper.

Read() [1/7]

template<class T , class A , std::enable_if_t< std::is_trivially_copyable_v< T >, bool > = true>

void StreamIn::Read ( Array< T, A > & outT )

inline

Read a vector of primitives from the binary stream.

Read() [2/7]

template<class T , class A , typename F >

void StreamIn::Read ( Array< T, A > & outT, const F & inReadElement )

inline

Read a vector of primitives from the binary stream using a custom function to read the elements.

Read() [3/7]

void StreamIn::Read ( DMat44 & outVec )

inline

Read a DMat44 (don't read W component of translation)

Read() [4/7]

void StreamIn::Read ( DVec3 & outVec )

inline

Read a DVec3 (don't read W)

Read() [5/7]

template<class Type , class Traits , class Allocator >

void StreamIn::Read ( std::basic_string< Type, Traits, Allocator > & outString )

inline

Read a string from the binary stream (reads the number of characters and then the characters)

Read() [6/7]

template<class T , std::enable_if_t< std::is_trivially_copyable_v< T >, bool > = true>

void StreamIn::Read ( T & outT )

inline

Read a primitive (e.g. float, int, etc.) from the binary stream.

Read() [7/7]

void StreamIn::Read ( Vec3 & outVec )

inline

Read a Vec3 (don't read W)

ReadBytes()

virtual void StreamIn::ReadBytes ( void * outData, size_t inNumBytes )

pure virtual

Read a string of bytes from the binary stream.

Implemented in StateRecorderImpl, and StreamInWrapper.

---

The documentation for this class was generated from the following file:

• Jolt/Core/StreamIn.h