Load ttf - Revision history

Sandman at 00:54, 1 March 2008

2008-03-01T00:54:13Z

←Older revision		Revision as of 00:54, 1 March 2008
Line 11:		Line 11:

	Loads a [[TTF]] file as a [[font]] into memory.		Loads a [[TTF]] file as a [[font]] into memory.
		+
		+	Also called '''TTF_Load'''() (if TTF.fh is included).

	== Parameters ==		== Parameters ==

Sandman at 12:56, 29 February 2008

2008-02-29T12:56:19Z

←Older revision		Revision as of 12:56, 29 February 2008
Line 10:		Line 10:
	'''INT''' load_ttf ( <'''STRING''' filename> , <'''INT''' height> )		'''INT''' load_ttf ( <'''STRING''' filename> , <'''INT''' height> )

-	Loads a [[TTF]] file into memory.	+	Loads a [[TTF]] file as a [[font]] into memory.

	== Parameters ==		== Parameters ==
Line 16:		Line 16:
	\| '''STRING''' filename \|\| - The filename of the [[TTF]] file that you wish to load (including extension and possible path).		\| '''STRING''' filename \|\| - The filename of the [[TTF]] file that you wish to load (including extension and possible path).
	\|-		\|-
-	\| '''INT''' height \|\| - The height of the font ~~in pixels~~, a size indication.	+	\| '''INT''' height \|\| - The height in pixels of the to be created font, a size indication.
	\|}		\|}

Line 23:		Line 23:
	{\|		{\|
	\| -1 \|\| - Error: file does not exist; insufficient memory; failed to init freetype.dll; error while loading file; error creating new font.		\| -1 \|\| - Error: file does not exist; insufficient memory; failed to init freetype.dll; error while loading file; error creating new font.
		+	\|-
		+	\| 0 \|\| - Invalid filename.
	\|-		\|-
	\| >0 \|\| - The FontID.		\| >0 \|\| - The FontID.
Line 55:		Line 57:
	Begin		Begin

		+	set_text_color(rgb(255,0,255));
	fontID = load_ttf("myttf.ttf",20);		fontID = load_ttf("myttf.ttf",20);

Line 67:		Line 70:
	End		End
	</pre>		</pre>
-	Used in example: [[write]](), [[key]](), [[unload_fnt]]()	+	Used in example: [[set_text_color]](), [[rgb]](), [[load_ttf]](), [[write]](), [[key]](), [[unload_fnt]]()

	{{Ttffuncbox}}		{{Ttffuncbox}}

Sandman at 12:31, 29 February 2008

2008-02-29T12:31:34Z

←Older revision		Revision as of 12:31, 29 February 2008
Line 1:		Line 1:
	[[Category:functions]]		[[Category:functions]]
-	[[Category:~~networkdll~~]]	+	[[Category:ttfdll]]
	[[Category:dll]]		[[Category:dll]]

-	[[Functioncategory:~~Networkdll~~\|'''Up to ~~Network~~.DLL Functions''']]	+	[[Functioncategory:Ttfdll\|'''Up to TTF.DLL Functions''']]
	----		----

Sandman: New page: Category:functions Category:networkdll Category:dll '''Up to Network.DLL Functions''' ---- ==Definition== '''INT''' load_ttf ( <'''STRING''' ...

2008-02-29T12:29:11Z

New page: Category:functions Category:networkdll Category:dll '''Up to Network.DLL Functions''' ---- ==Definition== '''INT''' load_ttf ( <'''STRING''' ...

New page

[[Category:functions]]
[[Category:networkdll]]
[[Category:dll]]

[[Functioncategory:Networkdll|'''Up to Network.DLL Functions''']]
----

==Definition==
'''INT''' load_ttf ( <'''STRING''' filename> , <'''INT''' height> )

Loads a [[TTF]] file into memory.

== Parameters ==
{|
| '''STRING''' filename || - The filename of the [[TTF]] file that you wish to load (including extension and possible path).
|-
| '''INT''' height || - The height of the font in pixels, a size indication.
|}

== Returns ==
'''INT''' : [[FontID]]
{|
| -1 || - Error: file does not exist; insufficient memory; failed to init freetype.dll; error while loading file; error creating new font.
|-
| >0 || - The FontID.
|}

== Errors ==
{|
| Insufficient memory || - There is insufficient memory available. This error doesn't occur often.
|-
| Failed to init freetype.dll || - There was an error initializing freetype.dll
|-
| Error loading file || - There occurred an error while trying to load the file.
|-
| Error creating new font || - There occurred an error while trying to create a new font.
|}

== Notes ==
This function gets a [http://en.wikipedia.org/wiki/Truetype TrueType] font and creates a new [[font]] with generated [[glyph]]s based on the recovered font in the standard characters set (ISO-8859-1).
These glyphs are generated with two colours, being colour 0 (transparent) and the color last set by [[set_text_color]](). The first one is the background colour and the last one is the colour of the characters self.

It's possible to save the loaded font as [[FNT]] with [[save_fnt]](). This way the font can be reused on platforms not supporting [[TTF.DLL]]. Note that a FNT file only has information about the font for one size, while a TTF file has information for any size.

The specified size is only an indication; some characters may be a little higher in fact.

== Example ==
<pre>
include "TTF.fh";

Process Main()
Private
int fontID;
Begin

fontID = load_ttf("myttf.ttf",20);

write(fontID,160,100,4,"Look at my TTF font!");

Repeat
frame;
Until(key(_ESC))

unload_fnt(fontID);

End
</pre>
Used in example: [[write]](), [[key]](), [[unload_fnt]]()

{{Ttffuncbox}}