H3D::Image Class Reference

Virtual base class for all images containing virtual functions that all Image classes must define. More...

#include <Image.h>

List of all members.

Public Types
enum	PixelType {   LUMINANCE, LUMINANCE_ALPHA, RGB, RGBA,   BGR, BGRA, VEC3 }
	Type that defines what format each pixel in the image is on.
enum	PixelComponentType { SIGNED, UNSIGNED, RATIONAL }
	Type of each component in the pixel.
Public Member Functions
virtual unsigned int	width ()=0
	Returns the width of the image in pixels.
virtual unsigned int	height ()=0
	Returns the height of the image in pixels.
virtual unsigned int	depth ()=0
	Returns the depth of the image in pixels.
virtual unsigned int	bitsPerPixel ()=0
	Returns the number of bits used for each pixel in the image.
virtual PixelType	pixelType ()=0
	Returns the PixelType of the image.
virtual PixelComponentType	pixelComponentType ()=0
	Returns the PixelComponentType of the image.
virtual Vec3f	pixelSize ()
	Returns the size of the pixel in x, y and z direction in metres.
virtual void *	getImageData ()=0
	Returns a pointer to the raw image data.
virtual void	getElement (void *value, int x=0, int y=0, int z=0)
virtual void	setElement (void *value, int x=0, int y=0, int z=0)

---

Detailed Description

Virtual base class for all images containing virtual functions that all Image classes must define.

---

Member Function Documentation

virtual void* H3D::Image::getImageData (   )  [pure virtual]

Returns a pointer to the raw image data. The ownership of the pointer is held by the Image class, if any memory allocations are made for the pointer the Image class is responsible for deallocating that memory.

virtual Vec3f H3D::Image::pixelSize (   )  [inline, virtual]

Returns the size of the pixel in x, y and z direction in metres. By default all pixels have the size Vec3f( 1, 1, 1 ).

---