PoDoFo::PdfImage Class Reference
#include <PdfImage.h>
List of all members.
Public Member Functions |
| PdfImage (PdfVecObjects *pParent, const char *pszPrefix=NULL) |
| PdfImage (PdfDocument *pParent, const char *pszPrefix=NULL) |
| PdfImage (PdfObject *pObject) |
void | SetImageColorSpace (EPdfColorSpace eColorSpace) |
void | SetImageICCProfile (PdfInputStream *pStream, long lColorComponents, EPdfColorSpace eAlternateColorSpace=ePdfColorSpace_DeviceRGB) |
void | SetImageSoftmask (const PdfImage *pSoftmask) |
double | GetWidth () const |
double | GetHeight () const |
void | SetImageData (unsigned int nWidth, unsigned int nHeight, unsigned int nBitsPerComponent, PdfInputStream *pStream) |
void | SetImageData (unsigned int nWidth, unsigned int nHeight, unsigned int nBitsPerComponent, PdfInputStream *pStream, const TVecFilters &vecFilters) |
void | LoadFromFile (const char *pszFilename) |
void | SetImageChromaKeyMask (pdf_int64 r, pdf_int64 g, pdf_int64 b, pdf_int64 threshold=0) |
void | SetInterpolate (bool bValue) |
Static Public Member Functions |
static const char ** | GetSupportedFormats () |
Detailed Description
A PdfImage object is needed when ever you want to embedd 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
-
SetImageData
Constructor & Destructor Documentation
PoDoFo::PdfImage::PdfImage |
( |
PdfVecObjects * |
pParent, |
|
|
const char * |
pszPrefix = NULL | |
|
) |
| | |
Constuct a new PdfImage object
- Parameters:
-
| pParent | parent vector of this image |
| pszPrefix | optional prefix for XObject-name |
PoDoFo::PdfImage::PdfImage |
( |
PdfDocument * |
pParent, |
|
|
const char * |
pszPrefix = NULL | |
|
) |
| | |
Constuct a new PdfImage object This is an overloaded constructor.
- Parameters:
-
| pParent | parent document |
| pszPrefix | optional prefix for XObject-name |
PoDoFo::PdfImage::PdfImage |
( |
PdfObject * |
pObject |
) |
|
Construct an image from an existing PdfObject
- Parameters:
-
Member Function Documentation
double PoDoFo::PdfImage::GetHeight |
( |
|
) |
const [inline] |
Get the height of the image when drawn in PDF units
- Returns:
- the height in PDF units
const char ** PoDoFo::PdfImage::GetSupportedFormats |
( |
|
) |
[static] |
Get a list of all image formats supported by this PoDoFo build.
Example: { "JPEG", "TIFF", NULL }
- Returns:
- a zero terminates list of all supported image formats
double PoDoFo::PdfImage::GetWidth |
( |
|
) |
const [inline] |
Get the width of the image when drawn in PDF units
- Returns:
- the width in PDF units
void PoDoFo::PdfImage::LoadFromFile |
( |
const char * |
pszFilename |
) |
|
Load the image data from a file
- Parameters:
-
void PoDoFo::PdfImage::SetImageChromaKeyMask |
( |
pdf_int64 |
r, |
|
|
pdf_int64 |
g, |
|
|
pdf_int64 |
b, |
|
|
pdf_int64 |
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)] |
void PoDoFo::PdfImage::SetImageColorSpace |
( |
EPdfColorSpace |
eColorSpace |
) |
|
Set the color space of this image. The default value is ePdfColorSpace_DeviceRGB.
- Parameters:
-
| eColorSpace | one of ePdfColorSpace_DeviceGray, ePdfColorSpace_DeviceRGB and ePdfColorSpace_DeviceCMYK |
- See also:
- SetImageICCProfile to set an ICC profile instead of a simple colorspace
void PoDoFo::PdfImage::SetImageData |
( |
unsigned int |
nWidth, |
|
|
unsigned int |
nHeight, |
|
|
unsigned int |
nBitsPerComponent, |
|
|
PdfInputStream * |
pStream, |
|
|
const TVecFilters & |
vecFilters | |
|
) |
| | |
Set the actual image data from an input stream
- Parameters:
-
| nWidth | width of the image in pixels |
| nHeight | height of the image in pixels |
| nBitsPerComponent | bits per color component of the image (depends on the image colorspace you have set but is 8 in most cases) |
| pStream | stream supplieding raw image data |
| vecFilters | these filters will be applied to compress the image data |
void PoDoFo::PdfImage::SetImageData |
( |
unsigned int |
nWidth, |
|
|
unsigned int |
nHeight, |
|
|
unsigned int |
nBitsPerComponent, |
|
|
PdfInputStream * |
pStream | |
|
) |
| | |
Set the actual image data from an input stream
The image data will be flate compressed. If you want no compression or another filter to be applied use the overload of SetImageData which takes a TVecFilters as argument.
- Parameters:
-
| nWidth | width of the image in pixels |
| nHeight | height of the image in pixels |
| nBitsPerComponent | bits per color component of the image (depends on the image colorspace you have set but is 8 in most cases) |
| pStream | stream supplieding raw image data |
- See also:
- SetImageData
void PoDoFo::PdfImage::SetImageICCProfile |
( |
PdfInputStream * |
pStream, |
|
|
long |
lColorComponents, |
|
|
EPdfColorSpace |
eAlternateColorSpace = ePdfColorSpace_DeviceRGB | |
|
) |
| | |
Set an ICC profile for this image.
- Parameters:
-
| pStream | an input stream from which the ICC profiles data can be read |
| lColorComponents | the number of colorcomponents of the ICC profile |
| eAlternateColorSpace | an alternate colorspace to use if the ICC profile cannot be used |
- See also:
- SetImageColorSpace to set an colorspace instead of an ICC profile for this image
void PoDoFo::PdfImage::SetImageSoftmask |
( |
const PdfImage * |
pSoftmask |
) |
|
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 |
void PoDoFo::PdfImage::SetInterpolate |
( |
bool |
bValue |
) |
|
Apply an interpolation to the image if the source resolution is lower than the resolution of the output device. Default is false.
- Parameters:
-
| bValue | whether the image should be interpolated |