Pdftools SDK
Loading...
Searching...
No Matches
PdfTools_PdfToolsOptimizationProfiles.h
Go to the documentation of this file.
1/******************************************************************************
2 *
3 * File: PdfTools_PdfToolsOptimizationProfiles.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_PDFTOOLSOPTIMIZATIONPROFILES_H__
20#define PDFTOOLS_PDFTOOLSOPTIMIZATIONPROFILES_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 * Profile
44 *****************************************************************************/
122 TPdfToolsOptimizationProfiles_Profile* pProfile, BOOL bCopyMetadata);
123
139/******************************************************************************
140 * Web
141 *****************************************************************************/
151
210 TPdfToolsOptimizationProfiles_Web* pWeb, const double* pResolutionDPI);
262
263/******************************************************************************
264 * Print
265 *****************************************************************************/
275
276/******************************************************************************
277 * Archive
278 *****************************************************************************/
288
289/******************************************************************************
290 * MinimalFileSize
291 *****************************************************************************/
302
333 TPdfToolsOptimizationProfiles_MinimalFileSize* pMinimalFileSize, double* pResolutionDPI);
363 TPdfToolsOptimizationProfiles_MinimalFileSize* pMinimalFileSize, const double* pResolutionDPI);
418 TPdfToolsOptimizationProfiles_MinimalFileSize* pMinimalFileSize, double dThresholdDPI);
419
420/******************************************************************************
421 * Mrc
422 *****************************************************************************/
432
483 TPdfToolsOptimizationProfiles_Mrc* pMrc, double dLayerCompressionQuality);
508 TPdfToolsOptimizationProfiles_Mrc* pMrc, double* pLayerResolutionDPI);
532 TPdfToolsOptimizationProfiles_Mrc* pMrc, const double* pLayerResolutionDPI);
575
576#ifdef __cplusplus
577}
578#endif
579
580#endif /* PDFTOOLS_PDFTOOLSOPTIMIZATIONPROFILES_H__ */
PDFTOOLS_EXPORT TPdfToolsOptimizationProfiles_ProfileType PDFTOOLS_CALL PdfToolsOptimizationProfiles_Profile_GetType(TPdfToolsOptimizationProfiles_Profile *pProfile)
Get actual derived type of base type TPdfToolsOptimizationProfiles_Profile.
PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfToolsOptimizationProfiles_Mrc_SetLayerResolutionDPI(TPdfToolsOptimizationProfiles_Mrc *pMrc, const double *pLayerResolutionDPI)
The target resolution in DPI (dots per inch) for downsampling MRC foreground and background layers.
PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfToolsOptimizationProfiles_Web_SetThresholdDPI(TPdfToolsOptimizationProfiles_Web *pWeb, double dThresholdDPI)
The threshold resolution of images in DPI.
PDFTOOLS_EXPORT double PDFTOOLS_CALL PdfToolsOptimizationProfiles_MinimalFileSize_GetThresholdDPI(TPdfToolsOptimizationProfiles_MinimalFileSize *pMinimalFileSize)
The threshold resolution of images in DPI.
PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfToolsOptimizationProfiles_Mrc_GetRecognizePictures(TPdfToolsOptimizationProfiles_Mrc *pMrc)
The option to recognize photographic regions when doing MRC.
PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfToolsOptimizationProfiles_MinimalFileSize_SetResolutionDPI(TPdfToolsOptimizationProfiles_MinimalFileSize *pMinimalFileSize, const double *pResolutionDPI)
The target resolution of images in DPI.
PDFTOOLS_EXPORT TPdfToolsOptimizationProfiles_Web *PDFTOOLS_CALL PdfToolsOptimizationProfiles_Web_New(void)
PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfToolsOptimizationProfiles_Web_SetResolutionDPI(TPdfToolsOptimizationProfiles_Web *pWeb, const double *pResolutionDPI)
The target resolution of images in DPI.
PDFTOOLS_EXPORT TPdfToolsOptimizationProfiles_MinimalFileSize *PDFTOOLS_CALL PdfToolsOptimizationProfiles_MinimalFileSize_New(void)
PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfToolsOptimizationProfiles_Mrc_GetLayerResolutionDPI(TPdfToolsOptimizationProfiles_Mrc *pMrc, double *pLayerResolutionDPI)
The target resolution in DPI (dots per inch) for downsampling MRC foreground and background layers.
PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfToolsOptimizationProfiles_Web_GetResolutionDPI(TPdfToolsOptimizationProfiles_Web *pWeb, double *pResolutionDPI)
The target resolution of images in DPI.
PDFTOOLS_EXPORT TPdfToolsOptimization_ImageRecompressionOptions *PDFTOOLS_CALL PdfToolsOptimizationProfiles_Profile_GetImageRecompressionOptions(TPdfToolsOptimizationProfiles_Profile *pProfile)
The image recompression options.
PDFTOOLS_EXPORT TPdfToolsOptimizationProfiles_Archive *PDFTOOLS_CALL PdfToolsOptimizationProfiles_Archive_New(void)
PDFTOOLS_EXPORT double PDFTOOLS_CALL PdfToolsOptimizationProfiles_Web_GetThresholdDPI(TPdfToolsOptimizationProfiles_Web *pWeb)
The threshold resolution of images in DPI.
PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfToolsOptimizationProfiles_MinimalFileSize_SetThresholdDPI(TPdfToolsOptimizationProfiles_MinimalFileSize *pMinimalFileSize, double dThresholdDPI)
The threshold resolution of images in DPI.
PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfToolsOptimizationProfiles_Profile_GetCopyMetadata(TPdfToolsOptimizationProfiles_Profile *pProfile)
Whether to copy metadata Copy document information dictionary and XMP metadata. Default: TRUE.
PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfToolsOptimizationProfiles_MinimalFileSize_GetResolutionDPI(TPdfToolsOptimizationProfiles_MinimalFileSize *pMinimalFileSize, double *pResolutionDPI)
The target resolution of images in DPI.
PDFTOOLS_EXPORT TPdfToolsOptimizationProfiles_Print *PDFTOOLS_CALL PdfToolsOptimizationProfiles_Print_New(void)
PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfToolsOptimizationProfiles_Profile_SetCopyMetadata(TPdfToolsOptimizationProfiles_Profile *pProfile, BOOL bCopyMetadata)
Whether to copy metadata Copy document information dictionary and XMP metadata. Default: TRUE.
PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfToolsOptimizationProfiles_Mrc_SetLayerCompressionQuality(TPdfToolsOptimizationProfiles_Mrc *pMrc, double dLayerCompressionQuality)
The image quality for MRC foreground and background layers.
PDFTOOLS_EXPORT TPdfToolsOptimizationProfiles_Mrc *PDFTOOLS_CALL PdfToolsOptimizationProfiles_Mrc_New(void)
#define PDFTOOLS_CALL
Definition PdfTools_PdfToolsOptimizationProfiles.h:26
PDFTOOLS_EXPORT TPdfToolsOptimization_RemovalOptions *PDFTOOLS_CALL PdfToolsOptimizationProfiles_Profile_GetRemovalOptions(TPdfToolsOptimizationProfiles_Profile *pProfile)
The parameters defining the optional data to remove or flatten.
PDFTOOLS_EXPORT TPdfToolsOptimization_FontOptions *PDFTOOLS_CALL PdfToolsOptimizationProfiles_Profile_GetFontOptions(TPdfToolsOptimizationProfiles_Profile *pProfile)
The font optimization options.
PDFTOOLS_EXPORT double PDFTOOLS_CALL PdfToolsOptimizationProfiles_Mrc_GetLayerCompressionQuality(TPdfToolsOptimizationProfiles_Mrc *pMrc)
The image quality for MRC foreground and background layers.
PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfToolsOptimizationProfiles_Mrc_SetRecognizePictures(TPdfToolsOptimizationProfiles_Mrc *pMrc, BOOL bRecognizePictures)
The option to recognize photographic regions when doing MRC.
#define PDFTOOLS_EXPORT
Definition PdfTools_Platform.h:143
TPdfToolsOptimizationProfiles_ProfileType
Type and subtype enumeration of TPdfToolsOptimizationProfiles_Profile.
Definition PdfTools_Types.h:1923
#define BOOL
Definition PdfTools_Types.h:23
The parameters for font optimization.
The parameters for image recompression.
The parameters defining the optional data to remove or flatten.
The optimization profile suitable for archiving.
The optimization profile producing a minimal file size.
The optimization profile suitable for documents with Mixed Raster Content Reduce the file size for do...
The optimization profile suitable for printing.
The base class for PDF optimization profiles The profile defines the optimization parameters suitable...
The optimization profile suitable for electronic document exchange.