BLGradient Class Reference

Gradient [C++ API].

Member Functions

Construction & Destruction

BLGradient()

BLGradient(BLGradient&& other)

BLGradient(const BLGradient& other)

BLGradient(BLGradientType type, const double* values = nullptr)

BLGradient(const BLLinearGradientValues& values, BLExtendMode extendMode = BL_EXTEND_MODE_PAD)

BLGradient(const BLRadialGradientValues& values, BLExtendMode extendMode = BL_EXTEND_MODE_PAD)

BLGradient(const BLConicGradientValues& values, BLExtendMode extendMode = BL_EXTEND_MODE_PAD)

BLGradient(const BLLinearGradientValues& values, BLExtendMode extendMode, const BLGradientStop* stops, size_t n)

BLGradient(const BLRadialGradientValues& values, BLExtendMode extendMode, const BLGradientStop* stops, size_t n)

BLGradient(const BLConicGradientValues& values, BLExtendMode extendMode, const BLGradientStop* stops, size_t n)

BLGradient(const BLLinearGradientValues& values, BLExtendMode extendMode, const BLGradientStop* stops, size_t n, const BLMatrix2D& transform)

BLGradient(const BLRadialGradientValues& values, BLExtendMode extendMode, const BLGradientStop* stops, size_t n, const BLMatrix2D& transform)

BLGradient(const BLConicGradientValues& values, BLExtendMode extendMode, const BLGradientStop* stops, size_t n, const BLMatrix2D& transform)

~BLGradient()

Overloaded Operators

BLGradient& operator=(BLGradient&& other)

BLGradient& operator=(const BLGradient& other)

bool operator==(const BLGradient& other) const

bool operator!=(const BLGradient& other) const

Common Functionality

BLResult reset()

void swap(BLGradient& other)

Create Gradient

BLResult create(const BLLinearGradientValues& values, BLExtendMode extendMode = BL_EXTEND_MODE_PAD)

BLResult create(const BLRadialGradientValues& values, BLExtendMode extendMode = BL_EXTEND_MODE_PAD)

BLResult create(const BLConicGradientValues& values, BLExtendMode extendMode = BL_EXTEND_MODE_PAD)

BLResult create(const BLLinearGradientValues& values, BLExtendMode extendMode, const BLGradientStop* stops, size_t n)

BLResult create(const BLRadialGradientValues& values, BLExtendMode extendMode, const BLGradientStop* stops, size_t n)

BLResult create(const BLConicGradientValues& values, BLExtendMode extendMode, const BLGradientStop* stops, size_t n)

BLResult create(const BLLinearGradientValues& values, BLExtendMode extendMode, const BLGradientStop* stops, size_t n, const BLMatrix2D& transform)

BLResult create(const BLRadialGradientValues& values, BLExtendMode extendMode, const BLGradientStop* stops, size_t n, const BLMatrix2D& transform)

BLResult create(const BLConicGradientValues& values, BLExtendMode extendMode, const BLGradientStop* stops, size_t n, const BLMatrix2D& transform)

Accessors

BLGradientType type() const

BLResult setType(BLGradientType type)

BLExtendMode extendMode() const

BLResult setExtendMode(BLExtendMode extendMode)

BLResult resetExtendMode()

double value(size_t index) const

const BLLinearGradientValues& linear() const

const BLRadialGradientValues& radial() const

const BLConicGradientValues& conic() const

BLResult setValue(size_t index, double value)

BLResult setValues(size_t index, const double* values, size_t n)

BLResult setValues(const BLLinearGradientValues& values)

BLResult setValues(const BLRadialGradientValues& values)

BLResult setValues(const BLConicGradientValues& values)

double x0() const

double y0() const

double x1() const

double y1() const

double r0() const

double r1() const

double angle() const

double conicAngle() const

double conicRepeat() const

BLResult setX0(double value)

BLResult setY0(double value)

BLResult setX1(double value)

BLResult setY1(double value)

BLResult setR0(double value)

BLResult setR1(double value)

BLResult setAngle(double value)

BLResult setConicAngle(double value)

BLResult setConicRepeat(double value)

Gradient Stops

bool empty() const

size_t size() const

size_t capacity() const

BLResult reserve(size_t n)

BLResult shrink()

const BLGradientStop* stops() const

