oa::DetectionOverlay

DetectionOverlay class in the OA Ui public surface.

ClC++ public headers

Public Methods

oa::U32 oa::DetectionOverlay::count()

void oa::DetectionOverlay::draw(Ui & inUi, const TextAtlas & inAtlas, PixelRect inDestination, PixelRect inClip)

bool oa::DetectionOverlay::isValid()

oa::Status oa::DetectionOverlay::markConsumed(const oa::Event & inCompletion)

oa::Status oa::DetectionOverlay::update(oa::Span<const DetectionOverlayItem> inItems, const TextAtlas & inAtlas)

Static Public Methods

static oa::Result<DetectionOverlay> oa::DetectionOverlay::create(oa::Engine & inRuntime, const DetectionOverlayConfig & inConfig = {})

Constructor & Destructor Documentation

oa::DetectionOverlay::DetectionOverlay()

No public source comment is attached to this declaration.

void oa::DetectionOverlay::~DetectionOverlay()

No public source comment is attached to this declaration.

Public Method Documentation

oa::U32 oa::DetectionOverlay::count()

No public source comment is attached to this declaration.

Returns

oa::U32

The declared return value.

void oa::DetectionOverlay::draw(
	Ui & inUi,
	const TextAtlas & inAtlas,
	PixelRect inDestination,
	PixelRect inClip
)

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

Parameters

inUi

Ui &

—

inAtlas

const TextAtlas &

—

inDestination

PixelRect

—

inClip

PixelRect

—

Returns

void

The declared return value.

bool oa::DetectionOverlay::isValid()

No public source comment is attached to this declaration.

Returns

bool

The declared return value.

oa::Status oa::DetectionOverlay::markConsumed(
	const oa::Event & inCompletion
)

No public source comment is attached to this declaration.

Parameters

inCompletion

const oa::Event &

—

Returns

oa::Status

The declared return value.

oa::Status oa::DetectionOverlay::update(
	oa::Span<const DetectionOverlayItem> inItems,
	const TextAtlas & inAtlas
)

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

Parameters

inItems

oa::Span<const DetectionOverlayItem>

—

inAtlas

const TextAtlas &

—

Returns

oa::Status

The declared return value.

static oa::Result<DetectionOverlay> oa::DetectionOverlay::create(
	oa::Engine & inRuntime,
	const DetectionOverlayConfig & inConfig = {}
)

No public source comment is attached to this declaration.

Parameters

inRuntime

oa::Engine &

—

inConfig

const DetectionOverlayConfig &

Default: {}

Returns

oa::Result<DetectionOverlay>

The declared return value.