PoDoFo 0.9.20
PoDoFo::PdfTilingPattern Class Referencefinal

#include <PdfTilingPattern.h>

Public Member Functions

const PdfNameGetIdentifier () const
 
 PdfTilingPattern (PdfDocument &doc, PdfTilingPatternType tilingType, double strokeR, double strokeG, double strokeB, bool doFill, double fillR, double fillG, double fillB, double offsetX, double offsetY, PdfImage *image)
 

Detailed Description

This class defined a tiling pattern which can be used to fill abitrary shapes with a pattern using PdfPainter.

Constructor & Destructor Documentation

◆ PdfTilingPattern()

PdfTilingPattern::PdfTilingPattern ( PdfDocument & doc,
PdfTilingPatternType tilingType,
double strokeR,
double strokeG,
double strokeB,
bool doFill,
double fillR,
double fillG,
double fillB,
double offsetX,
double offsetY,
PdfImage * image )

Create a new PdfTilingPattern object, which will introduce itself automatically to every page object it is used on.

Parameters
tilingTypethe type of this tiling pattern
strokeRstrok color red component
strokeGstrok color green component
strokeBstrok color blue component
doFillwhether tile fills content first, with fill color
fillRfill color red component
fillGfill color green component
fillBfill color blue component
offsetXtile offset on X axis
offsetYtile offset on Y axis
imageimage to use - can be set only if tilingType is PdfTilingPatternType::Image
parentparent document
Note
stroke and fill colors are ignored if eTilingType is PdfTilingPatternType::Image
fill color is ignored if doFill is false
image is ignored for all but PdfTilingPatternType::Image tilingType types, where it cannot be nullptr

Member Function Documentation

◆ GetIdentifier()

const PdfName & PoDoFo::PdfTilingPattern::GetIdentifier ( ) const
inline

Returns the identifier of this TilingPattern how it is known in the pages resource dictionary.

Returns
PdfName containing the identifier (e.g. /PtrnXXXXX)