The OpenD Programming Language

Gradient

Base class for LinearGradient and RadialGradient.

It's not possible to create instances of this class.

Constructors

this
this(cairo_pattern_t* ptr)

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

Members

Aliases

colorStopCount
alias colorStopCount = getColorStopCount

Convenience alias

Functions

addColorStopRGB
void addColorStopRGB(double offset, RGB color)
void addColorStopRGB(double offset, double red, double green, double blue)

Adds an opaque color stop to a gradient pattern. The offset specifies the location along the gradient's control vector. For example, a LinearGradient's control vector is from (x0,y0) to (x1,y1) while a RadialGradient's control vector is from any point on the start circle to the corresponding point on the end circle.

addColorStopRGBA
void addColorStopRGBA(double offset, RGBA color)
void addColorStopRGBA(double offset, double red, double green, double blue, double alpha)

Adds a translucent color stop to a gradient pattern. The offset specifies the location along the gradient's control vector. For example, a linear gradient's control vector is from (x0,y0) to (x1,y1) while a radial gradient's control vector is from any point on the start circle to the corresponding point on the end circle.

getColorStopCount
int getColorStopCount()

Gets the number of color stops specified in the given gradient pattern.

getColorStopRGBA
void getColorStopRGBA(int index, double offset, RGBA color)

Gets the color and offset information at the given index for a gradient pattern. Values of index are 0 to 1 less than the number returned by getColorStopCount().

Inherited Members

From Pattern

__anonymous
mixin CairoCountedClass!(cairo_pattern_t*, "cairo_pattern_")
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

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.

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.

getExtend
Extend getExtend()

Gets the current extend mode for a pattern. See Extend for details on the semantics of each extend strategy.

setFilter
void setFilter(Filter fil)

Sets the filter to be used for resizing when using this pattern. See Filter for details on each filter.

getFilter
Filter getFilter()

Gets the current filter for a pattern. See Filter for details on each filter.

filter
void filter(Filter fil)
Filter filter()

Convenience property

setMatrix
void setMatrix(Matrix mat)

Sets the pattern's transformation matrix to matrix. This matrix is a transformation from user space to pattern space.

getMatrix
Matrix getMatrix()

Returns the pattern's transformation matrix.

matrix
Matrix matrix [@property setter]
Matrix matrix [@property getter]

Convenience property

getType
PatternType getType()

This function returns the C type of a pattern. See PatternType for available types.

type
PatternType type [@property getter]

Convenience property

Meta