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(T&& value) noexcept

Overloaded Operators

BLVar& operator=(T&& value) noexcept
bool operator==(const T& other) const noexcept
bool operator!=(const T& other) const noexcept

Common Functionality

Type Accessors

Properties

Casts

T& as() noexcept
const T& as() const noexcept

Assignment

BLResult assign(T&& value) noexcept

Equality

bool equals(const T& value) const noexcept

Static Functions

Static Construction

Additional Inherited Members

Public Attributes inherited from BLObjectCore

BLObjectType BLVar::type() constnodiscardnoexcept[¶]

Returns the type of the underlying object.

bool BLVar::is_array() constnodiscardnoexcept[¶]

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

bool BLVar::is_bit_array() constnodiscardnoexcept[¶]

Tests whether this BLVar instance represents BLBitArray.

bool BLVar::is_bit_set() constnodiscardnoexcept[¶]

Tests whether this BLVar instance represents BLBitSet.

bool BLVar::is_bool() constnodiscardnoexcept[¶]

Tests whether this BLVar instance represents a boxed bool value.

bool BLVar::is_context() constnodiscardnoexcept[¶]

Tests whether this BLVar instance represents BLContext.

bool BLVar::is_double() constnodiscardnoexcept[¶]

Tests whether this BLVar instance represents a boxed double value.

bool BLVar::is_font() constnodiscardnoexcept[¶]

Tests whether this BLVar instance represents BLFont.

bool BLVar::is_font_data() constnodiscardnoexcept[¶]

Tests whether this BLVar instance represents BLFontData.

bool BLVar::is_font_face() constnodiscardnoexcept[¶]

Tests whether this BLVar instance represents BLFontFace.

bool BLVar::is_font_manager() constnodiscardnoexcept[¶]

Tests whether this BLVar instance represents BLFontManager.

bool BLVar::is_gradient() constnodiscardnoexcept[¶]

Tests whether this BLVar instance represents BLGradient.

bool BLVar::is_image() constnodiscardnoexcept[¶]

Tests whether this BLVar instance represents BLImage.

bool BLVar::is_image_codec() constnodiscardnoexcept[¶]

Tests whether this BLVar instance represents BLImageCodec.

bool BLVar::is_image_decoder() constnodiscardnoexcept[¶]

Tests whether this BLVar instance represents BLImageDecoder.

bool BLVar::is_image_encoder() constnodiscardnoexcept[¶]

Tests whether this BLVar instance represents BLImageEncoder.

bool BLVar::is_int64() constnodiscardnoexcept[¶]

Tests whether this BLVar instance represents a boxed int64_t value.

bool BLVar::is_null() constnodiscardnoexcept[¶]

Tests whether this BLVar instance represents a null value.

bool BLVar::is_path() constnodiscardnoexcept[¶]

Tests whether this BLVar instance represents BLPath.

bool BLVar::is_pattern() constnodiscardnoexcept[¶]

Tests whether this BLVar instance represents BLPattern.

bool BLVar::is_string() constnodiscardnoexcept[¶]

Tests whether this BLVar instance represents BLString.

bool BLVar::is_rgba() constnodiscardnoexcept[¶]

Tests whether this BLVar instance represents boxed BLRgba.

bool BLVar::is_rgba32() constnodiscardnoexcept[¶]

Tests whether this BLVar instance represents boxed BLRgba32.

bool BLVar::is_rgba64() constnodiscardnoexcept[¶]

Tests whether this BLVar instance represents boxed BLRgba64.

bool BLVar::is_uint64() constnodiscardnoexcept[¶]

Tests whether this BLVar instance represents a boxed uint64_t value.

bool BLVar::is_style() constnodiscardnoexcept[¶]

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

BLResult BLVar::get_property(
BLStringView name,
BLVarCore& value_out
) 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::set_property(
const char* name,
const BLObjectCore& value
)noexcept[1/2][¶]

Sets a property of the given name to value.

BLResult BLVar::set_property(
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-2025 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.