Struct TextAnnotation

Struct Documentation

struct TextAnnotation

A text label on a 2D image.

Public Functions

FoxgloveError encode(uint8_t *ptr, size_t len, size_t *encoded_len)

Encoded the TextAnnotation as protobuf to the provided buffer.

On success, writes the serialized length to *encoded_len. If the provided buffer has insufficient capacity, writes the required capacity to *encoded_len and returns FoxgloveError::BufferTooShort. If the message cannot be encoded, writes the reason to stderr and returns FoxgloveError::EncodeError.

Parameters:

  • ptr – the destination buffer. must point to at least len valid bytes.

  • len – the length of the destination buffer.

  • encoded_len – where the serialized length or required capacity will be written to.

Public Members

std::optional<Timestamp> timestamp

Timestamp of annotation.

std::optional<Point2> position

Bottom-left origin of the text label in 2D image coordinates (pixels).

The coordinate uses the top-left corner of the top-left pixel of the image as the origin.

std::string text

Text to display.

double font_size = 0

Font size in pixels.

std::optional<Color> text_color

Text color.

std::optional<Color> background_color

Background fill color.

Public Static Functions

static Schema schema()

Get the TextAnnotation schema.

The schema data returned is statically allocated.