PFCPDFImage Class Reference

Represents an image extracted from a PDF file, thru use of a PFCPDFImageIterator. More...

#include <PFCPDFImage.h>

Public Member Functions
PoDoFo::PdfObject *	pdfObject ()
	For advanced usage the object from which the image was extracted. More...
void *	compressedBuffer ()
	Raw compressed bytes. These bytes are owned by PFCPDImageFile. More...
void	setCompressedBuffer (void *compressedBuffer, int compressedBufferSize, int width, int height)
	Sets the raw compressed bytes for the image. The PFCPDFImage doesn't take ownership of the buffer and will not be de-allocated. More...
void	setCompressedBufferPath (const char *compressedBufferPath, int width, int height)
	Sets the path to compressed buffer on disk. More...

Data Fields
PFCImageFile *	imageFile
	Instance to the already expanded image for processing. Use it as you would any other PFCImageFile. PFCPDFImage keeps ownership of the imageFile.
uint32_t	pdfObjectNumber
	Object number for the image in the PDF document. Can be used to ID a given image.
int	compressedBufferSize
	Compressed buffer size.

Friends
class	PFCPDFImageIterator
	Open a PDF file using this interator.

Detailed Description

Represents an image extracted from a PDF file, thru use of a PFCPDFImageIterator.

Definition at line 30 of file PFCPDFImage.h.

Member Function Documentation

compressedBuffer()

void* compressedBuffer

(

)

Raw compressed bytes. These bytes are owned by PFCPDImageFile.

Returns

pointer to compressed buffer

pdfObject()

PoDoFo::PdfObject* pdfObject

(

)

For advanced usage the object from which the image was extracted.

Returns

pdfObject

setCompressedBuffer()

void setCompressedBuffer	(	void *	compressedBuffer,
		int	compressedBufferSize,
		int	width,
		int	height
	)

Sets the raw compressed bytes for the image. The PFCPDFImage doesn't take ownership of the buffer and will not be de-allocated.

Parameters

compressedBuffer	[in] pointer to raw compressed bytes
compressedBufferSize	[in] size of compressed bytes buffer
width	[in] width of image
height	[in] height of image

setCompressedBufferPath()

void setCompressedBufferPath	(	const char *	compressedBufferPath,
		int	width,
		int	height
	)

Sets the path to compressed buffer on disk.

Parameters

compressedBufferPath	[in] utf8 path to compressed JPEG on disk
width	[in] width of image
height	[in] height of image

---

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

• PFCPDFImage.h