Om  1.0.0
A universal framework for multimedia simulation
Public Member Functions | Public Attributes | Static Public Attributes | List of all members
om::io::BinaryFormat Class Reference

A class that stores the global format parameters of a binary file. More...

#include <omBinaryFormat.h>

Public Member Functions

 BinaryFormat ()
 Create a new binary format that uses the native endianness and default alignment. More...
 
 BinaryFormat (const data::Endianness &newEndianness, Size newAlignment)
 Create a new binary format that uses the specified endianness for primitive types and alignment. More...
 

Public Attributes

data::Endianness endianness
 The endianness that the asset file is encoded or decoded to/from. More...
 
Size alignment
 The required alignment in bytes of all objects in the file and the padding for strings. More...
 

Static Public Attributes

static const Size DEFAULT_ALIGNMENT = 8
 The default alignment to use for objects. More...
 

Detailed Description

A class that stores the global format parameters of a binary file.

Constructor & Destructor Documentation

om::io::BinaryFormat::BinaryFormat ( )
inline

Create a new binary format that uses the native endianness and default alignment.

om::io::BinaryFormat::BinaryFormat ( const data::Endianness newEndianness,
Size  newAlignment 
)
inline

Create a new binary format that uses the specified endianness for primitive types and alignment.

Member Data Documentation

const Size om::io::BinaryFormat::DEFAULT_ALIGNMENT = 8
static

The default alignment to use for objects.

data::Endianness om::io::BinaryFormat::endianness

The endianness that the asset file is encoded or decoded to/from.

Size om::io::BinaryFormat::alignment

The required alignment in bytes of all objects in the file and the padding for strings.


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