Pattern

A Pattern represents a source when drawing onto a Surface. There are different subtypes of Pattern, for different types of sources; for example, SolidPattern.fromRGB creates a pattern for a solid opaque color.

Other than various Pattern subclasses, some of the pattern types can be implicitly created using various Context.setSource functions; for example Context.setSourceRGB.

The C type of a pattern can be queried with getType(), although D polymorphism features also work.

Memory management of Pattern can be done with the dispose() method, see https://github.com/jpf91/cairoD/wiki/Memory-Management#3-RC-class

Note: This class uses the CairoCountedClass mixin, so all it's members are also available in Pattern classes, although they do not show up in the documentation because of a limitation in ddoc.

class Pattern {

mixin CairoCountedClass!(cairo_pattern_t*, "cairo_pattern_") ;

void checkError();

this(cairo_pattern_t* ptr);

static Pattern createFromNative(cairo_pattern_t* ptr, bool adjRefCount);

void setExtend(Extend ext);

Extend getExtend();

void setFilter(Filter fil);

Filter getFilter();

void filter(Filter fil);

Filter filter();

void setMatrix(Matrix mat);

Matrix getMatrix();

Matrix matrix [@property setter];

Matrix matrix [@property getter];

PatternType getType();

PatternType type [@property getter];

}

Constructors

this this(cairo_pattern_t* ptr): Create a Pattern from a existing cairo_pattern_t*. Pattern is a garbage collected class. It will call cairo_pattern_destroy when it gets collected by the GC or when dispose() is called.

Members

Functions

checkError void checkError(): Method for use in subclasses. Calls cairo_pattern_status(nativePointer) and throws an exception if the status isn't CAIRO_STATUS_SUCCESS
filter void filter(Filter fil)
Filter filter(): Convenience property
getExtend Extend getExtend(): Gets the current extend mode for a pattern. See Extend for details on the semantics of each extend strategy.
getFilter Filter getFilter(): Gets the current filter for a pattern. See Filter for details on each filter.
getMatrix Matrix getMatrix(): Returns the pattern's transformation matrix.
getType PatternType getType(): This function returns the C type of a pattern. See PatternType for available types.
setExtend void setExtend(Extend ext): Sets the mode to be used for drawing outside the area of a pattern. See Extend for details on the semantics of each extend strategy. The default extend mode is CAIRO_EXTEND_NONE for surface patterns and CAIRO_EXTEND_PAD for gradient patterns.
setFilter void setFilter(Filter fil): Sets the filter to be used for resizing when using this pattern. See Filter for details on each filter.
setMatrix void setMatrix(Matrix mat): Sets the pattern's transformation matrix to matrix. This matrix is a transformation from user space to pattern space.

Mixins

__anonymous mixin CairoCountedClass!(cairo_pattern_t*, "cairo_pattern_")

Properties

matrix Matrix matrix [@property setter]
Matrix matrix [@property getter]: Convenience property
type PatternType type [@property getter]: Convenience property

Static functions

createFromNative Pattern createFromNative(cairo_pattern_t* ptr, bool adjRefCount): The createFromNative method for the Pattern classes. See https://github.com/jpf91/cairoD/wiki/Memory-Management#createFromNative for more information.