#include "unicode/ubidi.h"
#include "layout/LETypes.h"
#include "plruns.h"
Go to the source code of this file.
Typedefs | |
typedef void | pl_paragraph |
The opaque type for a paragraph layout. | |
typedef void | pl_line |
The opaque type for a line in a paragraph layout. | |
typedef void | pl_visualRun |
The opaque type for a visual run in a line. | |
Functions | |
pl_paragraph * | pl_create (const LEUnicode chars[], le_int32 count, const pl_fontRuns *fontRuns, const pl_valueRuns *levelRuns, const pl_valueRuns *scriptRuns, const pl_localeRuns *localeRuns, UBiDiLevel paragraphLevel, le_bool vertical, LEErrorCode *status) |
Construct a ParagraphLayout object for a styled paragraph. | |
void | pl_close (pl_paragraph *paragraph) |
Close the given paragraph layout object. | |
le_bool | pl_isComplex (const LEUnicode chars[], le_int32 count) |
Examine the given text and determine if it contains characters in any script which requires complex processing to be rendered correctly. | |
UBiDiLevel | pl_getParagraphLevel (pl_paragraph *paragraph) |
Return the resolved paragraph level. | |
UBiDiDirection | pl_getTextDirection (pl_paragraph *paragraph) |
Return the directionality of the text in the paragraph. | |
le_int32 | pl_getAscent (const pl_paragraph *paragraph) |
Get the max ascent value for all the fonts in the paragraph. | |
le_int32 | pl_getDescent (const pl_paragraph *paragraph) |
Return the max descent value for all the fonts in the paragraph. | |
le_int32 | pl_getLeading (const pl_paragraph *paragraph) |
Return the max leading value for all the fonts in the paragraph. | |
void | pl_reflow (pl_paragraph *paragraph) |
Reset line breaking to start from the beginning of the paragraph. | |
pl_line * | pl_nextLine (pl_paragraph *paragraph, float width) |
Return a pl_line object which represents next line in the paragraph. | |
void | pl_closeLine (pl_line *line) |
Close the given line object. | |
le_int32 | pl_countLineRuns (const pl_line *line) |
Count the number of visual runs in the line. | |
le_int32 | pl_getLineAscent (const pl_line *line) |
Get the ascent of the line. | |
le_int32 | pl_getLineDescent (const pl_line *line) |
Get the descent of the line. | |
le_int32 | pl_getLineLeading (const pl_line *line) |
Get the leading of the line. | |
le_int32 | pl_getLineWidth (const pl_line *line) |
Get the width of the line. | |
const pl_visualRun * | pl_getLineVisualRun (const pl_line *line, le_int32 runIndex) |
Get a ParagraphLayout::VisualRun object for a given visual run in the line. | |
const le_font * | pl_getVisualRunFont (const pl_visualRun *run) |
Get the le_font object which represents the font of the visual run. | |
UBiDiDirection | pl_getVisualRunDirection (const pl_visualRun *run) |
Get the direction of the visual run. | |
le_int32 | pl_getVisualRunGlyphCount (const pl_visualRun *run) |
Get the number of glyphs in the visual run. | |
const LEGlyphID * | pl_getVisualRunGlyphs (const pl_visualRun *run) |
Get the glyphs in the visual run. | |
const float * | pl_getVisualRunPositions (const pl_visualRun *run) |
Get the (x, y) positions of the glyphs in the visual run. | |
const le_int32 * | pl_getVisualRunGlyphToCharMap (const pl_visualRun *run) |
Get the glyph-to-character map for this visual run. | |
le_int32 | pl_getVisualRunAscent (const pl_visualRun *run) |
A convenience method which returns the ascent value for the font associated with this run. | |
le_int32 | pl_getVisualRunDescent (const pl_visualRun *run) |
A convenience method which returns the descent value for the font associated with this run. | |
le_int32 | pl_getVisualRunLeading (const pl_visualRun *run) |
A convenience method which returns the leading value for the font associated with this run. |
This is a technology preview. The API may change significantly.
Definition in file playout.h.
|
The opaque type for a line in a paragraph layout.
|
|
The opaque type for a paragraph layout.
|
|
The opaque type for a visual run in a line.
|
|
Close the given paragraph layout object.
|
|
Close the given line object.
Line objects are created by
|
|
Count the number of visual runs in the line.
|
|
Construct a
The paragraph is specified as runs of text all in the same font. An Clients can optionally specify directional runs and / or script runs. If these aren't specified they will be computed.
If any errors are encountered during construction,
|
|
Get the max ascent value for all the fonts in the paragraph.
|
|
Return the max descent value for all the fonts in the paragraph.
|
|
Return the max leading value for all the fonts in the paragraph.
|
|
Get the ascent of the line. This is the maximum ascent of all the fonts on the line.
|
|
Get the descent of the line. This is the maximum descent of all the fonts on the line.
|
|
Get the leading of the line. This is the maximum leading of all the fonts on the line.
|
|
Get a
|
|
Get the width of the line. This is a convenience method which returns the last X position of the last visual run in the line.
|
|
Return the resolved paragraph level. This is useful for those cases where the bidi analysis has determined the level based on the first strong character in the paragraph.
|
|
Return the directionality of the text in the paragraph.
|
|
A convenience method which returns the ascent value for the font associated with this run.
|
|
A convenience method which returns the descent value for the font associated with this run.
|
|
Get the direction of the visual run.
|
|
Get the This will always be a non-composite font.
|
|
Get the number of glyphs in the visual run.
|
|
Get the glyphs in the visual run.
Glyphs with the values
|
|
Get the glyph-to-character map for this visual run. This maps the indices into the glyph array to indices into the character array used to create the paragraph.
|
|
A convenience method which returns the leading value for the font associated with this run.
|
|
Get the (x, y) positions of the glyphs in the visual run. To simplify storage management, the x and y positions are stored in a single array with the x positions at even offsets in the array and the corresponding y position in the following odd offset. There is an extra (x, y) pair at the end of the array which represents the advance of the final glyph in the run.
|
|
Examine the given text and determine if it contains characters in any script which requires complex processing to be rendered correctly.
|
|
Return a The width of the line is specified each time so that it can be varied to support arbitrary paragraph shapes.
|
|
Reset line breaking to start from the beginning of the paragraph.
|