PageImageParams Class Documentation

classPageImageParams

Namespace:datalogics_interface

Detailed Description

The Page Image Parameters are a set of parameters used to control converting a PDF page to an image, such as a PNG, JPG, or BMP. The parameters include pixel height & width, color space, resolution, so on.

Constructor & Destructor Documentation

PageImageParams

PageImageParams()

Initializes with DeviceRGB color space, no smoothing, zero pixel dimensions, 300 dpi resolution, relative colorimetric render intent, and black point compensation enabled.

~PageImageParams

~PageImageParams()

Member Function Documentation

get_black_point_compensation

boolget_black_point_compensation()

Returns:

bool

Default is true if not explicitly set.

get_bypass_copy_perm

boolget_bypass_copy_perm()

Returns:

true if this option is turned on.

The BypassCopyPerm allows to bypass copy permitions.

get_calibrate_device_spaces_when_printing

boolget_calibrate_device_spaces_when_printing()

Returns:

true if this option is turned on.

Sets if Device spaces should be treated as calibrated to the associated working profile (when true), otherwise it treats them as uncalibrated (when false) when printing.

get_horizontal_resolution

doubleget_horizontal_resolution()

Returns:

double

Defaults to 300 dpi. Must not be negative. Horizontal and vertical resolution must be either both zero or both non-zero.

get_icc_profile

ColorProfileget_icc_profile()

Returns:

ColorProfile

Gets the ICC Profile of the colorspace to be used for rendering from a known value.

NOTE: The ICCProfileCustomPath must not be set for this property to be used. The profile must be compatible with the ColorSpace property value, which can't be set to ICCBased either.

get_icc_profile_custom_path

std::stringget_icc_profile_custom_path()

Returns:

std::string

Gets the ICC Profile of the colorspace to be used for rendering from a custom file path.

NOTE: The ICCProfile is ignored when this property is a non-empty string. The profile must be compatible with the ColorSpace property value, which can't be set to ICCBased either.

get_page_draw_flags

DrawFlagsget_page_draw_flags()

Returns:

DrawFlags

An OR of the flags from DrawFlags which control how the PDF page is drawn.

get_pixel_height

intget_pixel_height()

Returns:

int

If not specified (zero), the rendered PDF page size will be used. PixelWidth and PixelHeight must be either both zero or both non-zero.

get_pixel_width

intget_pixel_width()

Returns:

int

If not specified (zero), the rendered PDF page size will be used. PixelWidth and PixelHeight must be either both zero or both non-zero.

get_smoothing

SmoothFlagsget_smoothing()

Returns:

SmoothFlags

Indicates what parts of the PDF page (text, image, art, none) are to be smoothed when rendering to an image. These flags can be OR'd together.

get_thin_line_heuristics

boolget_thin_line_heuristics()

Returns:

true if thin line heuristics are applied, false otherwise.

Determines whether thin lines will be fattened non-linearly or the stroke adjust will be applied to thin rectangles.

get_use_device_n_for_image_separations

boolget_use_device_n_for_image_separations()

Returns:

true if this option is turned on. NOTE: This member is only applicable when calling the GetImageSeparations() method, only when Colorants used are only Process.

Gets the UseDeviceNForImageSeparations setting, which indicates when the GetImageSeparations() method is called if a DeviceN colorspace will be used for rasterization. When false, if only Process colorants are provided to GetImageSeparations() then it's rendered using DeviceCMYK. When true, then it's rendered using DeviceN.

get_vertical_resolution

doubleget_vertical_resolution()

Returns:

double

Defaults to 300 dpi. Must not be negative. Horizontal and vertical resolution must be either both zero or both non-zero.

set_black_point_compensation

voidset_black_point_compensation(boolvalue)

Parameters

value: bool

Returns:

void

Default is true if not explicitly set.

set_bypass_copy_perm

voidset_bypass_copy_perm(boolvalue)

Parameters

value: bool

the bypass copy perm

Returns:

void

set_calibrate_device_spaces_when_printing

voidset_calibrate_device_spaces_when_printing(boolvalue)

Parameters

value: bool

the calibrate device spaces when printing

Returns:

void

set_horizontal_resolution

voidset_horizontal_resolution(doubledpi)

Parameters

dpi: double

Returns:

void

Defaults to 300 dpi. Must not be negative. Horizontal and vertical resolution must be either both zero or both non-zero.

set_icc_profile

voidset_icc_profile(ColorProfileprofile)

Parameters

profile: ColorProfile

the ICC Profile of the colorspace to be used for rendering to a known value

Returns:

void

Sets the ICC Profile of the colorspace to be used for rendering to a known value.

NOTE: The ICCProfileCustomPath must not be set for this property to be used. The profile must be compatible with the ColorSpace property value, which can't be set to ICCBased either.

set_icc_profile_custom_path

voidset_icc_profile_custom_path(const std::string &path)

Parameters

path: const std::string &

the ICC Profile of the colorspace to be used for rendering from a custom file path

Returns:

void

Sets the ICC Profile of the colorspace to be used for rendering from a custom file path.

NOTE: The ICCProfile is ignored when this property is a non-empty string. The profile must be compatible with the ColorSpace property value, which can't be set to ICCBased either.

set_image_color_space

voidset_image_color_space(ColorSpace &cs)

Parameters

cs: ColorSpace &

Returns:

void

Must be one of DeviceGray, DeviceRGB, DeviceRGBA, DeviceCMYK, DeviceN, or ICCBased.

set_page_draw_flags

voidset_page_draw_flags(DrawFlagsflags)

Parameters

flags: DrawFlags

Returns:

void

An OR of the flags from DrawFlags which control how the PDF page is drawn.

set_pixel_height

voidset_pixel_height(intheight)

Parameters

height: int

Returns:

void

If not specified (zero), the rendered PDF page size will be used. PixelWidth and PixelHeight must be either both zero or both non-zero.

set_pixel_width

voidset_pixel_width(intwidth)

Parameters

width: int

Returns:

void

If not specified (zero), the rendered PDF page size will be used. PixelWidth and PixelHeight must be either both zero or both non-zero.

set_render_intent

voidset_render_intent(RenderIntentintent)

Parameters

intent: RenderIntent

Returns:

void

The default is relative colorimetric.

set_smoothing

voidset_smoothing(SmoothFlagsflags)

Parameters

flags: SmoothFlags

Returns:

void

Indicates what parts of the PDF page (text, image, art, none) are to be smoothed when rendering to an image. These flags can be OR'd together.

set_thin_line_heuristics

voidset_thin_line_heuristics(boolvalue)

Parameters

value: bool

Returns:

void

Determines whether thin lines will be fattened non-linearly or the stroke adjust will be applied to thin rectangles.

set_use_device_n_for_image_separations

voidset_use_device_n_for_image_separations(boolvalue)

Parameters

value: bool

true to render with DeviceN when only Process colorants are provided to GetImageSeparations(); false to render with DeviceCMYK in that case.

Returns:

void

Sets the UseDeviceNForImageSeparations setting, which indicates when GetImageSeparations() is called if a DeviceN colorspace will be used for rasterization. When false, if only Process colorants are provided to GetImageSeparations() then it's rendered using DeviceCMYK. When true, then it's rendered using DeviceN. NOTE: This member is only applicable when calling the GetImageSeparations() method, only when Colorants used are only Process.

set_vertical_resolution

voidset_vertical_resolution(doubledpi)

Parameters

dpi: double

Returns:

void

Defaults to 300 dpi. Must not be negative. Horizontal and vertical resolution must be either both zero or both non-zero.