A PdfImage object is needed when ever you want to embed an image file into a PDF document. More...

#include <PdfImage.h>

Inheritance diagram for PoDoFo::PdfImage:

Public Member Functions
void	DecodeTo (charbuff &buff, PdfPixelFormat format, int scanLineSize=-1) const

void	DecodeTo (const bufferspan &buff, PdfPixelFormat format, int scanLineSize=-1) const

void	DecodeTo (OutputStream &stream, PdfPixelFormat format, int scanLineSize=-1) const

charbuff	GetDecodedCopy (PdfPixelFormat format)

void	SetSoftMask (const PdfImage &softmask)
	Set a softmask for this image.

void	SetData (const bufferview &buffer, unsigned width, unsigned height, PdfPixelFormat format, int rowSize=-1)
	Set the actual image data from a buffer.

void	SetData (InputStream &stream, unsigned width, unsigned height, PdfPixelFormat format, int rowSize=-1)
	Set the actual image data from an input stream.

void	SetDataRaw (const bufferview &buffer, const PdfImageInfo &info)
	Set the actual image encoded data from a buffer.

void	SetDataRaw (InputStream &stream, const PdfImageInfo &info)
	Set the actual image encoded data from an input stream.

PdfImageMetadata	Load (const std::string_view &filepath, const PdfImageLoadParams &params={ })
	Load the image data from bytes.

PdfImageMetadata	LoadFromBuffer (const bufferview &buffer, const PdfImageLoadParams &params={ })
	Load the image data from bytes.

void	ExportTo (charbuff &buff, PdfExportFormat format, PdfArray args={}) const

void	SetChromaKeyMask (int64_t r, int64_t g, int64_t b, int64_t threshold=0)
	Set an color/chroma-key mask on an image.

void	SetInterpolate (bool value)
	Apply an interpolation to the image if the source resolution is lower than the resolution of the output device.

Rect	GetRect () const override

const PdfColorSpaceFilter &	GetColorSpace () const
	Get the color space of the image.

unsigned	GetWidth () const
	Get the width of the image when drawn in PDF units.

unsigned	GetHeight () const
	Get the height of the image when drawn in PDF units.

Public Member Functions inherited from PoDoFo::PdfXObject
virtual const Matrix &	GetMatrix () const

PdfXObjectType	GetType () const

Protected Member Functions
const PdfXObjectForm *	GetForm () const override

Friends
class	PdfXObject

class	PdfDocument

Additional Inherited Members
Static Public Member Functions inherited from PoDoFo::PdfXObject
static bool	TryCreateFromObject (PdfObject &obj, std::unique_ptr< PdfXObject > &xobj)

static bool	TryCreateFromObject (const PdfObject &obj, std::unique_ptr< const PdfXObject > &xobj)

template<typename XObjectT >
static bool	TryCreateFromObject (PdfObject &obj, std::unique_ptr< XObjectT > &xobj)

template<typename XObjectT >
static bool	TryCreateFromObject (const PdfObject &obj, std::unique_ptr< const XObjectT > &xobj)

Detailed Description

A PdfImage object is needed when ever you want to embed an image file into a PDF document.

The PdfImage object is embedded once and can be drawn as often as you want on any page in the document using PdfPainter

See also: GetImageReference; PdfPainter::DrawImage

Member Function Documentation

◆ GetColorSpace()

const PdfColorSpaceFilter & PoDoFo::PdfImage::GetColorSpace ( ) const

inline

Get the color space of the image.

Returns: the color space of the image

◆ GetForm()

const PdfXObjectForm * PdfImage::GetForm ( ) const

overrideprotectedvirtual

Reimplemented from PoDoFo::PdfXObject.

◆ GetHeight()

unsigned PoDoFo::PdfImage::GetHeight ( ) const

inline

Get the height of the image when drawn in PDF units.

Returns: the height in PDF units

◆ GetRect()

Rect PdfImage::GetRect ( ) const

