Classes | Public Types | Public Member Functions | Static Public Member Functions

xl7::io::RIFF Class Reference

#include <RIFF.h>

Inheritance diagram for xl7::io::RIFF:
xl7::io::IRom

List of all members.

Classes

struct  Chunk

Public Types

enum  DescendFlags { find_riff = 1, find_chunk = 2 }

Public Member Functions

 RIFF (IRom &target_rom)
 ~RIFF (void)
bool IsOpen () const
unsigned GetSize () const
unsigned GetPointer () const
unsigned SetPointer (unsigned pointer)
bool Open ()
bool Close ()
unsigned Read (void *buffer, unsigned bytes)
unsigned Seek (signed bytes, const SeekFlags from=current)
bool Descend (Chunk *chunk, const Chunk *parent_chunk, DescendFlags flags)
bool Ascend (Chunk *chunk)

Static Public Member Functions

static unsigned long FourCC (char ch0, char ch1, char ch2, char ch3)

Detailed Description

Supports functionality to read multimedia files of the Resource Interchange File Format (RIFF).


Member Enumeration Documentation

Enumerator:
find_riff 
find_chunk 

Constructor & Destructor Documentation

xl7::io::RIFF::RIFF ( IRom target_rom  )  [explicit]

Explicit constructor.

xl7::io::RIFF::~RIFF ( void   ) 

Destructor.


Member Function Documentation

bool xl7::io::RIFF::Ascend ( Chunk chunk  ) 

Ascends out of a RIFF chunk descended into with function Descend.

bool xl7::io::RIFF::Close (  )  [virtual]

Closes the file.

Implements xl7::io::IRom.

bool xl7::io::RIFF::Descend ( Chunk chunk,
const Chunk parent_chunk,
DescendFlags  flags 
)

Descends into a RIFF chunk.

unsigned long xl7::io::RIFF::FourCC ( char  ch0,
char  ch1,
char  ch2,
char  ch3 
) [static]
unsigned xl7::io::RIFF::GetPointer (  )  const [virtual]

Returns the current byte position to read or write data.

Implements xl7::io::IRom.

unsigned xl7::io::RIFF::GetSize (  )  const [virtual]

Returns the size of the file, in bytes.

Implements xl7::io::IRom.

bool xl7::io::RIFF::IsOpen (  )  const [virtual]

Checks whether the file is open and can be read.

Implements xl7::io::IRom.

bool xl7::io::RIFF::Open (  )  [virtual]

Opens the file for reading data.

Implements xl7::io::IRom.

unsigned xl7::io::RIFF::Read ( void *  buffer,
unsigned  bytes 
) [virtual]

Reads data from the file and returns the number of bytes read.

Implements xl7::io::IRom.

unsigned xl7::io::RIFF::Seek ( signed  bytes,
const SeekFlags  from = current 
) [virtual]

Resets the current byte position to read or write data by moving the pointer by the specified bytes. The function returns the new position.

Implements xl7::io::IRom.

unsigned xl7::io::RIFF::SetPointer ( unsigned  pointer  )  [virtual]

Resets the current byte position to read or write data. The function returns the new position.

Implements xl7::io::IRom.


The documentation for this class was generated from the following files:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines