Source

pygame / src / doc / freetype_doc.h

/* Auto generated file: with makeref.py .  Docs go in src/ *.doc . */
#define DOC_PYGAMEFREETYPE "Enhanced Pygame module for loading and rendering fonts"

#define DOC_PYGAMEFREETYPEGETERROR "pygame.freetype.get_error(): return str\nGet the latest error"

#define DOC_PYGAMEFREETYPEGETVERSION "pygame.freetype.get_version(): return (int, int, int)\nGet the FreeType version"

#define DOC_PYGAMEFREETYPEINIT "pygame.freetype.init(default_cache_size=64): return None\nInitialize the underlying FreeType 2 library."

#define DOC_PYGAMEFREETYPEQUIT "pygame.freetype.quit(): return None\nShuts down the underlying FreeType 2 library."

#define DOC_PYGAMEFREETYPEWASINIT "pygame.freetype.quit(): return bool\nReturns whether the the FreeType 2 library is initialized."

#define DOC_PYGAMEFREETYPEFONT "pygame.freetype.Font(file, style=STYLE_NONE, ptsize=-1, face_index=0): return Font\nCreates a new Font from a supported font file."

#define DOC_FONTNAME "Font.name: return string\nGets the name of the font face."

#define DOC_FONTGETSIZE "Font.get_size(text, style=STYLE_DEFAULT, rotation=0, ptsize=default): return (int, int)\nGets the size of rendered text"

#define DOC_FONTGETMETRICS "Font.get_metrics(text, bbmode=BBOX_PIXEL_GRIDFIT, ptsize=default): return [(...), ...]\nGets glyph metrics for the font's characters"

#define DOC_FONTHEIGHT "Font.height: return int\nGets the height of the Font"

#define DOC_FONTRENDER "Font.render(dest, text, fgcolor, bgcolor=None, style=STYLE_DEFAULT, rotation=0, ptsize=default): return (Surface, int, int)\nRenders text on a surface"

#define DOC_FONTSTYLE "Font.style: return int\nGets or sets the font's style"

#define DOC_FONTUNDERLINE "Font.underline: return bool\nGets or sets the font's underline style"

#define DOC_FONTBOLD "Font.bold: return bool\nGets or sets the font's bold style"

#define DOC_FONTITALIC "Font.italic: return bool\nGets or sets the font's italic style"

#define DOC_FONTFIXEDWIDTH "Font.fixed_width: return bool\nGets whether the font is fixed-width"

#define DOC_FONTANTIALIASED "Font.antialiased: return bool\nFont antialiasing mode"

#define DOC_FONTVERTICAL "Font.vertical: return bool\nFont vertical mode"

#define DOC_ ""



/* Docs in a comments... slightly easier to read. */


/*

pygame.freetype
 Enhanced Pygame module for loading and rendering fonts



pygame.freetype.get_error
 pygame.freetype.get_error(): return str
Get the latest error



pygame.freetype.get_version
 pygame.freetype.get_version(): return (int, int, int)
Get the FreeType version



pygame.freetype.init
 pygame.freetype.init(default_cache_size=64): return None
Initialize the underlying FreeType 2 library.



pygame.freetype.quit
 pygame.freetype.quit(): return None
Shuts down the underlying FreeType 2 library.



pygame.freetype.was_init
 pygame.freetype.quit(): return bool
Returns whether the the FreeType 2 library is initialized.



pygame.freetype.Font
 pygame.freetype.Font(file, style=STYLE_NONE, ptsize=-1, face_index=0): return Font
Creates a new Font from a supported font file.



Font.name
 Font.name: return string
Gets the name of the font face.



Font.get_size
 Font.get_size(text, style=STYLE_DEFAULT, rotation=0, ptsize=default): return (int, int)
Gets the size of rendered text



Font.get_metrics
 Font.get_metrics(text, bbmode=BBOX_PIXEL_GRIDFIT, ptsize=default): return [(...), ...]
Gets glyph metrics for the font's characters



Font.height
 Font.height: return int
Gets the height of the Font



Font.render
 Font.render(dest, text, fgcolor, bgcolor=None, style=STYLE_DEFAULT, rotation=0, ptsize=default): return (Surface, int, int)
Renders text on a surface



Font.style
 Font.style: return int
Gets or sets the font's style



Font.underline
 Font.underline: return bool
Gets or sets the font's underline style



Font.bold
 Font.bold: return bool
Gets or sets the font's bold style



Font.italic
 Font.italic: return bool
Gets or sets the font's italic style



Font.fixed_width
 Font.fixed_width: return bool
Gets whether the font is fixed-width



Font.antialiased
 Font.antialiased: return bool
Font antialiasing mode



Font.vertical
 Font.vertical: return bool
Font vertical mode




 



*/