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 ⭢ Object Model ⭢ BLObjectInfo

BLObjectInfo Struct Reference

Information bits used by BLObjectCore and all Blend2D compatible objects inheriting it.

Public Members

Members

uint32_t bits

Public Types

Constants

enum : uint32_t

Member Functions

Overloaded Operators

constexpr bool operator==(const BLObjectInfo& other) const noexcept

constexpr bool operator!=(const BLObjectInfo& other) const noexcept

constexpr BLObjectInfo operator|(const BLObjectInfo& v) const noexcept

constexpr BLObjectInfo operator&(const BLObjectInfo& v) const noexcept

constexpr BLObjectInfo operator^(const BLObjectInfo& v) const noexcept

constexpr BLObjectInfo operator|(const BLObjectInfoBits& v) const noexcept

constexpr BLObjectInfo operator&(const BLObjectInfoBits& v) const noexcept

constexpr BLObjectInfo operator^(const BLObjectInfoBits& v) const noexcept

BLObjectInfo& operator| = (const BLObjectInfo& v) noexcept

BLObjectInfo& operator& = (const BLObjectInfo& v) noexcept

BLObjectInfo& operator^ = (const BLObjectInfo& v) noexcept

BLObjectInfo& operator| = (const BLObjectInfoBits& v) noexcept

BLObjectInfo& operator& = (const BLObjectInfoBits& v) noexcept

BLObjectInfo& operator^ = (const BLObjectInfoBits& v) noexcept

Info Data Accessors - Generic

template<uint32_t Shift, uint32_t Mask>

constexpr uint32_t getField() const noexcept

template<uint32_t Shift, uint32_t Mask>

void setField(uint32_t value) noexcept

constexpr bool sso() const noexcept

constexpr bool dynamicFlag() const noexcept

constexpr uint32_t aField() const noexcept

constexpr uint32_t bField() const noexcept

constexpr uint32_t cField() const noexcept

constexpr uint32_t pField() const noexcept

constexpr uint32_t qField() const noexcept

constexpr uint32_t fields() const noexcept

void setAField(uint32_t value) noexcept

void setBField(uint32_t value) noexcept

void setCField(uint32_t value) noexcept

void setPField(uint32_t value) noexcept

void setQField(uint32_t value) noexcept

void setFields(uint32_t value) noexcept

BLObject Signature Accessors

constexpr bool hasObjectSignatureAndFlags(uint32_t mask, uint32_t check) const noexcept

constexpr bool hasObjectSignatureAndFlags(uint32_t flags) const noexcept

constexpr bool hasObjectSignature() const noexcept

constexpr bool checkObjectSignatureAndRawType(BLObjectType type) const noexcept

BLObject Type Accessors

constexpr bool isObject() const noexcept

constexpr uint32_t isObjectMask() const noexcept

constexpr bool isDynamicObject() const noexcept

constexpr bool isRefCountedObject() const noexcept

constexpr bool isVirtualObject() const noexcept

constexpr BLObjectType rawType() const noexcept

constexpr BLObjectType getType() const noexcept

constexpr bool isArray() const noexcept

constexpr bool isBitArray() const noexcept

constexpr bool isBitSet() const noexcept

constexpr bool isBool() const noexcept

constexpr bool isContext() const noexcept

constexpr bool isDouble() const noexcept

constexpr bool isFont() const noexcept

constexpr bool isFontData() const noexcept

constexpr bool isFontFace() const noexcept

constexpr bool isFontFeatureSettings() const noexcept

constexpr bool isFontManager() const noexcept

constexpr bool isFontVariationSettings() const noexcept

constexpr bool isGradient() const noexcept

constexpr bool isImage() const noexcept

constexpr bool isImageCodec() const noexcept

constexpr bool isImageDecoder() const noexcept

constexpr bool isImageEncoder() const noexcept

constexpr bool isInt64() const noexcept

constexpr bool isNull() const noexcept

constexpr bool isPath() const noexcept

constexpr bool isPattern() const noexcept

constexpr bool isRgba() const noexcept

constexpr bool isRgba32() const noexcept

constexpr bool isRgba64() const noexcept

constexpr bool isString() const noexcept

constexpr bool isUInt64() const noexcept

constexpr bool isStyle() const noexcept

Static Functions

Static Methods for Packing & Unpacking

static constexpr uint32_t packType(BLObjectType type) noexcept

static constexpr uint32_t packTypeWithMarker(BLObjectType type) noexcept

static constexpr uint32_t packAbcp(uint32_t aField, uint32_t bField = 0u, uint32_t cField = 0u, uint32_t pField = 0u) noexcept

static constexpr BLObjectInfo fromType(BLObjectType type) noexcept

static constexpr BLObjectInfo fromTypeWithMarker(BLObjectType type) noexcept

static constexpr BLObjectInfo fromAbcp(uint32_t aField, uint32_t bField = 0u, uint32_t cField = 0u, uint32_t pField = 0u) noexcept

anonymous enum : uint32_t

Constant	Description
kSignatureSSOBitSetRange	Signature of a SSO BitSet, which is in Range mode.

uint32_t BLObjectInfo::packType(

BLObjectType type

)constexprstaticnoexcept

Packs object type into object info bits.

uint32_t BLObjectInfo::packTypeWithMarker(

BLObjectType type

)constexprstaticnoexcept

Packs object type and M flag into object info bits.

uint32_t BLObjectInfo::packAbcp(

uint32_t aField,

uint32_t bField = 0u,

uint32_t cField = 0u,

uint32_t pField = 0u

)constexprstaticnoexcept

Packs A, B, C, and P fields so they can be combined with other object info bits.

template<uint32_t Shift, uint32_t Mask>

