API

Vision

Root image, codec, capture, media, viewer, and Vulkan Video values plus FnImage and FnDetection.

Compiler-extracted public headersNative C++ surface82 functions114 classes35 enums5 constants & variables

This inventory is extracted from OA public headers by clang-doc. Native types, pointers, references, defaults, public inheritance, comments and source ownership come from the compiler surface.

Examples

ExVision

Load the Vision cover, convert its GPU-resident RGB pixels to Rec.709 grayscale, save the semantic Gray image, and optionally inspect it in Viewer.

ExUi

Record one training-loss series, render the retained figure through OA's GPU compositor, save it, and optionally inspect it in Viewer.

ExVision

Open the authored ML cover in OA’s native Vulkan viewer, inspect it on the navigable canvas, and move into fullspace presentation.

Vision

Functions

Source

Classes

0 members

codec config parsed from av1C (AV1 ISO-BMFF §2.3): the configOBUs blob, which carries the sequence-header OBU out-of-band. AV1 MP4 samples are OBU temporal units that omit the sequence header, so we prepend this to every keyframe temporal unit (analogous to SPS/PPS for H.264/H.265).

Vector

VideoProfile

bool

Source

0 members

codec config parsed from avcC (H.264): SPS + PPS as Annex-B bytes, ready to prepend to the first IDR packet. Also exposes the NAL length field width so readNextPacket can rewrite length-prefix → start codes.

oa::U8

Vector

VideoProfile

Vector

bool

Source

15 members

constructor

Explicit completion and release boundary for producer-owned images and mapped ring slots still referenced by GPU consumers.

method

static

acquire and upload the newest available frame. Returns false when the camera has not produced another frame yet.

method

release a frame after its final consumer. The no-token overload declares immediate reuse; pass the exact completion when GPU work remains live.

method

Source

0 members

oa::I32

String

oa::I32

bool

oa::U32

oa::I32

Source

0 members

F32

U32

F32

U32

F32

Source

10 members

method

Host-visible creation path for sidecars, tests, and CPU integrations. Native GPU postprocess will use the same record layout and consumer API.

static

constructor

method

Replaces the current records. Fails while a previous render submission still consumes this slot.

method

Source

1 members

Matrix

method

Source

0 members

Encoded frame output — bitstream + PTS + key/keyflag.

Vector

oa::U32

bool

oa::U64

Source

0 members

ISO-BMFF fragment defaults. `moov/mvex/trex` establishes this state; later `moof/traf/trun` boxes use it without retaining media payloads.

oa::U32

Source

0 members

bool

oa::I32

bool

oa::U32

oa::I32

oa::U32

bool

oa::I32

oa::U32

bool

oa::U32

bool

Source

0 members

oa::U32

bool

oa::U32

bool

oa::U32

bool

oa::U32

bool

oa::U32

oa::I32

Array

oa::I32

oa::U32

bool

oa::U32

Source

0 members

oa::I32

bool

oa::I32

bool

oa::I32

bool

oa::U32

bool

oa::I32

bool

oa::U32

bool

oa::U32

bool

oa::U32

bool

oa::U32

oa::I32

bool

Source

0 members

bool

oa::U32

bool

Array

oa::U32

bool

oa::U32

bool

oa::U32

Source

0 members

bool

oa::U32

bool

oa::U32

bool

oa::U32

bool

oa::U32

Source

0 members

codec config parsed from hvcC (H.265): VPS + SPS + PPS as Annex-B bytes

oa::U8

Vector

VideoProfile

Vector

bool

Vector

Source

0 members

Lightweight NAL unit descriptor — payload references back into the caller's bitstream buffer (no copy). For Annex-B framing the payload begins at the NAL header byte (skip the 00 00 00 01 / 00 00 01 prefix).

Span

oa::U8

Source

0 members

bool

oa::F32

oa::I32

oa::F32

Source

1 members

Matrix

method

Source

0 members

oa::F32[3]

Source

0 members

MP4 sample entry (used by parser)

oa::I32

oa::U64

bool

oa::U64

oa::U32

Source

11 members

Stops the producer thread, completes exact frame-consumer dependencies, and releases portal, PipeWire, and vulkan resources.

method

static

Non-blocking. Returns true when a newer frame than the previous poll() is published through the common video-frame contract.

method

release a frame returned by poll(). The no-token overload declares that no asynchronous consumer remains.

method

GPU-deferred release. DMA-BUF ownership returns to PipeWire only after inConsumed completes. mapped fallback ring slots are likewise withheld from producer reuse until the exact completion becomes ready.

method

constructor

method

Source

0 members

ScreenCaptureCursor

oa::U32

ScreenCaptureTarget

Source

1 members

Matrix

method

Source

0 members

Container information (probed from file header)

VideoCodec

oa::U64

oa::U32

VideoContainerKind

oa::U64

oa::U32

Source

0 members

YCbCr to RGB conversion options

YCbCrModel

bool

Filter

bool

Source

0 members

codec/profile-specific vulkan Video decode capabilities.

VkVideoDecodeCapabilityFlagsKHR

Vector

bool

oa::U32

oa::U64

oa::U32

bool

Vector

oa::U32

VkFormat

VideoProfile

VkFormat

VkExtensionProperties

bool

Source

36 members

hardware video decoder session. Wraps VkVideoSessionKHR + DPB management.

method

Explicit completion and resource-release boundary.

method

Decoder-owned color conversion, explicit targets, host observations, and ML bridges.

method

Create decoder for specific codec and resolution.

static

method

Decode one compressed access unit through this session's owning engine.

method

flush decoder state (call at stream end or seek).

method

static

query capabilities

static

method

Returns tightly packed two-plane 4:2:0 bytes in the frame's native storage representation: NV12 bytes or little-endian P010 16-bit words.

method

wait for the last GPU submission on this decoder to complete.

method

Source

21 members

Video stream demuxer

Av1Config

AvcConfig

FragmentConfig

HvcConfig

VideoContainerInfo

Vector

Vp9Config

Explicit resource-release boundary. Reports local file close failures; pending packets are discarded and no container data is manufactured.

method

Returns SPS+PPS concatenated as Annex-B (empty if not parsed). Caller prepends to the first IDR packet to bootstrap the decoder.

method

index of the next sample readNextPacket() will read (0-based). After decoding sample N, this equals N+1. Used by Video for step-back.

method

get container info

method

get video profile for decoder creation

method

Check if end of stream

method

open either a local path or a URL through one canonical source boundary.

static

probe container info without opening full file

static

Enums

Source

Constant · Replicate · Reflect · Reflect101 · Wrap

Source

Auto · Jpeg · Png · Webp · Bmp · Tga

Source

Nearest · Bilinear · Bicubic

Source

NV12 · RGB8 · RGBA8 · BF16 · F32

Source

Hidden · Embedded

Source

