PoDoFo 0.9.6
|
#include <PdfImage.h>
Public Member Functions | |
PdfImage (PdfVecObjects *pParent, const char *pszPrefix=NULL) | |
PdfImage (PdfDocument *pParent, const char *pszPrefix=NULL) | |
PdfImage (PdfObject *pObject) | |
void | SetImageColorSpace (EPdfColorSpace eColorSpace, const PdfArray *indexedData=NULL) |
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 | SetImageDataRaw (unsigned int nWidth, unsigned int nHeight, unsigned int nBitsPerComponent, PdfInputStream *pStream) |
void | LoadFromFile (const char *pszFilename) |
void | LoadFromData (const unsigned char *pData, pdf_long dwLen) |
void | SetImageChromaKeyMask (pdf_int64 r, pdf_int64 g, pdf_int64 b, pdf_int64 threshold=0) |
void | SetInterpolate (bool bValue) |
![]() | |
PdfXObject (const PdfRect &rRect, PdfDocument *pParent, const char *pszPrefix=NULL, bool bWithoutObjNum=false) | |
PdfXObject (const PdfRect &rRect, PdfVecObjects *pParent, const char *pszPrefix=NULL) | |
PdfXObject (const PdfMemDocument &rSourceDoc, int nPage, PdfDocument *pParent, const char *pszPrefix=NULL, bool bUseTrimBox=false) | |
PdfXObject (PdfDocument *pDoc, int nPage, const char *pszPrefix=NULL, bool bUseTrimBox=false) | |
PdfXObject (PdfObject *pObject) | |
virtual PdfObject * | GetContents () const |
virtual PdfObject * | GetContentsForAppending () const |
virtual PdfObject * | GetResources () const |
virtual const PdfRect | GetPageSize () const |
const PdfName & | GetIdentifier () const |
const PdfReference & | GetObjectReference () const |
![]() | |
PdfObject * | GetObject () |
const PdfObject * | GetObject () const |
![]() | |
virtual | ~PdfCanvas () |
virtual PdfObject * | GetContents () const =0 |
virtual PdfObject * | GetContentsForAppending () const =0 |
virtual PdfObject * | GetResources () const =0 |
virtual const PdfRect | GetPageSize () const =0 |
void | AddColorResource (const PdfColor &rColor) |
void | AddResource (const PdfName &rIdentifier, const PdfReference &rRef, const PdfName &rName) |
Static Public Member Functions | |
static const char ** | GetSupportedFormats () |
![]() | |
static const PdfArray | GetProcSet () |
Additional Inherited Members | |
![]() | |
PdfElement (const char *pszType, PdfVecObjects *pParent) | |
PdfElement (const char *pszType, PdfDocument *pParent) | |
PdfElement (const char *pszType, PdfObject *pObject) | |
PdfElement (EPdfDataType eExpectedDataType, PdfObject *pObject) | |
const char * | TypeNameForIndex (int i, const char **ppTypes, long lLen) const |
int | TypeNameToIndex (const char *pszType, const char **ppTypes, long lLen, int nUnknownValue) const |
PdfObject * | CreateObject (const char *pszType=NULL) |
PdfObject * | GetNonConstObject () const |
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
PoDoFo::PdfImage::PdfImage | ( | PdfVecObjects * | pParent, |
const char * | pszPrefix = NULL |
||
) |
Constuct a new PdfImage object
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.
pParent | parent document |
pszPrefix | optional prefix for XObject-name |
PoDoFo::PdfImage::PdfImage | ( | PdfObject * | pObject | ) |
|
inline |
Get the height of the image when drawn in PDF units
|
static |
Get a list of all image formats supported by this PoDoFo build.
Example: { "JPEG", "TIFF", NULL }
|
inline |
Get the width of the image when drawn in PDF units
void PoDoFo::PdfImage::LoadFromData | ( | const unsigned char * | pData, |
pdf_long | dwLen | ||
) |
Load the image data from bytes
pData | bytes |
dwLen | number of bytes |
void PoDoFo::PdfImage::LoadFromFile | ( | const char * | pszFilename | ) |
Load the image data from a file
pszFilename |
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.
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, |
const PdfArray * | indexedData = NULL |
||
) |
Set the color space of this image. The default value is ePdfColorSpace_DeviceRGB.
eColorSpace | one of ePdfColorSpace_DeviceGray, ePdfColorSpace_DeviceRGB and ePdfColorSpace_DeviceCMYK, ePdfColorSpace_Indexed |
indexedData | this parameter is required only for ePdfColorSpace_Indexed and it contains string with one number and then color palette, like "/DeviceRGB 15 <000000 00FF00...>" or the string array can be a resource name. |
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.
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 |
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
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::SetImageDataRaw | ( | unsigned int | nWidth, |
unsigned int | nHeight, | ||
unsigned int | nBitsPerComponent, | ||
PdfInputStream * | pStream | ||
) |
Set the actual image data from an input stream. The data has to be encoded already and an appropriate filters key entry has to be set manually before!
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 |
void PoDoFo::PdfImage::SetImageICCProfile | ( | PdfInputStream * | pStream, |
long | lColorComponents, | ||
EPdfColorSpace | eAlternateColorSpace = ePdfColorSpace_DeviceRGB |
||
) |
Set an ICC profile for this image.
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 |
void PoDoFo::PdfImage::SetImageSoftmask | ( | const PdfImage * | pSoftmask | ) |
Set a softmask for this image.
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.
bValue | whether the image should be interpolated |