Blend2D
2D Vector Graphics Engine
About
Roadmap
Performance
Docs
Blog
Research
Support
Download
{Fiddle}
Index ⭢ Globals ⭢ BLVar
BLVar Class Referencefinal

Variant [C++ API].

Member Functions

Construction & Destruction
BLVar() noexcept
BLVar(BLVar&& other) noexcept
BLVar(const BLVar& other) noexcept
template<typename T>
BLVar(T&& value) noexcept
~BLVar() noexcept
Overloaded Operators
template<typename T>
BLVar& operator=(T&& value) noexcept
template<typename T>
bool operator==(const T& other) const noexcept
template<typename T>
bool operator!=(const T& other) const noexcept
Common Functionality
BLResult reset() noexcept
void swap(BLVarCore& other) noexcept
Type Accessors
BLObjectType type() const noexcept
bool isArray() const noexcept
bool isBitArray() const noexcept
bool isBitSet() const noexcept
bool isBool() const noexcept
bool isContext() const noexcept
bool isDouble() const noexcept
bool isFont() const noexcept
bool isFontData() const noexcept
bool isFontFace() const noexcept
bool isFontManager() const noexcept
bool isGradient() const noexcept
bool isImage() const noexcept
bool isImageCodec() const noexcept
bool isImageDecoder() const noexcept
bool isImageEncoder() const noexcept
bool isInt64() const noexcept
bool isNull() const noexcept
bool isPath() const noexcept
bool isPattern() const noexcept
bool isString() const noexcept
bool isRgba() const noexcept
bool isRgba32() const noexcept
bool isRgba64() const noexcept
bool isUInt64() const noexcept
bool isStyle() const noexcept
BLResult toBool(bool* out) const noexcept
BLResult toInt32(int32_t* out) const noexcept
BLResult toInt64(int64_t* out) const noexcept
BLResult toUInt32(uint32_t* out) const noexcept
BLResult toUInt64(uint64_t* out) const noexcept
BLResult toDouble(double* out) const noexcept
BLResult toRgba(BLRgba* out) const noexcept
BLResult toRgba32(BLRgba32* out) const noexcept
BLResult toRgba64(BLRgba64* out) const noexcept
Properties
BLResult getProperty(const char* name, BLVarCore& valueOut) const noexcept
BLResult getProperty(BLStringView name, BLVarCore& valueOut) const noexcept
BLResult setProperty(const char* name, const BLObjectCore& value) noexcept
BLResult setProperty(BLStringView name, const BLObjectCore& value) noexcept
Casts
template<typename T>
T& as() noexcept
template<typename T>
const T& as() const noexcept
Assignment
template<typename T>
BLResult assign(T&& value) noexcept
Equality
template<typename T>
bool equals(const T& value) const noexcept
bool strictEquals(const BLVarCore& other) const noexcept

Static Functions

Static Constructors
static BLVar null() noexcept

Additional Inherited Members

- Public Attributes inherited from BLObjectCore

BLObjectType BLVar::type() constnoexcept[¶]

Returns the type of the underlying object.

bool BLVar::isArray() constnoexcept[¶]

Tests whether this BLVar instance represents a BLArray<T> storing any supported type.

bool BLVar::isBitArray() constnoexcept[¶]

Tests whether this BLVar instance represents BLBitArray.

bool BLVar::isBitSet() constnoexcept[¶]

Tests whether this BLVar instance represents BLBitSet.

bool BLVar::isBool() constnoexcept[¶]

Tests whether this BLVar instance represents a boxed bool value.

bool BLVar::isContext() constnoexcept[¶]

Tests whether this BLVar instance represents BLContext.

bool BLVar::isDouble() constnoexcept[¶]

Tests whether this BLVar instance represents a boxed double value.

bool BLVar::isFont() constnoexcept[¶]

Tests whether this BLVar instance represents BLFont.

bool BLVar::isFontData() constnoexcept[¶]

Tests whether this BLVar instance represents BLFontData.

bool BLVar::isFontFace() constnoexcept[¶]

