Interface to a class representing a PNG (.png) image. More...

#include <idomimageresource.h>

Inheritance diagram for IDOMPNGImage:

[legend]

Static Public Member Functions
static EDL_API IDOMPNGImagePtr	create (IEDLClassFactory *pFactory, const IInputStreamPtr &stream)
	Create a PNG Image resource with the given PNG stream. More...

static EDL_API IDOMImagePtr	createWriterAndImage (const ISessionPtr &session, IImageFrameWriterPtr &frame, const IDOMColorSpacePtr &colorSpace, uint32 width, uint32 height, uint8 bitsPerComponent=8, double xResolution=96.0, double yResolution=96.0, eImageExtraChannelType extraChannel=eIECNone, const IInputStreamPtr &inStream=IInputStreamPtr(), const IOutputStreamPtr &outStream=IOutputStreamPtr())
	Create an IDOMPNGImage and frame that can be used to populate same. More...

static EDL_API void	encode (const ISessionPtr &pSession, const IDOMImagePtr &image, const IOutputStreamPtr &stream)
	Encode an image as a PNG stream, returning the stream. This routine may convert the image samples into a form that may be encoded as PNG if required, such as by converting to a supported color space. More...

static EDL_API void	encode (const ISessionPtr &pSession, const IImageFramePtr &frame, const IOutputStreamPtr &stream)
	Encode the contents of an IImageFrame as a PNG stream, returning the stream. This routine may convert the image samples into a form that may be encoded as PNG if required, such as by converting to a supported color space. More...

static EDL_API void	encode (const ISessionPtr &pSession, const IDOMColorSpacePtr &colorSpace, float dpi, uint8 bpc, void *frameBuffer, uint32 width, uint32 height, int32 stride, bool hasAlpha, const IOutputStreamPtr &stream)
	Encode a frame buffer as a PNG stream, returning the stream. The source image must be compatible with PNG. More...

static const CClassID &	classID ()
	Retrieves class id of IDOM. More...

Additional Inherited Members
Public Member Functions inherited from IDOMImage
virtual IImageDecoderPtr	createImageDecoder (IEDLClassFactory *factory, const IDOMImagePropertiesPtr &imageProperties)=0
	Creates a properly initialized image decoder object that reads from an inputstream that is specific to that image format. More...

virtual IImageFramePtr	getImageFrame (IEDLClassFactory *factory)
	Fetch the image frame; convenience. More...

virtual IImageEncoderPtr	createImageEncoder (const ISessionPtr &session, const IOutputStreamPtr &imageDest, const IDOMImagePropertiesPtr &imageProperties)=0
	Creates a properly initialized image encoder object that writes to an outputstream that is specific to that image format. More...

virtual IDOMImagePropertiesPtr	getImageProperties ()=0
	Returns an object that stores the properties for this image object. The properties can then be inspected (or more added) by clients that need to manipulate the image resource. More...

virtual eDOMImageType	getImageType ()=0
	Retrieves the image type. More...

virtual bool	getIsRendered ()=0
	Determine if the image is as a result of rendering. This is indicated if the image type is eDITRendered or if the image explicitly notes this is the case (such as for IDOMPDFImage). More...

virtual IDOMImagePtr	getImageWithSubstitutedColorSpace (IEDLClassFactory *factory, const IDOMColorSpacePtr &colorSpace)
	Obtain an image that is the same as this image, but with the colorspace substituted for another. More...

Public Member Functions inherited from IDOMResource
virtual IInputStreamPtr	getStream () const =0
	Retrieves the resource stream. More...

virtual void	setStream (const IInputStreamPtr &stream)=0
	Sets the resource stream for the node. More...

virtual uint64	getStreamLength () const =0
	Retrieves the stream length, if it is available. More...

virtual const EDLSysString &	getUri () const =0
	Retrieves the resource URI. More...

virtual void	setUri (const EDLSysString &uri)=0
	Sets the resource URI. More...

Public Member Functions inherited from IEDLObject
virtual const CClassID &	getClassID () const =0
	Returns class ID of IEDLObject. More...

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. More...

virtual bool	clone (IEDLObjectPtr &ptrObject, IEDLClassFactory *pFactory)
	Create a copy of EDLObject. More...

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. More...

virtual int32	getRefCount () const =0
	Retrieve the current reference count of the actual object pointed to. More...

Public Member Functions inherited from IDOMHashable
virtual	~IDOMHashable ()
	Virtual destructor.

virtual bool	hash (uint64 &hash)=0
	Retrieve a hash for this object. More...