MonitorOrWindow · Monitor · Window

Source

Bit8 · Bit10 · Bit12

Source

Monochrome · Yuv420 · Yuv422 · Yuv444

Source

H264 · H265 · AV1 · VP9

Source

codec-standard profile. values are codec-qualified so a VideoProfile is self-describing without exposing vulkan std Video enums.

Unspecified · H264Baseline · H264Main · H264High · H264High444Predictive · H265Main · H265Main10 · H265MainStillPicture · H265FormatRangeExtensions · H265ScreenContentCodingExtensions · Av1Main · Av1High · Av1Professional · Vp9Profile0 · Vp9Profile1 · Vp9Profile2 · Vp9Profile3

Source

Container kind enumeration

Unknown · Mp4 · WebM · MpegTs · Matroska

Source

storage backing a video frame.

None · Image · Buffer

Source

Progressive · InterlacedInterleavedLines · InterlacedSeparatePlanes

Source

ConstantQp · Cbr · Vbr

Source

Decoded-frame resource path — selected once at decoder create() based on device capabilities + queue topology.

CoincidentFastStaging · DistinctComputeConvert · CoincidentComputeStaging · DirectCoincidentSampling · Unavailable

Source

Auto · BT709 · BT2020

Functions

Source

Binary mask counts [true-positive, false-positive, false-negative, true-negative]. Inputs are equally-shaped UInt8 masks.

Source

Pairwise IoU for FP32 center-x/center-y/width/height boxes. inA [N,4], inB [M,4] -> FP32 [N,M]. Coordinates may be normalized or pixel-valued, but widths and heights must be non-negative.

Source

Classification confusion matrix. rows are target classes and columns are predicted classes: Int32 [N], Int32 [N] -> UInt32 [C,C].

DetectionMetricsResult oa::FnDetection::evaluate(const Matrix & inPredictedBoxes, const Matrix & inPredictedScores, const Matrix & inPredictedClasses, const Matrix & inPredictedImageIds, const Matrix & inTargetBoxes, const Matrix & inTargetClasses, const Matrix & inTargetImageIds, const Matrix & inIouThresholds, oa::I32 inClassCount, oa::F32 inScoreThreshold = 0.0F)DetectionMetricsResult oa::FnDetection::evaluate(const Matrix & inPredictedBoxes, const Matrix & inPredictedScores, const Matrix & inPredictedClasses, const Matrix & inPredictedImageIds, const Matrix & inTargetBoxes, const Matrix & inTargetClasses, const Matrix & inTargetImageIds, const Matrix & inIouThresholds, oa::I32 inClassCount, oa::F32 inScoreThreshold = 0.0F)

Source

Dataset-level object-detection evaluation. Predictions are FP32 boxes [P,4], FP32 scores [P], Int32 classes [P] and Int32 image IDs [P]. targets are FP32 boxes [G,4], Int32 classes [G] and Int32 image IDs [G]. IoU thresholds are FP32 [T]. Matching is greedy by descending score, class-aware and constrained to the same image. classes without targets do not contribute to mAP. All outputs and internal scratch stay GPU-resident.

Source

Multiclass semantic-segmentation metrics over flattened Int32 label matrices. labels outside [0,classCount) are ignored by the confusion accumulator, which provides the ordinary ignore-index behavior.

Source

Deterministic class-aware NMS. boxes are FP32 [N,4] cx/cy/w/h, scores FP32 [N], and classes Int32 [N]. The implementation is GPU-resident and records as one graph node; it never sorts or compacts on the host.

Functions

oa::Matrix oa::FnImage::adaptiveThresholdGaussian(oa::Engine & inEngine, const oa::Matrix & inImage, oa::U32 inKernelSize = 11, oa::F32 inC = 0.0F, oa::F32 inMaxValue = 1.0F, oa::F32 inSigma = 0.0F, oa::BorderMode inBorder = oa::BorderMode::Reflect101)oa::Matrix oa::FnImage::adaptiveThresholdGaussian(oa::Engine & inEngine, const oa::Matrix & inImage, oa::U32 inKernelSize = 11, oa::F32 inC = 0.0F, oa::F32 inMaxValue = 1.0F, oa::F32 inSigma = 0.0F, oa::BorderMode inBorder = oa::BorderMode::Reflect101)oa::Matrix oa::FnImage::adaptiveThresholdGaussian(const oa::Matrix & inImage, oa::U32 inKernelSize = 11, oa::F32 inC = 0.0F, oa::F32 inMaxValue = 1.0F, oa::F32 inSigma = 0.0F, oa::BorderMode inBorder = oa::BorderMode::Reflect101)oa::Matrix oa::FnImage::adaptiveThresholdGaussian(const oa::Matrix & inImage, oa::U32 inKernelSize = 11, oa::F32 inC = 0.0F, oa::F32 inMaxValue = 1.0F, oa::F32 inSigma = 0.0F, oa::BorderMode inBorder = oa::BorderMode::Reflect101)

Source

adaptiveThresholdGaussian: Local Gaussian adaptive binary threshold.

oa::Matrix oa::FnImage::adaptiveThresholdMean(oa::Engine & inEngine, const oa::Matrix & inImage, oa::U32 inKernelSize = 11, oa::F32 inC = 0.0F, oa::F32 inMaxValue = 1.0F, oa::BorderMode inBorder = oa::BorderMode::Reflect101)oa::Matrix oa::FnImage::adaptiveThresholdMean(oa::Engine & inEngine, const oa::Matrix & inImage, oa::U32 inKernelSize = 11, oa::F32 inC = 0.0F, oa::F32 inMaxValue = 1.0F, oa::BorderMode inBorder = oa::BorderMode::Reflect101)oa::Matrix oa::FnImage::adaptiveThresholdMean(const oa::Matrix & inImage, oa::U32 inKernelSize = 11, oa::F32 inC = 0.0F, oa::F32 inMaxValue = 1.0F, oa::BorderMode inBorder = oa::BorderMode::Reflect101)oa::Matrix oa::FnImage::adaptiveThresholdMean(const oa::Matrix & inImage, oa::U32 inKernelSize = 11, oa::F32 inC = 0.0F, oa::F32 inMaxValue = 1.0F, oa::BorderMode inBorder = oa::BorderMode::Reflect101)

Source

adaptiveThresholdMean: Local mean adaptive binary threshold.

Source

alphaBlend: Scalar alpha blend of equal-shaped images.

Source

averageBlur: Normalized box blur lowered through the generic 2D filter.

