IImageFrame Class Reference

IImageFrame encapsulates an EDL image with its details. More...

#include <iimagecodec.h>

Inheritance diagram for IImageFrame:

Public Member Functions
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	readScanLine (void *pRow, size_t bufferSize)=0
	Gets an image row scanline (of size given by getRawBytesPerRow())
virtual void	skipScanLines (uint32 skipCount)
	Skips the given number of scanline rows, which may be fast for some image types.
virtual bool	getEfficientlySkippable () const =0
	Determine if the image may be efficiently skipped via skipScanLines (rather than having to decode every scanline in the skipped range).
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

IImageFrame encapsulates an EDL image with its details.

Member Function Documentation

getBPS()

virtual uint8 IImageFrame::getBPS ( ) const

pure virtual

Gets the bits per sample of the image.

Returns

uint8 Returns the image bits from sample.

getColorSpace()

virtual IDOMColorSpacePtr IImageFrame::getColorSpace ( ) const

pure virtual

Gets the color space.

Returns

IDOMColorSpacePtr The colorspace of the image.

getEfficientlySkippable()

virtual bool IImageFrame::getEfficientlySkippable ( ) const

pure virtual

Determine if the image may be efficiently skipped via skipScanLines (rather than having to decode every scanline in the skipped range).

Returns

bool true if the the image has an efficient skipScanLines implementation.

Implemented in IImageFrameWriter.

getExtraChannelType()

virtual eImageExtraChannelType IImageFrame::getExtraChannelType ( ) const

pure virtual

Gets the type of information contained in the extra channel.

Returns

eImageExtraChannelType Returns the type of information in the extra channel.

getHasAlphaChannel()

virtual bool IImageFrame::getHasAlphaChannel ( ) const

inlinevirtual

Indicates if the image has an alpha mask.

Returns

bool. Returns an indication of alpha mask present in the image.

getHasMask()

virtual bool IImageFrame::getHasMask ( bool & isNoisy ) const

inlinevirtual

Indicates if the image has a mask (i.e. a binary alpha channel)

Parameters

isNoisy

An indicator that the alpha channel has binary values and so is acting as a mask.

Returns

bool. Returns an indication of mask present in the image

getHeight()

virtual uint32 IImageFrame::getHeight ( ) const

pure virtual

Gets the height of the image.

Returns

uint32 Returns the image height.

getNumChannels()

virtual uint8 IImageFrame::getNumChannels ( ) const

inlinevirtual

Gets the total number of image channels (including extra channels)

Returns

uint8 Returns the total number of image channels.

getNumExtraChannels()

virtual uint8 IImageFrame::getNumExtraChannels ( ) const

inlinevirtual

Gets the number of image extra channels (for example an alpha or mask)

Returns

uint8 Returns the number of image extra channels.

getRawBytesPerRow()

virtual uint32 IImageFrame::getRawBytesPerRow ( ) const

pure virtual

Gets the image row size in bytes, which may include padding space.

Returns

uint32 The image row size in bytes

getWidth()

virtual uint32 IImageFrame::getWidth ( ) const

pure virtual

Gets the width of the image.

Returns

uint32 Returns the image width.

getXResolution()

virtual double IImageFrame::getXResolution ( ) const

pure virtual

Gets the resolution of the image in the X direction.

Returns

double The resolution in the X direction.

getYResolution()

virtual double IImageFrame::getYResolution ( ) const

pure virtual

Gets the resolution of the image in the Y direction.

Returns

double The resolution in the Y direction.

readScanLine()

virtual void IImageFrame::readScanLine ( void * pRow, size_t bufferSize )

pure virtual

Gets an image row scanline (of size given by getRawBytesPerRow())

Parameters

pRow	The buffer in which the row scanline will be copied into.
bufferSize	The size of the buffer. A check will be made that the buffer is large enough to receive the scanline before it is read.

Implemented in IImageFrameWriter.

skipScanLines()

virtual void IImageFrame::skipScanLines ( uint32 skipCount )

inlinevirtual

Skips the given number of scanline rows, which may be fast for some image types.

Parameters

skipCount

The number of scanlines to skip..

---

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

• iimagecodec.h