Magnum::Ui::DebugLayer::DebugIntegration class

Debug layer integration.

If an inner type with this name is implemented on a layer that's passed to DebugLayer::setLayerName(const T&, const Containers::StringView&), the print() function is used by the DebugLayerFlag::NodeHighlight functionality to provide additional details about all data attachments coming from given layer. See DebugLayer integration for custom layers for more information.

Public functions

void print(Debug& debug, const Layer& layer, Containers::StringView layerName, LayerDataHandle data)
Print details about particular data.

Function documentation

void Magnum::Ui::DebugLayer::DebugIntegration::print(Debug& debug, const Layer& layer, Containers::StringView layerName, LayerDataHandle data)

Print details about particular data.

Parameters
debug Debug output where to print
layer Layer associated with given data. The implementation can use either the layer type this class is part of or any base type.
layerName Layer name that was passed to DebugLayer::setLayerName(const T&, const Containers::StringView&)
data Data to print info about. Guaranteed to be valid.

Used internally by DebugLayer. To fit among other info provided by DebugLayer itself, the implementation is expected to indent the output by at least two spaces and end with a newline (i.e., Debug::newline).