oa::DeviceCanary

DeviceCanary class in the OA Core public surface.

ClC++ public headers

Static Public Methods

static oa::Status oa::DeviceCanary::run(oa::Engine & inEngine, DeviceCanaryReport & outReport)

Public Method Documentation

static oa::Status oa::DeviceCanary::run(
	oa::Engine & inEngine,
	DeviceCanaryReport & outReport
)

Requires an otherwise idle engine context. On arithmetic or transport disagreement outReport is populated and DATA_LOSS is returned. vulkan, allocation, and readback failures preserve their original status code.

Parameters

inEngine

oa::Engine &

—

outReport

DeviceCanaryReport &

—

Returns

oa::Status

The declared return value.