Eidolon
Public Member Functions | List of all members
Image Class Reference

Image objects represented loaded image files. These are used to access image data in code rather than load it into the renderer. More...

#include <RenderTypes.h>

Inheritance diagram for Image:
Inheritance graph
Collaboration diagram for Image:
Collaboration graph

Public Member Functions

virtual ~Image ()
 
virtual TextureFormat getFormat () const
 Get the loaded data's format. More...
 
virtual sval getWidth () const
 Get the image width. More...
 
virtual sval getHeight () const
 Get the image height. More...
 
virtual sval getDepth () const
 Get the image depth. More...
 
virtual size_t getDataSize () const
 Get the image data size in bytes. More...
 
virtual u8getData ()
 Get a pointer to the internal data buffer. More...
 
virtual std::string encode (const std::string &format)
 Encode the image data as the byte stream for a file, the format of which is given by `format' (eg. png, jpg) More...
 
virtual void fillRealMatrix (RealMatrix *mat) throw (IndexException)
 Transfer the image data into the given matrix. More...
 
virtual void fillColorMatrix (ColorMatrix *mat) throw (IndexException)
 Transfer the image data into the given matrix. More...
 

Detailed Description

Image objects represented loaded image files. These are used to access image data in code rather than load it into the renderer.

Constructor & Destructor Documentation

◆ ~Image()

virtual ~Image ( )
inlinevirtual

Member Function Documentation

◆ encode()

virtual std::string encode ( const std::string &  format)
inlinevirtual

Encode the image data as the byte stream for a file, the format of which is given by `format' (eg. png, jpg)

Reimplemented in OgreImage.

◆ fillColorMatrix()

virtual void fillColorMatrix ( ColorMatrix mat)
throw (IndexException
)
inlinevirtual

Transfer the image data into the given matrix.

Reimplemented in OgreImage.

◆ fillRealMatrix()

virtual void fillRealMatrix ( RealMatrix mat)
throw (IndexException
)
inlinevirtual

Transfer the image data into the given matrix.

Reimplemented in OgreImage.

◆ getData()

virtual u8* getData ( )
inlinevirtual

Get a pointer to the internal data buffer.

Reimplemented in OgreImage.

◆ getDataSize()

virtual size_t getDataSize ( ) const
inlinevirtual

Get the image data size in bytes.

Reimplemented in OgreImage.

◆ getDepth()

virtual sval getDepth ( ) const
inlinevirtual

Get the image depth.

Reimplemented in OgreImage.

◆ getFormat()

virtual TextureFormat getFormat ( ) const
inlinevirtual

Get the loaded data's format.

Reimplemented in OgreImage.

◆ getHeight()

virtual sval getHeight ( ) const
inlinevirtual

Get the image height.

Reimplemented in OgreImage.

◆ getWidth()

virtual sval getWidth ( ) const
inlinevirtual

Get the image width.

Reimplemented in OgreImage.


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