String annotations

This topic describes the string annotations supported by Streamline.

String annotations write user-defined strings into the Log view and place framing overlays in the details panel in the Timeline view.

Annotation macros

ANNOTATE(string)

Add a string annotation. Streamline adds the annotation to channel 0.

ANNOTATE_COLOR(color, string)

Add a string annotation with a display colour. See streamline_annotate.h for the defined colors.

ANNOTATE_END()

Terminate the annotation in channel 0.

Example

The following example uses the ANNOTATE_COLOR string annotation to add a blue and green framing overlays in your capture timeline:

ANNOTATE_COLOR(ANNOTATE_BLUE, label);
ANNOTATE_COLOR(ANNOTATE_GREEN, label);

The blue and green overlays render in your capture timeline as:

String annotations in example capture

Note

The ANNOTATE_COLOR annotation is a simplified interface for the ANNOTATE_CHANNEL_COLOR group and channel annotation (see Group and Channel annotations), but uses a default channel and group.