# FlattenTransparencyParams Class

> Represents control parameters for flattening transparencies within a PDF file.

- Product: Adobe PDF Library 21
- Language: Modern C++
- Version: 21.4.0
- HTML page: https://docs.datalogics.com/apdfl21/ModernCPP/21.4.0/class/FlattenTransparencyParams
- Version index: https://docs.datalogics.com/apdfl21/ModernCPP/21.4.0/llms.txt

```cpp
class FlattenTransparencyParams
```

**Namespace:** `datalogics_interface`

## Description

Represents control parameters for flattening transparencies within a PDF file.

Class that represents control parameters for flattening transparencies within a PDF file. PDF files can hold objects that are stacked, and that are partially or fully transparent. This means that these objects can blend in various ways with objects behind them. With a stacked set of transparent graphics or images in a PDF file, each one contributing to the final result that appears on the page. One or more graphics images presented together in a stack is referred to as a transparency group. With a stack of transparent images, the final colors shown are the result of blending the colors of all of the overlapping objects. Flatten Transparency merges a stack of transparent objects or graphics into a single image on the PDF page.

Flattening images in a PDF file is generally necessary before you can send the document to a printer. The flattening process simplifies the PDF file and may make it smaller as well.

**Uses types:** [`FlattenerColorCompression`](https://docs.datalogics.com/apdfl21/ModernCPP/21.4.0/enum/FlattenerColorCompression.md), [`FlattenerGrayCompression`](https://docs.datalogics.com/apdfl21/ModernCPP/21.4.0/enum/FlattenerGrayCompression.md), [`FlattenerMonoCompression`](https://docs.datalogics.com/apdfl21/ModernCPP/21.4.0/enum/FlattenerMonoCompression.md), [`FlattenerQualitySetting`](https://docs.datalogics.com/apdfl21/ModernCPP/21.4.0/enum/FlattenerQualitySetting.md)

## Constructors

### FlattenTransparencyParams

```cpp
datalogics_interface::FlattenTransparencyParams::FlattenTransparencyParams()
```

*constructor*

Set up default parameters for flattening transparency.

Defaults: UseTextOutlines = false, ConvertStrokesToOutlines = true, ClipComplexRegions = false, InternalDPI = 800, ExternalDPI = 200, PreserveOverprint = true, Quality = 100.

### FlattenTransparencyParams

```cpp
datalogics_interface::FlattenTransparencyParams::FlattenTransparencyParams(bool use_text_outlines, bool convert_strokes_to_outlines, bool clip_complex_regions, int internal_dpi, int external_dpi, bool preserve_overprint, int quality)
```

*constructor*

**Parameters**

- `use_text_outlines` (`bool`)
- `convert_strokes_to_outlines` (`bool`)
- `clip_complex_regions` (`bool`)
- `internal_dpi` (`int`)
- `external_dpi` (`int`)
- `preserve_overprint` (`bool`)
- `quality` (`int`)

Set up default parameters for flattening transparency.

Defaults: UseTextOutlines = false, ConvertStrokesToOutlines = true, ClipComplexRegions = false, InternalDPI = 800, ExternalDPI = 200, PreserveOverprint = true, Quality = 100.

### FlattenTransparencyParams

```cpp
datalogics_interface::FlattenTransparencyParams::FlattenTransparencyParams(const FlattenTransparencyParams &other)
```

*constructor*

**Parameters**

- `other` ([`const FlattenTransparencyParams &`](https://docs.datalogics.com/apdfl21/ModernCPP/21.4.0/class/FlattenTransparencyParams.md))

Copy constructor.

### FlattenTransparencyParams

```cpp
datalogics_interface::FlattenTransparencyParams::FlattenTransparencyParams(FlattenTransparencyParams &&) noexcept
```

*constructor*

**Parameters**

- (unnamed) ([`FlattenTransparencyParams &&`](https://docs.datalogics.com/apdfl21/ModernCPP/21.4.0/class/FlattenTransparencyParams.md))

### ~FlattenTransparencyParams

```cpp
datalogics_interface::FlattenTransparencyParams::~FlattenTransparencyParams()
```

*destructor*

## Methods

### get_clip_complex_regions

```cpp
bool datalogics_interface::FlattenTransparencyParams::get_clip_complex_regions() const
```

**Returns:** `bool`

If true, ensure that boundaries between vector and rasterized artwork fall along object paths.

### get_color_compression

```cpp
FlattenerColorCompression datalogics_interface::FlattenTransparencyParams::get_color_compression() const
```

**Returns:** [`FlattenerColorCompression`](https://docs.datalogics.com/apdfl21/ModernCPP/21.4.0/enum/FlattenerColorCompression.md)

The compression scheme used for flattened color images. Default to JPEGCompression.

### get_color_image_quality

```cpp
FlattenerQualitySetting datalogics_interface::FlattenTransparencyParams::get_color_image_quality() const
```

**Returns:** [`FlattenerQualitySetting`](https://docs.datalogics.com/apdfl21/ModernCPP/21.4.0/enum/FlattenerQualitySetting.md)

Quality Setting for Flattened JPEG and JPEG2000 colored Images. This is valid only if the value of ColorCompressionScheme is equal to JPEGCompression or JPEG2000Compression Default value: High

### get_convert_strokes_to_outlines

```cpp
bool datalogics_interface::FlattenTransparencyParams::get_convert_strokes_to_outlines() const
```

**Returns:** `bool`

If true, convert strokes to outlines.

### get_external_dpi

```cpp
int datalogics_interface::FlattenTransparencyParams::get_external_dpi() const
```

**Returns:** `int`

Resolution for flattening edges of atomic regions. Range is 1 to 1200.

### get_gray_compression

```cpp
FlattenerGrayCompression datalogics_interface::FlattenTransparencyParams::get_gray_compression() const
```

**Returns:** [`FlattenerGrayCompression`](https://docs.datalogics.com/apdfl21/ModernCPP/21.4.0/enum/FlattenerGrayCompression.md)

The compression scheme used for flattened gray images. Default to GrayJPEGCompression.

### get_gray_image_quality

```cpp
FlattenerQualitySetting datalogics_interface::FlattenTransparencyParams::get_gray_image_quality() const
```

**Returns:** [`FlattenerQualitySetting`](https://docs.datalogics.com/apdfl21/ModernCPP/21.4.0/enum/FlattenerQualitySetting.md)

Quality Setting for Flattened JPEG and JPEG2000 gray Images. This is valid only if the value of GrayCompressionScheme is equal to GrayJPEGCompression or GrayJPEG2000Compression Default value: High

### get_internal_dpi

```cpp
int datalogics_interface::FlattenTransparencyParams::get_internal_dpi() const
```

**Returns:** `int`

Resolution for flattening the interior of an atomic region. Range is 1 to 9600.

### get_max_page_flattening_time

```cpp
int datalogics_interface::FlattenTransparencyParams::get_max_page_flattening_time() const
```

**Returns:** `int`

The maximum allowed time that will be spent flattening a single page. A value less than zero will disable the time limit. A value equal to 0 (default) will set the limit to 120 seconds. A value greater than 0 will set the allowed limit (in seconds). Any value less than 60 seconds will be increased to 60 seconds.

### get_mono_compression

```cpp
FlattenerMonoCompression datalogics_interface::FlattenTransparencyParams::get_mono_compression() const
```

**Returns:** [`FlattenerMonoCompression`](https://docs.datalogics.com/apdfl21/ModernCPP/21.4.0/enum/FlattenerMonoCompression.md)

The compression scheme used for flattened monochrome images. Default to MonoCCITTGroup4Compression.

### get_preserve_overprint

```cpp
bool datalogics_interface::FlattenTransparencyParams::get_preserve_overprint() const
```

**Returns:** `bool`

If true, attempt to preserve overprint.

### get_profile_description

```cpp
std::string datalogics_interface::FlattenTransparencyParams::get_profile_description() const
```

**Returns:** `std::string`

Represents control parameters for flattening transparencies within a PDF file.

Class that represents control parameters for flattening transparencies within a PDF file. PDF files can hold objects that are stacked, and that are partially or fully transparent. This means that these objects can blend in various ways with objects behind them. With a stacked set of transparent graphics or images in a PDF file, each one contributing to the final result that appears on the page. One or more graphics images presented together in a stack is referred to as a transparency group. With a stack of transparent images, the final colors shown are the result of blending the colors of all of the overlapping objects. Flatten Transparency merges a stack of transparent objects or graphics into a single image on the PDF page.

Flattening images in a PDF file is generally necessary before you can send the document to a printer. The flattening process simplifies the PDF file and may make it smaller as well.

### get_quality

```cpp
int datalogics_interface::FlattenTransparencyParams::get_quality() const
```

**Returns:** `int`

The percentage of vector information that is to be preserved. Lower values will cause higher rasterization of vectors. Range is 0 to 100.

### get_use_text_outlines

```cpp
bool datalogics_interface::FlattenTransparencyParams::get_use_text_outlines() const
```

**Returns:** `bool`

If true, output text outlines instead of native text.

### operator=

```cpp
FlattenTransparencyParams & datalogics_interface::FlattenTransparencyParams::operator=(const FlattenTransparencyParams &other)
```

**Parameters**

- `other` ([`const FlattenTransparencyParams &`](https://docs.datalogics.com/apdfl21/ModernCPP/21.4.0/class/FlattenTransparencyParams.md))

**Returns:** [`FlattenTransparencyParams &`](https://docs.datalogics.com/apdfl21/ModernCPP/21.4.0/class/FlattenTransparencyParams.md)

Copy assignment.

### operator=

```cpp
FlattenTransparencyParams & datalogics_interface::FlattenTransparencyParams::operator=(FlattenTransparencyParams &&) noexcept
```

**Parameters**

- (unnamed) ([`FlattenTransparencyParams &&`](https://docs.datalogics.com/apdfl21/ModernCPP/21.4.0/class/FlattenTransparencyParams.md))

**Returns:** [`FlattenTransparencyParams &`](https://docs.datalogics.com/apdfl21/ModernCPP/21.4.0/class/FlattenTransparencyParams.md)

### set_clip_complex_regions

```cpp
void datalogics_interface::FlattenTransparencyParams::set_clip_complex_regions(bool value)
```

**Parameters**

- `value` (`bool`): true to ensure that boundaries between vector and rasterized artwork fall along object paths, false otherwise.

**Returns:** `void`

If true, ensure that boundaries between vector and rasterized artwork fall along object paths.

### set_color_compression

```cpp
void datalogics_interface::FlattenTransparencyParams::set_color_compression(FlattenerColorCompression scheme)
```

**Parameters**

- `scheme` ([`FlattenerColorCompression`](https://docs.datalogics.com/apdfl21/ModernCPP/21.4.0/enum/FlattenerColorCompression.md)): the compression scheme used for flattened color images. Default to JPEGCompression

**Returns:** `void`

The compression scheme used for flattened color images. Default to JPEGCompression.

### set_color_image_quality

```cpp
void datalogics_interface::FlattenTransparencyParams::set_color_image_quality(FlattenerQualitySetting quality)
```

**Parameters**

- `quality` ([`FlattenerQualitySetting`](https://docs.datalogics.com/apdfl21/ModernCPP/21.4.0/enum/FlattenerQualitySetting.md)): the quality Setting for Flattened JPEG and JPEG2000 colored Images. This is valid only if the value of ColorCompressi... Default value: High

**Returns:** `void`

Quality Setting for Flattened JPEG and JPEG2000 colored Images. This is valid only if the value of ColorCompressionScheme is equal to JPEGCompression or JPEG2000Compression

### set_convert_strokes_to_outlines

```cpp
void datalogics_interface::FlattenTransparencyParams::set_convert_strokes_to_outlines(bool value)
```

**Parameters**

- `value` (`bool`): true to convert strokes to outlines, false otherwise.

**Returns:** `void`

If true, convert strokes to outlines.

### set_external_dpi

```cpp
void datalogics_interface::FlattenTransparencyParams::set_external_dpi(int dpi)
```

**Parameters**

- `dpi` (`int`): the resolution for flattening edges of atomic regions. Range is 1 to 1200

**Returns:** `void`

Resolution for flattening edges of atomic regions. Range is 1 to 1200.

### set_gray_compression

```cpp
void datalogics_interface::FlattenTransparencyParams::set_gray_compression(FlattenerGrayCompression scheme)
```

**Parameters**

- `scheme` ([`FlattenerGrayCompression`](https://docs.datalogics.com/apdfl21/ModernCPP/21.4.0/enum/FlattenerGrayCompression.md)): the compression scheme used for flattened gray images. Default to GrayJPEGCompression

**Returns:** `void`

The compression scheme used for flattened gray images. Default to GrayJPEGCompression.

### set_gray_image_quality

```cpp
void datalogics_interface::FlattenTransparencyParams::set_gray_image_quality(FlattenerQualitySetting quality)
```

**Parameters**

- `quality` ([`FlattenerQualitySetting`](https://docs.datalogics.com/apdfl21/ModernCPP/21.4.0/enum/FlattenerQualitySetting.md)): the quality Setting for Flattened JPEG and JPEG2000 gray Images. This is valid only if the value of GrayCompressionSc... Default value: High

**Returns:** `void`

Quality Setting for Flattened JPEG and JPEG2000 gray Images. This is valid only if the value of GrayCompressionScheme is equal to GrayJPEGCompression or GrayJPEG2000Compression

### set_internal_dpi

```cpp
void datalogics_interface::FlattenTransparencyParams::set_internal_dpi(int dpi)
```

**Parameters**

- `dpi` (`int`): the resolution for flattening the interior of an atomic region. Range is 1 to 9600

**Returns:** `void`

Resolution for flattening the interior of an atomic region. Range is 1 to 9600.

### set_max_page_flattening_time

```cpp
void datalogics_interface::FlattenTransparencyParams::set_max_page_flattening_time(int seconds)
```

**Parameters**

- `seconds` (`int`): the maximum allowed time that will be spent flattening a single page. A value less than zero will disable the time li...

**Returns:** `void`

The maximum allowed time that will be spent flattening a single page. A value less than zero will disable the time limit. A value equal to 0 (default) will set the limit to 120 seconds. A value greater than 0 will set the allowed limit (in seconds).

### set_mono_compression

```cpp
void datalogics_interface::FlattenTransparencyParams::set_mono_compression(FlattenerMonoCompression scheme)
```

**Parameters**

- `scheme` ([`FlattenerMonoCompression`](https://docs.datalogics.com/apdfl21/ModernCPP/21.4.0/enum/FlattenerMonoCompression.md)): the compression scheme used for flattened monochrome images. Default to MonoCCITTGroup4Compression

**Returns:** `void`

The compression scheme used for flattened monochrome images. Default to MonoCCITTGroup4Compression.

### set_preserve_overprint

```cpp
void datalogics_interface::FlattenTransparencyParams::set_preserve_overprint(bool value)
```

**Parameters**

- `value` (`bool`): true to attempt to preserve overprint, false otherwise.

**Returns:** `void`

If true, attempt to preserve overprint.

### set_profile_description

```cpp
void datalogics_interface::FlattenTransparencyParams::set_profile_description(const std::string &description)
```

**Parameters**

- `description` (`const std::string &`)

**Returns:** `void`

Represents control parameters for flattening transparencies within a PDF file.

Class that represents control parameters for flattening transparencies within a PDF file. PDF files can hold objects that are stacked, and that are partially or fully transparent. This means that these objects can blend in various ways with objects behind them. With a stacked set of transparent graphics or images in a PDF file, each one contributing to the final result that appears on the page. One or more graphics images presented together in a stack is referred to as a transparency group. With a stack of transparent images, the final colors shown are the result of blending the colors of all of the overlapping objects. Flatten Transparency merges a stack of transparent objects or graphics into a single image on the PDF page.

Flattening images in a PDF file is generally necessary before you can send the document to a printer. The flattening process simplifies the PDF file and may make it smaller as well.

### set_quality

```cpp
void datalogics_interface::FlattenTransparencyParams::set_quality(int quality)
```

**Parameters**

- `quality` (`int`): the percentage of vector information to preserve (0-100). Lower values cause higher rasterization of vectors.

**Returns:** `void`

The percentage of vector information that is to be preserved. Lower values will cause higher rasterization of vectors. Range is 0 to 100.

### set_use_text_outlines

```cpp
void datalogics_interface::FlattenTransparencyParams::set_use_text_outlines(bool value)
```

**Parameters**

- `value` (`bool`): true to output text outlines instead of native text, false otherwise.

**Returns:** `void`

If true, output text outlines instead of native text.
