DrawParams Class

class DrawParams

Namespace:datalogics_interface

Detailed Description

This is used for rendering PDF pages to images, such as PNG or JPG files, to export to separate files or to send to a printer.

Uses types

ColorProfile ColorSpace DrawFlags Matrix OptionalContentContext Rect RenderIntent SmoothFlags

Constructor & Destructor Documentation

DrawParams()

Initializes with DeviceRGB color space, relative colorimetric render intent, no smoothing, no draw flags, and no cancel or progress callbacks.

DrawParams(const DrawParams & other)

Parameters

other: const DrawParams &

Copy constructor.

DrawParams(DrawParams && )

Parameters

: DrawParams &&

~DrawParams()

Member Function Documentation

bool get_bypass_copy_perm()

Returns:

bool

Bypass copy permissions. Only used when drawing to a bitmap.

std::unique_ptr< ColorSpace > get_color_space()

Returns:

std::unique_ptr< ColorSpace >

Must be one of DeviceGray, DeviceRGB, DeviceRGBA, DeviceCMYK, Lab, or LabA. Only used when drawing to a bitmap.

Rect get_dest_rect()

Returns:

Rect

Only used when drawing to a bitmap.

bool get_enable_black_point_compensation()

Returns:

bool

Enable/disable black point compensation.

bool get_enable_thin_line_heuristics()

Returns:

bool

Enable/disable thin line adjustments when drawing rectangles.

DrawFlags get_flags()

Returns:

DrawFlags

Drawing flags.

ColorProfile get_icc_profile()

Returns:

ColorProfile

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.

std::string get_icc_profile_custom_path()

Returns:

std::string

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.

Matrix get_matrix()

Returns:

Matrix

Useful for converting from page to window coordinates and for scaling.

std::unique_ptr< OptionalContentContext > get_optional_content_context()

Returns:

std::unique_ptr< OptionalContentContext >

The optional content context, or NULL if using the document's default.

Get the optional-content context used for visibility state information.

RenderIntent get_render_intent()

Returns:

RenderIntent

Default rendering intent is RelColorimetric (relative colorimetric). Only used when drawing to a bitmap.

SmoothFlags get_smooth_flags()

Returns:

SmoothFlags

Smoothing flags. Only used when drawing to a bitmap.

Rect get_update_rect()

Returns:

Rect

A rectangle represented by the coordinates of its four sides. If unset (degenerate), the page's CropBox is used instead.

DrawParams & operator=(const DrawParams & other)

Parameters

other: const DrawParams &

Returns:

DrawParams &

Copy assignment.

DrawParams & operator=(DrawParams && )

Parameters

: DrawParams &&

Returns:

DrawParams &

void set_bypass_copy_perm(bool value)

Parameters

value: bool

Returns:

void

Bypass copy permissions. Only used when drawing to a bitmap.

void set_color_space(ColorSpace & color_space)

Parameters

color_space: ColorSpace &: the color space in which the bitmap data is represented

Returns:

void

Must be one of DeviceGray, DeviceRGB, DeviceRGBA, DeviceCMYK, Lab, or LabA. Only used when drawing to a bitmap.

void set_dest_rect(const Rect & rect)

Parameters

rect: const Rect &

Returns:

void

Only used when drawing to a bitmap.

void set_enable_black_point_compensation(bool value)

Parameters

value: bool

Returns:

void

Enable/disable black point compensation.

void set_enable_thin_line_heuristics(bool value)

Parameters

value: bool

Returns:

void

Enable/disable thin line adjustments when drawing rectangles.

void set_flags(DrawFlags flags)

Parameters

flags: DrawFlags

Returns:

void

Drawing flags.

void set_icc_profile(ColorProfile profile)

Parameters

profile: ColorProfile

Returns:

void

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.

void set_icc_profile_custom_path(const std::string & path)

Parameters

path: const std::string &

Returns:

void

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.

void set_matrix(const Matrix & matrix)

Parameters

matrix: const Matrix &

Returns:

void

Useful for converting from page to window coordinates and for scaling.

void set_optional_content_context(OptionalContentContext & context)

Parameters

context: OptionalContentContext &: The optional content context, or NULL for the default.

Returns:

void

Set to NULL to use the document's current states in the default context.

void set_render_intent(RenderIntent intent)

Parameters

intent: RenderIntent

Returns:

void

Default rendering intent is RelColorimetric (relative colorimetric). Only used when drawing to a bitmap.

void set_smooth_flags(SmoothFlags flags)

Parameters

flags: SmoothFlags

Returns:

void

Smoothing flags. Only used when drawing to a bitmap.

void set_update_rect(const Rect & rect)

Parameters

rect: const Rect &

Returns:

void

A rectangle represented by the coordinates of its four sides. If unset (degenerate), the page's CropBox is used instead.