Function

CTRunGetStringIndicesPtr

Returns a direct pointer for the string indices stored in the run.

Declaration

const CFIndex * CTRunGetStringIndicesPtr(CTRunRef run);

Parameters

run

The run for which to return string indices.

Return Value

A valid pointer to an array of CFIndex structures, or NULL.

Discussion

The indices are the character indices that originally spawned the glyphs that make up the run. They can be used to map the glyphs in the run back to the characters in the backing store. The string indices array will have a length equal to the value returned by CTRunGetGlyphCount. The caller should be prepared for this function to return NULL even if there are glyphs in the stream. If this function returns NULL, the caller must allocate its own buffer and call CTRunGetStringIndices to fetch the indices.

See Also

Getting Glyph Run Data

CTRunGetGlyphCount

Gets the glyph count for the run.

CTRunGetAttributes

Returns the attribute dictionary that was used to create the glyph run.

CTRunGetStatus

Returns the run's status.

CTRunGetGlyphsPtr

Returns a direct pointer for the glyph array stored in the run.

CTRunGetGlyphs

Copies a range of glyphs into a user-provided buffer.

CTRunGetPositionsPtr

Returns a direct pointer for the glyph position array stored in the run.

CTRunGetPositions

Copies a range of glyph positions into a user-provided buffer.

CTRunGetAdvancesPtr

Returns a direct pointer for the glyph advance array stored in the run.

CTRunGetAdvances

Copies a range of glyph advances into a user-provided buffer.

CTRunGetStringIndices

Copies a range of string indices into a user-provided buffer.

CTRunGetStringRange

Gets the range of characters that originally spawned the glyphs in the run.