oglplus::images::XPMImage Class Reference

Loader of images in the XPM (X Pix Map) format. More...

#include </home/chochlik/devel/oglplus/include/oglplus/images/xpm.hpp>

Inheritance diagram for oglplus::images::XPMImage:

Collaboration diagram for oglplus::images::XPMImage:

Public Member Functions
	XPMImage (std::istream &input, bool y_is_up=true, bool x_is_right=true)
	Load the image from the specified input stream.
GLsizei	Dimension (std::size_t i) const
	Returns the i-th dimension of the image. More...
GLsizei	Width (void) const
	Returns the width of the image.
GLsizei	Height (void) const
	Returns the height of the image.
GLsizei	Depth (void) const
	Returns the depth of the image.
GLsizei	Channels (void) const
	Returns the number of channels.
PixelDataType	Type (void) const
	Returns the pixel data type.
PixelDataFormat	Format (void) const
	Return the pixel data format.
PixelDataInternalFormat	InternalFormat (void) const
	Return a suitable pixel data internal format.
template<typename T >
const T *	Data (void) const
	Returns a pointer to the data.
const void *	RawData (void) const
	Returns an untyped pointer to the data.
std::size_t	DataSize (void) const
	Returns the size of data in bytes.
Vector< double, 4 >	Pixel (GLsizei width, GLsizei height, GLsizei depth) const
	Returns the pixel at the specified coordinates.
double	Component (GLsizei width, GLsizei height, GLsizei depth, GLsizei component) const
	Returns the component of the pixel at the specified coordinates.
template<typename T >
T	ComponentAs (GLsizei width, GLsizei height, GLsizei depth, GLsizei component) const
	Returns the component of the pixel at the specified coordinates.

Detailed Description

Loader of images in the XPM (X Pix Map) format.

Member Function Documentation

GLsizei oglplus::images::Image::Dimension ( std::size_t  i ) const

inherited

Returns the i-th dimension of the image.

0: Width 1: Height 2: Depth 3: Channels

References oglplus::images::Image::Channels(), oglplus::images::Image::Depth(), oglplus::images::Image::Height(), and oglplus::images::Image::Width().

---

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

• /home/chochlik/devel/oglplus/include/oglplus/images/xpm.hpp