oa::ViewerLiveSource

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.

ClC++ public headers

Public Methods

ViewerLiveCapabilities oa::ViewerLiveSource::capabilities()

oa::Status oa::ViewerLiveSource::close()

oa::Status oa::ViewerLiveSource::event(const UiEvent &)

oa::Status oa::ViewerLiveSource::init(InputSystem &, oa::Fn<void (bool)>)

oa::Status oa::ViewerLiveSource::markConsumed(const oa::Event &)

oa::Status oa::ViewerLiveSource::open(oa::Engine &)

oa::Status oa::ViewerLiveSource::render(Ui &, const TextAtlas &, oa::U32, oa::U32)

oa::Result<oa::Event> oa::ViewerLiveSource::renderReady()

oa::Status oa::ViewerLiveSource::update(oa::F32)

Constructor & Destructor Documentation

void oa::ViewerLiveSource::~ViewerLiveSource()

No public source comment is attached to this declaration.

Public Method Documentation

ViewerLiveCapabilities oa::ViewerLiveSource::capabilities()

No public source comment is attached to this declaration.

Returns

ViewerLiveCapabilities

The declared return value.

oa::Status oa::ViewerLiveSource::close()

No public source comment is attached to this declaration.

Returns

oa::Status

The declared return value.

oa::Status oa::ViewerLiveSource::event(
	const UiEvent &
)

No public source comment is attached to this declaration.

Parameters

(unnamed)

const UiEvent &

—

Returns

oa::Status

The declared return value.

oa::Status oa::ViewerLiveSource::init(
	InputSystem &,
	oa::Fn<void (bool)>
)

No public source comment is attached to this declaration.

Parameters

(unnamed)

InputSystem &

—

(unnamed)

oa::Fn<void (bool)>

—

Returns

oa::Status

The declared return value.

oa::Status oa::ViewerLiveSource::markConsumed(
	const oa::Event &
)

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

Parameters

(unnamed)

const oa::Event &

—

Returns

oa::Status

The declared return value.

oa::Status oa::ViewerLiveSource::open(
	oa::Engine &
)

No public source comment is attached to this declaration.

Parameters

(unnamed)

oa::Engine &

—

Returns

oa::Status

The declared return value.

oa::Status oa::ViewerLiveSource::render(
	Ui &,
	const TextAtlas &,
	oa::U32,
	oa::U32
)

No public source comment is attached to this declaration.

Parameters

(unnamed)

Ui &

—

(unnamed)

const TextAtlas &

—

(unnamed)

oa::U32

—

(unnamed)

oa::U32

—

Returns

oa::Status

The declared return value.

oa::Result<oa::Event> oa::ViewerLiveSource::renderReady()

No public source comment is attached to this declaration.

Returns

oa::Result<oa::Event>

The declared return value.

oa::Status oa::ViewerLiveSource::update(
	oa::F32
)

No public source comment is attached to this declaration.

Parameters

(unnamed)

oa::F32

—

Returns

oa::Status

The declared return value.