IImageFrameWriter Class Reference

IImageFrameWriter writes an image from an imageframe. More...

#include <iimagecodec.h>

Inheritance diagram for IImageFrameWriter:

Public Member Functions
	IImageFrameWriter ()
	Constructor.
virtual	~IImageFrameWriter ()
	Destructor.
virtual void	writeScanLine (const void *pScanLine)=0
	Writes an image row into the image frame.
virtual void	setWidth (uint32 width)=0
	Set the width of the frame in pixels.
virtual void	setHeight (uint32 height)=0
	Set the height of the frame in pixels.
virtual void	setBPS (uint8 bps)=0
	Set the bits per sample/components of the frame.
virtual void	setImageExtraChannelType (eImageExtraChannelType extraChannelType)=0
	Set the type of the extra image channel, if present.
virtual void	setXResolution (double xRes)=0
	Set the resolution of the frame in the X direction.
virtual void	setYResolution (double yRes)=0
	Set the resolution of the frame in the Y direction.
virtual void	setColorSpace (const IDOMColorSpacePtr &colorSpace)=0
	Set the color space of the frame's pixels.
virtual void	readScanLine (void *pRow, size_t bufferSize)
	It is not possible to read a scanline from an image frame writer.
virtual void	flushData ()=0
	Finish the image and flush. Must be called after the last scanline has been written.
virtual bool	getEfficientlySkippable () const
	Skipping is not possible when writing images.
Public Member Functions inherited from IImageFrame
virtual uint32	getWidth () const =0
	Gets the width of the image.
virtual uint32	getHeight () const =0
	Gets the height of the image.
virtual uint8	getBPS () const =0
	Gets the bits per sample of the image.
virtual IDOMColorSpacePtr	getColorSpace () const =0
	Gets the color space.
virtual eImageExtraChannelType	getExtraChannelType () const =0
	Gets the type of information contained in the extra channel.
virtual uint8	getNumExtraChannels () const
	Gets the number of image extra channels (for example an alpha or mask)
virtual uint8	getNumChannels () const
	Gets the total number of image channels (including extra channels)
virtual bool	getHasAlphaChannel () const
	Indicates if the image has an alpha mask.
virtual bool	getHasMask (bool &isNoisy) const
	Indicates if the image has a mask (i.e. a binary alpha channel)
virtual double	getXResolution () const =0
	Gets the resolution of the image in the X direction.
virtual double	getYResolution () const =0
	Gets the resolution of the image in the Y direction.
virtual uint32	getRawBytesPerRow () const =0
	Gets the image row size in bytes, which may include padding space.
virtual void	skipScanLines (uint32 skipCount)
	Skips the given number of scanline rows, which may be fast for some image types.
Public Member Functions inherited from IEDLObject
virtual const CClassID &	getClassID () const =0
	Returns class ID of IEDLObject.
virtual bool	init (CClassParams *pData)
	The init() method is called to perform any post-construction initialization of an IEDLObject that has been created by the EDL class factory, before it is actually returned by the factory.
virtual bool	clone (IEDLObjectPtr &ptrObject, IEDLClassFactory *pFactory)
	Create a copy of EDLObject.
Public Member Functions inherited from IRCObject
virtual void	addRef () const =0
	Increases the reference count of the actual object pointed to. This would take place during an assignment or copying.
virtual bool	decRef () const =0
	Decreases the reference count of the actual object pointed to. When the reference count falls to Zero, it deletes the actual object pointed to.
virtual int32	getRefCount () const =0
	Retrieve the current reference count of the actual object pointed to.

Additional Inherited Members
Protected Member Functions inherited from IRCObject
virtual	~IRCObject ()
	Virtual destructor.

Detailed Description

IImageFrameWriter writes an image from an imageframe.

Member Function Documentation

setBPS()

virtual void IImageFrameWriter::setBPS ( uint8 bps )

pure virtual

Set the bits per sample/components of the frame.

Parameters

bps	The desired bit depth per sample/component

setColorSpace()

virtual void IImageFrameWriter::setColorSpace ( const IDOMColorSpacePtr & colorSpace )

pure virtual

Set the color space of the frame's pixels.

Parameters

colorSpace

The desired colorspace

setHeight()

virtual void IImageFrameWriter::setHeight ( uint32 height )

pure virtual

Set the height of the frame in pixels.

Parameters

height

The height

setImageExtraChannelType()

virtual void IImageFrameWriter::setImageExtraChannelType ( eImageExtraChannelType extraChannelType )

pure virtual

Set the type of the extra image channel, if present.

Parameters

extraChannelType

The extra channel type

setWidth()

virtual void IImageFrameWriter::setWidth ( uint32 width )

pure virtual

Set the width of the frame in pixels.

Parameters

width

The width

setXResolution()

virtual void IImageFrameWriter::setXResolution ( double xRes )

pure virtual

Set the resolution of the frame in the X direction.

Parameters

xRes	The desired resolution in the X direction

setYResolution()

virtual void IImageFrameWriter::setYResolution ( double yRes )

pure virtual

Set the resolution of the frame in the Y direction.

Parameters

yRes	The desired resolution in the Y direction

writeScanLine()

virtual void IImageFrameWriter::writeScanLine ( const void * pScanLine )

pure virtual

Writes an image row into the image frame.

Parameters

pScanLine

A buffer that contains the scanline.

---

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

• iimagecodec.h