7.5  Color Functions s 181
reserved (C language binding only.) Reserved, must be 0.
optlist An option list (see Section 3.1.4, »Option Lists«, page 44) describing aspects of 
the profile handling according to Table 7.17.
Returns A profile handle which can be used in subsequent calls to PDF_load_image() or for set-
ting profile-related parameters. The return value must be checked for -1 (in PHP: 0) 
which signals an error. In order to get more detailed information about the nature of a 
profile-related problem (file not found, unsupported format, etc.) set the iccwarning pa-
rameter to true. The returned profile handle can not be reused across multiple PDF doc-
uments. Also, the returned handle can not be applied to an image if the usage option is 
outputintent. There is no limit to the number of ICC profiles in a document.
Details If the usage option is iccbased the named profile will be searched according to the search 
strategy discussed in Section 3.3.4, »Color Management and ICC Profiles«, page 63. If the 
profile is found, it will be checked whether it is suitable (e.g., number of color compo-
nents). The sRGB profile is always available internally, and must not be configured.
If usage option is outputintent the named profile is first searched in an internal list of 
standard output intents. If this search was unsuccessful, the name will be searched in 
the list of user-configured output intents. If the supplied name was found to be a stan-
dard output intent according to the built-in or user-configured list, no ICC profile will 
be searched, and the name supplied with the description option will be embedded in 
the PDF output as the PDF/X output intent. If the name was not found to be a standard 
output intent identifier, it is treated as a profile name and the corresponding ICC profile 
will be embedded in the PDF as the PDF/X output intent.
Scope document; if the usage option is iccbased the following scopes are also allowed: page, 
pattern, template, glyph.
Params See Table 7.18.
PDF/X The output intent for the generated document must be set either using this function, or 
by copying an imported document’s output intent using PDF_process_pdi().
Table 7.17 7 Options for PDF_load_iccprofile()
key
type
explanation and possible values
usage
keyword
Describes the intended use of the ICC profile (default: iccbased):
iccbased: the ICC profile will be used to define an ICC-based color space, or 
will be applied to an image.
outputintent: the ICC profile will be used to define a PDF/X output intent.
description
string
This option is only used if usage = outputintent. It contains the human-
readable description of the ICC profile which will be used along with the 
PDF/X output intent. Default: if profilename refers to a standard output 
intent, the description will be taken from an internal list; otherwise there 
will be no description.
embedprofile
boolean
This option is only used if usage = outputintent. Force an embedded ICC 
profile even if a standard output intent has been provided as profilename. 
Default: false.
Pdf to tiff open source c# - Convert PDF to tiff images in C#.net, ASP.NET MVC, Ajax, WinForms, WPF
Online C# Tutorial for How to Convert PDF File to Tiff Image File
pdf to tiff quality; convert pdf to tiff file
Pdf to tiff open source c# - VB.NET PDF Convert to Tiff SDK: Convert PDF to tiff images in vb.net, ASP.NET MVC, Ajax, WinForms, WPF
Free VB.NET Guide to Render and Convert PDF Document to TIFF
convert pdf to 300 dpi tiff; pdf to tiff c#
182
Chapter 7:  API Reference for PDFlib, PDI, and PPS
7.5.2Patterns and Shadings
int PDF_begin_pattern(PDF *p,
float width, float height, float xstep, float ystep, int painttype)
Start a pattern definition.
width, height The dimensions of the pattern’s bounding box in points.
xstep, ystep The offsets when repeatedly placing the pattern to stroke or fill some ob-
ject. Most applications will set these to the pattern width and height, respectively.
painttype If painttype is 1 the pattern must contain its own color specification which 
will be applied when the pattern is used; if painttype is 2 the pattern must not contain 
any color specification but instead the current fill or stroke color will be applied when 
the pattern is used for filling or stroking.
Returns A pattern handle that can be used in subsequent calls to PDF_setcolor() during the en-
closing document scope.
Details Hypertext functions and functions for opening images must not be used during a pat-
tern definition, but all text, graphics, and color functions (with the exception of the pat-
tern which is in the process of being defined) can be used.
Scope document; this function starts pattern scope, and must always be paired with a matching 
PDF_end_pattern() call.
Table 7.18 8 Parameters and values for ICC profiles
function
key
explanation
set_parameter ICCProfile
Standard-
OutputIntent
The corresponding resource file line as it would appear for the respective category 
in a UPR file (see Section 3.1.6, »Resource Configuration and File Searching«, page 
47). Multiple calls add new entries to the internal list. (See also prefix and 
resourcefile in Table 7.2). Scope: any.
set_parameter
iccwarning
Enable or suppress warnings (nonfatal exceptions) related to ICC profiles. Possible 
values are true and false, default value is false. Scope: any
get_value
icccomponents
Return the number of color components in the ICC profile referenced by the 
handle provided in the modifier.
set_value
defaultgray
defaultrgb
defaultcmyk
Set a default Gray, RGB, or CMYK color space for the page according to the 
supplied profile handle.
set_value
setcolor:icc-
profilegray
Set an ICC profile which specifies a Gray color space for use with 
PDF_
setcolor(). 
Scope: document, page, pattern, template, glyph
set_value
setcolor:icc-
profilergb
Set an ICC profile which specifies an RGB color space for use with 
PDF_
setcolor(). 
Scope: document, page, pattern, template, glyph
set_value
setcolor:icc-
profilecmyk
Set an ICC profile which specifies a CMYK color space for use with 
PDF_
setcolor(). 
Scope: document, page, pattern, template, glyph
C# PDF Text Extract Library: extract text content from PDF file in
it is feasible for users to extract text content from source PDF document file the following C# example code for text extraction from PDF page Open a document
compare pdf to tiff; convert pdf to tiff
C# PDF File Merge Library: Merge, append PDF files in C#.net, ASP.
Free online C#.NET source code for combining multiple PDF pages together in .NET framework. Combine scanned images to PDF, such as tiff, jpg, png, gif, bmp
pdf to tiff c# open source; c# pdf to tiff
7.5  Color Functions s 183
void PDF_end_pattern(PDF *p)
Finish a pattern definition.
Scope pattern; this function terminates pattern scope, and must always be paired with a 
matching PDF_begin_pattern() call.
int PDF_shading_pattern(PDF *p, int shading, const char *optlist)
Define a shading pattern using a shading object.
shading A shading handle returned by PDF_shading().
optlist An option list (see Section 3.1.4, »Option Lists«, page 44) describing aspects of 
the shading pattern according to Table 7.19.
Returns A pattern handle that can be used in subsequent calls to PDF_setcolor() during the en-
closing document scope.
Details This function can be used to fill arbitrary objects with a shading. To do so, a shading 
handle must be retrieved using PDF_shading(), then a pattern must be defined based on 
this shading using PDF_shading_pattern(). Finally, the pattern handle can be supplied to 
PDF_setcolor() to set the current color to the shading pattern.
Scope document, page, font
void PDF_shfill(PDF *p, int shading)
Fill an area with a shading, based on a shading object.
shading A shading handle returned by PDF_shading().
Details This function allows shadings to be used without involving PDF_shading_pattern() and 
PDF_setcolor(). However, it works only for simple shapes where the geometry of the ob-
ject to be filled is the same as that of the shading itself. Since the current clip area will be 
shaded (subject to the extend0 and extend1 options of the shading) this function will 
generally be used in combination with PDF_clip().
Scope page, pattern (only if the pattern’s paint type is 1), template, glyph (only if the Type 3 
font’s colorized option is true), document
int PDF_shading(PDF *p, const char *shtype, float x0, float y0, float x1, float y1,
float c1, float c2, float c3, float c4, const char *optlist)
Define a color blend (smooth shading) from the current fill color to the supplied color.
shtype The type of the shading; must be axial for linear shadings or radial for circle-
like shadings.
Table 7.19 9 Options for PDF_shading_pattern()
key
type
explanation and possible values
PDF
gstate
handle
A graphics state handle
1.3
C# PDF Page Extract Library: copy, paste, cut PDF pages in C#.net
Online C# source code for extracting, copying and pasting PDF The portable document format, known as PDF document, is of file that allows users to open & read
convert pdf to tiff high quality; pdf to tiff file converter
VB.NET PDF Annotate Library: Draw, edit PDF annotation, markups in
Decode source PDF document file into an in-memory object, namely 2.pdf" Dim outputFilePath As String = Program.RootPath + "\\" Annot_8.pdf" ' open a PDF file
pdf to tiff converter online; converting pdf to tiff file
184
Chapter 7:  API Reference for PDFlib, PDI, and PPS
x0, y0, x1, y1 For axial shadings, (x0, y0) and (x1, y1) are the coordinates of the starting 
and ending points of the shading. For radial shadings these points specify the centers of 
the starting and ending circles.
c1, c2, c3, c4 Color values of the shading’s endpoint, interpreted in the current fill color 
space in the same way as the color parameters in PDF_setcolor(). If the current fill color 
space is a spot color space c1 will be ignored, and c2 contains the tint value.
optlist An option list (see Section 3.1.4, »Option Lists«, page 44) describing aspects of 
the shading according to Table 7.20.
Returns A shading handle that can be used in subsequent calls to PDF_shading_pattern() and 
PDF_shfill() during the enclosing document scope.
Details The current fill color will be used as the starting color; it must not be based on a pattern.
Scope document, page, font
Table 7.20 0 Options for PDF_shading()
key
type
explanation and possible values
PDF
N
float
The exponent for the color transition function; must be > 0. 
Default: 1
1.3
r0
float
(Only for radial shadings, and required in this case) The radius of 
the starting circle.
1.3
r1
float
(Only for radial shadings, and required in this case) The radius of 
the ending circle.
1.3
extend0
boolean
Specifies whether to extend the shading beyond the starting point. 
Default: false
1.3
extend1
boolean
Specifies whether to extend the shading beyond the endpoint. 
Default: false
1.3
antialias
boolean
Specifies whether to activate antialiasing for the shading. Default: 
false
1.3
C# Create PDF from OpenOffice to convert odt, odp files to PDF in
Online source code for C#.NET class. to Use C#.NET Demo Code to Convert ODP to PDF in C#.NET Application. Description: Convert to PDF/TIFF and save it on the disk
online pdf to tiff; pdf to tiff online
C# PDF: PDF Document Viewer & Reader SDK for Windows Forms
in different display formats, and save source PDF file using file to a specified path in C# WinForms application visible page in the currently open PDF document
pdf converter to tiff online; convert pdf to tiff 300 dpi online
7.6  Image and Template Functions s 185
7.6Image and Template Functions
Table 7.21 lists relevant parameters and values for this section.
7.6.1Images
int PDF_load_image(PDF *p,
const char *imagetype, const char *filename, int reserved, const char *optlist)
Open a (disk-based or virtual) image file with various options.
imagetype The string auto instructs PDFlib to automatically detect the image file type 
(this is not possible for CCITT and raw images, and must not be used if the reftype option 
has the value url or fileref). Explicitly specifying the image format with the strings bmp, 
ccitt, gif, jpeg, pngraw, or tiff offers slight performance advantages (for details see Sec-
tion 5.1.2, »Supported Image File Formats«, page 110). Type ccitt is different from a TIFF 
file which contains CCITT-compressed image data.
filename Generally the name of the image file to be opened. This must be the name of 
a local or virtual file; PDFlib will not pull image data from URLs. However, if reftype=url 
(deprecated, though) this parameter contains the URL of the image; If reftype=fileref (al-
Table 7.21Parameters and values for the image functions (see Section 7.2.3, »Parameter Handling«, page 150)
function
key
explanation
get_value
imagewidth
imageheight
Get the width or height, respectively, of an image in pixels. The modifier is 
the integer handle of the selected image. Scope: page, pattern, template, 
glyph, document, path.
get_value
resx
resy
Get the horizontal or vertical resolution of an image, respectively. The 
modifier is the integer handle of the selected image. Scope: page, pattern, 
template, glyph, document, path.
If the value is positive, the return value is the image resolution in pixels per 
inch (dpi). If the return value is negative, resx and resy can be used to find 
the aspect ratio of non-square pixels, but don’t have any absolute 
meaning. If the return value is zero, the resolution of the image is 
unknown.
set_parameter honoriccprofile
Read ICC color profiles embedded in images, and apply them to the image 
data. Default: true.
set_parameter
imagewarning
This parameter can be used in order to obtain more detailed information 
about why an image couldn’t be opened successfully with PDF_load_
image(). Scope: any.
true
Raise an exception when the image function fails, and return -1 
(in PHP: 0). The message supplied with the exception may be
useful for debugging.
false
Do not raise an exception when the image function fails.
Instead, the function simply returns -1 (in PHP: 0) on error. This is
the default.
set_value
image:iccprofile
Handle for an ICC profile which will be applied to all respective images 
unless the iccprofile option is supplied.
get_value
image:iccprofile
Return a handle for the ICC profile embedded in the image referenced by 
the image handle provided in the modifier.
set_value
renderingintent
The rendering intent for images. See Table 3.8 for a list of possible 
keywords and their meaning. Default: AutoIntent.
C# Word - MailMerge Processing in C#.NET
In C# class programming, you can use XML file which contains data source, and execute String docFilePath = @""; String xmlFilePath = @""; Open the document
pdf to multipage tiff; pdf to tiff open source c#
VB.NET PDF File Split Library: Split, seperate PDF into multiple
Separate source PDF document file by defined page range in VB.NET class application. Divide PDF file into multiple files by outputting PDF file size.
create tiff from pdf; change pdf to tiff
186
Chapter 7:  API Reference for PDFlib, PDI, and PPS
so deprecated) it contains a file name on the viewing system, and not a local file name. 
Only 8-bit characters are supported in the image file name; Unicode or embedded null 
characters are not supported.
reserved (C language binding only.) Reserved, must be 0.
optlist An option list (see Section 3.1.4, »Option Lists«, page 44) specifying image-relat-
ed properties according to Table 7.22.
Returns An image handle which can be used in subsequent image-related calls. The return value 
must be checked for -1 (in PHP: 0) which signals an error. In order to get more detailed 
information about the nature of an image-related problem (wrong image file name, un-
supported format, bad image data, etc.), set the imagewarning parameter or option to 
true (see Table 7.21 and Table 7.22). The returned image handle can not be reused across 
multiple PDF documents.
Details This function opens and analyzes a raster graphics file in one of the supported formats 
as determined by the imagetype parameter. PDFlib will open the image file with the pro-
vided filename, process the contents, and close the file before returning from this call. 
Although images can be placed multiply within a document (see PDF_fit_image()), the 
actual image file will not be kept open after this call.
If imagetype = raw or ccitt, the width, height, components, and bpc options must be sup-
plied since PDFlib cannot deduce those from the image data. The user is responsible for 
supplying option values which actually match the image. Otherwise corrupt PDF out-
put may be generated, and Acrobat may respond with the message Insufficient data for 
an Image.
If imagetype = raw, the length of the supplied image data must be equal to [width x 
components x bpc / 8] x height bytes, with the bracketed term adjusted upwards to the 
next integer. The image samples are expected in the standard PostScript/PDF ordering, 
i.e., top to bottom and left to right (assuming no coordinate transformations have been 
applied). The polarity of the pixel values is as discussed in Section 3.3.1, »Color and Color 
Spaces«, page 59. Even if bpc is not 8, each pixel row begins on a byte boundary, and col-
or values must be packed from left to right within a byte. Image samples are always in-
terleaved, i.e., all color values for the first pixel are supplied first, followed by all color 
values for the second pixel, and so on.
Scope If the inline option is not provided, the scope is document, page, font, and this function 
must always be paired with a matching PDF_close_image() call. Loading images in 
document or font scope instead of page scope offers slight output size advantages.
If the inline option is provided, the scope is page, pattern, template, glyph, and PDF_close_
image() must not be called.
PDF/X All PDF/X conformance levels: GIF and LZW-compressed TIFF images are not allowed.
PDF/X-1 and PDF/X-1a: RGB images are not allowed.
PDF/X-3: Grayscale images require that the defaultgray parameter must have been set 
before unless the PDF/X output intent is a grayscale or CMYK device. RGB images 
require that the defaultrgb parameter must have been set before unless the PDF/X 
output intent is an RGB device. CMYK images require that the defaultcmyk parameter 
must have been set before unless the PDF/X output intent is a CMYK device.
Params imagewidth, imageheight, resx, resy, imagewarning
C# Create PDF from Tiff Library to convert tif images to PDF in C#
Selection of turning tiff into searchable PDF or scanned PDF. Online demo allows converting tiff to PDF online. C# source codes are provided to use in .NET class
how to convert pdf to tiff; pdf to tiff converter open source c#
7.6  Image and Template Functions s 187
Table 7.22 2 Options for PDF_load_image()
key
type
explanation
bitreverse
boolean
(Only for imagetype = ccitt) If true, do a bitwise reversal of all bytes in the 
compressed data. Default: false.
bpc
integer
(Only for imagetype = raw, and required in this case) The number of bits per 
component; must be 1, 2, 4, or 8.
colorize
spot color 
handle
Colorize the image with a spot color handle, which must have been retrieved with 
PDF_makespotcolor(). The image must be a grayscale image with 1, 2, 4, or 8 bits 
color depth.
components
integer
(Only for imagetype=raw, and required in this case) The number of image 
components (channels); must be 1, 3, or 4.
height
integer
(Only for imagetype = raw and ccitt, and required in this case) The height of the 
image in pixels.
honor-
iccprofile
boolean
(Only for imagetype = jpeg, png, and tiff) Read an embedded ICC profile (if any) 
and apply it to the image. Default: the value of the global honoriccprofile 
parameter.
iccprofile
icc handle
(Only for imagetype = jpeg, png, and tiff) Handle of the ICC profile which will be 
applied to the image. Default: the value of the global image:iccprofile parameter.
ignoremask
boolean
Ignore any transparency information which may be present in the image. Default: 
false.
image-
warning
boolean
Enable exceptions when the image cannot be opened. Default: the value of the 
global imagewarning parameter.
inline
boolean
(Only for imagetype = ccitt, jpeg, and raw) If true, the image will be written 
directly into the content stream of the page, pattern, template, or glyph 
description (see Section 5.1.1, »Basic Image Handling«, page 109).
interpolate
boolean
Enable image interpolation in Acrobat to improve the appearance on screen and 
paper. This is especially useful for bitmap images to be used as glyph descriptions 
in Type 3 fonts. Default: false.
invert
boolean
Invert the image (swap light and dark colors). This can be used as a workaround 
for certain images which are interpreted differently by different applications. 
Default: false.
K
integer
(Only for imagetype = ccitt) CCITT compression parameter for encoding scheme 
selection. -1 indicates G4 compression; 0 indicates one-dimensional G3 
compression (G3-1D); 1 indicates mixed one- and two-dimensional compression 
(G3, 2-D) as supported by PDF. Default: 0.
mask
boolean
The image is going to be used as a mask (see Section 5.1.3, »Image Masks and 
Transparency«, page 112). This is required for 1-bit masks, but optional for masks 
with more than 1 bit per pixel. However, masks with more than 1 bit require 
PDF1.4. Default is false. There are two uses for masks:
Masking another image: the returned image handle may be used in subsequent 
calls for opening another image and can be supplied for the »masked« option.
Placing a colorized transparent image: treat the 0-bit pixels in the image as 
transparent, and colorize the 1-bit pixels with the current fill color.
masked
image 
handle
An image handle for an image which will be applied as a mask to the current 
image. The integer is an image handle which has been returned by a previous call 
to PDF_load_image() (with the »mask« option if it is a 1-bit mask), and has not 
yet been closed. In PDF1.3 compatibility mode the image handle must refer to a 1-
bit image since soft masks are only supported in PDF1.4.
page
integer
(Only for imagetype = gif and tiff) Extract the image with the given number from 
a multi-page image file. The first image has the number 1. Default: 1.
188
Chapter 7:  API Reference for PDFlib, PDI, and PPS
void PDF_close_image(PDF *p, int image)
Close an image.
image A valid image handle retrieved with PDF_load_image().
Details This function only affects PDFlib’s associated internal image structure. If the image has 
been opened from file, the actual image file is not affected by this call since it has al-
ready been closed at the end of the corresponding PDF_load_image() call. An image han-
dle cannot be used any more after it has been closed with this function, since it breaks 
PDFlib’s internal association with the image.
Scope document, page, font; must always be paired with a matching call to PDF_load_image() 
unless the inline option has been used.
void PDF_fit_image(PDF *p, int im, float x, float y, const char *optlist)
Place an image or template at (x, y) with various options.
image A valid image or template handle retrieved with one of the PDF_load_image*() 
or PDF_begin_template() functions.
x, y The coordinates of the reference point in the user coordinate system where the 
image or template will be located, subject to various options.
optlist An option list (see Section 3.1.4, »Option Lists«, page 44) specifying placement 
details according to Table 7.23.
Details The image or template (collectively referred to as an object below) will be placed relative 
to the reference point (x, y). By default, the lower left corner of the object will be placed 
at the reference point. However, the orientate, boxsize, position, and fitmethod options 
can modify this behavior. By default, an image will be scaled according to its resolution 
value(s). This behavior can be modified with the dpi, scale, and fitmethod options.
Scope page, pattern, template, glyph (only if the Type 3 font’s colorized option is true, or if the 
image is a mask); this function can be called an arbitrary number of times on arbitrary 
pages, as long as the image handle has not been closed with PDF_close_image().
rendering-
intent
keyword
The rendering intent for the image. See Table 3.8 for a list of possible keywords 
and their meaning. Default: the value of the global renderingintent parameter.
reftype
keyword
(Deprecated; only for imagetype = ccitt, jpeg, and raw) One of direct (for image 
data to be read from a file), fileref or url to specify image data via a reference to a 
file on the viewing system or an URL. The following options are required for 
reftype=url or fileref: width, height, components, bpc; the following options will 
be ignored for reftype=url or fileref: bitreverse, honoriccprofile, inline. Default: 
direct.
width
integer
(Only for imagetype = raw and ccitt, and required in this case) The width of the 
image in pixels.
Table 7.22 2 Options for PDF_load_image()
key
type
explanation
7.6  Image and Template Functions s 189
Table 7.23 3 Options for PDF_fit_image() and PDF_fit_pdi_page()
key
type
explanation
adjustpage
boolean
Adjust the dimensions of the current page to the object such that the upper right 
corner of the page coincides with the upper right corner of the object plus (x, y). 
With the value 0 for the position option the following useful cases shall be noted:
x >= 0 and y >= 0: the object is surrounded by a white margin. This margin has 
thickness y in horizontal direction and thickness x in vertical direction.
x < 0 and y < 0: horizontal and vertical strips will be cropped from the image.
This option is only effective in scope page, and must not be used when the 
topdown parameter has been set to true. Default: false.
blind
boolean
If true, all positioning and scaling calculations will be done, but the object will not 
be placed on the output page. This is useful for processing the blocks on a page 
without actually using the page’s contents. Default: false.
boxsize
float list
Two values specifying the width and height of a box, relative to which the object 
will be placed and possibly scaled. The lower left corner of the box coincides with 
the reference point (x, y). Placing the image and fitting it into the box is controlled 
by the position and fitmethod options. If width=0, only the height is considered; 
If height=0, only the width is considered. In these cases the object will be placed 
relative to the vertical line from (x,y) to (x,y+height), or the horizontal line from 
(x, y) to (x+width, y), respectively. Default: {0 0}.
dpi
float list
One or two values specifying the desired image resolution in pixels per inch in 
horizontal and vertical direction. If a single value is supplied it will be used for 
both directions. With the value o the image’s internal resolution will be used if 
available, or 72dpi otherwise. As an alternative to the value 0, the keyword 
internal can be supplied. This option will be ignored for templates and PDF pages, 
or if the fitmethod option has been supplied with one of the keywords meet, slice, 
or entire. Default: internal.
fitmethod
keyword
Specifies the method used to fit the object into the specified box. This option will 
be ignored if no box has been specified. Default: nofit.
nofit
Position the object only, without any scaling or clipping.
clip
Position the object, and clip it at the edges of the box.
meet
Position the object according to the position option, and scale it such
that it entirely fits into the box while preserving its aspect ratio.
Generally at least two edges of the object will meet the corresponding
edges of the box. The dpi and scale options are ignored.
auto
This method tries to fit the object into the box automatically. In detail:
Same as nofit if the object fits into the box. Otherwise a scaling factor is
calculated such that the object fits into the box. If this factor is larger
than 0.75 the object is distorted to fit intothe box, otherwise the meet
method is applied.
slice
Position the object according to the position option, and scale it such
that it entirely covers the box, while preserving the aspect ratio and
making sure that at least one dimension of the object is fully contained
in the box. Generally parts of the object’s other dimension will extend
beyond the box, and will therefore be clipped. The dpi and scale options
are ignored.
entire
Position the object according to the position option, and scale it such
that it entirely covers the box. Generally this method will distort the
object. The dpi and scale options are ignored.
orientate
keyword
Specifies the desired orientation of the object when it is placed. Default: north.
north
upright
east
pointing to the right
south
upside down
west
pointing to the left
190
Chapter 7:  API Reference for PDFlib, PDI, and PPS
7.6.2Templates
int PDF_begin_template(PDF *p, float width, float height)
Start a template definition. 
width, height The dimensions of the template’s bounding box in points.
Returns A template handle which can be used in subsequent image-related calls, especially PDF_
fit_image(). There is no error return.
Details Hypertext functions and functions for opening images must not be used during a 
template definition, but all text, graphics, and color functions can be used.
Scope document; this function starts template scope, and must always be paired with a 
matching PDF_end_template() call.
void PDF_end_template(PDF *p)
Finish a template definition.
Scope template; this function terminates template scope, and must always be paired with a 
matching PDF_begin_template() call.
7.6.3Deprecated Functions
int PDF_open_image_file(PDF *p,
const char *imagetype, const char *filename, const char *stringparam, int intparam)
Deprecated, use PDF_load_image() with the colorize, ignoremask, invert, mask, masked, and 
page options instead.
position
float list
One or two values specifying the position of the reference point (x, y) within the 
object with {0 0} being the lower left corner of the object, and {100100} the upper 
right corner. If the boxsize option has been specified, the position option also 
specifies the positioning of the box. The values are expressed as percentages of the 
object’s width and height. If both percentages are equal it is sufficient to specify a 
single float value. Some examples: 0 or {0 0} means lower left corner; {50100} 
means middle of the top edge; 50 or {50 50} means the center of the object. 
Default: 0.
rotate
float
Rotate the coordinate system, using the reference point as center and the speci-
fied value as rotation angle in degrees. This results in the box and the object being 
rotated. The rotation will be reset when the object has been placed. Default: 0.
scale
float list
Scale the object in horizontal and vertical direction by the specified scaling factors 
(not percentages). If both factors are equal it is sufficient to specify a single float 
value. This option will be ignored if the fitmethod option has been supplied with 
one of the keywords meet, slice, or entire. Default: 1
Table 7.23 3 Options for PDF_fit_image() and PDF_fit_pdi_page()
key
type
explanation
Documents you may be interested
Documents you may be interested