Blend2D

2D Vector Graphics Engine

About

Roadmap

Performance

Docs

Blog

Research

Support

Download

{Fiddle}

API Reference

Index Class List Globals Containers Geometries Imaging Styling Text Rendering Runtime Filesystem Miscellaneous Impl API Macros C API Object Model

Topics

Getting StartedBuild InstructionsMultithreaded Rendering

Index ⭢ Styling ⭢ BLGradient

BLGradient Class Reference

Gradient [C++ API].

Member Functions

Construction & Destruction

BLGradient() noexcept

BLGradient(BLGradient&& other) noexcept

BLGradient(const BLGradient& other) noexcept

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

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

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

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

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

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

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

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

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

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

~BLGradient() noexcept

Overloaded Operators

BLGradient& operator=(BLGradient&& other) noexcept

BLGradient& operator=(const BLGradient& other) noexcept

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

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

Common Functionality

BLResult reset() noexcept

void swap(BLGradient& other) noexcept

Create Gradient

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

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

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

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

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

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

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

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

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

Accessors

BLGradientType type() const noexcept

BLResult setType(BLGradientType type) noexcept

BLExtendMode extendMode() const noexcept

BLResult setExtendMode(BLExtendMode extendMode) noexcept

BLResult resetExtendMode() noexcept

double value(size_t index) const noexcept

const BLLinearGradientValues& linear() const noexcept

const BLRadialGradientValues& radial() const noexcept

const BLConicGradientValues& conic() const noexcept

BLResult setValue(size_t index, double value) noexcept

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

BLResult setValues(const BLLinearGradientValues& values) noexcept

BLResult setValues(const BLRadialGradientValues& values) noexcept

BLResult setValues(const BLConicGradientValues& values) noexcept

double x0() const noexcept

double y0() const noexcept

double x1() const noexcept

double y1() const noexcept

double r0() const noexcept

double r1() const noexcept

double angle() const noexcept

double conicAngle() const noexcept

double conicRepeat() const noexcept

BLResult setX0(double value) noexcept

BLResult setY0(double value) noexcept

BLResult setX1(double value) noexcept

BLResult setY1(double value) noexcept

BLResult setR0(double value) noexcept

BLResult setR1(double value) noexcept

BLResult setAngle(double value) noexcept

BLResult setConicAngle(double value) noexcept

BLResult setConicRepeat(double value) noexcept

Gradient Stops

bool empty() const noexcept

size_t size() const noexcept

size_t capacity() const noexcept

BLResult reserve(size_t n) noexcept

BLResult shrink() noexcept

const BLGradientStop* stops() const noexcept

const BLGradientStop& stopAt(size_t i) const noexcept

BLArrayView<BLGradientStop> stopsView() const noexcept

Content Manipulation

BLResult assign(BLGradient&& other) noexcept

BLResult assign(const BLGradient& other) noexcept

BLResult resetStops() noexcept

BLResult assignStops(const BLGradientStop* stops, size_t n) noexcept

BLResult assignStops(BLArrayView<BLGradientStop> stops) noexcept

BLResult addStop(double offset, const BLRgba32& rgba32) noexcept

BLResult addStop(double offset, const BLRgba64& rgba64) noexcept

BLResult removeStop(size_t index) noexcept

BLResult removeStopByOffset(double offset, bool all = true) noexcept

BLResult removeStops(BLRange range) noexcept

BLResult removeStopsByOffset(double offsetMin, double offsetMax) noexcept

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

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

size_t indexOfStop(double offset) const noexcept

Equality & Comparison

bool equals(const BLGradient& other) const noexcept

Transformations

const BLMatrix2D& transform() const noexcept

BLTransformType transformType() const noexcept

bool hasTransform() const noexcept

BLResult _applyTransformOp(BLTransformOp opType, const void* opData) noexcept

BLResult setTransform(const BLMatrix2D& transform) noexcept

BLResult resetTransform() noexcept

BLResult translate(double x, double y) noexcept

BLResult translate(const BLPointI& p) noexcept

BLResult translate(const BLPoint& p) noexcept

BLResult scale(double xy) noexcept

BLResult scale(double x, double y) noexcept

BLResult scale(const BLPointI& p) noexcept

BLResult scale(const BLPoint& p) noexcept

BLResult skew(double x, double y) noexcept

BLResult skew(const BLPoint& p) noexcept

BLResult rotate(double angle) noexcept

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

BLResult rotate(double angle, const BLPoint& origin) noexcept

BLResult rotate(double angle, const BLPointI& origin) noexcept

BLResult applyTransform(const BLMatrix2D& transform) noexcept

BLResult postTranslate(double x, double y) noexcept