Tests whether this BLVar instance represents BLFontFace.

bool BLVar::isFontManager() constnoexcept[¶]

Tests whether this BLVar instance represents BLFontManager.

bool BLVar::isGradient() constnoexcept[¶]

Tests whether this BLVar instance represents BLGradient.

bool BLVar::isImage() constnoexcept[¶]

Tests whether this BLVar instance represents BLImage.

bool BLVar::isImageCodec() constnoexcept[¶]

Tests whether this BLVar instance represents BLImageCodec.

bool BLVar::isImageDecoder() constnoexcept[¶]

Tests whether this BLVar instance represents BLImageDecoder.

bool BLVar::isImageEncoder() constnoexcept[¶]

Tests whether this BLVar instance represents BLImageEncoder.

bool BLVar::isInt64() constnoexcept[¶]

Tests whether this BLVar instance represents a boxed int64_t value.

bool BLVar::isNull() constnoexcept[¶]

Tests whether this BLVar instance represents a null value.

bool BLVar::isPath() constnoexcept[¶]

Tests whether this BLVar instance represents BLPath.

bool BLVar::isPattern() constnoexcept[¶]

Tests whether this BLVar instance represents BLPattern.

bool BLVar::isString() constnoexcept[¶]

Tests whether this BLVar instance represents BLString.

bool BLVar::isRgba() constnoexcept[¶]

Tests whether this BLVar instance represents boxed BLRgba.

bool BLVar::isRgba32() constnoexcept[¶]

Tests whether this BLVar instance represents boxed BLRgba32.

bool BLVar::isRgba64() constnoexcept[¶]

Tests whether this BLVar instance represents boxed BLRgba64.

bool BLVar::isUInt64() constnoexcept[¶]

Tests whether this BLVar instance represents a boxed uint64_t value.

bool BLVar::isStyle() constnoexcept[¶]

Tests whether this BLVar instance is a style that can be used with the rendering context.

BLResult BLVar::toBool(
bool* out
) constnoexcept[¶]

Converts this value to bool and stores the result in out.

BLResult BLVar::toInt32(
int32_t* out
) constnoexcept[¶]

Converts this value to int32_t and stores the result in out.

BLResult BLVar::toInt64(
int64_t* out
) constnoexcept[¶]

Converts this value to int64_t and stores the result in out.

BLResult BLVar::toUInt32(
uint32_t* out
) constnoexcept[¶]

Converts this value to uint32_t and stores the result in out.

BLResult BLVar::toUInt64(
uint64_t* out
) constnoexcept[¶]

Converts this value to uint64_t and stores the result in out.

BLResult BLVar::toDouble(
double* out
) constnoexcept[¶]

Converts this value to double precision floating point and stores the result in out.

BLResult BLVar::toRgba(
BLRgba* out
) constnoexcept[¶]

Converts this value to BLRgba and stores the result in out.

BLResult BLVar::toRgba32(
BLRgba32* out
) constnoexcept[¶]

Converts this value to BLRgba32 and stores the result in out.

BLResult BLVar::toRgba64(
BLRgba64* out
) constnoexcept[¶]

Converts this value to BLRgba64 and stores the result in out.

BLResult BLVar::getProperty(
const char* name,
BLVarCore& valueOut
) constnoexcept[1/2][¶]

Gets a property of the given name and assigns it to an initialized valueOut.

BLResult BLVar::getProperty(
BLStringView name,
BLVarCore& valueOut
) constnoexcept[2/2][¶]

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

BLResult BLVar::setProperty(
const char* name,
const BLObjectCore& value
)noexcept[1/2][¶]

Sets a property of the given name to value.

BLResult BLVar::setProperty(
BLStringView name,
const BLObjectCore& value
)noexcept[2/2][¶]

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

template<typename T>
T& BLVar::as()noexcept[1/2][¶]

Casts this BLVar instance to T&.

template<typename T>
const T& BLVar::as() constnoexcept[2/2][¶]

Casts this BLVar instance to const T&.

© 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.