Runtime API

Interaction with Blend2D runtime.

Namespaces

namespace BLRuntime

Classes

struct BLRuntimeBuildInfo

struct BLRuntimeSystemInfo

struct BLRuntimeResourceInfo

class BLRuntimeInitializer

struct BLRuntimeScopeCore

class BLRuntimeScope

Runtime - Constants

enum BLRuntimeLimits : uint32_t

enum BLRuntimeInfoType : uint32_t

enum BLRuntimeBuildType : uint32_t

enum BLRuntimeCpuArch : uint32_t

enum BLRuntimeCpuFeatures : uint32_t

enum BLRuntimeCleanupFlags : uint32_t

Runtime - C API

BLResult blRuntimeInit()

BLResult blRuntimeShutdown()

BLResult blRuntimeCleanup(BLRuntimeCleanupFlags cleanupFlags)

BLResult blRuntimeQueryInfo(BLRuntimeInfoType infoType, void* infoOut)

BLResult blRuntimeMessageOut(const char* msg)

BLResult blRuntimeMessageFmt(const char* fmt, ...)

BLResult blRuntimeMessageVFmt(const char* fmt, va_list ap)

BLResult blResultFromPosixError(int e)

BLRuntimeScope - C API

BLResult blRuntimeScopeBegin(BLRuntimeScopeCore* self)

BLResult blRuntimeScopeEnd(BLRuntimeScopeCore* self)

bool blRuntimeScopeIsActive(const BLRuntimeScopeCore* self)

Enumeration Type Documentation

BLRuntimeLimits : uint32_tenum

Blend2D runtime limits.

Note

These constants are used across Blend2D, but they are not designed to be ABI stable. New versions of Blend2D can increase certain limits without notice. Use runtime to query the limits dynamically, see BLRuntimeBuildInfo.

Constant	Description
BL_RUNTIME_MAX_IMAGE_SIZE	Maximum width and height of an image.
BL_RUNTIME_MAX_THREAD_COUNT	Maximum number of threads for asynchronous operations (including rendering).

BLRuntimeInfoType : uint32_tenum

Type of runtime information that can be queried through blRuntimeQueryInfo().

Constant	Description
BL_RUNTIME_INFO_TYPE_BUILD	Blend2D build information.
BL_RUNTIME_INFO_TYPE_SYSTEM	System information (includes CPU architecture, features, core count, etc...).
BL_RUNTIME_INFO_TYPE_RESOURCE	Resources information (includes Blend2D memory consumption)
BL_RUNTIME_INFO_TYPE_MAX_VALUE	Count of runtime information types.

BLRuntimeBuildType : uint32_tenum

Blend2D runtime build type.

Constant	Description
BL_RUNTIME_BUILD_TYPE_DEBUG	Describes a Blend2D debug build.
BL_RUNTIME_BUILD_TYPE_RELEASE	Describes a Blend2D release build.

BLRuntimeCpuArch : uint32_tenum

CPU architecture that can be queried by BLRuntime::querySystemInfo().

Constant	Description
BL_RUNTIME_CPU_ARCH_UNKNOWN	Unknown architecture.
BL_RUNTIME_CPU_ARCH_X86	32-bit or 64-bit X86 architecture.
BL_RUNTIME_CPU_ARCH_ARM	32-bit or 64-bit ARM architecture.
BL_RUNTIME_CPU_ARCH_MIPS	32-bit or 64-bit MIPS architecture.

BLRuntimeCpuFeatures : uint32_tenum

CPU features Blend2D supports.

BLRuntimeCleanupFlags : uint32_tenum

Runtime cleanup flags that can be used through BLRuntime::cleanup().

Constant	Description
BL_RUNTIME_CLEANUP_NO_FLAGS	No flags.
BL_RUNTIME_CLEANUP_OBJECT_POOL	Cleanup object memory pool.
BL_RUNTIME_CLEANUP_ZEROED_POOL	Cleanup zeroed memory pool.
BL_RUNTIME_CLEANUP_THREAD_POOL	Cleanup thread pool (would join unused threads).
BL_RUNTIME_CLEANUP_EVERYTHING	Cleanup everything.