TOpenFontGlyphData Class Reference

#include <openfont.h>

class TOpenFontGlyphData

Detailed Description

Font glyph data.

Objects of this type are used by rasterizers to supply glyph data to font and bitmap server clients. Unless you are writing a rasterizer you will not need to use an object of this type.

The object cannot be constructed and destroyed by normal means. It resides on a specified heap. It is created by New() and deleted by RHeap::Free().

See also: COpenFont::RasterizeL()

Member Function Documentation

Bitmap ( )

TPtrC8 Bitmap()const [inline]

Gets a constant pointer descriptor containing the bitmap this object represents.

Returns: Pointer descriptor for the glyph.

BitmapPointer ( )

const TUint8 *BitmapPointer()const [inline]

Gets a pointer to the bitmap.

This points either to the buffer used to write the bitmap when it is first rasterized, or to the cache if the character was already rasterized.

Returns: A pointer to the bitmap.

BufferEnd ( )

TUint8 *BufferEnd()[inline]

Gets a pointer to the end of the bitmap buffer.

Returns: A pointer to the end of the bitmap buffer.

BufferStart ( )

TUint8 *BufferStart()[inline]

Gets a pointer to the start of the bitmap buffer.

Returns: A pointer to the start of the bitmap buffer.

BytesNeeded ( )

TInt BytesNeeded()const [inline]

Gets the number of bytes needed to store the glyph bitmap.

See also: SetBytesNeeded()

Returns: The number of bytes needed to store the glyph bitmap.

GlyphIndex ( )

TInt GlyphIndex()const [inline]

Gets the glyph index.

This is the index of a particular glyph within the font file.

Note: This makes it possible to gain access to glyphs which are not referenced by the Unicode character set. However, this feature is not yet supported by Symbian OS.

See also: SetGlyphIndex()

Returns: The glyph index.

Metrics ( )

const TOpenFontCharMetrics *Metrics()const [inline]

Gets the character's metrics.

Returns: The character's open font metrics.

New ( RHeap *, TInt )

IMPORT_C TOpenFontGlyphData *New(RHeap *aHeap,
TIntaBufferSize
)[static]

Overflow ( )

TBool Overflow()const [inline]

Tests whether the bitmap buffer is large enough to hold the bitmap.

Returns: ETrue if the bitmap will overflow its buffer, otherwise EFalse.

SetBitmapPointer ( const TUint8 * )

voidSetBitmapPointer(const TUint8 *aBitmap)[inline]

Sets the pointer to the bitmap buffer.

ParameterDescription
aBitmapThe pointer to the bitmap buffer.

SetBytesNeeded ( TInt )

voidSetBytesNeeded(TIntaBytes)[inline]

Sets the number of bytes needed to store the glyph bitmap.

See also: BytesNeeded()

ParameterDescription
aBytesThe number of bytes needed to store the glyph bitmap.

SetGlyphIndex ( TInt )

voidSetGlyphIndex(TIntaGlyphIndex)[inline]

Sets the glyph index.

ParameterDescription
aGlyphIndexThe glyph index.

SetMetrics ( TOpenFontCharMetrics & )

voidSetMetrics(TOpenFontCharMetrics &aMetrics)[inline]

Sets the character's metrics, passing a reference to a TOpenFontCharMetrics object.

ParameterDescription
aMetricsThe character's open font character metrics.

SetMetricsPointer ( const TOpenFontCharMetrics * )

voidSetMetricsPointer(const TOpenFontCharMetrics *aMetrics)[inline]

Sets the character's metrics, passing a pointer to a TOpenFontCharMetrics object.

ParameterDescription
aMetricsA pointer to the character's open font character metrics.

SetPointersToInternalBuffers ( )

voidSetPointersToInternalBuffers()[inline]

Sets the bitmap and metrics pointers to point to the internal buffers.

The alternative is that the pointers point to the cache of metrics and bitmaps that have already been rasterized.