Difference between revisions of "LOADFONT"

From QB64 Wiki
Jump to navigation Jump to search
imported>Clippy
m
imported>Clippy
m
Line 12: Line 12:
* '''Always check that font handle values are greater than 0 before using them or [[ERROR Codes|illegal function errors]] may occur!'''
* '''Always check that font handle values are greater than 0 before using them or [[ERROR Codes|illegal function errors]] may occur!'''
* ''TTF_filename$'' is the filename of '''truetype''' fonts only. Can include the path to the font file. Best to include font files with a program.
* ''TTF_filename$'' is the filename of '''truetype''' fonts only. Can include the path to the font file. Best to include font files with a program.
* '''Check the font file name! The name in the "viewer" is NOT necessarily the file's name! Use the name in properties!'''
* If a program is on a different drive than Windows, [[ENVIRON$]]("SYSTEMROOT") will return the path to the "WINDOWS" folder. Normally "C:\WINDOWS". Then add the "\FONTS\" folder and the font '''.TTF''' filename to the path [[STRING]].
* If a program is on a different drive than Windows, [[ENVIRON$]]("SYSTEMROOT") will return the path to the "WINDOWS" folder. Normally "C:\WINDOWS". Then add the "\FONTS\" folder and the font '''.TTF''' filename to the path [[STRING]].
* ''Size'' is the height of the font. Font sizes can be found using the [[_FONTHEIGHT]] function. Font ''size''s also affect [[SCREEN (statement)|SCREEN]] sizes!  
* ''Size'' is the height of the font. Font sizes can be found using the [[_FONTHEIGHT]] function. Font ''size''s also affect [[SCREEN (statement)|SCREEN]] sizes!  

Revision as of 08:07, 25 October 2010

The _LOADFONT function returns a font handle for a TrueType font (.TTF).


Syntax

handle& = _LOADFONT (ttf_filename$, size[, "MONOSPACE|, BOLD|, ITALIC|, UNDERLINE|, DONTBLEND"])



Description

  • The assigned LONG font handle variable return value designates a font style to be used somewhere in a program.
  • Always check that font handle values are greater than 0 before using them or illegal function errors may occur!
  • TTF_filename$ is the filename of truetype fonts only. Can include the path to the font file. Best to include font files with a program.
  • Check the font file name! The name in the "viewer" is NOT necessarily the file's name! Use the name in properties!
  • If a program is on a different drive than Windows, ENVIRON$("SYSTEMROOT") will return the path to the "WINDOWS" folder. Normally "C:\WINDOWS". Then add the "\FONTS\" folder and the font .TTF filename to the path STRING.
  • Size is the height of the font. Font sizes can be found using the _FONTHEIGHT function. Font sizes also affect SCREEN sizes!
  • _FONTWIDTH can only measure MONOSPACE fonts! "MONOSPACE" cannot be used on a variable width font.
  • _PRINTWIDTH can measure the width of a string of text in graphics modes only.
  • Style parameter(s) used, if any, are literal(in quotes) or variable text parameters. "Monospace" has limited font file selections.
  • You can pass different font styles using different predefined STRING variable lists. You can include an empty style string!
  • Multiple fonts will require multiple font variable handles unless used and freed consecutively.
  • Windows users should find TTF font files in the C:\WINDOWS\FONTS folder. Use the font properties to see the real filename.
  • Font handles with values greater than 0 that are no longer used should be freed using _FREEFONT.
  • Font handle values of -1 (load failure) do not need to be freed! An error will occur if you try to free invalid handles!
  • NOTE: SCREEN 0 can only use ONE font on a screen page! Thus a style like underline would affect the entire page.


Examples

Example 1: You need to know that if you are in a text mode (such as SCREEN 0 - the default) then you will only be able to use mono-spaced (fixed width) fonts.

rootpath$ = ENVIRON$("SYSTEMROOT") 'normally "C:\WINDOWS" fontfile$ = rootpath$ + "\Fonts\cour.ttf" 'TTF file in Windows style$ = "monospace, italic, bold" 'font style is not case sensitive f& =_LOADFONT(fontfile$, 30, style$) _FONT f& PRINT "Hello!"

Hello!

Note: 30 means each row of text (including vertical spacing) will be exactly 30 pixels high. This may make some program screens larger. If you don't want a style listed just use style$ = "" if using a STRING variable for different calls.


Example 2: In a 32-bit graphics mode you can alpha blend onto the background:

i& =_NEWIMAGE(800,600,32) SCREEN i& COLOR &HC0FFFF00,&H200000FF f& =_LOADFONT("C:\Windows\Fonts\times.ttf", 25) 'normal style PRINT "Hello!"

Hello!


Note: You can load a fixed width font file without using the "monospace" option and it will be treated as variable width. This can be useful because LOCATE treats the horizontal position as an offset in pixels for variable width fonts.


See also:



Navigation:
Keyword Reference - Alphabetical
Keyword Reference - By Usage
Main Wiki Page