Load fpg - Revision history

Sandman at 22:17, 25 July 2007

2007-07-25T22:17:07Z

←Older revision		Revision as of 22:17, 25 July 2007
Line 28:		Line 28:

	== Notes ==		== Notes ==
-	Using an FPG file to contain all or some of the graphics used in a Fenix program is convenient, but isn't always the best way to load graphics. Other methods of loading graphics into your program include [[load_map]]() and [[load_png]]() which load individual graphic files. Graphics loaded individually will be given [[FileID]] 0 and a [[GraphID]] starting at 1000. This is because Fenix reserves room for the first FPG loaded (FPG files can contain 999 different graphics max.), sometimes referred to as the environment ~~FPG~~.	+	Using an FPG file to contain all or some of the graphics used in a Fenix program is convenient, but isn't always the best way to load graphics. Other methods of loading graphics into your program include [[load_map]]() and [[load_png]]() which load individual graphic files. Graphics loaded individually will be given [[FileID]] 0 and a [[GraphID]] starting at 1000. This is because Fenix reserves room for the first FPG loaded (FPG files can contain 999 different graphics max.), sometimes referred to as the [[system file]] or [[environment file]].

-	The first FPG file loaded into a Fenix program returns and uses the [[FileID]] 0, which is reserved by Fenix for use as the ~~environment FPG~~. All extra FPG files loaded will have a different FileID, progressing from 1 upwards.	+	The first FPG file loaded into a Fenix program returns and uses the [[FileID]] 0, which is reserved by Fenix for use as the [[system file]]. All extra FPG files loaded will have a different FileID, progressing from 1 upwards.

	An FPG file holds all its contained graphs in memory simultaneously. Having a lot of large graphs being read from a single FPG file at once has been known to slow down Fenix programs.		An FPG file holds all its contained graphs in memory simultaneously. Having a lot of large graphs being read from a single FPG file at once has been known to slow down Fenix programs.

Sandman at 18:57, 8 July 2007

2007-07-08T18:57:06Z

←Older revision		Revision as of 18:57, 8 July 2007
Line 3:		Line 3:

	==Definition==		==Definition==
-	'''INT''' load_fpg ( <'''STRING''' ~~file~~> )	+	'''INT''' load_fpg ( <'''STRING''' filename> )

	Loads a graphics library into your program.		Loads a graphics library into your program.
Line 11:		Line 11:
	== Parameters ==		== Parameters ==
	{\|		{\|
-	\| '''STRING''' ~~file~~ \|\| - The filename of the FPG that you wish to load (including extension and possible path).	+	\| '''STRING''' filename \|\| - The filename of the FPG that you wish to load (including extension and possible path).
	\|}		\|}

Sandman at 11:02, 18 May 2007

2007-05-18T11:02:09Z

←Older revision		Revision as of 11:02, 18 May 2007
Line 7:		Line 7:
	Loads a graphics library into your program.		Loads a graphics library into your program.

-	This function loads the whole contents of a [[FPG]] graphics library into your project, enabling the contained graphics to be used in your program as [[process]]' graphs, screen backgrounds ([[put_screen]]) or other graphics.	+	This function loads the whole contents of an [[FPG]] graphics library into your project, enabling the contained [[graphics]] to be used in your program as [[process]]' graphs, screen backgrounds ([[put_screen]]()) or other graphics.

	== Parameters ==		== Parameters ==
	{\|		{\|
-	\| '''STRING''' file \|\| - The ~~file name~~ of the FPG that you wish to load (including extension).	+	\| '''STRING''' file \|\| - The filename of the FPG that you wish to load (including extension and possible path).
	\|}		\|}

	== Returns ==		== Returns ==
-	'''INT''' : ~~A numerical identifier for~~ the ~~FPG file~~.	+	'''INT''' : [[FileID]]
		+	{\|
		+	\| -1 \|\| - The specified archive could not be loaded.
		+	\|-
		+	\| >=0 \|\| - The [[FileID]] assigned to the archive.
		+	\|}
		+
		+	== Errors ==
		+	{\|
		+	\| Archive not found \|\| - The specified archive could not be found.
		+	\|}

	== Notes ==		== Notes ==
-	Using an FPG file to contain all or some of the graphics used in a Fenix program is convenient, but isn't always the best way to load graphics. Other methods of loading graphics into your program include [[load_map]] and [[load_png]] which load individual graphic files. Graphics loaded individually will be given ~~an ID~~ starting at 1000~~, this~~ is because Fenix ~~pre-allocates~~ room for the first FPG loaded (FPG files can contain 999 different graphics max.), sometimes referred to as the environment FPG.	+	Using an FPG file to contain all or some of the graphics used in a Fenix program is convenient, but isn't always the best way to load graphics. Other methods of loading graphics into your program include [[load_map]]() and [[load_png]]() which load individual graphic files. Graphics loaded individually will be given [[FileID]] 0 and a [[GraphID]] starting at 1000. This is because Fenix reserves room for the first FPG loaded (FPG files can contain 999 different graphics max.), sometimes referred to as the environment FPG.

-	The first FPG file loaded into a Fenix program returns and uses the [[FileID]] 0, which is ~~pre-allocated~~ by Fenix for use as the environment FPG. All extra FPG files loaded will have a different FileID, progressing from 1 upwards.	+	The first FPG file loaded into a Fenix program returns and uses the [[FileID]] 0, which is reserved by Fenix for use as the environment FPG. All extra FPG files loaded will have a different FileID, progressing from 1 upwards.

	An FPG file holds all its contained graphs in memory simultaneously. Having a lot of large graphs being read from a single FPG file at once has been known to slow down Fenix programs.		An FPG file holds all its contained graphs in memory simultaneously. Having a lot of large graphs being read from a single FPG file at once has been known to slow down Fenix programs.