oa::Matrix oa::FnImage::bilateralFilter(oa::Engine & inEngine, const oa::Matrix & inImage, oa::U32 inKernelSize = 5, oa::F32 inSigmaColor = 0.1F, oa::F32 inSigmaSpace = 1.0F, oa::BorderMode inBorder = oa::BorderMode::Reflect101)oa::Matrix oa::FnImage::bilateralFilter(oa::Engine & inEngine, const oa::Matrix & inImage, oa::U32 inKernelSize = 5, oa::F32 inSigmaColor = 0.1F, oa::F32 inSigmaSpace = 1.0F, oa::BorderMode inBorder = oa::BorderMode::Reflect101)oa::Matrix oa::FnImage::bilateralFilter(const oa::Matrix & inImage, oa::U32 inKernelSize = 5, oa::F32 inSigmaColor = 0.1F, oa::F32 inSigmaSpace = 1.0F, oa::BorderMode inBorder = oa::BorderMode::Reflect101)oa::Matrix oa::FnImage::bilateralFilter(const oa::Matrix & inImage, oa::U32 inKernelSize = 5, oa::F32 inSigmaColor = 0.1F, oa::F32 inSigmaSpace = 1.0F, oa::BorderMode inBorder = oa::BorderMode::Reflect101)

Source

bilateralFilter: Edge-preserving bilateral neighborhood filter.

Source

brightnessContrast: Affine brightness and contrast adjustment.

Source

centerCrop: Centered crop lowered through Crop.

Source

channelReorder: Reorder one to four NCHW channels.

Source

clamp: Clamp image values to a scalar interval.

Source

colorTwist: Apply a shared 3x4 RGB color transform matrix.

Source

composite: Per-pixel masked composite with one or C mask channels.

Source

convolve2d: Same-shape NCHW 2D cross-correlation with an odd shared kernel and explicit border semantics.

Source

crop: Crop NCHW image: out = A[y:y+h, x:x+w].

Source

Stateless still-image codec boundaries. Decode uploads one normalized Float32 NCHW image through the active engine. Encode and saveFile are explicit synchronous host boundaries which complete and read back their semantic image input.

Source

oa::Matrix oa::FnImage::dilate(oa::Engine & inEngine, const oa::Matrix & inImage, oa::U32 inKernelWidth = 3, oa::U32 inKernelHeight = 3, oa::BorderMode inBorder = oa::BorderMode::Reflect101, oa::F32 inBorderValue = 0.0F)oa::Matrix oa::FnImage::dilate(oa::Engine & inEngine, const oa::Matrix & inImage, oa::U32 inKernelWidth = 3, oa::U32 inKernelHeight = 3, oa::BorderMode inBorder = oa::BorderMode::Reflect101, oa::F32 inBorderValue = 0.0F)

Source

dilate: Rectangular NCHW dilation using the shared border contract.

Source

erase: Fill a rectangular region with a scalar value.

oa::Matrix oa::FnImage::erode(oa::Engine & inEngine, const oa::Matrix & inImage, oa::U32 inKernelWidth = 3, oa::U32 inKernelHeight = 3, oa::BorderMode inBorder = oa::BorderMode::Reflect101, oa::F32 inBorderValue = 0.0F)oa::Matrix oa::FnImage::erode(oa::Engine & inEngine, const oa::Matrix & inImage, oa::U32 inKernelWidth = 3, oa::U32 inKernelHeight = 3, oa::BorderMode inBorder = oa::BorderMode::Reflect101, oa::F32 inBorderValue = 0.0F)

Source

erode: Rectangular NCHW erosion using the shared border contract.

Source

flip: Flip NCHW image horizontally or vertically.

Source

gammaContrast: Gamma and gain adjustment.

Source

gaussianBlur: Gaussian blur filter with configurable kernel size and sigma.

Source

gaussianNoise: Add deterministic GPU-native Philox Gaussian noise.

Source

grayscale: Rec.709 RGB to single-channel grayscale conversion.

Source

inRange: Inclusive scalar range mask.

Source

invert: Invert values around a configurable maximum.

Source

laplacian: Signed four-neighbour discrete Laplacian lowered through the generic 2D filter.

Source

medianBlur: Odd-window median filter with explicit border semantics.

oa::Matrix oa::FnImage::morphologyBlackHat(oa::Engine & inEngine, const oa::Matrix & inImage, oa::U32 inKernelWidth = 3, oa::U32 inKernelHeight = 3, oa::BorderMode inBorder = oa::BorderMode::Reflect101, oa::F32 inBorderValue = 0.0F)oa::Matrix oa::FnImage::morphologyBlackHat(oa::Engine & inEngine, const oa::Matrix & inImage, oa::U32 inKernelWidth = 3, oa::U32 inKernelHeight = 3, oa::BorderMode inBorder = oa::BorderMode::Reflect101, oa::F32 inBorderValue = 0.0F)oa::Matrix oa::FnImage::morphologyBlackHat(const oa::Matrix & inImage, oa::U32 inKernelWidth = 3, oa::U32 inKernelHeight = 3, oa::BorderMode inBorder = oa::BorderMode::Reflect101, oa::F32 inBorderValue = 0.0F)oa::Matrix oa::FnImage::morphologyBlackHat(const oa::Matrix & inImage, oa::U32 inKernelWidth = 3, oa::U32 inKernelHeight = 3, oa::BorderMode inBorder = oa::BorderMode::Reflect101, oa::F32 inBorderValue = 0.0F)

Source

morphologyBlackHat: Morphological closing minus input.

oa::Matrix oa::FnImage::morphologyClose(oa::Engine & inEngine, const oa::Matrix & inImage, oa::U32 inKernelWidth = 3, oa::U32 inKernelHeight = 3, oa::BorderMode inBorder = oa::BorderMode::Reflect101, oa::F32 inBorderValue = 0.0F)oa::Matrix oa::FnImage::morphologyClose(oa::Engine & inEngine, const oa::Matrix & inImage, oa::U32 inKernelWidth = 3, oa::U32 inKernelHeight = 3, oa::BorderMode inBorder = oa::BorderMode::Reflect101, oa::F32 inBorderValue = 0.0F)oa::Matrix oa::FnImage::morphologyClose(const oa::Matrix & inImage, oa::U32 inKernelWidth = 3, oa::U32 inKernelHeight = 3, oa::BorderMode inBorder = oa::BorderMode::Reflect101, oa::F32 inBorderValue = 0.0F)oa::Matrix oa::FnImage::morphologyClose(const oa::Matrix & inImage, oa::U32 inKernelWidth = 3, oa::U32 inKernelHeight = 3, oa::BorderMode inBorder = oa::BorderMode::Reflect101, oa::F32 inBorderValue = 0.0F)

Source

morphologyClose: Dilation followed by erosion through the reusable morphology primitive.

