Helper data structure describing multiple glyphs metrics. More...

#include <LayoutUtils.h>

Public Attributes
int32_t	offsetX
	X axis offset of bounding box from origin. More...

int32_t	offsetY
	Y axis offset of bounding box from origin. More...

uint32_t	width
	Bounding box width. More...

uint32_t	height
	Bounding box height. More...

int32_t	combinedAdvance
	Advance to next StringBoundingBox. More...

Detailed Description

Helper data structure describing multiple glyphs metrics.

StringBoundingBox is essentially a union of a set of GlyphMetrics. It describes a bounding box of renderable glyphs (glyphs with non-empty bitmap data). Width and height are dimensions of the bounding box. The bounding box can be offset from origin using offsetX/Y. Combined advance is X axis offset from origin where next StringBoundingBox would be if put on same line. Similarly to GlyphMetrics, even when StringBoundingBox have zero width/height (which means there is no renderable data) it can still have non-zero advance which should be taken into account by other StringBoundingBox if combined.

Member Data Documentation

◆ combinedAdvance

int32_t ramses::LayoutUtils::StringBoundingBox::combinedAdvance

Advance to next StringBoundingBox.

◆ height

uint32_t ramses::LayoutUtils::StringBoundingBox::height

Bounding box height.

◆ offsetX

int32_t ramses::LayoutUtils::StringBoundingBox::offsetX

X axis offset of bounding box from origin.

◆ offsetY

int32_t ramses::LayoutUtils::StringBoundingBox::offsetY

Y axis offset of bounding box from origin.

◆ width

uint32_t ramses::LayoutUtils::StringBoundingBox::width

Bounding box width.

The documentation for this struct was generated from the following file:

/home/runner/work/ramses/ramses/client/ramses-client/ramses-text-api/include/ramses-text-api/LayoutUtils.h