-	Once an FPG file is no longer necessary to be held in the memory, its memory space can be released by using the function [[unload_fpg]]. It is not necessary to unload files ~~loaded within Fenix, even~~ at the termination of a program. Fenix always releases all used memory at the end of program execution.	+	Once an FPG file is no longer necessary to be held in the memory, its memory space can be released by using the function [[unload_fpg]](). It is not necessary to unload files at the termination of a program, as Fenix always releases all used memory at the end of program execution.

	== Example ==		== Example ==
Line 30:		Line 40:
	Program example;		Program example;
	Global		Global
-	my_fpg;	+	int my_fpg;
	Begin		Begin
	my_fpg=load_fpg("test.fpg"); //Loads the FPG file into memory		my_fpg=load_fpg("test.fpg"); //Loads the FPG file into memory
	put_screen(my_fpg,1); //Puts graphic with code 1 onto screen		put_screen(my_fpg,1); //Puts graphic with code 1 onto screen
-	~~Loop~~	+	Repeat
	frame;		frame;
-	~~End~~	+	Until(key(_esc))
		+	unload_fpg(my_fpg);
	End		End
	</pre>		</pre>
		+	Used in example: [[put_screen]](), [[unload_fpg]]()

G105b: /* Notes */

2007-05-17T15:22:45Z

Notes

←Older revision		Revision as of 15:22, 17 May 2007
Line 18:		Line 18:

	== Notes ==		== Notes ==
-	Using a FPG file to contain all or some of the graphics used in a Fenix program is convenient, but isn't always the best way to load graphics. Other methods of loading graphics into your program include [[load_map]] and [[load_png]] which load individual graphic files. Graphics loaded individually will be given an ID starting at 1000, this is because Fenix pre-allocates room for the first FPG loaded (FPG files can contain 999 different graphics max.), sometimes referred to as the environment FPG.	+	Using an FPG file to contain all or some of the graphics used in a Fenix program is convenient, but isn't always the best way to load graphics. Other methods of loading graphics into your program include [[load_map]] and [[load_png]] which load individual graphic files. Graphics loaded individually will be given an ID starting at 1000, this is because Fenix pre-allocates room for the first FPG loaded (FPG files can contain 999 different graphics max.), sometimes referred to as the environment FPG.

	The first FPG file loaded into a Fenix program returns and uses the [[FileID]] 0, which is pre-allocated by Fenix for use as the environment FPG. All extra FPG files loaded will have a different FileID, progressing from 1 upwards.		The first FPG file loaded into a Fenix program returns and uses the [[FileID]] 0, which is pre-allocated by Fenix for use as the environment FPG. All extra FPG files loaded will have a different FileID, progressing from 1 upwards.

-	A FPG file holds all its contained graphs in memory simultaneously. Having a lot of large graphs being read from a single FPG file at once has been known to slow down Fenix programs.	+	An FPG file holds all its contained graphs in memory simultaneously. Having a lot of large graphs being read from a single FPG file at once has been known to slow down Fenix programs.

-	Once a FPG file is no longer necessary to be held in the memory, its memory space can be released by using the function [[unload_fpg]]. It is not necessary to unload files loaded within Fenix, even at the termination of a program. Fenix always releases all used memory at the end of program execution.	+	Once an FPG file is no longer necessary to be held in the memory, its memory space can be released by using the function [[unload_fpg]]. It is not necessary to unload files loaded within Fenix, even at the termination of a program. Fenix always releases all used memory at the end of program execution.

	== Example ==		== Example ==

G105b at 15:16, 17 May 2007

2007-05-17T15:16:18Z

New page

[[Category:functions]]
[[Category:fpg]]

==Definition==
'''INT''' load_fpg ( <'''STRING''' file> )

Loads a graphics library into your program.

This function loads the whole contents of a [[FPG]] graphics library into your project, enabling the contained graphics to be used in your program as [[process]]' graphs, screen backgrounds ([[put_screen]]) or other graphics.

== Parameters ==
{|
| '''STRING''' file || - The file name of the FPG that you wish to load (including extension).
|}

== Returns ==
'''INT''' : A numerical identifier for the FPG file.

== Notes ==
Using a FPG file to contain all or some of the graphics used in a Fenix program is convenient, but isn't always the best way to load graphics. Other methods of loading graphics into your program include [[load_map]] and [[load_png]] which load individual graphic files. Graphics loaded individually will be given an ID starting at 1000, this is because Fenix pre-allocates room for the first FPG loaded (FPG files can contain 999 different graphics max.), sometimes referred to as the environment FPG.

The first FPG file loaded into a Fenix program returns and uses the [[FileID]] 0, which is pre-allocated by Fenix for use as the environment FPG. All extra FPG files loaded will have a different FileID, progressing from 1 upwards.

A FPG file holds all its contained graphs in memory simultaneously. Having a lot of large graphs being read from a single FPG file at once has been known to slow down Fenix programs.

Once a FPG file is no longer necessary to be held in the memory, its memory space can be released by using the function [[unload_fpg]]. It is not necessary to unload files loaded within Fenix, even at the termination of a program. Fenix always releases all used memory at the end of program execution.

== Example ==
<pre>
Program example;
Global
my_fpg;
Begin
my_fpg=load_fpg("test.fpg"); //Loads the FPG file into memory
put_screen(my_fpg,1); //Puts graphic with code 1 onto screen
Loop
frame;
End
End
</pre>