coolray.org FAQ Contact Us
CoolRay Banner
CoolRay / Documentation
Main Page   Class Hierarchy   Compound List   Compound Members   Related Pages  

ImageWriter Class Reference

This is the abstract basis class for an image writer. More...

#include <ImageWriter.h>

Inheritance diagram for ImageWriter

Inheritance graph
[legend]
List of all members.

Public Methods

virtual ~ImageWriter ()
virtual void initWriter (Area area,int nChannels)=0
 This method has to be called before any pixel is given to the implementation with writePixels. More...

virtual void writePixels (Area area,unsigned short *pData,bool bAreaFinal)=0
 The engine delivers a bulk of pixels to the front end with this method. More...

virtual void finishWriter (int nStatus)=0
 This is called after the rendering is done and before the image writer is deleted. More...


Detailed Description

This is the abstract basis class for an image writer.

Image Writers are implemented by the front end, i.e. the application which uses the engine. If a pixel is rendered this interface is called to deliver pixels to the output.


Member Function Documentation

void ImageWriter::finishWriter ( int dwStatus ) [pure virtual]
 

This is called after the rendering is done and before the image writer is deleted.

Implementations can use this to store the image to disk and to deallocate memory.

Parameters:
dwStatus  

Reimplemented in ImageWriterConsole, ImageWriterImageLib, and ImageWriterPPM.

void ImageWriter::initWriter ( Area area,
int nChannels ) [pure virtual]
 

This method has to be called before any pixel is given to the implementation with writePixels.

It defines the maximum range of pixels the engine intends to write. Implementation can allocate space for caching data.

Parameters:
area  
nChannels  

void ImageWriter::writePixels ( Area area,
unsigned short * pData,
bool bAreaFinal ) [pure virtual]
 

The engine delivers a bulk of pixels to the front end with this method.

The area defines how many pixels are delivered an where they are located within the picture.

Parameters:
area  
pData  
bAreaFinal  


The documentation for this class was generated from the following file:
  • ImageWriter.h
You are visitor No.

counter

Copyright (c) 2001 Stefan Michel, All Rights Reserved.
Last modified: