Main Page   Modules   Compound List   File List   Compound Members   File Members  

Glyph vector methods


Functions

STStatus STGlyphVectorNew (STGlyphVector *oGlyphVector, STTypeEnv iEnv, STStyledGlyph *iSource, STCount iGlyphCount)
 Creates a new glyph vector. More...

STStatus STGlyphVectorNewCopy (STGlyphVector *oGlyphVector, STGlyphVector iOldGlyphVector)
 Creates a copy of a glyph vector. More...

STStatus STGlyphVectorDispose (STGlyphVector iGlyphVector)
 Deallocates a glyph vector. More...

STStatus STGlyphVectorSerialize (STGlyphVector iGlyphVector, int iFileDes)
 Writes an XML representation of a glyph vector to a file stream. More...

STStatus STGlyphVectorDeserialize (STGlyphVector *oGlyphVector, int iFileDes)
 Constructs a glyph vector from its serialized representation. More...

STStatus STGlyphVectorSetGlyphs (STGlyphVector iGlyphVector, STStyledGlyph *iGlyphs, STCount iGlyphCount)
 Assigns styled glyphs to a glyph vector replacing existing styled glyphs. More...

STStatus STGlyphVectorGetGlyphs (STGlyphVector iGlyphVector, STPosition iStartFrom, STCount *ioGlyphCount, STStyledGlyph **oGlyphs)
 Retrieves an array of styled glyphs from a glyph vector. More...

STStatus STGlyphVectorReplaceGlyphs (STGlyphVector iGlyphVector, STPosition iStartFrom, STCount iGlyphCount, STStyledGlyph *iGlyphArray, STCount iGlyphArraySize)
 Replaces some styled glyphs in a glyph vector with new glyphs. More...

STStatus STGlyphVectorAdjustPositions (STGlyphVector iGlyphVector, STPosition iStartFrom, STCount iGlyphCount, STPoint iDelta)
 Adjust X and Y positions of a range of glyphs in a glyph vector by the same amount. More...

STStatus STGlyphVectorMeasure (STGlyphVector iGlyphVector, STPosition iStartFrom, STCount iGlyphCount, STRectangle *oBBox)
 Calculates a typographic bounding rectangle of a range of glyphs of the glyph vector in user space. More...

STStatus STGlyphVectorGetBounds (STGlyphVector iGlyphVector, STPosition iStartFrom, STCount iGlyphCount, STGraphics iGraphics, int iMaxBoundsCount, STBounds iBounds, int *oBoundsCount, STTrapezoidPtr *oBounds)
 Calculates boundaries of a range of glyphs of a glyph vector in device space. More...

STStatus STGlyphVectorRender (STGlyphVector iGlyphVector, STPosition iStartFrom, STCount iGlyphCount, STGraphics iGraphics)
 Renders a range of glyphs of a glyph vector on an output device. More...

Function Documentation

STStatus STGlyphVectorAdjustPositions (  STGlyphVector    iGlyphVector,
STPosition    iStartFrom,
STCount    iGlyphCount,
STPoint    iDelta
) 
 

Adjust X and Y positions of a range of glyphs in a glyph vector by the same amount.

Parameters:
iGlyphVector  a glyph vector
iStartFrom  first glyph in the range or ST_BEGINNING
iGlyphCount  number of glyphs in the range or ST_ALL
iDelta  a value which the that glyphs positions are adjusted by
Returns:
STStatus

STStatus STGlyphVectorDeserialize (  STGlyphVector *    oGlyphVector,
int    iFileDes
) 
 

Constructs a glyph vector from its serialized representation.

Parameters:
oGlyphVector  on return a newly allocated glyph vector is stored there
iFileDes  a file descriptor open for reading
Returns:
STStatus

STStatus STGlyphVectorDispose (  STGlyphVector    iGlyphVector ) 
 

Deallocates a glyph vector.

Parameters:
iGlyphVector 
Returns:
STStatus

STStatus STGlyphVectorGetBounds (  STGlyphVector    iGlyphVector,
STPosition    iStartFrom,
STCount    iGlyphCount,
STGraphics    iGraphics,
int    iMaxBoundsCount,
STBounds    iBounds,
int *    oBoundsCount,
STTrapezoidPtr *    oBounds
) 
 

Calculates boundaries of a range of glyphs of a glyph vector in device space.

Parameters:
iGlyphVector  a glyph vector
iStartFrom  first glyph in the range or ST_BEGINNING
iGlyphCount  number of glyphs in the range or ST_ALL
iGraphics  a graphics object - a raster or an outline device
iMaxBoundsCount  specifies the precision of the output - the maximal number of trapezoids the function can allocate to store glyph bounds. Set it to 1 if only one trapezoid for the entire line is requested
iBoundsType  specifies the type of origin used for calculating bounds
oBoundsCount  number of trapezoids in the oBounds array
oBounds  array of bounding trapezoids
Returns:
STStatus

STStatus STGlyphVectorGetGlyphs (  STGlyphVector    iGlyphVector,
STPosition    iStartFrom,
STCount *    ioGlyphCount,
STStyledGlyph **    oGlyphs
) 
 

Retrieves an array of styled glyphs from a glyph vector.

Memory is allocated by ST and the caller is responsible for deallocating it.

Parameters:
iGlyphVector  a glyph vector
oGlyphCount  number of glyphs in the output array
oGlyphs  an array of styled glyphs
Returns:
STStatus

STStatus STGlyphVectorMeasure (  STGlyphVector    iGlyphVector,
STPosition    iStartFrom,
STCount    iGlyphCount,
STRectangle *    oBBox
) 
 

Calculates a typographic bounding rectangle of a range of glyphs of the glyph vector in user space.

Parameters:
iGlyphVector  a glyph vector
iStartFrom  first glyph in the range or ST_BEGINNING
iGlyphCount  number of glyphs in the range or ST_ALL
oBBox  returned bounding box values
Returns:
STStatus

STStatus STGlyphVectorNew (  STGlyphVector *    oGlyphVector,
STTypeEnv    iEnv,
STStyledGlyph *    iSource,
STCount    iGlyphCount
) 
 

Creates a new glyph vector.

A glyph vector is a dynamic array of positioned attributed glyphs (styled glyphs.) All postprocessed text can be represented as a glyph vector.

Parameters:
oGlyphVector  a glyph vector
iEnv  a type environment object
iSource  an array of styled glyphs
iGlyphCount  number of styled glyphs in the source array
Returns:
STStatus

STStatus STGlyphVectorNewCopy (  STGlyphVector *    oGlyphVector,
STGlyphVector    iOldGlyphVector
) 
 

Creates a copy of a glyph vector.

Parameters:
oGlyphVector  on return a newly allocated glyph vector is stored there
iOldGlyphVector  a glyph vector
Returns:
STStatus

STStatus STGlyphVectorRender (  STGlyphVector    iGlyphVector,
STPosition    iStartFrom,
STCount    iGlyphCount,
STGraphics    iGraphics
) 
 

Renders a range of glyphs of a glyph vector on an output device.

Parameters:
iGlyphVector  a glyph vector
iStartFrom  first glyph in the range or ST_BEGINNING
iGlyphCount  number of glyphs in the range or ST_ALL
iGraphics  a graphics object - a raster or an outline device
Returns:
STStatus

STStatus STGlyphVectorReplaceGlyphs (  STGlyphVector    iGlyphVector,
STPosition    iStartFrom,
STCount    iGlyphCount,
STStyledGlyph *    iGlyphArray,
STCount    iGlyphArraySize
) 
 

Replaces some styled glyphs in a glyph vector with new glyphs.

The number of new glyphs and the number of replaced glyphs do not have to be the same.

Parameters:
iGlyphVector  a glyph vector
iStartFrom  first glyph to replace
iGlyphCount  the number of glyphs to replace. If this number is 0, new glyphs are inserted after glyph iStartFrom
iGlyphArray  an array of styled glyphs or NULL.
iGlyphArraySize  number of glyphs in the iGlyphArray. If iGlyphArray is NULL, this number has to be 0. If iGlyphArraySize is 0 and iGlyphCount is greater than 0, iGlyphCount glyphs are removed from the glyph vecrot.
Returns:
STStatus

STStatus STGlyphVectorSerialize (  STGlyphVector    iGlyphVector,
int    iFileDes
) 
 

Writes an XML representation of a glyph vector to a file stream.

Parameters:
iGlyphVector  a glyph vector
iFileDes  a file descriptor open for writing
Returns:
STStatus

STStatus STGlyphVectorSetGlyphs (  STGlyphVector    iGlyphVector,
STStyledGlyph *    iGlyphs,
STCount    iGlyphCount
) 
 

Assigns styled glyphs to a glyph vector replacing existing styled glyphs.

Parameters:
iGlyphVector  a glyph vector
iGlyphs  an array of styled glyphs
iGlyphCount  number of styled glyphs in the glyph array
Returns:
STStatus

Generated on Thu Mar 20 23:35:54 2003 for Standard Type Services by doxygen1.2.13.1 written by Dimitri van Heesch, © 1997-2001