oa::Matrix oa::FnImage::morphologyGradient(oa::Engine & inEngine, const oa::Matrix & inImage, oa::U32 inKernelWidth = 3, oa::U32 inKernelHeight = 3, oa::BorderMode inBorder = oa::BorderMode::Reflect101, oa::F32 inBorderValue = 0.0F)oa::Matrix oa::FnImage::morphologyGradient(oa::Engine & inEngine, const oa::Matrix & inImage, oa::U32 inKernelWidth = 3, oa::U32 inKernelHeight = 3, oa::BorderMode inBorder = oa::BorderMode::Reflect101, oa::F32 inBorderValue = 0.0F)oa::Matrix oa::FnImage::morphologyGradient(const oa::Matrix & inImage, oa::U32 inKernelWidth = 3, oa::U32 inKernelHeight = 3, oa::BorderMode inBorder = oa::BorderMode::Reflect101, oa::F32 inBorderValue = 0.0F)oa::Matrix oa::FnImage::morphologyGradient(const oa::Matrix & inImage, oa::U32 inKernelWidth = 3, oa::U32 inKernelHeight = 3, oa::BorderMode inBorder = oa::BorderMode::Reflect101, oa::F32 inBorderValue = 0.0F)

Source

morphologyGradient: Difference between dilation and erosion.

oa::Matrix oa::FnImage::morphologyOpen(oa::Engine & inEngine, const oa::Matrix & inImage, oa::U32 inKernelWidth = 3, oa::U32 inKernelHeight = 3, oa::BorderMode inBorder = oa::BorderMode::Reflect101, oa::F32 inBorderValue = 0.0F)oa::Matrix oa::FnImage::morphologyOpen(oa::Engine & inEngine, const oa::Matrix & inImage, oa::U32 inKernelWidth = 3, oa::U32 inKernelHeight = 3, oa::BorderMode inBorder = oa::BorderMode::Reflect101, oa::F32 inBorderValue = 0.0F)oa::Matrix oa::FnImage::morphologyOpen(const oa::Matrix & inImage, oa::U32 inKernelWidth = 3, oa::U32 inKernelHeight = 3, oa::BorderMode inBorder = oa::BorderMode::Reflect101, oa::F32 inBorderValue = 0.0F)oa::Matrix oa::FnImage::morphologyOpen(const oa::Matrix & inImage, oa::U32 inKernelWidth = 3, oa::U32 inKernelHeight = 3, oa::BorderMode inBorder = oa::BorderMode::Reflect101, oa::F32 inBorderValue = 0.0F)

Source

morphologyOpen: Erosion followed by dilation through the reusable morphology primitive.

oa::Matrix oa::FnImage::morphologyTopHat(oa::Engine & inEngine, const oa::Matrix & inImage, oa::U32 inKernelWidth = 3, oa::U32 inKernelHeight = 3, oa::BorderMode inBorder = oa::BorderMode::Reflect101, oa::F32 inBorderValue = 0.0F)oa::Matrix oa::FnImage::morphologyTopHat(oa::Engine & inEngine, const oa::Matrix & inImage, oa::U32 inKernelWidth = 3, oa::U32 inKernelHeight = 3, oa::BorderMode inBorder = oa::BorderMode::Reflect101, oa::F32 inBorderValue = 0.0F)oa::Matrix oa::FnImage::morphologyTopHat(const oa::Matrix & inImage, oa::U32 inKernelWidth = 3, oa::U32 inKernelHeight = 3, oa::BorderMode inBorder = oa::BorderMode::Reflect101, oa::F32 inBorderValue = 0.0F)oa::Matrix oa::FnImage::morphologyTopHat(const oa::Matrix & inImage, oa::U32 inKernelWidth = 3, oa::U32 inKernelHeight = 3, oa::BorderMode inBorder = oa::BorderMode::Reflect101, oa::F32 inBorderValue = 0.0F)

Source

morphologyTopHat: Input minus morphological opening.

Source

normalize: Apply per-channel normalization to an NCHW image tensor.

oa::Matrix oa::FnImage::pad(oa::Engine & inEngine, const oa::Matrix & inImage, oa::U32 inLeft, oa::U32 inRight, oa::U32 inTop, oa::U32 inBottom, oa::BorderMode inBorder = oa::BorderMode::Constant, oa::F32 inBorderValue = 0.0F)oa::Matrix oa::FnImage::pad(oa::Engine & inEngine, const oa::Matrix & inImage, oa::U32 inLeft, oa::U32 inRight, oa::U32 inTop, oa::U32 inBottom, oa::BorderMode inBorder = oa::BorderMode::Constant, oa::F32 inBorderValue = 0.0F)oa::Matrix oa::FnImage::pad(const oa::Matrix & inImage, oa::U32 inLeft, oa::U32 inRight, oa::U32 inTop, oa::U32 inBottom, oa::BorderMode inBorder = oa::BorderMode::Constant, oa::F32 inBorderValue = 0.0F)oa::Matrix oa::FnImage::pad(const oa::Matrix & inImage, oa::U32 inLeft, oa::U32 inRight, oa::U32 inTop, oa::U32 inBottom, oa::BorderMode inBorder = oa::BorderMode::Constant, oa::F32 inBorderValue = 0.0F)

Source

pad: Asymmetric NCHW padding with the shared border contract.

Source

posterize: Quantize an intensity interval to a fixed number of levels.

oa::Matrix oa::FnImage::remap(oa::Engine & inEngine, const oa::Matrix & inImage, const oa::Matrix & inMap, oa::InterpolationMode inInterpolation = oa::InterpolationMode::Bilinear, oa::BorderMode inBorder = oa::BorderMode::Constant, oa::F32 inBorderValue = 0.0F)oa::Matrix oa::FnImage::remap(oa::Engine & inEngine, const oa::Matrix & inImage, const oa::Matrix & inMap, oa::InterpolationMode inInterpolation = oa::InterpolationMode::Bilinear, oa::BorderMode inBorder = oa::BorderMode::Constant, oa::F32 inBorderValue = 0.0F)oa::Matrix oa::FnImage::remap(const oa::Matrix & inImage, const oa::Matrix & inMap, oa::InterpolationMode inInterpolation = oa::InterpolationMode::Bilinear, oa::BorderMode inBorder = oa::BorderMode::Constant, oa::F32 inBorderValue = 0.0F)oa::Matrix oa::FnImage::remap(const oa::Matrix & inImage, const oa::Matrix & inMap, oa::InterpolationMode inInterpolation = oa::InterpolationMode::Bilinear, oa::BorderMode inBorder = oa::BorderMode::Constant, oa::F32 inBorderValue = 0.0F)

Source

remap: Absolute-coordinate NCHW remapping with nearest or bilinear sampling.

Source

resize: Resize an NCHW image using nearest or bilinear interpolation.

Source

rotate: Rotate NCHW image by 90/180/270 degrees.

Source

saltPepperNoise: Apply deterministic GPU-native salt-and-pepper noise.

Source

Synchronous host sink for one exact packed RGBA8 image. This is the encoder boundary used by image-backed render sessions after their own explicit readback/completion protocol has produced host bytes.

Source

