oa::TrainingViewerSource

TrainingViewerSource class in the OA Ui public surface.

ClC++ public headers

Inheritance

public ViewerLiveSource

Public Methods

ViewerLiveCapabilities oa::TrainingViewerSource::capabilities()

oa::Status oa::TrainingViewerSource::close()

oa::Status oa::TrainingViewerSource::init(InputSystem & inInput, oa::Fn<void (bool)> inCapturePointer)

oa::Optional<TrainingPreviewFrame> oa::TrainingViewerSource::latestPreview()

oa::Optional<oa::TrainingSnapshot> oa::TrainingViewerSource::latestSnapshot()

oa::U32 oa::TrainingViewerSource::metricSampleCount(oa::StringView inName)

oa::U32 oa::TrainingViewerSource::metricSeriesCount()

oa::Status oa::TrainingViewerSource::open(oa::Engine & inEngine)

oa::Status oa::TrainingViewerSource::publishPreview(TrainingPreviewFrame inFrame)

oa::Status oa::TrainingViewerSource::render(Ui & inUi, const TextAtlas & inTextAtlas, oa::U32 inWidth, oa::U32 inHeight)

oa::Status oa::TrainingViewerSource::update(oa::F32 inDeltaMs)

Constructor & Destructor Documentation

oa::TrainingViewerSource::TrainingViewerSource(
	oa::TrainingSession & inSession,
	TrainingViewerConfig inConfig = {}
)

No public source comment is attached to this declaration.

Parameters

inSession

oa::TrainingSession &

—

inConfig

TrainingViewerConfig

Default: {}

void oa::TrainingViewerSource::~TrainingViewerSource()

No public source comment is attached to this declaration.

Public Method Documentation

ViewerLiveCapabilities oa::TrainingViewerSource::capabilities()

No public source comment is attached to this declaration.

Returns

ViewerLiveCapabilities

The declared return value.

oa::Status oa::TrainingViewerSource::close()

No public source comment is attached to this declaration.

Returns

oa::Status

The declared return value.

oa::Status oa::TrainingViewerSource::init(
	InputSystem & inInput,
	oa::Fn<void (bool)> inCapturePointer
)

No public source comment is attached to this declaration.

Parameters

inInput

InputSystem &

—

inCapturePointer

oa::Fn<void (bool)>

—

Returns

oa::Status

The declared return value.

oa::Optional<TrainingPreviewFrame> oa::TrainingViewerSource::latestPreview()

No public source comment is attached to this declaration.

Returns

oa::Optional<TrainingPreviewFrame>

The declared return value.

oa::Optional<oa::TrainingSnapshot> oa::TrainingViewerSource::latestSnapshot()

No public source comment is attached to this declaration.

Returns

oa::Optional<oa::TrainingSnapshot>

The declared return value.

oa::U32 oa::TrainingViewerSource::metricSampleCount(
	oa::StringView inName
)

No public source comment is attached to this declaration.

Parameters

inName

oa::StringView

—

Returns

oa::U32

The declared return value.

oa::U32 oa::TrainingViewerSource::metricSeriesCount()

No public source comment is attached to this declaration.

Returns

oa::U32

The declared return value.

oa::Status oa::TrainingViewerSource::open(
	oa::Engine & inEngine
)

No public source comment is attached to this declaration.

Parameters

inEngine

oa::Engine &

—

Returns

oa::Status

The declared return value.

oa::Status oa::TrainingViewerSource::publishPreview(
	TrainingPreviewFrame inFrame
)

No public source comment is attached to this declaration.

Parameters

inFrame

TrainingPreviewFrame

—

Returns

oa::Status

The declared return value.

oa::Status oa::TrainingViewerSource::render(
	Ui & inUi,
	const TextAtlas & inTextAtlas,
	oa::U32 inWidth,
	oa::U32 inHeight
)

No public source comment is attached to this declaration.

Parameters

inUi

Ui &

—

inTextAtlas

const TextAtlas &

—

inWidth

oa::U32

—

inHeight

oa::U32

—

Returns

oa::Status

The declared return value.

oa::Status oa::TrainingViewerSource::update(
	oa::F32 inDeltaMs
)

No public source comment is attached to this declaration.

Parameters

inDeltaMs

oa::F32

—

Returns

oa::Status

The declared return value.