DrawParams Class Documentation
classDrawParamsNamespace: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.
Constructor & Destructor Documentation
DrawParams
DrawParams()Initializes with DeviceRGB color space, relative colorimetric render intent, no smoothing, no draw flags, and no cancel or progress callbacks.
DrawParams
DrawParams(const DrawParams &other)Parameters
other: const DrawParams &
Copy constructor.
DrawParams
DrawParams(DrawParams &&)Parameters
~DrawParams
~DrawParams()Member Function Documentation
get_bypass_copy_perm
boolget_bypass_copy_perm()Returns:
boolBypass copy permissions. Only used when drawing to a bitmap.
get_color_space
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.
get_dest_rect
Rectget_dest_rect()Returns:
RectOnly used when drawing to a bitmap.
get_enable_black_point_compensation
boolget_enable_black_point_compensation()Returns:
boolEnable/disable black point compensation.
get_enable_thin_line_heuristics
boolget_enable_thin_line_heuristics()Returns:
boolEnable/disable thin line adjustments when drawing rectangles.
get_flags
DrawFlagsget_flags()Returns:
DrawFlagsDrawing flags.
get_icc_profile
ColorProfileget_icc_profile()Returns:
ColorProfileNOTE: 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::stringNOTE: 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_matrix
Matrixget_matrix()Returns:
MatrixUseful for converting from page to window coordinates and for scaling.
get_optional_content_context
std::unique_ptr< OptionalContentContext >get_optional_content_context()Returns:
The optional content context, or NULL if using the document's default.Get the optional-content context used for visibility state information.
get_render_intent
RenderIntentget_render_intent()Returns:
RenderIntentDefault rendering intent is RelColorimetric (relative colorimetric). Only used when drawing to a bitmap.
get_smooth_flags
SmoothFlagsget_smooth_flags()Returns:
SmoothFlagsSmoothing flags. Only used when drawing to a bitmap.
get_update_rect
Rectget_update_rect()Returns:
RectA rectangle represented by the coordinates of its four sides. If unset (degenerate), the page's CropBox is used instead.
operator=
DrawParams &operator=(const DrawParams &other)Parameters
other: const DrawParams &
Returns:
DrawParams &Copy assignment.
operator=
DrawParams &operator=(DrawParams &&)Parameters
Returns:
DrawParams &set_bypass_copy_perm
voidset_bypass_copy_perm(boolvalue)Parameters
value: bool
Returns:
voidBypass copy permissions. Only used when drawing to a bitmap.
set_color_space
voidset_color_space(ColorSpace &color_space)Parameters
color_space: ColorSpace &the color space in which the bitmap data is represented
Returns:
voidMust be one of DeviceGray, DeviceRGB, DeviceRGBA, DeviceCMYK, Lab, or LabA. Only used when drawing to a bitmap.
set_dest_rect
voidset_dest_rect(const Rect &rect)Parameters
rect: const Rect &
Returns:
voidOnly used when drawing to a bitmap.
set_enable_black_point_compensation
voidset_enable_black_point_compensation(boolvalue)Parameters
value: bool
Returns:
voidEnable/disable black point compensation.
set_enable_thin_line_heuristics
voidset_enable_thin_line_heuristics(boolvalue)Parameters
value: bool
Returns:
voidEnable/disable thin line adjustments when drawing rectangles.
set_flags
voidset_flags(DrawFlagsflags)Parameters
flags: DrawFlags
Returns:
voidDrawing flags.
set_icc_profile
voidset_icc_profile(ColorProfileprofile)Parameters
profile: ColorProfile
Returns:
voidNOTE: 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 &
Returns:
voidNOTE: 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_matrix
voidset_matrix(const Matrix &matrix)Parameters
matrix: const Matrix &
Returns:
voidUseful for converting from page to window coordinates and for scaling.
set_optional_content_context
voidset_optional_content_context(OptionalContentContext &context)Parameters
context: OptionalContentContext &The optional content context, or NULL for the default.
Returns:
voidSet to NULL to use the document's current states in the default context.
set_render_intent
voidset_render_intent(RenderIntentintent)Parameters
intent: RenderIntent
Returns:
voidDefault rendering intent is RelColorimetric (relative colorimetric). Only used when drawing to a bitmap.
set_smooth_flags
voidset_smooth_flags(SmoothFlagsflags)Parameters
flags: SmoothFlags
Returns:
voidSmoothing flags. Only used when drawing to a bitmap.
set_update_rect
voidset_update_rect(const Rect &rect)Parameters
rect: const Rect &
Returns:
voidA rectangle represented by the coordinates of its four sides. If unset (degenerate), the page's CropBox is used instead.