Mondschein Engine  0.3.0
Public Member Functions | List of all members
mondschein::io::FI_Buffer Class Reference

This class implements an image file loader based on the FreeImage library. More...

#include <buffer.h>

Inheritance diagram for mondschein::io::FI_Buffer:
mondschein::io::Buffer

Public Member Functions

virtual void parse_istream (std::istream &_in)
 Parse from an input stream. More...
 
virtual void parse_string (const std::string &_in)
 Parse from a string. More...
 
virtual void serialize_ostream (std::ostream &_out) const
 Serialize to an output stream. More...
 
virtual void serialize_string (std::string &_out) const
 Serialize to a string. More...
 
- Public Member Functions inherited from mondschein::io::Buffer
virtual void set_io_objects (const io_objects_t &_io_objects)
 Set the I/O objects container. More...
 
virtual io_objects_t get_io_objects () const
 Get the I/O objects container. More...
 

Detailed Description

This class implements an image file loader based on the FreeImage library.

The FI_Buffer class provides functionality to load and store a variety of image file formats. This buffer can handle any file formats the FreeImage library can handle. Thus it is basically possible to convert one file format into another one. But any caveats of the FreeImage library regarding image handling and conversion must be taken into account.

Definition at line 42 of file buffer.h.

Member Function Documentation

void FI_Buffer::parse_istream ( std::istream &  _in)
virtual

Parse from an input stream.

Parameters
_inthe input stream
Exceptions
mondschein::exceptionif a known exception is thrown during execution or if the file type doesn't match

If _in is a valid input stream containing data in the right format the buffer can parse all elements from that stream into the I/O objects container. What data can be parsed and how it is treated is implementation dependent.

Implements mondschein::io::Buffer.

Definition at line 62 of file buffer.cpp.

void FI_Buffer::parse_string ( const std::string &  _in)
virtual

Parse from a string.

Parameters
_inthe string
Exceptions
mondschein::exceptionif a known exception is thrown during execution or if the file type doesn't match

If _in is a valid string containing data in the right format the buffer can parse all elements from that string into the I/O objects container. What data can be parsed and how it is treated is implementation dependent.

Implements mondschein::io::Buffer.

Definition at line 83 of file buffer.cpp.

void FI_Buffer::serialize_ostream ( std::ostream &  _out) const
virtual

Serialize to an output stream.

Parameters
_outthe output stream
Exceptions
mondschein::exceptionif a known exception is thrown during execution

If _out is a valid output stream the buffer can serialize all elements in the I/O objects container into _out. What data can be processed and how it is treated is implementation dependent.

Implements mondschein::io::Buffer.

Definition at line 166 of file buffer.cpp.

void FI_Buffer::serialize_string ( std::string &  _out) const
virtual

Serialize to a string.

Parameters
_outthe string
Exceptions
mondschein::exceptionif a known exception is thrown during execution

If _out is a valid string the buffer can serialize all elements in the I/O objects container into _out. What data can be processed and how it is treated is implementation dependent.

Implements mondschein::io::Buffer.

Definition at line 183 of file buffer.cpp.


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