OFX::Image Class Reference

#include <ofxsImageEffect.h>

List of all members.

---

Detailed Description

Wraps up an image.

Public Member Functions
	Image (OfxPropertySetHandle props)
	ctor
virtual	~Image ()
	dtor
const PropertySet &	getPropertySet () const
PropertySet &	getPropertySet ()
BitDepthEnum	getPixelDepth (void) const
	get the pixel depth
PixelComponentEnum	getPixelComponents (void) const
	get the components in the image
std::string	getPixelComponentsProperty (void) const
	get the string representing the pixel components
PreMultiplicationEnum	getPreMultiplication (void) const
	premultiplication on the image
OfxPointD	getRenderScale (void) const
	get the scale factor that has been applied to this image
double	getPixelAspectRatio (void) const
	get the scale factor that has been applied to this image
void *	getPixelData (void) const
	get the pixel data for this image
OfxRectI	getRegionOfDefinition (void) const
	get the region of definition (in pixel coordinates) of this image
OfxRectI	getBounds (void) const
	get the bounds on the image data (in pixel coordinates) of this image
int	getRowBytes (void) const
	get the row bytes, may be negative
FieldEnum	getField (void) const
	get the fielding of this image
std::string	getUniqueIdentifier (void) const
	the unique ID of this image
void *	getPixelAddress (int x, int y)
	return a pixel pointer
Protected Attributes
PropertySet	_imageProps
	the handle that holds this image
void *	_pixelData
	the base address of the image
PixelComponentEnum	_pixelComponents
	get the components in the image
int	_rowBytes
	the number of bytes per scanline
int	_pixelBytes
	the number of bytes per pixel
BitDepthEnum	_pixelDepth
	get the pixel depth
PreMultiplicationEnum	_preMultiplication
	premultiplication on the image
OfxRectI	_regionOfDefinition
	the RoD in pixel coordinates, this may be more or less than the bounds!
OfxRectI	_bounds
	the bounds on the pixel data
double	_pixelAspectRatio
	the pixel aspect ratio
FieldEnum	_field
	which field this represents
std::string	_uniqueID
	the unique ID of this image
OfxPointD	_renderScale
	any scaling factor applied to the image
Friends
class	Clip
	friend so we get access to ctor

---

Constructor & Destructor Documentation

OFX::Image::Image (  OfxPropertySetHandle  props  )

ctor

OFX::Image::~Image (   )  [virtual]

dtor

---

Member Function Documentation

OfxRectI OFX::Image::getBounds (  void   )  const [inline]

get the bounds on the image data (in pixel coordinates) of this image

FieldEnum OFX::Image::getField (  void   )  const [inline]

get the fielding of this image

void * OFX::Image::getPixelAddress (  int  x, int  y )

return a pixel pointer x and y are in pixel coordinates If the components are custom, then this will return NULL as the support code can't know the pixel size to do the work.

double OFX::Image::getPixelAspectRatio (  void   )  const [inline]

get the scale factor that has been applied to this image

PixelComponentEnum OFX::Image::getPixelComponents (  void   )  const [inline]

get the components in the image

std::string OFX::Image::getPixelComponentsProperty (  void   )  const [inline]

get the string representing the pixel components

void* OFX::Image::getPixelData (  void   )  const [inline]

get the pixel data for this image

BitDepthEnum OFX::Image::getPixelDepth (  void   )  const [inline]

get the pixel depth

PreMultiplicationEnum OFX::Image::getPreMultiplication (  void   )  const [inline]

premultiplication on the image

PropertySet& OFX::Image::getPropertySet (   )  [inline]

const PropertySet& OFX::Image::getPropertySet (   )  const [inline]

OfxRectI OFX::Image::getRegionOfDefinition (  void   )  const [inline]

get the region of definition (in pixel coordinates) of this image

OfxPointD OFX::Image::getRenderScale (  void   )  const [inline]

get the scale factor that has been applied to this image

int OFX::Image::getRowBytes (  void   )  const [inline]

get the row bytes, may be negative

std::string OFX::Image::getUniqueIdentifier (  void   )  const [inline]

the unique ID of this image

---

Friends And Related Function Documentation

friend class Clip [friend]

friend so we get access to ctor

---

Member Data Documentation

OfxRectI OFX::Image::_bounds [protected]

the bounds on the pixel data

FieldEnum OFX::Image::_field [protected]

which field this represents

PropertySet OFX::Image::_imageProps [protected]

the handle that holds this image

double OFX::Image::_pixelAspectRatio [protected]

the pixel aspect ratio

int OFX::Image::_pixelBytes [protected]

the number of bytes per pixel

PixelComponentEnum OFX::Image::_pixelComponents [protected]

get the components in the image

void* OFX::Image::_pixelData [protected]

the base address of the image

BitDepthEnum OFX::Image::_pixelDepth [protected]

get the pixel depth

PreMultiplicationEnum OFX::Image::_preMultiplication [protected]

premultiplication on the image

OfxRectI OFX::Image::_regionOfDefinition [protected]

the RoD in pixel coordinates, this may be more or less than the bounds!

OfxPointD OFX::Image::_renderScale [protected]

any scaling factor applied to the image

int OFX::Image::_rowBytes [protected]

the number of bytes per scanline

std::string OFX::Image::_uniqueID [protected]

the unique ID of this image

---

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

• ofxsImageEffect.h
• ofxsImageEffect.cpp

---