Pdftools SDK
Loading...
Searching...
No Matches
PdfTools_PdfToolsPdf2Image.h
Go to the documentation of this file.
1/******************************************************************************
2 *
3 * File: PdfTools_PdfToolsPdf2Image.h
4 *
5 * Description: Sub Header file for Pdftools SDK
6 *
7 * Author: PDF Tools AG
8 *
9 * Copyright: Copyright (C) 2023 - 2024 PDF Tools AG, Switzerland
10 * All rights reserved.
11 *
12 * Notice: By downloading and using this artifact, you accept PDF Tools AG's
13 * [license agreement](https://www.pdf-tools.com/license-agreement/),
14 * [privacy policy](https://www.pdf-tools.com/privacy-policy/),
15 * and allow PDF Tools AG to track your usage data.
16 *
17 *****************************************************************************/
18
19#ifndef PDFTOOLS_PDFTOOLSPDF2IMAGE_H__
20#define PDFTOOLS_PDFTOOLSPDF2IMAGE_H__
21
22#ifndef PDFTOOLS_CALL
23#if defined(WIN32)
24#define PDFTOOLS_CALL __stdcall
25#else
26#define PDFTOOLS_CALL
27#endif
28#endif
29
30#include "PdfTools_Types.h"
32
33#ifdef __cplusplus
34extern "C"
35{
36#endif
37
38#ifdef _UNICODE
39#else
40#endif
41
42/******************************************************************************
43 * ContentOptions
44 *****************************************************************************/
86
102/******************************************************************************
103 * FaxImageOptions
104 *****************************************************************************/
197
198/******************************************************************************
199 * TiffJpegImageOptions
200 *****************************************************************************/
210
259 TPdfToolsPdf2Image_TiffJpegImageOptions* pTiffJpegImageOptions, int iJpegQuality);
303 const TPdfToolsPdf2Image_JpegColorSpace* pColorSpace);
304
305/******************************************************************************
306 * TiffLzwImageOptions
307 *****************************************************************************/
317
403 TPdfToolsPdf2Image_TiffLzwImageOptions* pTiffLzwImageOptions, const TPdfToolsPdf2Image_ColorSpace* pColorSpace);
404
405/******************************************************************************
406 * TiffFlateImageOptions
407 *****************************************************************************/
418
483 TPdfToolsPdf2Image_TiffFlateImageOptions* pTiffFlateImageOptions, TPdfToolsPdf2Image_ColorSpace* pColorSpace);
504 TPdfToolsPdf2Image_TiffFlateImageOptions* pTiffFlateImageOptions, const TPdfToolsPdf2Image_ColorSpace* pColorSpace);
505
506/******************************************************************************
507 * PngImageOptions
508 *****************************************************************************/
518
599
600/******************************************************************************
601 * JpegImageOptions
602 *****************************************************************************/
612
657 TPdfToolsPdf2Image_JpegImageOptions* pJpegImageOptions, const TPdfToolsPdf2Image_JpegColorSpace* pColorSpace);
706 TPdfToolsPdf2Image_JpegImageOptions* pJpegImageOptions, int iJpegQuality);
707
723/******************************************************************************
724 * RenderPageAtResolution
725 *****************************************************************************/
742
760 TPdfToolsPdf2Image_RenderPageAtResolution* pRenderPageAtResolution, TPdfToolsGeomUnits_Resolution* pResolution);
778 TPdfToolsPdf2Image_RenderPageAtResolution* pRenderPageAtResolution,
779 const TPdfToolsGeomUnits_Resolution* pResolution);
780
781/******************************************************************************
782 * RenderPageToMaxImageSize
783 *****************************************************************************/
800
824 TPdfToolsPdf2Image_RenderPageToMaxImageSize* pRenderPageToMaxImageSize, TPdfToolsGeomInt_Size* pSize);
848 TPdfToolsPdf2Image_RenderPageToMaxImageSize* pRenderPageToMaxImageSize, const TPdfToolsGeomInt_Size* pSize);
849
850/******************************************************************************
851 * Converter
852 *****************************************************************************/
862
955 const TPdfToolsSys_StreamDescriptor* pOutStreamDesc, TPdfToolsPdf2ImageProfiles_Profile* pProfile, int iPageNumber);
956
957#ifdef __cplusplus
958}
959#endif
960
961#endif /* PDFTOOLS_PDFTOOLSPDF2IMAGE_H__ */
PDFTOOLS_EXPORT TPdfToolsPdf2Image_TiffFlateImageOptions *PDFTOOLS_CALL PdfToolsPdf2Image_TiffFlateImageOptions_New(void)
PDFTOOLS_EXPORT TPdfToolsPdf2Image_FaxVerticalResolution PDFTOOLS_CALL PdfToolsPdf2Image_FaxImageOptions_GetVerticalResolution(TPdfToolsPdf2Image_FaxImageOptions *pFaxImageOptions)
The vertical image resolution.
PDFTOOLS_EXPORT TPdfToolsPdf2Image_RenderPageToMaxImageSize *PDFTOOLS_CALL PdfToolsPdf2Image_RenderPageToMaxImageSize_New(const TPdfToolsGeomInt_Size *pSize)
PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfToolsPdf2Image_JpegImageOptions_GetColorSpace(TPdfToolsPdf2Image_JpegImageOptions *pJpegImageOptions, TPdfToolsPdf2Image_JpegColorSpace *pColorSpace)
The color space of the output image.
PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfToolsPdf2Image_RenderPageToMaxImageSize_SetSize(TPdfToolsPdf2Image_RenderPageToMaxImageSize *pRenderPageToMaxImageSize, const TPdfToolsGeomInt_Size *pSize)
The maximum size of the image in pixels.
PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfToolsPdf2Image_TiffLzwImageOptions_GetColorSpace(TPdfToolsPdf2Image_TiffLzwImageOptions *pTiffLzwImageOptions, TPdfToolsPdf2Image_ColorSpace *pColorSpace)
The color space of the output image.
PDFTOOLS_EXPORT TPdfToolsPdf2Image_BackgroundType PDFTOOLS_CALL PdfToolsPdf2Image_TiffLzwImageOptions_GetBackground(TPdfToolsPdf2Image_TiffLzwImageOptions *pTiffLzwImageOptions)
Combine a background with the image.
PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfToolsPdf2Image_TiffFlateImageOptions_GetColorSpace(TPdfToolsPdf2Image_TiffFlateImageOptions *pTiffFlateImageOptions, TPdfToolsPdf2Image_ColorSpace *pColorSpace)
The color space of the output image.
PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfToolsPdf2Image_PngImageOptions_SetColorSpace(TPdfToolsPdf2Image_PngImageOptions *pPngImageOptions, TPdfToolsPdf2Image_PngColorSpace iColorSpace)
The color space of the output image.
PDFTOOLS_EXPORT TPdfToolsPdf2Image_BackgroundType PDFTOOLS_CALL PdfToolsPdf2Image_TiffFlateImageOptions_GetBackground(TPdfToolsPdf2Image_TiffFlateImageOptions *pTiffFlateImageOptions)
Combine a background with the image.
PDFTOOLS_EXPORT int PDFTOOLS_CALL PdfToolsPdf2Image_TiffJpegImageOptions_GetJpegQuality(TPdfToolsPdf2Image_TiffJpegImageOptions *pTiffJpegImageOptions)
The JPEG quality factor.
PDFTOOLS_EXPORT TPdfToolsPdf2Image_PngImageOptions *PDFTOOLS_CALL PdfToolsPdf2Image_PngImageOptions_New(void)
PDFTOOLS_EXPORT TPdfToolsPdf2Image_Converter *PDFTOOLS_CALL PdfToolsPdf2Image_Converter_New(void)
PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfToolsPdf2Image_JpegImageOptions_SetColorSpace(TPdfToolsPdf2Image_JpegImageOptions *pJpegImageOptions, const TPdfToolsPdf2Image_JpegColorSpace *pColorSpace)
The color space of the output image.
PDFTOOLS_EXPORT TPdfToolsImage_MultiPageDocument *PDFTOOLS_CALL PdfToolsPdf2Image_Converter_ConvertDocument(TPdfToolsPdf2Image_Converter *pConverter, TPdfToolsPdf_Document *pInDoc, const TPdfToolsSys_StreamDescriptor *pOutStreamDesc, TPdfToolsPdf2ImageProfiles_Profile *pProfile)
Convert all pages of a PDF document to a rasterized image.
PDFTOOLS_EXPORT TPdfToolsPdf2Image_ImageOptionsType PDFTOOLS_CALL PdfToolsPdf2Image_ImageOptions_GetType(TPdfToolsPdf2Image_ImageOptions *pImageOptions)
Get actual derived type of base type TPdfToolsPdf2Image_ImageOptions.
PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfToolsPdf2Image_TiffLzwImageOptions_SetBackground(TPdfToolsPdf2Image_TiffLzwImageOptions *pTiffLzwImageOptions, TPdfToolsPdf2Image_BackgroundType iBackground)
Combine a background with the image.
PDFTOOLS_EXPORT TPdfToolsPdf2Image_BackgroundType PDFTOOLS_CALL PdfToolsPdf2Image_PngImageOptions_GetBackground(TPdfToolsPdf2Image_PngImageOptions *pPngImageOptions)
Combine a background with the image.
PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfToolsPdf2Image_RenderPageAtResolution_GetResolution(TPdfToolsPdf2Image_RenderPageAtResolution *pRenderPageAtResolution, TPdfToolsGeomUnits_Resolution *pResolution)
The resolution of the output image Valid values are 0.0, 10000.0 or in between.
PDFTOOLS_EXPORT int PDFTOOLS_CALL PdfToolsPdf2Image_JpegImageOptions_GetJpegQuality(TPdfToolsPdf2Image_JpegImageOptions *pJpegImageOptions)
The JPEG quality factor.
PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfToolsPdf2Image_JpegImageOptions_SetJpegQuality(TPdfToolsPdf2Image_JpegImageOptions *pJpegImageOptions, int iJpegQuality)
The JPEG quality factor.
PDFTOOLS_EXPORT TPdfToolsPdf2Image_ImageSectionMappingType PDFTOOLS_CALL PdfToolsPdf2Image_ImageSectionMapping_GetType(TPdfToolsPdf2Image_ImageSectionMapping *pImageSectionMapping)
Get actual derived type of base type TPdfToolsPdf2Image_ImageSectionMapping.
PDFTOOLS_EXPORT TPdfToolsImage_Document *PDFTOOLS_CALL PdfToolsPdf2Image_Converter_ConvertPage(TPdfToolsPdf2Image_Converter *pConverter, TPdfToolsPdf_Document *pInDoc, const TPdfToolsSys_StreamDescriptor *pOutStreamDesc, TPdfToolsPdf2ImageProfiles_Profile *pProfile, int iPageNumber)
Convert a single page of a PDF document to a rasterized image.
PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfToolsPdf2Image_PngImageOptions_SetBackground(TPdfToolsPdf2Image_PngImageOptions *pPngImageOptions, TPdfToolsPdf2Image_BackgroundType iBackground)
Combine a background with the image.
PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfToolsPdf2Image_TiffJpegImageOptions_SetJpegQuality(TPdfToolsPdf2Image_TiffJpegImageOptions *pTiffJpegImageOptions, int iJpegQuality)
The JPEG quality factor.
PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfToolsPdf2Image_TiffJpegImageOptions_GetColorSpace(TPdfToolsPdf2Image_TiffJpegImageOptions *pTiffJpegImageOptions, TPdfToolsPdf2Image_JpegColorSpace *pColorSpace)
The color space of the output image.
PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfToolsPdf2Image_FaxImageOptions_SetCompression(TPdfToolsPdf2Image_FaxImageOptions *pFaxImageOptions, TPdfToolsPdf2Image_TiffBitonalCompressionType iCompression)
The Fax compression algorithm.
PDFTOOLS_EXPORT TPdfToolsPdf2Image_TiffBitonalCompressionType PDFTOOLS_CALL PdfToolsPdf2Image_FaxImageOptions_GetCompression(TPdfToolsPdf2Image_FaxImageOptions *pFaxImageOptions)
The Fax compression algorithm.
PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfToolsPdf2Image_ContentOptions_SetAnnotations(TPdfToolsPdf2Image_ContentOptions *pContentOptions, TPdfToolsPdf2Image_AnnotationOptions iAnnotations)
The render strategy for annotations.
PDFTOOLS_EXPORT TPdfToolsPdf2Image_TiffLzwImageOptions *PDFTOOLS_CALL PdfToolsPdf2Image_TiffLzwImageOptions_New(void)
PDFTOOLS_EXPORT TPdfToolsPdf2Image_AnnotationOptions PDFTOOLS_CALL PdfToolsPdf2Image_ContentOptions_GetAnnotations(TPdfToolsPdf2Image_ContentOptions *pContentOptions)
The render strategy for annotations.
#define PDFTOOLS_CALL
Definition PdfTools_PdfToolsPdf2Image.h:26
PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfToolsPdf2Image_TiffJpegImageOptions_SetColorSpace(TPdfToolsPdf2Image_TiffJpegImageOptions *pTiffJpegImageOptions, const TPdfToolsPdf2Image_JpegColorSpace *pColorSpace)
The color space of the output image.
PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfToolsPdf2Image_TiffFlateImageOptions_SetColorSpace(TPdfToolsPdf2Image_TiffFlateImageOptions *pTiffFlateImageOptions, const TPdfToolsPdf2Image_ColorSpace *pColorSpace)
The color space of the output image.
PDFTOOLS_EXPORT TPdfToolsPdf2Image_PngColorSpace PDFTOOLS_CALL PdfToolsPdf2Image_PngImageOptions_GetColorSpace(TPdfToolsPdf2Image_PngImageOptions *pPngImageOptions)
The color space of the output image.
PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfToolsPdf2Image_TiffLzwImageOptions_SetColorSpace(TPdfToolsPdf2Image_TiffLzwImageOptions *pTiffLzwImageOptions, const TPdfToolsPdf2Image_ColorSpace *pColorSpace)
The color space of the output image.
PDFTOOLS_EXPORT TPdfToolsPdf2Image_TiffJpegImageOptions *PDFTOOLS_CALL PdfToolsPdf2Image_TiffJpegImageOptions_New(void)
PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfToolsPdf2Image_FaxImageOptions_SetVerticalResolution(TPdfToolsPdf2Image_FaxImageOptions *pFaxImageOptions, TPdfToolsPdf2Image_FaxVerticalResolution iVerticalResolution)
The vertical image resolution.
PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfToolsPdf2Image_RenderPageToMaxImageSize_GetSize(TPdfToolsPdf2Image_RenderPageToMaxImageSize *pRenderPageToMaxImageSize, TPdfToolsGeomInt_Size *pSize)
The maximum size of the image in pixels.
PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfToolsPdf2Image_TiffFlateImageOptions_SetBackground(TPdfToolsPdf2Image_TiffFlateImageOptions *pTiffFlateImageOptions, TPdfToolsPdf2Image_BackgroundType iBackground)
Combine a background with the image.
PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfToolsPdf2Image_RenderPageAtResolution_SetResolution(TPdfToolsPdf2Image_RenderPageAtResolution *pRenderPageAtResolution, const TPdfToolsGeomUnits_Resolution *pResolution)
The resolution of the output image Valid values are 0.0, 10000.0 or in between.
PDFTOOLS_EXPORT TPdfToolsPdf2Image_JpegImageOptions *PDFTOOLS_CALL PdfToolsPdf2Image_JpegImageOptions_New(void)
PDFTOOLS_EXPORT TPdfToolsPdf2Image_RenderPageAtResolution *PDFTOOLS_CALL PdfToolsPdf2Image_RenderPageAtResolution_New(const TPdfToolsGeomUnits_Resolution *pResolution)
#define PDFTOOLS_EXPORT
Definition PdfTools_Platform.h:143
TPdfToolsPdf2Image_PngColorSpace
The color space used in PNG images.
Definition PdfTools_Types.h:491
TPdfToolsPdf2Image_AnnotationOptions
Defines how to render annotations and their popups.
Definition PdfTools_Types.h:543
TPdfToolsPdf2Image_ImageOptionsType
Type and subtype enumeration of TPdfToolsPdf2Image_ImageOptions.
Definition PdfTools_Types.h:1949
TPdfToolsPdf2Image_ColorSpace
The color space used in various image formats.
Definition PdfTools_Types.h:520
TPdfToolsPdf2Image_JpegColorSpace
The color space used in JPEG images.
Definition PdfTools_Types.h:504
TPdfToolsPdf2Image_BackgroundType
The background type to use when rendering into an image.
Definition PdfTools_Types.h:471
TPdfToolsPdf2Image_ImageSectionMappingType
Type and subtype enumeration of TPdfToolsPdf2Image_ImageSectionMapping.
Definition PdfTools_Types.h:1976
TPdfToolsPdf2Image_TiffBitonalCompressionType
The compression type for bitonal (Fax) TIFF images.
Definition PdfTools_Types.h:450
#define BOOL
Definition PdfTools_Types.h:23
TPdfToolsPdf2Image_FaxVerticalResolution
The vertical resolution of Fax images The two resolutions available in Fax images.
Definition PdfTools_Types.h:435
The base class for image documents Image documents are either opened using PdfToolsImage_Document_Ope...
The image document of an image format that supports multi-page images This class is used for TIFF ima...
The parameters how to render PDF content elements.
The class to convert a PDF document to a rasterized image.
The settings for TIFF Fax output images Create a black-and-white (bitonal) TIFF Fax output image....
The base class for output image options.
The base class for image section mappings An image section mapping specifies how a PDF page,...
The settings for JPEG output images.
The settings for PNG output images For the output file name, it is recommended to use the file extens...
The image section mapping to render entire pages at a specific resolution.
The image section mapping to render entire pages using a specific image pixel size.
The settings for TIFF output images using the Flate compression algorithm.
The settings for TIFF output images using the JPEG compression algorithm.
The settings for TIFF output images using the LZW compression algorithm.
The base class for PDF to image conversion profiles The profile defines how the PDF pages are rendere...
The PDF document PDF documents are either opened using PdfToolsPdf_Document_Open or the result of an ...
Definition PdfTools_Types.h:3300
Definition PdfTools_Types.h:3314
Structure that groups a set of callbacks that model streams.
Definition PdfTools_PdfToolsSys.h:49