virtual uint64	hashE ()
	As hash(), but throws an exception if the operation fails. More...

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

Detailed Description

Interface to a class representing a PNG (.png) image.

Member Function Documentation

◆ classID()

static const CClassID& IDOMPNGImage::classID ( )

inlinestatic

Retrieves class id of IDOM.

Returns: CClassID Class id of the element

◆ create()

static EDL_API IDOMPNGImagePtr IDOMPNGImage::create	(	IEDLClassFactory *	pFactory,
		const IInputStreamPtr &	stream
	)

static

Create a PNG Image resource with the given PNG stream.

Parameters

pFactory	The EDL Class factory to use.
stream	The stream containing the PNG image.

Returns: IDOMImagePtr The new image.

◆ createWriterAndImage()

static EDL_API IDOMImagePtr IDOMPNGImage::createWriterAndImage	(	const ISessionPtr &	session,
		IImageFrameWriterPtr &	frame,
		const IDOMColorSpacePtr &	colorSpace,
		uint32	width,
		uint32	height,
		uint8	bitsPerComponent = `8`,
		double	xResolution = `96.0`,
		double	yResolution = `96.0`,
		eImageExtraChannelType	extraChannel = `eIECNone`,
		const IInputStreamPtr &	inStream = `IInputStreamPtr()`,
		const IOutputStreamPtr &	outStream = `IOutputStreamPtr()`
	)

static

Create an IDOMPNGImage and frame that can be used to populate same.

Parameters

session	The session to use
frame	On exit, this is populated with a frame ready to receive image data via frame->writeScanLine(). Use frame->flushData() to complete the encoding process.
colorSpace	The color space to use. Must be compatible with the PNG format.
width	The width of the image, in pixels.
height	The height of the image, in pixels.
bitsPerComponent	The bits per component to use. Must be compatible with the PNG format.
xResolution	The x resolution, in pixels-per-inch.
yResolution	The y resolution, in pixels-per-inch.
extraChannel	The type of extra channel, if provided. Must be either eIECAlpha or eIECNone for PNG.
inStream	Optional. The first in a pair of streams used to read and write the raw image data if an external stream is desired. If NULL, a temporary store stream will be created. If non NULL, outStream must also be provided.
outStream	Optional. The second in a pair of streams used to read and write the raw image data if an external stream is desired. If NULL, a temporary store stream will be created. If non NULL, inStream must also be provided.

Returns: IDOMImagePtr The resulting image. Not valid until the frame is flushed.

◆ encode() [1/3]

static EDL_API void IDOMPNGImage::encode	(	const ISessionPtr &	pSession,
		const IDOMColorSpacePtr &	colorSpace,
		float	dpi,
		uint8	bpc,
		void *	frameBuffer,
		uint32	width,
		uint32	height,
		int32	stride,
		bool	hasAlpha,
		const IOutputStreamPtr &	stream
	)

static

Encode a frame buffer as a PNG stream, returning the stream. The source image must be compatible with PNG.

Parameters

pSession	The relevant EDL session
colorSpace	The color space of the frame buffer
dpi	The image resolution in dots-per-inch
bpc	Bits per component (pixel)
frameBuffer	The frame buffer to be encoded
width	The width of the frame buffer
height	The height of the frame buffer
stride	The offset in bytes in the frameBuffer from one scanline to the next. May be negative.
hasAlpha	Set true if the frame buffer has an alpha channel.
stream	The stream to use to store the image data.

◆ encode() [2/3]

static EDL_API void IDOMPNGImage::encode	(	const ISessionPtr &	pSession,
		const IDOMImagePtr &	image,
		const IOutputStreamPtr &	stream
	)

static

Encode an image as a PNG stream, returning the stream. This routine may convert the image samples into a form that may be encoded as PNG if required, such as by converting to a supported color space.

Parameters

pSession	The relevant EDL session
image	The image to be encoded
stream	The stream to use to store the image data.

◆ encode() [3/3]

static EDL_API void IDOMPNGImage::encode	(	const ISessionPtr &	pSession,
		const IImageFramePtr &	frame,
		const IOutputStreamPtr &	stream
	)

static

Encode the contents of an IImageFrame as a PNG stream, returning the stream. This routine may convert the image samples into a form that may be encoded as PNG if required, such as by converting to a supported color space.

Parameters

pSession	The relevant EDL session
frame	The frame providing the source image data
stream	The stream to use to store the image data.

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

idomimageresource.h

Static Public Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ classID()

◆ create()

◆ createWriterAndImage()

◆ encode() [1/3]

◆ encode() [2/3]

◆ encode() [3/3]