PoDoFo::PdfImage Class Reference
#include <PdfImage.h>
List of all members.
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 a PdfImageRef object which has to be retrieved from the PdfImage object before drawing.
- See also:
- GetImageReference
-
PdfPainter::DrawImage
-
SetImageData
Constructor & Destructor Documentation
Constuct a new PdfImage object
- Parameters:
-
| pParent | parent vector of this image |
Constuct a new PdfImage object This is an overloaded constructor.
- Parameters:
-
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
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::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 flater 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