IDOMCustomImage::ICustomImageData Class Reference

Abstract class that references image data and provides image information. Must be implemented by users. All member functions must be reentrant; they may be called at unpredictable times across multiple threads. More...

#include <edl/idomimageresource.h>

Public Member Functions
virtual	~ICustomImageData ()=default
virtual IDOMColorSpacePtr	getColorSpace ()=0
	Returns the image color space.
virtual uint32	getWidth ()=0
	Returns the image width.
virtual uint32	getHeight ()=0
	Returns the image height.
virtual uint8	getDepth ()=0
	Returns the image depth per channel. 1, 2, 4, 8, 12 and 16 bit are supported.
virtual double	getXResolution ()=0
	Returns the resolution (dpi) of the image data in the x direction.
virtual double	getYResolution ()=0
	Returns the resolution (dpi) of the image data in the y direction.
virtual eImageExtraChannelType	getExtraChannelType ()=0
	Returns the type of any additional alpha/mask channel.
virtual uint32	getRawBytesPerRow ()=0
	Gets the image row size in bytes, which may include padding space.
virtual bool	getEfficientlySkippable ()=0
	Determine if the frame may be efficiently skipped via ICustomImageFrame::skipScanLines (rather than having to decode every scanline in the skipped range).
virtual uint64	getKey ()=0
	Return a 64-bit key that can be used to uniquely identify this image. DOMids (via allocateNewDOMid()) can be used for this purposes, as can a suitable hash.
virtual bool	shouldCache ()=0
	Return if this image should be cached. Mako, ordinarily, attempts to cache images for performance reasons, particularly in the ITransform mechanism. However, if the image is resident in memory or is particularly large, and is also unlikely to be reused, then this provides a mechanism to prevent caching this image or image brushes using this image.
virtual ICustomImageFramePtr	getFrame ()=0
	Obtain an ICustomImageFrame that can be used to retrieve pixel data.

Detailed Description

Abstract class that references image data and provides image information. Must be implemented by users. All member functions must be reentrant; they may be called at unpredictable times across multiple threads.

Constructor & Destructor Documentation

~ICustomImageData()

virtual IDOMCustomImage::ICustomImageData::~ICustomImageData ( )

virtualdefault

Member Function Documentation

getColorSpace()

virtual IDOMColorSpacePtr IDOMCustomImage::ICustomImageData::getColorSpace ( )

pure virtual

Returns the image color space.

Returns

IDOMColorSpacePtr The image color space.

getDepth()

virtual uint8 IDOMCustomImage::ICustomImageData::getDepth ( )

pure virtual

Returns the image depth per channel. 1, 2, 4, 8, 12 and 16 bit are supported.

Returns

uint8 The image depth.

getEfficientlySkippable()

virtual bool IDOMCustomImage::ICustomImageData::getEfficientlySkippable ( )

pure virtual

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

Returns

bool true if the image can be skipped and reopened quickly.

getExtraChannelType()

virtual eImageExtraChannelType IDOMCustomImage::ICustomImageData::getExtraChannelType ( )

pure virtual

Returns the type of any additional alpha/mask channel.

Returns

eImageExtraChannelType The extra channel type, eIECNone if there is no extra channel.

getFrame()

virtual ICustomImageFramePtr IDOMCustomImage::ICustomImageData::getFrame ( )

pure virtual

Obtain an ICustomImageFrame that can be used to retrieve pixel data.

Returns

ICustomImageFramePtr The custom image frame.

getHeight()

virtual uint32 IDOMCustomImage::ICustomImageData::getHeight ( )

pure virtual

Returns the image height.

Returns

uint32 The image height.

getKey()

virtual uint64 IDOMCustomImage::ICustomImageData::getKey ( )

pure virtual

Return a 64-bit key that can be used to uniquely identify this image. DOMids (via allocateNewDOMid()) can be used for this purposes, as can a suitable hash.

Returns

uint64 The unique (for custom images) key.

getRawBytesPerRow()

virtual uint32 IDOMCustomImage::ICustomImageData::getRawBytesPerRow ( )

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 IDOMCustomImage::ICustomImageData::getWidth ( )

pure virtual

Returns the image width.

Returns

uint32 The image width.

getXResolution()

virtual double IDOMCustomImage::ICustomImageData::getXResolution ( )

pure virtual

Returns the resolution (dpi) of the image data in the x direction.

Returns

double The image x resolution.

getYResolution()

virtual double IDOMCustomImage::ICustomImageData::getYResolution ( )

pure virtual

Returns the resolution (dpi) of the image data in the y direction.

Returns

double The image y resolution.

shouldCache()

virtual bool IDOMCustomImage::ICustomImageData::shouldCache ( )

pure virtual

Return if this image should be cached. Mako, ordinarily, attempts to cache images for performance reasons, particularly in the ITransform mechanism. However, if the image is resident in memory or is particularly large, and is also unlikely to be reused, then this provides a mechanism to prevent caching this image or image brushes using this image.

Returns

bool true if the image should be cached, false otherwise.

---

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

• edl/idomimageresource.h