Pdftools SDK
Loading...
Searching...
No Matches
include
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
"
31
#include "
PdfTools_PdfToolsSys.h
"
32
33
#ifdef __cplusplus
34
extern
"C"
35
{
36
#endif
37
38
#ifdef _UNICODE
39
#else
40
#endif
41
42
/******************************************************************************
43
* Profile
44
*****************************************************************************/
57
PDFTOOLS_EXPORT
TPdfToolsOptimization_ImageRecompressionOptions
*
PDFTOOLS_CALL
58
PdfToolsOptimizationProfiles_Profile_GetImageRecompressionOptions
(
TPdfToolsOptimizationProfiles_Profile
* pProfile);
71
PDFTOOLS_EXPORT
TPdfToolsOptimization_FontOptions
*
PDFTOOLS_CALL
72
PdfToolsOptimizationProfiles_Profile_GetFontOptions
(
TPdfToolsOptimizationProfiles_Profile
* pProfile);
85
PDFTOOLS_EXPORT
TPdfToolsOptimization_RemovalOptions
*
PDFTOOLS_CALL
86
PdfToolsOptimizationProfiles_Profile_GetRemovalOptions
(
TPdfToolsOptimizationProfiles_Profile
* pProfile);
103
PDFTOOLS_EXPORT
BOOL
PDFTOOLS_CALL
104
PdfToolsOptimizationProfiles_Profile_GetCopyMetadata
(
TPdfToolsOptimizationProfiles_Profile
* pProfile);
121
PDFTOOLS_EXPORT
BOOL
PDFTOOLS_CALL
PdfToolsOptimizationProfiles_Profile_SetCopyMetadata
(
122
TPdfToolsOptimizationProfiles_Profile
* pProfile,
BOOL
bCopyMetadata);
123
137
PDFTOOLS_EXPORT
TPdfToolsOptimizationProfiles_ProfileType
PDFTOOLS_CALL
138
PdfToolsOptimizationProfiles_Profile_GetType
(
TPdfToolsOptimizationProfiles_Profile
* pProfile);
139
/******************************************************************************
140
* Web
141
*****************************************************************************/
150
PDFTOOLS_EXPORT
TPdfToolsOptimizationProfiles_Web
*
PDFTOOLS_CALL
PdfToolsOptimizationProfiles_Web_New
(
void
);
151
180
PDFTOOLS_EXPORT
BOOL
PDFTOOLS_CALL
181
PdfToolsOptimizationProfiles_Web_GetResolutionDPI
(
TPdfToolsOptimizationProfiles_Web
* pWeb,
double
* pResolutionDPI);
209
PDFTOOLS_EXPORT
BOOL
PDFTOOLS_CALL
PdfToolsOptimizationProfiles_Web_SetResolutionDPI
(
210
TPdfToolsOptimizationProfiles_Web
* pWeb,
const
double
* pResolutionDPI);
234
PDFTOOLS_EXPORT
double
PDFTOOLS_CALL
235
PdfToolsOptimizationProfiles_Web_GetThresholdDPI
(
TPdfToolsOptimizationProfiles_Web
* pWeb);
260
PDFTOOLS_EXPORT
BOOL
PDFTOOLS_CALL
261
PdfToolsOptimizationProfiles_Web_SetThresholdDPI
(
TPdfToolsOptimizationProfiles_Web
* pWeb,
double
dThresholdDPI);
262
263
/******************************************************************************
264
* Print
265
*****************************************************************************/
274
PDFTOOLS_EXPORT
TPdfToolsOptimizationProfiles_Print
*
PDFTOOLS_CALL
PdfToolsOptimizationProfiles_Print_New
(
void
);
275
276
/******************************************************************************
277
* Archive
278
*****************************************************************************/
287
PDFTOOLS_EXPORT
TPdfToolsOptimizationProfiles_Archive
*
PDFTOOLS_CALL
PdfToolsOptimizationProfiles_Archive_New
(
void
);
288
289
/******************************************************************************
290
* MinimalFileSize
291
*****************************************************************************/
300
PDFTOOLS_EXPORT
TPdfToolsOptimizationProfiles_MinimalFileSize
*
PDFTOOLS_CALL
301
PdfToolsOptimizationProfiles_MinimalFileSize_New
(
void
);
302
332
PDFTOOLS_EXPORT
BOOL
PDFTOOLS_CALL
PdfToolsOptimizationProfiles_MinimalFileSize_GetResolutionDPI
(
333
TPdfToolsOptimizationProfiles_MinimalFileSize
* pMinimalFileSize,
double
* pResolutionDPI);
362
PDFTOOLS_EXPORT
BOOL
PDFTOOLS_CALL
PdfToolsOptimizationProfiles_MinimalFileSize_SetResolutionDPI
(
363
TPdfToolsOptimizationProfiles_MinimalFileSize
* pMinimalFileSize,
const
double
* pResolutionDPI);
389
PDFTOOLS_EXPORT
double
PDFTOOLS_CALL
PdfToolsOptimizationProfiles_MinimalFileSize_GetThresholdDPI
(
390
TPdfToolsOptimizationProfiles_MinimalFileSize
* pMinimalFileSize);
417
PDFTOOLS_EXPORT
BOOL
PDFTOOLS_CALL
PdfToolsOptimizationProfiles_MinimalFileSize_SetThresholdDPI
(
418
TPdfToolsOptimizationProfiles_MinimalFileSize
* pMinimalFileSize,
double
dThresholdDPI);
419
420
/******************************************************************************
421
* Mrc
422
*****************************************************************************/
431
PDFTOOLS_EXPORT
TPdfToolsOptimizationProfiles_Mrc
*
PDFTOOLS_CALL
PdfToolsOptimizationProfiles_Mrc_New
(
void
);
432
456
PDFTOOLS_EXPORT
double
PDFTOOLS_CALL
457
PdfToolsOptimizationProfiles_Mrc_GetLayerCompressionQuality
(
TPdfToolsOptimizationProfiles_Mrc
* pMrc);
482
PDFTOOLS_EXPORT
BOOL
PDFTOOLS_CALL
PdfToolsOptimizationProfiles_Mrc_SetLayerCompressionQuality
(
483
TPdfToolsOptimizationProfiles_Mrc
* pMrc,
double
dLayerCompressionQuality);
507
PDFTOOLS_EXPORT
BOOL
PDFTOOLS_CALL
PdfToolsOptimizationProfiles_Mrc_GetLayerResolutionDPI
(
508
TPdfToolsOptimizationProfiles_Mrc
* pMrc,
double
* pLayerResolutionDPI);
531
PDFTOOLS_EXPORT
BOOL
PDFTOOLS_CALL
PdfToolsOptimizationProfiles_Mrc_SetLayerResolutionDPI
(
532
TPdfToolsOptimizationProfiles_Mrc
* pMrc,
const
double
* pLayerResolutionDPI);
552
PDFTOOLS_EXPORT
BOOL
PDFTOOLS_CALL
553
PdfToolsOptimizationProfiles_Mrc_GetRecognizePictures
(
TPdfToolsOptimizationProfiles_Mrc
* pMrc);
573
PDFTOOLS_EXPORT
BOOL
PDFTOOLS_CALL
574
PdfToolsOptimizationProfiles_Mrc_SetRecognizePictures
(
TPdfToolsOptimizationProfiles_Mrc
* pMrc,
BOOL
bRecognizePictures);
575
576
#ifdef __cplusplus
577
}
578
#endif
579
580
#endif
/* PDFTOOLS_PDFTOOLSOPTIMIZATIONPROFILES_H__ */
PdfToolsOptimizationProfiles_Profile_GetType
PDFTOOLS_EXPORT TPdfToolsOptimizationProfiles_ProfileType PDFTOOLS_CALL PdfToolsOptimizationProfiles_Profile_GetType(TPdfToolsOptimizationProfiles_Profile *pProfile)
Get actual derived type of base type TPdfToolsOptimizationProfiles_Profile.
PdfToolsOptimizationProfiles_Mrc_SetLayerResolutionDPI
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.
PdfToolsOptimizationProfiles_Web_SetThresholdDPI
PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfToolsOptimizationProfiles_Web_SetThresholdDPI(TPdfToolsOptimizationProfiles_Web *pWeb, double dThresholdDPI)
The threshold resolution of images in DPI.
PdfToolsOptimizationProfiles_MinimalFileSize_GetThresholdDPI
PDFTOOLS_EXPORT double PDFTOOLS_CALL PdfToolsOptimizationProfiles_MinimalFileSize_GetThresholdDPI(TPdfToolsOptimizationProfiles_MinimalFileSize *pMinimalFileSize)
The threshold resolution of images in DPI.
PdfToolsOptimizationProfiles_Mrc_GetRecognizePictures
PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfToolsOptimizationProfiles_Mrc_GetRecognizePictures(TPdfToolsOptimizationProfiles_Mrc *pMrc)
The option to recognize photographic regions when doing MRC.
PdfToolsOptimizationProfiles_MinimalFileSize_SetResolutionDPI
PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfToolsOptimizationProfiles_MinimalFileSize_SetResolutionDPI(TPdfToolsOptimizationProfiles_MinimalFileSize *pMinimalFileSize, const double *pResolutionDPI)
The target resolution of images in DPI.
PdfToolsOptimizationProfiles_Web_New
PDFTOOLS_EXPORT TPdfToolsOptimizationProfiles_Web *PDFTOOLS_CALL PdfToolsOptimizationProfiles_Web_New(void)
PdfToolsOptimizationProfiles_Web_SetResolutionDPI
PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfToolsOptimizationProfiles_Web_SetResolutionDPI(TPdfToolsOptimizationProfiles_Web *pWeb, const double *pResolutionDPI)
The target resolution of images in DPI.
PdfToolsOptimizationProfiles_MinimalFileSize_New
PDFTOOLS_EXPORT TPdfToolsOptimizationProfiles_MinimalFileSize *PDFTOOLS_CALL PdfToolsOptimizationProfiles_MinimalFileSize_New(void)
PdfToolsOptimizationProfiles_Mrc_GetLayerResolutionDPI
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.
PdfToolsOptimizationProfiles_Web_GetResolutionDPI
PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfToolsOptimizationProfiles_Web_GetResolutionDPI(TPdfToolsOptimizationProfiles_Web *pWeb, double *pResolutionDPI)
The target resolution of images in DPI.
PdfToolsOptimizationProfiles_Profile_GetImageRecompressionOptions
PDFTOOLS_EXPORT TPdfToolsOptimization_ImageRecompressionOptions *PDFTOOLS_CALL PdfToolsOptimizationProfiles_Profile_GetImageRecompressionOptions(TPdfToolsOptimizationProfiles_Profile *pProfile)
The image recompression options.
PdfToolsOptimizationProfiles_Archive_New
PDFTOOLS_EXPORT TPdfToolsOptimizationProfiles_Archive *PDFTOOLS_CALL PdfToolsOptimizationProfiles_Archive_New(void)
PdfToolsOptimizationProfiles_Web_GetThresholdDPI
PDFTOOLS_EXPORT double PDFTOOLS_CALL PdfToolsOptimizationProfiles_Web_GetThresholdDPI(TPdfToolsOptimizationProfiles_Web *pWeb)
The threshold resolution of images in DPI.
PdfToolsOptimizationProfiles_MinimalFileSize_SetThresholdDPI
PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfToolsOptimizationProfiles_MinimalFileSize_SetThresholdDPI(TPdfToolsOptimizationProfiles_MinimalFileSize *pMinimalFileSize, double dThresholdDPI)
The threshold resolution of images in DPI.
PdfToolsOptimizationProfiles_Profile_GetCopyMetadata
PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfToolsOptimizationProfiles_Profile_GetCopyMetadata(TPdfToolsOptimizationProfiles_Profile *pProfile)
Whether to copy metadata Copy document information dictionary and XMP metadata. Default: TRUE.
PdfToolsOptimizationProfiles_MinimalFileSize_GetResolutionDPI
PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfToolsOptimizationProfiles_MinimalFileSize_GetResolutionDPI(TPdfToolsOptimizationProfiles_MinimalFileSize *pMinimalFileSize, double *pResolutionDPI)
The target resolution of images in DPI.
PdfToolsOptimizationProfiles_Print_New
PDFTOOLS_EXPORT TPdfToolsOptimizationProfiles_Print *PDFTOOLS_CALL PdfToolsOptimizationProfiles_Print_New(void)
PdfToolsOptimizationProfiles_Profile_SetCopyMetadata
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.
PdfToolsOptimizationProfiles_Mrc_SetLayerCompressionQuality
PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfToolsOptimizationProfiles_Mrc_SetLayerCompressionQuality(TPdfToolsOptimizationProfiles_Mrc *pMrc, double dLayerCompressionQuality)
The image quality for MRC foreground and background layers.
PdfToolsOptimizationProfiles_Mrc_New
PDFTOOLS_EXPORT TPdfToolsOptimizationProfiles_Mrc *PDFTOOLS_CALL PdfToolsOptimizationProfiles_Mrc_New(void)
PDFTOOLS_CALL
#define PDFTOOLS_CALL
Definition
PdfTools_PdfToolsOptimizationProfiles.h:26
PdfToolsOptimizationProfiles_Profile_GetRemovalOptions
PDFTOOLS_EXPORT TPdfToolsOptimization_RemovalOptions *PDFTOOLS_CALL PdfToolsOptimizationProfiles_Profile_GetRemovalOptions(TPdfToolsOptimizationProfiles_Profile *pProfile)
The parameters defining the optional data to remove or flatten.
PdfToolsOptimizationProfiles_Profile_GetFontOptions
PDFTOOLS_EXPORT TPdfToolsOptimization_FontOptions *PDFTOOLS_CALL PdfToolsOptimizationProfiles_Profile_GetFontOptions(TPdfToolsOptimizationProfiles_Profile *pProfile)
The font optimization options.
PdfToolsOptimizationProfiles_Mrc_GetLayerCompressionQuality
PDFTOOLS_EXPORT double PDFTOOLS_CALL PdfToolsOptimizationProfiles_Mrc_GetLayerCompressionQuality(TPdfToolsOptimizationProfiles_Mrc *pMrc)
The image quality for MRC foreground and background layers.
PdfToolsOptimizationProfiles_Mrc_SetRecognizePictures
PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfToolsOptimizationProfiles_Mrc_SetRecognizePictures(TPdfToolsOptimizationProfiles_Mrc *pMrc, BOOL bRecognizePictures)
The option to recognize photographic regions when doing MRC.
PdfTools_PdfToolsSys.h
PDFTOOLS_EXPORT
#define PDFTOOLS_EXPORT
Definition
PdfTools_Platform.h:143
PdfTools_Types.h
TPdfToolsOptimizationProfiles_ProfileType
TPdfToolsOptimizationProfiles_ProfileType
Type and subtype enumeration of TPdfToolsOptimizationProfiles_Profile.
Definition
PdfTools_Types.h:1923
BOOL
#define BOOL
Definition
PdfTools_Types.h:23
TPdfToolsOptimization_FontOptions
The parameters for font optimization.
TPdfToolsOptimization_ImageRecompressionOptions
The parameters for image recompression.
TPdfToolsOptimization_RemovalOptions
The parameters defining the optional data to remove or flatten.
TPdfToolsOptimizationProfiles_Archive
The optimization profile suitable for archiving.
TPdfToolsOptimizationProfiles_MinimalFileSize
The optimization profile producing a minimal file size.
TPdfToolsOptimizationProfiles_Mrc
The optimization profile suitable for documents with Mixed Raster Content Reduce the file size for do...
TPdfToolsOptimizationProfiles_Print
The optimization profile suitable for printing.
TPdfToolsOptimizationProfiles_Profile
The base class for PDF optimization profiles The profile defines the optimization parameters suitable...
TPdfToolsOptimizationProfiles_Web
The optimization profile suitable for electronic document exchange.
Generated by
1.10.0