const BLGradientStop& stopAt(size_t i) const

BLArrayView<BLGradientStop> stopsView() const

Content Manipulation

BLResult assign(BLGradient&& other)

BLResult assign(const BLGradient& other)

BLResult resetStops()

BLResult assignStops(const BLGradientStop* stops, size_t n)

BLResult assignStops(BLArrayView<BLGradientStop> stops)

BLResult addStop(double offset, const BLRgba32& rgba32)

BLResult addStop(double offset, const BLRgba64& rgba64)

BLResult removeStop(size_t index)

BLResult removeStopByOffset(double offset, bool all = true)

BLResult removeStops(BLRange range)

BLResult removeStopsByOffset(double offsetMin, double offsetMax)

BLResult replaceStop(size_t index, double offset, const BLRgba32& rgba32)

BLResult replaceStop(size_t index, double offset, const BLRgba64& rgba64)

size_t indexOfStop(double offset) const

Equality & Comparison

bool equals(const BLGradient& other) const

Transformations

const BLMatrix2D& transform() const

BLTransformType transformType() const

bool hasTransform() const

BLResult _applyTransformOp(BLTransformOp opType, const void* opData)

BLResult setTransform(const BLMatrix2D& transform)

BLResult resetTransform()

BLResult translate(double x, double y)

BLResult translate(const BLPointI& p)

BLResult translate(const BLPoint& p)

BLResult scale(double xy)

BLResult scale(double x, double y)

BLResult scale(const BLPointI& p)

BLResult scale(const BLPoint& p)

BLResult skew(double x, double y)

BLResult skew(const BLPoint& p)

BLResult rotate(double angle)

BLResult rotate(double angle, double x, double y)

BLResult rotate(double angle, const BLPoint& origin)

BLResult rotate(double angle, const BLPointI& origin)

BLResult applyTransform(const BLMatrix2D& transform)

BLResult postTranslate(double x, double y)

BLResult postTranslate(const BLPointI& p)

BLResult postTranslate(const BLPoint& p)

BLResult postScale(double xy)

BLResult postScale(double x, double y)

BLResult postScale(const BLPointI& p)

BLResult postScale(const BLPoint& p)

BLResult postSkew(double x, double y)

BLResult postSkew(const BLPoint& p)

BLResult postRotate(double angle)

BLResult postRotate(double angle, double x, double y)

BLResult postRotate(double angle, const BLPoint& origin)

BLResult postRotate(double angle, const BLPointI& origin)

BLResult postTransform(const BLMatrix2D& transform)

Additional Inherited Members

 Public Attributes inherited from BLObjectCore

BLObjectDetail _d

Constructor & Destructor Documentation

BLGradient::BLGradient()[1/3]

Creates a default constructed gradient.

A default constructed gradient has BL_GRADIENT_TYPE_LINEAR type, all values set to zero, and has no color stops.

BLGradient::BLGradient(BLGradient&& other)[2/3]

Move constructor.

The other gradient is reset to its construction state after the move.

BLGradient::BLGradient(const BLGradient& other)[3/3]

Copy constructor creates a weak copy of other.

Member Function Documentation

BLGradient& BLGradient::operator=(BLGradient&& other)[1/2]

Move assignment operator, does the same as assign(other).

BLGradient& BLGradient::operator=(const BLGradient& other)[2/2]

Copy assignment operator, does the same as assign(other).

bool BLGradient::operator==(const BLGradient& other) const

Equality operator, performs the same operation as equals(other).

bool BLGradient::operator!=(const BLGradient& other) const

Inequality operator, performs the same operation as !equals(other).

BLResult BLGradient::reset()

Resets the gradient to its construction state.

Note

This operation always succeeds and returns BL_SUCCESS. The return value is provided for convenience so reset() can be used in tail calls in case other functions need to return BLResult.

void BLGradient::swap(BLGradient& other)

Swaps this gradient with other.

Note

This operation always succeeds.

BLGradientType BLGradient::type() const

Returns the type of the gradient.

BLResult BLGradient::setType(BLGradientType type)

Sets the type of the gradient.

BLExtendMode BLGradient::extendMode() const

Returns the gradient extend mode, see BLExtendMode.

BLResult BLGradient::setExtendMode(BLExtendMode extendMode)