BLResult postTranslate(const BLPointI& p) noexcept

BLResult postTranslate(const BLPoint& p) noexcept

BLResult postScale(double xy) noexcept

BLResult postScale(double x, double y) noexcept

BLResult postScale(const BLPointI& p) noexcept

BLResult postScale(const BLPoint& p) noexcept

BLResult postSkew(double x, double y) noexcept

BLResult postSkew(const BLPoint& p) noexcept

BLResult postRotate(double angle) noexcept

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

BLResult postRotate(double angle, const BLPoint& origin) noexcept

BLResult postRotate(double angle, const BLPointI& origin) noexcept

BLResult postTransform(const BLMatrix2D& transform) noexcept

Additional Inherited Members

 Public Attributes inherited from BLObjectCore

BLObjectDetail _d

BLGradient::BLGradient()noexcept[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

)noexcept[2/3]

Move constructor.

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

BLGradient::BLGradient(

const BLGradient& other

)noexcept[3/3]

Copy constructor creates a weak copy of other.

BLGradient& BLGradient::operator=(

BLGradient&& other

)noexcept[1/2]

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

BLGradient& BLGradient::operator=(

const BLGradient& other

)noexcept[2/2]

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

bool BLGradient::operator==(

const BLGradient& other

) constnoexcept

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

bool BLGradient::operator!=(

const BLGradient& other

) constnoexcept

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

BLResult BLGradient::reset()noexcept

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

)noexcept

Swaps this gradient with other.

Note

This operation always succeeds.

BLGradientType BLGradient::type() constnoexcept

Returns the type of the gradient.

BLResult BLGradient::setType(

BLGradientType type

)noexcept

Sets the type of the gradient.

BLExtendMode BLGradient::extendMode() constnoexcept

Returns the gradient extend mode, see BLExtendMode.

BLResult BLGradient::setExtendMode(

BLExtendMode extendMode

)noexcept

Set the gradient extend mode, see BLExtendMode.

BLResult BLGradient::resetExtendMode()noexcept

Resets the gradient extend mode to BL_EXTEND_MODE_PAD.

bool BLGradient::empty() constnoexcept

Tests whether the gradient is empty.

Empty gradient is considered any gradient that has no stops.

size_t BLGradient::size() constnoexcept

Returns the number of stops the gradient has.

size_t BLGradient::capacity() constnoexcept

Returns the gradient capacity [in stops].

BLResult BLGradient::reserve(

size_t n

)noexcept

Reserves the capacity of gradient for at least n stops.

BLResult BLGradient::shrink()noexcept

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

const BLGradientStop* BLGradient::stops() constnoexcept

Returns the gradient stop data.

const BLGradientStop& BLGradient::stopAt(

size_t i

) constnoexcept

Returns a gradient stop at i.

BLArrayView<BLGradientStop>BLGradient::stopsView() constnoexcept

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

BLResult BLGradient::assign(

BLGradient&& other

)noexcept[1/2]

Move assignment of other gradient to this gradient.

This function resets other to its initialization state.

BLResult BLGradient::assign(

const BLGradient& other

)noexcept[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()noexcept

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

)noexcept[1/2]

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

BLResult BLGradient::assignStops(

BLArrayView<BLGradientStop> stops

)noexcept[2/2]

Assigns colors stops of the gradient to stops.

BLResult BLGradient::addStop(

double offset,

const BLRgba32& rgba32

)noexcept[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

)noexcept[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

)noexcept

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

)noexcept

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

)noexcept

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

BLResult BLGradient::removeStopsByOffset(

double offsetMin,

double offsetMax

)noexcept

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

)noexcept[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

)noexcept[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

) constnoexcept

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

) constnoexcept

Tests whether the gradient equals other.

Note

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

const BLMatrix2D& BLGradient::transform() constnoexcept

Returns the transformation matrix applied to the gradient.

BLTransformType BLGradient::transformType() constnoexcept

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

bool BLGradient::hasTransform() constnoexcept

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

BLResult BLGradient::_applyTransformOp(

BLTransformOp opType,

const void* opData

)noexcept

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

More Information

About Blend2D

Project Roadmap

Performance Comparison

Documentation

Getting Started

Build Instructions

C/C++ API Reference

Support

Contact

Donation Options

Commercial Support

Get Blend2D

Download Page

Blend2D on GitHub

© 2017-2024 Blend2D Team | GitHub | Chat | Support | Download

Blend2D library and its dependencies are open source software released under the Zlib license and can be used safely in any open-source or commercial product, statically or dynamically linked, and without advertising the use of Blend2D. Code snippets and examples are released into public domain, see Unlicense for more details.