BLVar Class Reference

Variant [C++ API].

Member Functions

Construction & Destruction

BLVar()

BLVar(BLVar&& other)

BLVar(const BLVar& other)

template<typename T>

BLVar(T&& value)

~BLVar()

Overloaded Operators

template<typename T>

BLVar& operator=(T&& value)

template<typename T>

bool operator==(const T& other) const

template<typename T>

bool operator!=(const T& other) const

Common Functionality

BLResult reset()

void swap(BLVarCore& other)

Type Accessors

BLObjectType type() const

bool isArray() const

bool isBitArray() const

bool isBitSet() const

bool isBool() const

bool isContext() const

bool isDouble() const

bool isFont() const

bool isFontData() const

bool isFontFace() const

bool isFontManager() const

bool isGradient() const

bool isImage() const

bool isImageCodec() const

bool isImageDecoder() const

bool isImageEncoder() const

bool isInt64() const

bool isNull() const

bool isPath() const

bool isPattern() const

bool isString() const

bool isRgba() const

bool isRgba32() const

bool isRgba64() const

bool isUInt64() const

bool isStyle() const

BLResult toBool(bool* out) const

BLResult toInt32(int32_t* out) const

BLResult toInt64(int64_t* out) const

BLResult toUInt32(uint32_t* out) const

BLResult toUInt64(uint64_t* out) const

BLResult toDouble(double* out) const

BLResult toRgba(BLRgba* out) const

BLResult toRgba32(BLRgba32* out) const

BLResult toRgba64(BLRgba64* out) const

Properties

BLResult getProperty(const char* name, BLVarCore& valueOut) const

BLResult getProperty(BLStringView name, BLVarCore& valueOut) const

BLResult setProperty(const char* name, const BLObjectCore& value)

BLResult setProperty(BLStringView name, const BLObjectCore& value)

Casts

template<typename T>

T& as()

template<typename T>

const T& as() const

Assignment

template<typename T>

BLResult assign(T&& value)

Equality

template<typename T>

bool equals(const T& value) const

bool strictEquals(const BLVarCore& other) const

Static Functions

Static Constructors

static BLVar null()

Additional Inherited Members

 Public Attributes inherited from BLObjectCore

BLObjectDetail _d

Member Function Documentation

BLObjectType BLVar::type() const

Returns the type of the underlying object.

bool BLVar::isArray() const

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

bool BLVar::isBitArray() const

Tests whether this BLVar instance represents BLBitArray.

bool BLVar::isBitSet() const

Tests whether this BLVar instance represents BLBitSet.

bool BLVar::isBool() const

Tests whether this BLVar instance represents a boxed bool value.

bool BLVar::isContext() const

Tests whether this BLVar instance represents BLContext.

bool BLVar::isDouble() const

Tests whether this BLVar instance represents a boxed double value.

bool BLVar::isFont() const

Tests whether this BLVar instance represents BLFont.

bool BLVar::isFontData() const

Tests whether this BLVar instance represents BLFontData.

bool BLVar::isFontFace() const

Tests whether this BLVar instance represents BLFontFace.

bool BLVar::isFontManager() const

Tests whether this BLVar instance represents BLFontManager.

bool BLVar::isGradient() const

Tests whether this BLVar instance represents BLGradient.

bool BLVar::isImage() const

Tests whether this BLVar instance represents BLImage.

bool BLVar::isImageCodec() const

Tests whether this BLVar instance represents BLImageCodec.

bool BLVar::isImageDecoder() const

Tests whether this BLVar instance represents BLImageDecoder.

bool BLVar::isImageEncoder() const

Tests whether this BLVar instance represents BLImageEncoder.

bool BLVar::isInt64() const

Tests whether this BLVar instance represents a boxed int64_t value.

bool BLVar::isNull() const

Tests whether this BLVar instance represents a null value.

bool BLVar::isPath() const

Tests whether this BLVar instance represents BLPath.

bool BLVar::isPattern() const

Tests whether this BLVar instance represents BLPattern.

bool BLVar::isString() const

Tests whether this BLVar instance represents BLString.

bool BLVar::isRgba() const

Tests whether this BLVar instance represents boxed BLRgba.

bool BLVar::isRgba32() const

Tests whether this BLVar instance represents boxed BLRgba32.

bool BLVar::isRgba64() const

Tests whether this BLVar instance represents boxed BLRgba64.

bool BLVar::isUInt64() const

Tests whether this BLVar instance represents a boxed uint64_t value.

bool BLVar::isStyle() const

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

BLResult BLVar::toBool(bool* out) const

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

BLResult BLVar::toInt32(int32_t* out) const

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

BLResult BLVar::toInt64(int64_t* out) const

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

BLResult BLVar::toUInt32(uint32_t* out) const

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

BLResult BLVar::toUInt64(uint64_t* out) const

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

BLResult BLVar::toDouble(double* out) const

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

BLResult BLVar::toRgba(BLRgba* out) const

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

BLResult BLVar::toRgba32(BLRgba32* out) const

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

BLResult BLVar::toRgba64(BLRgba64* out) const

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

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

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

BLResult BLVar::getProperty(BLStringView name, BLVarCore& valueOut) const[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)[1/2]

Sets a property of the given name to value.

BLResult BLVar::setProperty(BLStringView name, const BLObjectCore& value)[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()[1/2]

Casts this BLVar instance to T&.

template<typename T>

const T& BLVar::as() const[2/2]

Casts this BLVar instance to const T&.