Synchronous file sink for a device-local packed RGBA8 texture. pending work in the engine's matching private recorder completes before readback. The output codec is inferred from .png, .jpg/.jpeg, .bmp, or .tga.

Source

scharr: Signed 3x3 Scharr x or y derivative lowered through the generic 2D filter.

Source

Blend an Int32 semantic label map over an FP32 NCHW RGB/RGBA image. mask is [N,H,W] or [N,1,H,W], palette is FP32 [K,3], and invalid labels leave the source pixel unchanged.

Source

separableConvolve2d: Same-shape NCHW separable cross-correlation with odd horizontal and vertical kernels.

Source

sharpen: Parameterized 3x3 sharpening lowered through Convolve2d.

Source

sobel: Signed 3x3 Sobel x or y derivative lowered through the generic 2D filter.

Source

solarize: Invert values above a threshold.

Source

thresholdBinary: Global binary threshold.

Source

thresholdBinaryInv: Global inverse binary threshold.

Source

thresholdToZero: Set values at or below a threshold to zero.

Source

thresholdToZeroInv: Set values above a threshold to zero.

Source

thresholdTruncate: Truncate values above a threshold.

Source

unsharpMask: Gaussian unsharp masking composed from graph-native primitives.

oa::Matrix oa::FnImage::warpAffine(oa::Engine & inEngine, const oa::Matrix & inImage, const oa::Matrix & inTransform, oa::U32 inWidth, oa::U32 inHeight, oa::InterpolationMode inInterpolation = oa::InterpolationMode::Bilinear, oa::BorderMode inBorder = oa::BorderMode::Constant, oa::F32 inBorderValue = 0.0F)oa::Matrix oa::FnImage::warpAffine(oa::Engine & inEngine, const oa::Matrix & inImage, const oa::Matrix & inTransform, oa::U32 inWidth, oa::U32 inHeight, oa::InterpolationMode inInterpolation = oa::InterpolationMode::Bilinear, oa::BorderMode inBorder = oa::BorderMode::Constant, oa::F32 inBorderValue = 0.0F)oa::Matrix oa::FnImage::warpAffine(const oa::Matrix & inImage, const oa::Matrix & inTransform, oa::U32 inWidth, oa::U32 inHeight, oa::InterpolationMode inInterpolation = oa::InterpolationMode::Bilinear, oa::BorderMode inBorder = oa::BorderMode::Constant, oa::F32 inBorderValue = 0.0F)oa::Matrix oa::FnImage::warpAffine(const oa::Matrix & inImage, const oa::Matrix & inTransform, oa::U32 inWidth, oa::U32 inHeight, oa::InterpolationMode inInterpolation = oa::InterpolationMode::Bilinear, oa::BorderMode inBorder = oa::BorderMode::Constant, oa::F32 inBorderValue = 0.0F)

Source

warpAffine: Inverse 2x3 affine warp with explicit interpolation and border semantics.

oa::Matrix oa::FnImage::warpPerspective(oa::Engine & inEngine, const oa::Matrix & inImage, const oa::Matrix & inTransform, oa::U32 inWidth, oa::U32 inHeight, oa::InterpolationMode inInterpolation = oa::InterpolationMode::Bilinear, oa::BorderMode inBorder = oa::BorderMode::Constant, oa::F32 inBorderValue = 0.0F)oa::Matrix oa::FnImage::warpPerspective(oa::Engine & inEngine, const oa::Matrix & inImage, const oa::Matrix & inTransform, oa::U32 inWidth, oa::U32 inHeight, oa::InterpolationMode inInterpolation = oa::InterpolationMode::Bilinear, oa::BorderMode inBorder = oa::BorderMode::Constant, oa::F32 inBorderValue = 0.0F)oa::Matrix oa::FnImage::warpPerspective(const oa::Matrix & inImage, const oa::Matrix & inTransform, oa::U32 inWidth, oa::U32 inHeight, oa::InterpolationMode inInterpolation = oa::InterpolationMode::Bilinear, oa::BorderMode inBorder = oa::BorderMode::Constant, oa::F32 inBorderValue = 0.0F)oa::Matrix oa::FnImage::warpPerspective(const oa::Matrix & inImage, const oa::Matrix & inTransform, oa::U32 inWidth, oa::U32 inHeight, oa::InterpolationMode inInterpolation = oa::InterpolationMode::Bilinear, oa::BorderMode inBorder = oa::BorderMode::Constant, oa::F32 inBorderValue = 0.0F)

Source

warpPerspective: Inverse 3x3 perspective warp with explicit interpolation and border semantics.

Ui

Functions

Source

Classes

0 members

oa::I32

oa::F32

String

oa::F32

Source

0 members

oa::F32

Color

oa::I32

oa::F32

bool

Source

4 members

─── CvFrame ────────────────────────────────────────────────────────────────

const oavk::Buffer *

oa::I32

Vector

oa::I32

method

CPU reference/diagnostic composite -> upload RGBA8 oa::Texture. pending work in the engine's matching private recorder completes before reading base. Realtime consumers must use DetectionOverlay or another resident path.

method

Source

0 members

─── CvOverlay ──────────────────────────────────────────────────────────────

Vector

CvBboxesConfig

Source

8 members

method

static

constructor

Compute-compose path used by the ordinary image/video widgets.

method

Non-blocking update. A three-slot completion-tracked ring prevents the CPU from overwriting records still consumed by a previous GPU frame.

method

Source

0 members

Color

oa::F32

Color

oa::U32

bool

oa::F32

Source

0 members

Detection

String

Source

10 members

method

static

constructor

method

Source

0 members

oa::F32

oa::U32

oa::F32

Source

0 members

One source-anchored glyph quad. anchor is normalized to the source image; offsets and dimensions are compose-target pixels so labels remain readable while the image camera pans and zooms.

oa::F32

oa::U32

oa::F32

Source

11 members

method

upload caller-provided planes. inPlanes and inDtypes must have the same length (1–4). Each span is W*H * sizeof(dtype) bytes. Synchronous.

static

method

constructor

method

Decode any stb_image-supported file to planar U8. 1-channel files → gray (channelCount=1). 3-channel files → RGB (channelCount=3). 4-channel files → RGBA (channelCount=4). HDR (.hdr) → planar F32. synchronous (transfer completes on return).

static

Records the exact UI consumer completion. Abandoning the value before completion transfers all owned plane buffers to engine retirement.

method

Source

11 members

─── InputSystem ────────────────────────────────────────────────────────────

method

Returns true if inEvent was consumed by a matching action.

method

constructor

YAML schema: {version: 1, bindings: [{action, key, modifiers, context, allow_repeat}]}. Loading is transactional for syntax and schema errors. Without yaml-cpp these calls report Unimplemented, never success.

method

register the reusable Realm tool bindings. This installs named actions with no callbacks; the application owns every operation they trigger: F12 — screenshot ctrl+R — start/stop recording Space — toggle camera ctrl+Z — undo (node graph) ctrl+Y — redo ctrl+S — save F — fit-to-view (node canvas)

