ShadingPattern Class Documentation
classShadingPattern : PatternNamespace:datalogics_interface
- Inherits from:
Pattern
- Derived classes:
- AxialShadingPattern
Detailed Description
A shading pattern consists of a smoothly varying gradient between two colors.
Uses types
Member Function Documentation
get_anti_alias
boolget_anti_alias()Returns:
true if anti-aliasing is enabled, false otherwise.When enabled, the shading function is filtered to prevent aliasing artifacts.
get_bounding_box
Rectget_bounding_box()Returns:
The bounding box Rect, or NULL if none is set.The coordinates are interpreted in the target coordinate space. If present, provides an additional, temporary clipping boundary to the shading.
get_color_space
std::unique_ptr< ColorSpace >get_color_space()Returns:
The ColorSpace of the shading pattern.This space is restricted to be any space except a Pattern space.
get_pdf_object
std::unique_ptr< PDFObject >get_pdf_object()Returns:
The PDFObject representing this pattern in the PDF document.Gets the underlying PDF object for this pattern.
set_anti_alias
voidset_anti_alias(boolanti_alias)Parameters
anti_alias: booltrue to enable anti-aliasing, false to disable it.
Returns:
voidWhen enabled, the shading function is filtered to prevent aliasing artifacts.
set_bounding_box
voidset_bounding_box(const Rect &bbox)Parameters
bbox: const Rect &The bounding box Rect to set, or NULL to remove it.
Returns:
voidThe coordinates are interpreted in the target coordinate space. If present, provides an additional, temporary clipping boundary to the shading. Set to NULL to remove the bounding box.
set_color_space
voidset_color_space(ColorSpace &color_space)Parameters
color_space: ColorSpace &The ColorSpace to set for the shading pattern.
Returns:
voidThis space is restricted to be any space except a Pattern space.
to_string
std::stringto_string()Returns:
A string describing the shading pattern.Converts the shading pattern to a string representation.