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 *****************************************************************************/
13
14#ifndef PDFTOOLS_PDFTOOLSPDF2IMAGE_H__
15#define PDFTOOLS_PDFTOOLSPDF2IMAGE_H__
16
17#ifndef PDFTOOLS_CALL
18#if defined(WIN32)
19#define PDFTOOLS_CALL __stdcall
20#else
21#define PDFTOOLS_CALL
22#endif
23#endif
24
25#include "PdfTools_Types.h"
27
28#ifdef __cplusplus
29extern "C"
30{
31#endif
32
33#ifdef _UNICODE
34#else
35#endif
36
37/******************************************************************************
38 * ContentOptions
39 *****************************************************************************/
82
98/******************************************************************************
99 * FaxImageOptions
100 *****************************************************************************/
195
196/******************************************************************************
197 * TiffJpegImageOptions
198 *****************************************************************************/
209
259 TPdfToolsPdf2Image_TiffJpegImageOptions* pTiffJpegImageOptions, int iJpegQuality);
303 const TPdfToolsPdf2Image_JpegColorSpace* pColorSpace);
304
305/******************************************************************************
306 * TiffLzwImageOptions
307 *****************************************************************************/
318
405 TPdfToolsPdf2Image_TiffLzwImageOptions* pTiffLzwImageOptions, const TPdfToolsPdf2Image_ColorSpace* pColorSpace);
406
407/******************************************************************************
408 * TiffFlateImageOptions
409 *****************************************************************************/
421
487 TPdfToolsPdf2Image_TiffFlateImageOptions* pTiffFlateImageOptions, TPdfToolsPdf2Image_ColorSpace* pColorSpace);
508 TPdfToolsPdf2Image_TiffFlateImageOptions* pTiffFlateImageOptions, const TPdfToolsPdf2Image_ColorSpace* pColorSpace);
509
510/******************************************************************************
511 * PngImageOptions
512 *****************************************************************************/
523
606
607/******************************************************************************
608 * JpegImageOptions
609 *****************************************************************************/
620
665 TPdfToolsPdf2Image_JpegImageOptions* pJpegImageOptions, const TPdfToolsPdf2Image_JpegColorSpace* pColorSpace);
715 TPdfToolsPdf2Image_JpegImageOptions* pJpegImageOptions, int iJpegQuality);
716
732/******************************************************************************
733 * RenderPageAtResolution
734 *****************************************************************************/
752
770 TPdfToolsPdf2Image_RenderPageAtResolution* pRenderPageAtResolution, TPdfToolsGeomUnits_Resolution* pResolution);
788 TPdfToolsPdf2Image_RenderPageAtResolution* pRenderPageAtResolution,
789 const TPdfToolsGeomUnits_Resolution* pResolution);
790
791/******************************************************************************
792 * RenderPageToMaxImageSize
793 *****************************************************************************/
811
835 TPdfToolsPdf2Image_RenderPageToMaxImageSize* pRenderPageToMaxImageSize, TPdfToolsGeomInt_Size* pSize);
859 TPdfToolsPdf2Image_RenderPageToMaxImageSize* pRenderPageToMaxImageSize, const TPdfToolsGeomInt_Size* pSize);
860
861/******************************************************************************
862 * Converter
863 *****************************************************************************/
874
969 const TPdfToolsSys_StreamDescriptor* pOutStreamDesc, TPdfToolsPdf2ImageProfiles_Profile* pProfile, int iPageNumber);
970
971#ifdef __cplusplus
972}
973#endif
974
975#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:21
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:138
struct TPdfToolsPdf2Image_ImageSectionMapping TPdfToolsPdf2Image_ImageSectionMapping
The base class for image section mappings An image section mapping specifies how a PDF page,...
Definition PdfTools_Types.h:2535
TPdfToolsPdf2Image_PngColorSpace
The color space used in PNG images.
Definition PdfTools_Types.h:460
struct TPdfToolsPdf2Image_ContentOptions TPdfToolsPdf2Image_ContentOptions
The parameters how to render PDF content elements.
Definition PdfTools_Types.h:2467
TPdfToolsPdf2Image_AnnotationOptions
Defines how to render annotations and their popups.
Definition PdfTools_Types.h:512
struct TPdfToolsPdf2Image_Converter TPdfToolsPdf2Image_Converter
The class to convert a PDF document to a rasterized image.
Definition PdfTools_Types.h:2571
struct TPdfToolsPdf2Image_PngImageOptions TPdfToolsPdf2Image_PngImageOptions
The settings for PNG output images For the output file name, it is recommended to use the file extens...
Definition PdfTools_Types.h:2517
TPdfToolsPdf2Image_ImageOptionsType
Type and subtype enumeration of TPdfToolsPdf2Image_ImageOptions.
Definition PdfTools_Types.h:1881
struct TPdfToolsPdf2Image_JpegImageOptions TPdfToolsPdf2Image_JpegImageOptions
The settings for JPEG output images.
Definition PdfTools_Types.h:2527
struct TPdfToolsImage_MultiPageDocument TPdfToolsImage_MultiPageDocument
The image document of an image format that supports multi-page images This class is used for TIFF ima...
Definition PdfTools_Types.h:2322
TPdfToolsPdf2Image_ColorSpace
The color space used in various image formats.
Definition PdfTools_Types.h:489
struct TPdfToolsPdf2Image_ImageOptions TPdfToolsPdf2Image_ImageOptions
The base class for output image options.
Definition PdfTools_Types.h:2471
TPdfToolsPdf2Image_JpegColorSpace
The color space used in JPEG images.
Definition PdfTools_Types.h:473
struct TPdfToolsPdf2Image_TiffFlateImageOptions TPdfToolsPdf2Image_TiffFlateImageOptions
The settings for TIFF output images using the Flate compression algorithm.
Definition PdfTools_Types.h:2511
TPdfToolsPdf2Image_BackgroundType
The background type to use when rendering into an image.
Definition PdfTools_Types.h:440
struct TPdfToolsPdf2Image_RenderPageAtResolution TPdfToolsPdf2Image_RenderPageAtResolution
The image section mapping to render entire pages at a specific resolution.
Definition PdfTools_Types.h:2556
struct TPdfToolsPdf2Image_RenderPageToMaxImageSize TPdfToolsPdf2Image_RenderPageToMaxImageSize
The image section mapping to render entire pages using a specific image pixel size.
Definition PdfTools_Types.h:2567
struct TPdfToolsPdf2ImageProfiles_Profile TPdfToolsPdf2ImageProfiles_Profile
The base class for PDF to image conversion profiles The profile defines how the PDF pages are rendere...
Definition PdfTools_Types.h:2580
struct TPdfToolsPdf2Image_TiffJpegImageOptions TPdfToolsPdf2Image_TiffJpegImageOptions
The settings for TIFF output images using the JPEG compression algorithm.
Definition PdfTools_Types.h:2490
TPdfToolsPdf2Image_ImageSectionMappingType
Type and subtype enumeration of TPdfToolsPdf2Image_ImageSectionMapping.
Definition PdfTools_Types.h:1909
TPdfToolsPdf2Image_TiffBitonalCompressionType
The compression type for bitonal (Fax) TIFF images.
Definition PdfTools_Types.h:419
struct TPdfToolsImage_Document TPdfToolsImage_Document
The base class for image documents Image documents are either opened using PdfToolsImage_Document_Ope...
Definition PdfTools_Types.h:2303
#define BOOL
Definition PdfTools_Types.h:18
struct TPdfToolsPdf2Image_FaxImageOptions TPdfToolsPdf2Image_FaxImageOptions
The settings for TIFF Fax output images Create a black-and-white (bitonal) TIFF Fax output image....
Definition PdfTools_Types.h:2478
struct TPdfToolsPdf2Image_TiffLzwImageOptions TPdfToolsPdf2Image_TiffLzwImageOptions
The settings for TIFF output images using the LZW compression algorithm.
Definition PdfTools_Types.h:2501
struct TPdfToolsPdf_Document TPdfToolsPdf_Document
The PDF document PDF documents are either opened using PdfToolsPdf_Document_Open or the result of an ...
Definition PdfTools_Types.h:2224
TPdfToolsPdf2Image_FaxVerticalResolution
The vertical resolution of Fax images The two resolutions available in Fax images.
Definition PdfTools_Types.h:404
Definition PdfTools_Types.h:3110
Definition PdfTools_Types.h:3124
Structure that groups a set of callbacks that model streams.
Definition PdfTools_PdfToolsSys.h:44