uint32_t BLObjectInfo::getField() constconstexprnoexcept

Extracts a field based on Shift and Mask.

Note

It doesn't verify whether the object info is valid, it just extracts the field.

bool BLObjectInfo::hasObjectSignatureAndFlags(

uint32_t mask,

uint32_t check

) constconstexprnoexcept[1/2]

Tests whether BLObjectInfo describes a valid BLObject and verifies that additionalBits match the given mask in BLObjectInfo bits as well. This function is a higher-level function used by others.

bool BLObjectInfo::hasObjectSignatureAndFlags(

uint32_t flags

) constconstexprnoexcept[2/2]

Tests whether BLObjectInfo describes a valid BLObject and verifies the the given flags are all set.

bool BLObjectInfo::hasObjectSignature() constconstexprnoexcept

Tests whether the object info represents a valid BLObject signature.

A valid signature describes a BLObjectCore and not an alternative representation used by BLRgba data.

bool BLObjectInfo::checkObjectSignatureAndRawType(

BLObjectType type

) constconstexprnoexcept

Tests whether BLObjectInfo describes a valid BLObject of the given type.

bool BLObjectInfo::isObject() constconstexprnoexcept

Tests a whether this BLObjectInfo represents a valid BLObjectCore.

uint32_t BLObjectInfo::isObjectMask() constconstexprnoexcept

Returns a whether this BLObjectInfo represents a valid BLObjectCore as a mask (either all zeros or all ones).

bool BLObjectInfo::isDynamicObject() constconstexprnoexcept

Tests whether the object info represents a valid BLObject, which has a valid Impl field.

bool BLObjectInfo::isRefCountedObject() constconstexprnoexcept

Tests whether the object info represents a valid BLObject, which has a valid Impl, and is reference counted.

bool BLObjectInfo::isVirtualObject() constconstexprnoexcept

Tests whether the object info represents a valid BLObject, which has a valid Impl, and has a virtual function table.

BLObjectType BLObjectInfo::rawType() constconstexprnoexcept

Returns a RAW BLObjectType read from object info bits without checking for a 'M' object marker.

This function should only be used in case that the caller knows that the object info is of a valid BLObjectCore. In any other case the use of getType() is preferred and would always provide a correct type.

BLObjectType BLObjectInfo::getType() constconstexprnoexcept

Returns a corrected BLObjectType read from object info bits.

If the object marker bit 'M' is not set, 0 will be returned, which represents BL_OBJECT_TYPE_RGBA.

bool BLObjectInfo::isArray() constconstexprnoexcept

Tests whether the object info represents a BLArray<T> storing any supported type.

bool BLObjectInfo::isBitArray() constconstexprnoexcept

Tests whether the object info represents a BLBitArray.

bool BLObjectInfo::isBitSet() constconstexprnoexcept

Tests whether the object info represents a BLBitSet.

bool BLObjectInfo::isBool() constconstexprnoexcept

Tests whether the object info represents a boxed bool value.

bool BLObjectInfo::isContext() constconstexprnoexcept

Tests whether the object info represents BLContext.

bool BLObjectInfo::isDouble() constconstexprnoexcept

Tests whether the object info represents a boxed double value.

bool BLObjectInfo::isFont() constconstexprnoexcept

Tests whether the object info represents BLFont.

bool BLObjectInfo::isFontData() constconstexprnoexcept

Tests whether the object info represents BLFontData.

bool BLObjectInfo::isFontFace() constconstexprnoexcept

Tests whether the object info represents BLFontFace.

bool BLObjectInfo::isFontFeatureSettings() constconstexprnoexcept

Tests whether the object info represents BLFontFeatureSettings.

bool BLObjectInfo::isFontManager() constconstexprnoexcept

Tests whether the object info represents BLFontManager.

bool BLObjectInfo::isFontVariationSettings() constconstexprnoexcept

Tests whether the object info represents BLFontVariationSettings.

bool BLObjectInfo::isGradient() constconstexprnoexcept

Tests whether the object info represents BLGradient.

bool BLObjectInfo::isImage() constconstexprnoexcept

Tests whether the object info represents BLImage.

bool BLObjectInfo::isImageCodec() constconstexprnoexcept

Tests whether the object info represents BLImageCodec.

bool BLObjectInfo::isImageDecoder() constconstexprnoexcept

Tests whether the object info represents BLImageDecoder.

bool BLObjectInfo::isImageEncoder() constconstexprnoexcept

Tests whether the object info represents BLImageEncoder.

bool BLObjectInfo::isInt64() constconstexprnoexcept

Tests whether the object info represents a boxed int64_t value.

bool BLObjectInfo::isNull() constconstexprnoexcept

Tests whether the object info represents a null value.

bool BLObjectInfo::isPath() constconstexprnoexcept

Tests whether the object info represents BLPath.

bool BLObjectInfo::isPattern() constconstexprnoexcept

Tests whether the object info represents BLPattern.

bool BLObjectInfo::isRgba() constconstexprnoexcept

Tests whether the object info represents BLRgba.

bool BLObjectInfo::isRgba32() constconstexprnoexcept

Tests whether the object info represents BLRgba32.

bool BLObjectInfo::isRgba64() constconstexprnoexcept

Tests whether the object info represents BLRgba64.

bool BLObjectInfo::isString() constconstexprnoexcept

Tests whether the object info represents BLString.

bool BLObjectInfo::isUInt64() constconstexprnoexcept

Tests whether the object info represents a boxed uint64_t value.

bool BLObjectInfo::isStyle() constconstexprnoexcept

Tests whether the object info represents a style that can be passed to the rendering context.

uint32_t BLObjectInfo::bits

Stores all object info bits.

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.