method

Source

0 members

─── KeyAction ──────────────────────────────────────────────────────────────

bool

KeyBinding

Fn

InputContext

String

Source

1 members

─── KeyBinding ─────────────────────────────────────────────────────────────

UiKey

oa::U32

method

Source

24 members

Source

0 members

oa::F32

Source

0 members

UiKey

Source

14 members

const oa::F32

Animate pan/zoom to fit all nodes. call every frame until isAnimating().

method

constructor

method

── input: update pan/zoom from raw deltas ────────────────────────────────

method

── Coordinate transforms ─────────────────────────────────────────────────

method

zoom centered on inFocusScreen (screen pixel).

method

Source

0 members

oa::U32

oa::F32

Vec2

oa::U32

Source

0 members

oa::U64

oa::Usize

oa::I32

Vec2

Source

0 members

─── Caller-borrowed hit-test records ────────────────────────────────────────

WorldAabb

bool

oa::U64

oa::I32

Source

0 members

─── NodeCanvas ─────────────────────────────────────────────────────────────

Vec2

oa::F32

Source

3 members

oa::I32

method

Source

0 members

Vec3

Source

0 members

─── TextLayout ───────────────────────────────────────────────────────────── CPU-side layout: strictly decodes UTF-8, selects explicit per-codepoint font fallback, and uses HarfBuzz for OpenType substitution, positioning, and source-byte clusters over OA's embedded left-to-right coverage. Paragraph BiDi and right-to-left script coverage are intentionally outside this API.

oa::U32

FontId

oa::F32

Source

2 members

ScissorDesc — Scissor rectangle for clipping.

oa::I32

method

Source

8 members

─── TextAtlas ────────────────────────────────────────────────────────────── Manages the device-side coverage atlas and the glyph metadata table.

method

Selects the nearest generated physical-pixel strike. Returns nullptr for unmapped codepoints or an invalid font/size.

method

Zero identifies direct grayscale coverage to the shared glyph shader; positive values remain reserved for a future SDF lowering.

method

constructor

method

Source

2 members

measure text extent without appending.

method

Shape inText at inOrigin. Appends to inOutGlyphs (does not clear).

method

Source

0 members

FontId

bool

oa::F32

Source

0 members

Immutable generated artifact handed from a training/evaluation producer to the viewer. The texture allocation is shared; the timeline token prevents presentation until the producing GPU batch has completed. Replacing a pending frame drops it without ever blocking the training owner.

Event

String

oa::I64

SharedPtr

Source

0 members

oa::U32

bool

String

Source

13 members

Inherits public ViewerLiveSource

method

constructor

method

Source

74 members

─── Ui ──────────────────────────────────────────────────────────────────────

valid after widgets are submitted and until the next beginFrame. This is a flat, caller-borrowed platform-adapter snapshot, not an OA-owned desktop or document tree. bounds are ancestor-clipped physical pixels.

method

The viewport is required only by top-layer popup/tooltip placement. Viewer supplies its live compose extent. content scale converts the init style's logical geometry into physical pixels; event coordinates and explicit PixelRect values remain physical. Non-finite/non-positive scale is a frame error.

method

── layout containers ─────────────────────────────────────────────────────

method

beginPopup/endPopup render through the same deferred UI compositor, but their commands are submitted after every base-layer command. Popup calls must use the same parent scope as openPopup.

method

Explicit rows hug measured item widths and advance with layout.gap. Column items otherwise stretch across the panel's padded inner width.

method

Scroll panels retain only interaction/offset state under their stable ID. content coordinates are shifted and every nested draw/hit-test is clipped to the viewport. inContentHeight includes any layout padding. The caller owns content data; endScrollPanel must close the matching begin call.

method

Borrows the Viewer-owned atlas and allocates completion-tracked dynamic glyph slots. Bind once before the first frame; the atlas must outlive Ui.

method

labels identify controls within the active panel/row scope and must be unique there. mouse activation fires on release-inside; Tab/shift+Tab traverse focus and Return/Space activate the focused control. Returns true on click or keyboard activation.

method

Returns true when state changes.

method

Explicit circular OSD control with a GPU-drawn previous/next chevron. inLabel is both the stable widget identity and accessibility label.

method

Explicit renderer completion and release boundary. Waits every exact frame completion accepted by markFrameSubmitted before releasing pipelines, descriptor slots, and transient upload storage.

method

Passive color preview participating in panel/row layout.

method

draw a source-anchored glyph batch from one persistent coverage atlas.

method

One reusable viewport/chart/canvas grid. The default decimal hierarchy is 10-unit minor, 100-unit major, 1000-unit super-major, plus black axes and a subtle theme-derived vertical background gradient.

method

Host values → heatmap through the same bounded frame-safe upload ring as PlotLine. Intended for compact metric tables and recorded oa::plot figures.

method

Matrix convenience overload. rows/cols and value type are inferred when omitted, and matrix byte offsets are honored for views.

method

GPU buffer → heatmap (zero-copy — reads directly from inBuffer on GPU).

method

void oa::Ui::image(const oa::Texture & inTexture, VkPipelineStageFlags2 inSourceStageMask = VK_PIPELINE_STAGE_2_COMPUTE_SHADER_BIT, VkAccessFlags2 inSourceAccessMask = VK_ACCESS_2_SHADER_STORAGE_WRITE_BIT)void oa::Ui::image(const oa::Texture & inTexture, VkPipelineStageFlags2 inSourceStageMask = VK_PIPELINE_STAGE_2_COMPUTE_SHADER_BIT, VkAccessFlags2 inSourceAccessMask = VK_ACCESS_2_SHADER_STORAGE_WRITE_BIT)

texture values are engine-checked before recording. Buffer-backed shared leases are retained through the exact markFrameSubmitted completion.

method

Planar path: blitPlanar.slang handles per-channel dtype conversion + sRGB. inPlanes must remain at a stable address through markFrameSubmitted; that call attaches the exact consumer event used by its non-blocking RAII path.

method

draw one plane as grayscale without constructing a non-owning planes value.

method

void oa::Ui::imageVkRgba(void * inImage, void * inImageView, oa::I32 inW, oa::I32 inH, VkImageLayout inLayout = VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL, VkPipelineStageFlags2 inSourceStageMask = VK_PIPELINE_STAGE_2_COMPUTE_SHADER_BIT, VkAccessFlags2 inSourceAccessMask = VK_ACCESS_2_SHADER_STORAGE_WRITE_BIT)void oa::Ui::imageVkRgba(void * inImage, void * inImageView, oa::I32 inW, oa::I32 inH, VkImageLayout inLayout = VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL, VkPipelineStageFlags2 inSourceStageMask = VK_PIPELINE_STAGE_2_COMPUTE_SHADER_BIT, VkAccessFlags2 inSourceAccessMask = VK_ACCESS_2_SHADER_STORAGE_WRITE_BIT)