Set the gradient extend mode, see BLExtendMode.

BLResult BLGradient::resetExtendMode()

Resets the gradient extend mode to BL_EXTEND_MODE_PAD.

bool BLGradient::empty() const

Tests whether the gradient is empty.

Empty gradient is considered any gradient that has no stops.

size_t BLGradient::size() const

Returns the number of stops the gradient has.

size_t BLGradient::capacity() const

Returns the gradient capacity [in stops].

BLResult BLGradient::reserve(size_t n)

Reserves the capacity of gradient for at least n stops.

BLResult BLGradient::shrink()

Shrinks the capacity of gradient stops to fit the current use.

const BLGradientStop* BLGradient::stops() const

Returns the gradient stop data.

const BLGradientStop& BLGradient::stopAt(size_t i) const

Returns a gradient stop at i.

BLArrayView<BLGradientStop>BLGradient::stopsView() const

Returns gradient stops and their count as BLArrayView<BLGradientStop>.

BLResult BLGradient::assign(BLGradient&& other)[1/2]

Move assignment of other gradient to this gradient.

This function resets other to its initialization state.

BLResult BLGradient::assign(const BLGradient& other)[2/2]

Copy assignment of other gradient to this gradient.

This function creates a weak copy of other gradient by increasing its reference count if other is reference counted.

BLResult BLGradient::resetStops()

Resets all stops of the gradient.

After the operation the gradient will have no color stops.

BLResult BLGradient::assignStops(const BLGradientStop* stops, size_t n)[1/2]

Assigns colors stops of the gradient to stops of size n.

BLResult BLGradient::assignStops(BLArrayView<BLGradientStop> stops)[2/2]

Assigns colors stops of the gradient to stops.

BLResult BLGradient::addStop(double offset, const BLRgba32& rgba32)[1/2]

Adds a color stop described as a 32-bit color rgba32 at the given offset.

Note

The offset value must be in [0, 1] range.

BLResult BLGradient::addStop(double offset, const BLRgba64& rgba64)[2/2]

Adds a color stop described as a 64-bit color rgba64 at the given offset.

Note

The offset value must be in [0, 1] range.

BLResult BLGradient::removeStop(size_t index)

Removes stop at the given index.

Note

This function should be used together with indexOfStop(), which returns index to the stop array.

BLResult BLGradient::removeStopByOffset(double offset, bool all = true)

Removes stop at the given offset, which should be in [0, 1] range.

The all parameter specifies whether all stops at the given offset should be removed as there are cases in which two stops can occupy the same offset to create sharp transitions. If all is false and there is a sharp transition only the first stop would be removed. If all is true both stops will be removed.

Note

There are never 3 stops occupying the same offset.

BLResult BLGradient::removeStops(BLRange range)

Removes all stops in the given range, which describes indexes in the stop array.

BLResult BLGradient::removeStopsByOffset(double offsetMin, double offsetMax)

Removes all stops in the given interval [offsetMin, offsetMax], which specifies stop offsets, which are between [0, 1].

BLResult BLGradient::replaceStop(size_t index, double offset, const BLRgba32& rgba32)[1/2]

Replaces stop at the given index with a new color stop described by offset and rgba32.

The operation leads to the same result as removeStop(index) followed by addStop(offset, rgba32).

BLResult BLGradient::replaceStop(size_t index, double offset, const BLRgba64& rgba64)[2/2]

Replaces stop at the given index with a new color stop described by offset and rgba64.

The operation leads to the same result as removeStop(index) followed by addStop(offset, rgba64).

size_t BLGradient::indexOfStop(double offset) const

Returns the index of a color stop in stops[] array of the given offset.

Note

If there is no such offset, SIZE_MAX is returned.

bool BLGradient::equals(const BLGradient& other) const

Tests whether the gradient equals other.

Note

The equality check returns true if both gradients are the same value-wise.

const BLMatrix2D& BLGradient::transform() const

Returns the transformation matrix applied to the gradient.

BLTransformType BLGradient::transformType() const

Returns the type of the transformation matrix returned by transform().

bool BLGradient::hasTransform() const

Tests whether the gradient has a non-identity transformation matrix.

BLResult BLGradient::_applyTransformOp(BLTransformOp opType, const void* opData)

Applies a matrix operation to the current transformation matrix (internal).