overridevirtual

Implements PoDoFo::PdfXObject.

◆ GetWidth()

unsigned PoDoFo::PdfImage::GetWidth ( ) const

inline

Get the width of the image when drawn in PDF units.

Returns: the width in PDF units

◆ Load()

PdfImageMetadata PdfImage::Load	(	const std::string_view &	filepath,
		const PdfImageLoadParams &	params = `{ }`
	)

Load the image data from bytes.

Parameters

params parameters like index to be fed to multi image/page formats (eg. TIFF)

Returns: image non PDF specific image metadata

◆ LoadFromBuffer()

PdfImageMetadata PdfImage::LoadFromBuffer	(	const bufferview &	buffer,
		const PdfImageLoadParams &	params = `{ }`
	)

Load the image data from bytes.

Parameters

params parameters like index to be fed to multi image/page formats (eg. TIFF)

Returns: image non PDF specific image metadata

◆ SetChromaKeyMask()

void PdfImage::SetChromaKeyMask	(	int64_t	r,
		int64_t	g,
		int64_t	b,
		int64_t	threshold = `0`
	)

Set an color/chroma-key mask on an image.

The masked color will not be painted, i.e. masked as being transparent.

Parameters

r	red RGB value of color that should be masked
g	green RGB value of color that should be masked
b	blue RGB value of color that should be masked
threshold	colors are masked that are in the range [(r-threshold, r+threshold),(g-threshold, g+threshold),(b-threshold, b+threshold)]

◆ SetData() [1/2]

void PdfImage::SetData	(	const bufferview &	buffer,
		unsigned	width,
		unsigned	height,
		PdfPixelFormat	format,
		int	rowSize = `-1`
	)

Set the actual image data from a buffer.

Parameters

buffer	buffer supplying image data
width	width of the image in pixels
height	height of the image in pixels
format	pixel format of the bitmap
rowSize	length of the row, if negative the default is used

◆ SetData() [2/2]

void PdfImage::SetData	(	InputStream &	stream,
		unsigned	width,
		unsigned	height,
		PdfPixelFormat	format,
		int	rowSize = `-1`
	)

Set the actual image data from an input stream.

Parameters

stream	stream supplying raw image data
width	width of the image in pixels
height	height of the image in pixels
format	pixel format of the bitmap
rowSize	length of the row, if negative the default is used

◆ SetDataRaw() [1/2]

void PdfImage::SetDataRaw	(	const bufferview &	buffer,
		const PdfImageInfo &	info
	)

Set the actual image encoded data from a buffer.

Parameters

buffer	buffer supplying image data
info	parameters describing the encoded image data

◆ SetDataRaw() [2/2]

void PdfImage::SetDataRaw	(	InputStream &	stream,
		const PdfImageInfo &	info
	)

Set the actual image encoded data from an input stream.

Parameters

stream	stream supplying encoded image data
info	parameters describing the encoded image data

◆ SetInterpolate()

void PdfImage::SetInterpolate ( bool value )

Apply an interpolation to the image if the source resolution is lower than the resolution of the output device.

Default is false.

Parameters

value whether the image should be interpolated

◆ SetSoftMask()

void PdfImage::SetSoftMask ( const PdfImage & softmask )

Set a softmask for this image.

Parameters

pSoftmask a PdfImage pointer to the image, which is to be set as softmask, must be 8-Bit-Grayscale

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

src/podofo/main/PdfImage.h
src/podofo/main/PdfImage.cpp

Public Member Functions

Protected Member Functions

Friends

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ GetColorSpace()

◆ GetForm()

◆ GetHeight()

◆ GetRect()

◆ GetWidth()

◆ Load()

◆ LoadFromBuffer()

◆ SetChromaKeyMask()

◆ SetData() [1/2]

◆ SetData() [2/2]

◆ SetDataRaw() [1/2]

◆ SetDataRaw() [2/2]

◆ SetInterpolate()

◆ SetSoftMask()