source stage/access describe the producer's last write made visible to this sampled read. Defaults preserve compute storage-image producers; graphics render targets must pass their color-attachment scopes.

method

Called once after init, before the first frame. inComposeImageView: vkImageView (as void*) of the compose storage image (set=1, slot 0).

method

── input state ───────────────────────────────────────────────────────────

method

Single-line UTF-8 editor. Returns true only when inOutText changes. The caller owns the value; the field retains bounded local edit history and IME composition state. It supports single/double/triple-click caret/word/all selection, shift and word navigation, scalar-safe deletion, clipboard, ctrl/Cmd+Z redo variants, Home/End, horizontal scrolling, visible native pre-edit and committed UTF-8 input. An external value replacement rebases local undo history; document-level undo remains application policy.

method

label does not soft-wrap; text wraps to the current panel's inner width. Both honor explicit newlines, require an active panel and a bound text atlas, and report misuse through recordRender instead of dropping text.

method

draw an anti-aliased screen-space line in one GPU dispatch.

method

Marks transient resources sampled by this frame. Plot buffers are recycled only after the exact engine-owned graphics completion is reached.

method

Menu items require an active popup and close it after activation.

method

draw one adaptive world-space canvas grid in one compute dispatch. Canvas screen coordinates are local to inRect; colors follow the current style.

method

at most one interactive popup owns pointer/keyboard input. The no-anchor overload anchors to the most recently submitted interactive item. The explicit overload supports context menus and application-defined anchors.

method

CPU float array → line chart.

method

ring-buffer variant: reads inCount floats from inData[inOffset % inCount].

method

CPU explicit-X/Y metric arrays -> one GPU polyline dispatch. The shader handles arbitrary segment direction without one dispatch per segment.

method

Finite fractions are clamped to [0, 1]. An empty overlay renders a rounded integer percentage; an explicit overlay is centered without soft wrapping.

method

Draws a passive compact label/value row. Empty values leave the returned Value rectangle available for a caller-owned editor control.

method

── style stack (O(1), max depth 32) ─────────────────────────────────────

method

Record all widget dispatch commands into inCmd.

method

draw filled or outlined axis-aligned rectangles directly into the GPU compose image. Rectangles must already be clipped to its extent.

method

draw normalized rectangle records from a bindless GPU buffer in one dispatch. inDstRect maps source-image coordinates into the compose image.

method

route a platform event. Returns true when an active/focused widget consumes it.

method

Draws a one-pixel horizontal rule in columns or a vertical rule in rows.

method

Sliders clamp the referenced value into [min, max] and return true only when it changes. Focused sliders accept arrow-key adjustment (1% of the range, shift=10x, ctrl=0.1x); pointer drags remain captured outside bounds.

method

Divides an explicit rectangle without beginning either child panel. The caller owns and may persist inOutRatio; it is the first region's fraction of the extent remaining after handleSize. Pointer drags retain capture outside the handle. Focused row splits accept Left/Right, and focused column splits accept Up/Down; shift/ctrl use the shared coarse/fine scale.

method

Draws one caller-owned tab sequence. Selection and overflow position live in inOutState; close and reorder are returned as requests so OA never owns documents or mutates their order. Left/Right/Home/End navigate the focused sequence and ctrl/Cmd+W requests closure of a closable focused tab.

method

Returns and clears a focused editor's pending copy/cut payload so the platform layer can publish it without introducing SDL into Ui.

method

Positioned GPU text primitive for plots, overlays, and other fixed-layout drawing. It does not participate in panel flow; inRect is an absolute compose-space clip/alignment rectangle. Stretch alignment is invalid.

method

Explicit transport timeline. inOutFraction is normalized to [0, 1]; returns true when pointer scrubbing changes it.

method

One row of a caller-flattened hierarchy. The caller owns open/selection state and applies open when openChanged is returned. Pointer activation on the disclosure toggles only; activation elsewhere selects. Focused tree rows use Up/Down to select among prior rendered rows, Left/Right to close or open, and Return/Space to activate. Explicit rectangles make the row directly compatible with virtualRows.

method

constructor

Called after a compose image rebuild (resize) to refresh the image descriptor.

method

Returns the visible half-open row range for the active scroll panel. rows start after layout.padding.top and use inRowHeight + inRowGap stride. Overscan is expressed in rows and is clamped to the item count.

method

Platform bridge for enabling native committed-text/IME input only while a field rendered in the current frame owns keyboard focus.

method

Full-surface audio scrubber backed by a GPU [bins, 2] min/max envelope.

method

Source

0 members

oa::I32

Source

3 members

oa::F32

constructor

Source

3 members

─── UiEvent ─────────────────────────────────────────────────────────────────

oa::I32

oa::U32

oa::F32

oa::I32

UiKey

bool

oa::U32

oa::F32

UiPinchPhase

UiScrollGesture

oa::F32

String

oa::I32

oa::U64

UiEventType

oa::I32

method

Source

0 members

Color

oa::F32

Color

bool

Color

oa::U32

oa::F32

Color

Vec2

oa::F32

Vec2

Color

oa::U32

oa::F32

Source

0 members

oa::U32

oa::I32

oa::U32

oa::I32

bool

oa::U32

oa::F32

Source

1 members

─── UiInputState ──────────────────────────────────────────────────────────── Stable per-frame snapshot updated by Ui::beginFrame before widget dispatch.

oa::U32

bool

oa::I32

bool

oa::U32

oa::F32

bool

oa::F32

method

Source

0 members

UiAlign

UiDirection

oa::F32

UiSizing

UiAlign

UiEdge

UiSizing

Source

0 members

oa::F32

bool

oa::U32

oa::F32

oa::U32

oa::F32

Source

0 members

─── Widget config structs ────────────────────────────────────────────────────

oa::U32

bool

Color

bool

oa::F32

bool

oa::F32

Source

0 members

oa::I32

UiEdge

oa::I32

Source

0 members

PixelRect

Source

0 members

bool

oa::I32

oa::F32

oa::I32

Source

0 members

oa::U32

UiStyle

oa::U32

Source

0 members

oa::I32

bool

oa::I32

Source

0 members

PixelRect

oa::I32

PixelRect

Source

3 members

UiSizingKind

oa::F32

static

Source

0 members

UiDirection

oa::I32

oa::F32

oa::I32

Source

0 members

bool

PixelRect

Source

5 members

Color

oa::F32

Color

oa::F32

Color

Compact OA editor presets adapted from the prior editor's Dark Modern and Light Modern palettes. These are the default Viewer application themes.

static

Struct defaults are already RealmDark; this exists for explicitness.

static

Realm Design System light variant.

static

