VRS::FileImage Class Reference

Class for representing file mapped image data. More...

#include <vrs/image/fileimage.h>

Inheritance diagram for VRS::FileImage:

List of all members.

Public Member Functions
	FileImage (const std::string &filename, bool isWritable=false)
	FileImage (const std::string &filename, int width, int height, Image::LayerSequence layerSequence=Image::RGB, bool persistent=true)
	FileImage (const std::string &filename, Image *source, bool persistent=true)
	FileImage (const std::string &filename, Image *source, int newWidth, int newHeight, bool persistent=true)
	FileImage (DataResource *resource)
	Uses the memory-mapped file as an image.
virtual int	width () const
virtual int	height () const
	See Image.
virtual void *	lineComponents (int y) const
virtual void *	pixelComponents (int x, int y, int component=0) const
	See Image.
	VRS_TYPEINFO (FileImage, Image)
	VRS_SERIALIZABLE (FileImage)
Protected Member Functions
	FileImage ()

---

Detailed Description

Class for representing file mapped image data.

---

Constructor & Destructor Documentation

VRS::FileImage::FileImage	(	const std::string &	filename,
		bool	isWritable = false
	)

Open the image-file 'filename' which must be a binary grey-scale or binary true-color PPM image. For the 'isWritable'-flag see FileMapper.

VRS::FileImage::FileImage	(	const std::string &	filename,
		int	width,
		int	height,
		Image::LayerSequence	layerSequence = Image::RGB,
		bool	persistent = true
	)

VRS::FileImage::FileImage	(	const std::string &	filename,
		Image *	source,
		bool	persistent = true
	)

VRS::FileImage::FileImage	(	const std::string &	filename,
		Image *	source,
		int	newWidth,
		int	newHeight,
		bool	persistent = true
	)

Create an image-file 'filename' for the given image-parameters (PPM binary grey-scale or PPM binary true-color). It is opened in read-write-mode. For the 'persistent'-flag see FileMapper.

VRS::FileImage::FileImage

(

DataResource *

resource

)

Uses the memory-mapped file as an image.

VRS::FileImage::FileImage

(

)

[protected]

---

Member Function Documentation

virtual int VRS::FileImage::width

(

)

const [virtual]

Implements VRS::Image.

virtual int VRS::FileImage::height

(

)

const [virtual]

See Image.

Implements VRS::Image.

virtual void* VRS::FileImage::lineComponents

(

int

y

)

const [virtual]

Reimplemented from VRS::Image.

virtual void* VRS::FileImage::pixelComponents	(	int	x,
		int	y,
		int	component = 0
	)			const [virtual]

See Image.

Implements VRS::Image.

VRS::FileImage::VRS_TYPEINFO	(	FileImage	,
		Image
	)

VRS::FileImage::VRS_SERIALIZABLE

(

FileImage

)

---

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

• fileimage.h