ScummVM API documentation
Public Member Functions | Static Public Member Functions | List of all members
Graphics::MacFONTFont Class Reference

#include <macfont.h>

Inheritance diagram for Graphics::MacFONTFont:
Graphics::Font

Public Member Functions

 MacFONTFont (const MacFONTdata &data)
 
virtual int getFontHeight () const
 
virtual int getFontAscent () const
 
virtual int getFontDescent () const
 
virtual int getFontLeading () const
 
virtual int getMaxCharWidth () const
 
virtual int getCharWidth (uint32 chr) const
 
virtual void drawChar (Surface *dst, uint32 chr, int x, int y, uint32 color) const
 
bool loadFont (Common::SeekableReadStream &stream, MacFontFamily *family=nullptr, int size=12, int style=0)
 
virtual int getKerningOffset (uint32 left, uint32 right) const
 
int getFontSize () const
 
- Public Member Functions inherited from Graphics::Font
virtual Common::String getFontName () const
 
virtual Common::Rect getBoundingBox (uint32 chr) const
 
Common::Rect getBoundingBox (const Common::String &str, int x=0, int y=0, const int w=0, TextAlign align=kTextAlignLeft, int deltax=0, bool useEllipsis=false) const
 
Common::Rect getBoundingBox (const Common::U32String &str, int x=0, int _y=0, const int w=0, TextAlign align=kTextAlignLeft, int deltax=0, bool useEllipsis=false) const
 
virtual void drawChar (ManagedSurface *dst, uint32 chr, int x, int y, uint32 color) const
 
void drawString (Surface *dst, const Common::String &str, int x, int y, int w, uint32 color, TextAlign align=kTextAlignLeft, int deltax=0, bool useEllipsis=false) const
 
void drawString (Surface *dst, const Common::U32String &str, int x, int y, int w, uint32 color, TextAlign align=kTextAlignLeft, int deltax=0, bool useEllipsis=false) const
 
void drawString (ManagedSurface *dst, const Common::String &str, int x, int _y, int w, uint32 color, TextAlign align=kTextAlignLeft, int deltax=0, bool useEllipsis=false) const
 
void drawString (ManagedSurface *dst, const Common::U32String &str, int x, int y, int w, uint32 color, TextAlign align=kTextAlignLeft, int deltax=0, bool useEllipsis=false) const
 
int getStringWidth (const Common::String &str) const
 
int getStringWidth (const Common::U32String &str) const
 
int wordWrapText (const Common::String &str, int maxWidth, Common::Array< Common::String > &lines, int initWidth=0, uint32 mode=kWordWrapOnExplicitNewLines) const
 
int wordWrapText (const Common::U32String &str, int maxWidth, Common::Array< Common::U32String > &lines, int initWidth=0, uint32 mode=kWordWrapOnExplicitNewLines) const
 
int wordWrapText (const Common::U32String &str, int maxWidth, Common::Array< Common::U32String > &lines, Common::Array< bool > &lineContinuation, int initWidth=0, uint32 mode=kWordWrapOnExplicitNewLines) const
 
void scaleSingleGlyph (Surface *scaleSurface, int *grayScaleMap, int grayScaleMapSize, int width, int height, int xOffset, int yOffset, int grayLevel, int chr, int srcheight, int srcwidth, float scale) const
 

Static Public Member Functions

static MacFONTFont * scaleFont (const MacFONTFont *src, int newSize, int slant)
 
static void testBlit (const MacFONTFont *src, ManagedSurface *dst, int color, int x0, int y0, int width)
 

Detailed Description

Processing of Mac FONT/NFNT rResources

Member Function Documentation

◆ getFontHeight()

virtual int Graphics::MacFONTFont::getFontHeight ( ) const
inlinevirtual

Return the height of the font.

Returns
Font height in pixels.

Implements Graphics::Font.

◆ getFontAscent()

virtual int Graphics::MacFONTFont::getFontAscent ( ) const
inlinevirtual

Return the ascent of the font.

Returns
Font ascent in pixels. If it is unknown a value of -1 is returned.

Reimplemented from Graphics::Font.

◆ getFontDescent()

virtual int Graphics::MacFONTFont::getFontDescent ( ) const
inlinevirtual

Return the descent of the font.

Returns
Font descent in pixels. If it is unknown a value of -1 is returned.

Reimplemented from Graphics::Font.

◆ getFontLeading()

virtual int Graphics::MacFONTFont::getFontLeading ( ) const
inlinevirtual

Return the leading of the font. This is the distance between the descent line and the ascent line below it.

Returns
Font leading in pixels. If it is unknown a value of -1 is returned.

Reimplemented from Graphics::Font.

◆ getMaxCharWidth()

virtual int Graphics::MacFONTFont::getMaxCharWidth ( ) const
inlinevirtual

Return the maximum width of the font.

Returns
Maximum font width in pixels.

Implements Graphics::Font.

◆ getCharWidth()

virtual int Graphics::MacFONTFont::getCharWidth ( uint32  chr) const
virtual

Return the width of a specific character.

Parameters
chrThe character to query the width of.
Returns
The width of the character in pixels.

Implements Graphics::Font.

◆ drawChar()

virtual void Graphics::MacFONTFont::drawChar ( Surface *  dst,
uint32  chr,
int  x,
int  y,
uint32  color 
) const
virtual

Draw a character at a specific point on the surface.

Note that the point describes the top left edge point where to draw the character. This can be different from the top left edge point of the character's bounding box. For example, TTF fonts sometimes move characters like 't' by one (or more) pixels to the left to create better visual results. To query the actual bounding box of a character, use getBoundingBox.

See also
getBoundingBox

The Font implementation should take care of not drawing outside of the specified surface.

Parameters
dstThe surface to draw on.
chrThe character to draw.
xThe x coordinate where to draw the character.
yThe y coordinate where to draw the character.
colorThe color of the character.

Implements Graphics::Font.

◆ getKerningOffset()

virtual int Graphics::MacFONTFont::getKerningOffset ( uint32  left,
uint32  right 
) const
virtual

Query the kerning offset between two characters.

Parameters
leftLeft character. Can be 0.
rightRight character. Can be 0.
Returns
The horizontal displacement.

Reimplemented from Graphics::Font.

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