Every geometry value must be finite; sizes are non-negative and fontSize is positive. Every color component must be finite and in [0,1].

method

Source

0 members

oa::I32

bool

Source

0 members

oa::I32

PixelRect

oa::I32

bool

PixelRect

Source

0 members

oa::I32

Source

0 members

bool

StringView

Source

0 members

Color

UiTextDirection

oa::F32

UiAlign

Source

0 members

oa::F32

oa::I32

UiEdge

Source

0 members

oa::I32

bool

oa::I32

bool

Source

0 members

bool

PixelRect

bool

PixelRect

Source

1 members

oa::I32

method

Source

24 members

Windowed or headless application session for inspecting OA images, video, audio and live GPU output. The Viewer owns UI, input, window and presenter state. It either creates one engine for run() or borrows the caller's engine for run(oa::Engine & ); it never creates a second device runtime in that path.

Unified blocking preview front door. Paths are decoder-probed as image, video, then audio and may either own an application engine or borrow the caller's presentation-capable engine. Direct GPU values always borrow the caller's engine and retain the exact completion contract of show().

static

method

run the windowed session against an existing presentation-capable engine. The viewer borrows the engine and closes only its presenter/window state.

method

Headless sink for a ready buffer-backed texture. Image-backed renderer frames use their owning session's saveTo/consumeReadback contract.

static

method

static

Compatibility spelling for blocking one-shot display sinks. Matrix and image overloads record the RGBA8 conversion into the engine's matching private recorder, submit it once, and pass its exact completion into presentation. New code uses preview() so file-backed and direct values share one discoverable verb.

static

Ready buffer-backed textures can be displayed without conversion.

static

Image-backed renderer targets require their generation-safe frame and owning session. The blocking viewer returns its final graphics completion to that session before the presentation timelines are destroyed.

static

constructor

method

Source

Examples

ExexAudio.cppLoad the OA narration, convert it to mono, normalize it, render a native GPU reverberation tail, then save a checked WAV output.ExexImage.cppLoad the Vision cover, convert its GPU-resident RGB pixels to Rec.709 grayscale, save the semantic Gray image, and optionally inspect it in Viewer.ExexPlotFigure.cppRecord one training-loss series, render the retained figure through OA's GPU compositor, save it, and optionally inspect it in Viewer.ExexViewerImage.cppOpen the authored ML cover in OA’s native Vulkan viewer, inspect it on the navigable canvas, and move into fullspace presentation.

0 members

Vector

DetectionOverlayConfig

oa::U32

oa::U64

ViewerAudioView

oa::U32

bool

Filter

oa::F32

oa::U32

UiKey

ViewerLiveSource *

bool

ViewerMode

String

bool

Filter

oa::U32

bool

UiStyle

String

bool

oa::U32

Source

0 members

bool

Source

10 members

Non-owning live producer attached to the one Viewer application lifecycle. It may render domain-specific overlays, but it never owns the window, swapchain, input pump or presentation submission.

method

Retain the exact Viewer submission until every resource rendered by this frame can be recycled. A source may reject stale or foreign completion.

method

Source

24 members

Viewport — Passive view description for rendering Declares: camera, target, viewport, and view-specific settings. Does NOT: handle input, own windows, manage swapchains, or animate.

method

Check if a layer is visible

method

Validation.

method

camera (required).

method

═══════════════════════════════════════════════════════════════════════ clear values ═══════════════════════════════════════════════════════════════════════

method

═══════════════════════════════════════════════════════════════════════ layer filtering ═══════════════════════════════════════════════════════════════════════

method

Mode and configuration.

method

═══════════════════════════════════════════════════════════════════════ Render target (required) ═══════════════════════════════════════════════════════════════════════

method

Setup for 2D image viewing (orthographic camera)

method

Setup for aspect-fit image display

method

═══════════════════════════════════════════════════════════════════════ viewport and scissor ═══════════════════════════════════════════════════════════════════════

method

constructor

Source

2 members

ViewportDesc — viewport rectangle and depth range.

oa::I32

oa::F32

oa::I32

method

Source

3 members

─── WorldAabb ──────────────────────────────────────────────────────────────

Vec2

method

Source

Enums

Source

─── FontId ─────────────────────────────────────────────────────────────────

Sans · Mono

Source

U8 · U16 · F32 · BF16

Source

Global · NodeCanvas · TextInput · Timeline

Source

═════════════════════════════════════════════════════════════════════════════ RenderLayer — layer/filter flags for selective rendering ═════════════════════════════════════════════════════════════════════════════

None · Default · Ui · Overlay · Background · Debug · All

Source

None · Focus · Activate · Toggle · Increment · Decrement · SetValue · Close

Source

─── Accessibility export ───────────────────────────────────────────────

Button · Checkbox · Slider · TextField · ComboBox · MenuItem · Tab · TreeItem · Splitter · Timeline

Source

None · Disabled · Focused · Checked · Selected · Expanded · Editable · HasPopup

Source

Start · Center · End · Stretch

Source

Previous · Next

Source

─── layout primitives ────────────────────────────────────────────────────────

Column · Row

Source

─── UiEventType ─────────────────────────────────────────────────────────────

None · MouseMove · MouseDown · MouseUp · MouseScroll · KeyDown · KeyUp · KeyChar · WindowResize · WindowClose · WindowFocus · WindowBlur · Pinch · TextEditing

Source

─── UiKey ─────────────────────────────────────────────────────────────────── SDL3 scancode subset. values deliberately match SDL_Scancode to allow direct cast; do not rely on the numeric values in switch logic.

Unknown · A · B · C · D · E · F · G · H · I · J · K · L · M · N · O · P · Q · R · S · T · U · V · W · X · Y · Z · Num1 · Num2 · Num3 · Num4 · Num5 · Num6 · Num7 · Num8 · Num9 · Num0 · Return · Escape · Backspace · Tab · Space · Minus · Equals · Comma · Period · Slash · Home · Delete · End · Right · Left · Down · Up · F1 · F2 · F3 · F4 · F5 · F6 · F7 · F8 · F9 · F10 · F11 · F12 · KpEnter · Kp1 · Kp2 · Kp3 · Kp4 · Kp5 · Kp6 · Kp7 · Kp8 · Kp9 · Kp0

Source

─── UiPinchPhase ────────────────────────────────────────────────────────────

None · Begin · Update · End

Source

─── UiScrollGesture ─────────────────────────────────────────────────────── Classified once in the input layer (SDL wheel heuristics). Navigation maps each gesture to its own sensitivity — wheel zoom, touchpad pan, pinch zoom.

None · MouseWheel · TouchpadPan · PinchScroll

Source

Fill · Fixed · Hug

Source

LeftToRight · BottomToTop

Source

Waveform · Spectrum · Mel

Source

Auto · Image · Video · Audio · Live

Source

Image2D · Scene3D · Matrix · Video · CameraStream