FenixWiki - New pages [en]

Stop scroll

2009-06-25T11:26:04Z

Summary: New page: [[Category:functions]] [[Category:scrolls]] Stop_scroll(<int> scroll number)

[[Category:functions]]
[[Category:scrolls]]

Stop_scroll(<int> scroll number)

Ascii

2009-06-25T10:49:08Z

Summary:

[[category:global variables]]

Returns the ASCII value of the last pressed key

Scan code

2009-06-25T10:45:50Z

Summary:

[[category:global variables]]

Returns the [[scancode]] of a key (same code as scancodes _a, _b, _enter,...)

Bool

2008-12-28T19:17:28Z

Summary: New page: [[Category:language]] [[Category:datatypes]] == Definition == '''BOOL''' '''Bool'''s are 1 or 0.

[[Category:language]]
[[Category:datatypes]]

== Definition ==
'''BOOL'''

'''Bool'''s are 1 or 0.

Cd currtrack

2008-08-29T20:41:34Z

Summary:

[[Category:functions]]
[[Category:CD]]

==Definition==
'''INT''' cd_currtrack ( <'''INT''' cdID> )

Returns the currently being played track on the specified CD/DVD drive.

* ''Added in [[Fenix]] [[0.92a]]''
* ''Removed in [[Fenix]] [[0.93]]'' (use [[cd_getinfo]]() and [[cdinfo]])

== Parameters ==
{|
| '''INT''' cdID || - The cdID of the CD/DVD drive with the CD of which currently being played track is wanted.
|}

== Returns ==
'''INT''' : The currently being played track number.
{|
| 0 || - Invalid CD/DVD drive.
|-
| 1 || - The currently being played track number.
|}

{{Funcbox
| category = CD
}}

Cd numtracks

2008-08-29T20:32:36Z

Summary:

[[Category:functions]]
[[Category:CD]]

==Definition==
'''INT''' cd_numtracks ( <'''INT''' cdID> )

Returns the number of tracks on the CD/DVD in the specified CD/DVD drive.

* ''Added in [[Fenix]] [[0.92a]]''
* ''Removed in [[Fenix]] [[0.93]]'' (use [[cd_getinfo]]() and [[cdinfo]])

== Parameters ==
{|
| '''INT''' cdID || - The cdID of the CD/DVD drive with the CD of which the number of tracks is wanted.
|}

== Returns ==
'''INT''' : The number of tracks on the CD.
{|
| 0 || - Invalid CD/DVD drive; no tracks.
|-
| !0 || - The number of tracks on the CD.
|}

{{Funcbox
| category = CD
}}

Cd stop

2008-08-29T20:29:34Z

Summary: New page: [[Category:functions]] [[Category:CD]] ==Definition== '''INT''' cd_stop ( <'''INT''' cdID> ) Stops playback of the specified CD/DVD drive. == Parameters == {| | '''INT''' cdID || - The ...

[[Category:functions]]
[[Category:CD]]

==Definition==
'''INT''' cd_stop ( <'''INT''' cdID> )

Stops playback of the specified CD/DVD drive.

== Parameters ==
{|
| '''INT''' cdID || - The cdID of the CD/DVD drive to stop playback on.
|}

== Returns ==
'''INT'''
{|
| 0 || - Invalid CD/DVD drive.
|-
| 1 || - Playback of the CD/DVD drive is stopped.
|}

{{Funcbox
| category = CD
}}

Cd resume

2008-08-29T20:28:44Z

Summary: New page: [[Category:functions]] [[Category:CD]] ==Definition== '''INT''' cd_resume ( <'''INT''' cdID> ) Resumes playback of the specified CD/DVD drive. == Parameters == {| | '''INT''' cdID || - ...

[[Category:functions]]
[[Category:CD]]

==Definition==
'''INT''' cd_resume ( <'''INT''' cdID> )

Resumes playback of the specified CD/DVD drive.

== Parameters ==
{|
| '''INT''' cdID || - The cdID of the CD/DVD drive to resume playback on.
|}

== Returns ==
'''INT'''
{|
| 0 || - Invalid CD/DVD drive.
|-
| 1 || - Playback of the CD/DVD drive is resumed.
|}

{{Funcbox
| category = CD
}}

Cd pause

2008-08-29T20:27:18Z

Summary:

[[Category:functions]]
[[Category:CD]]

==Definition==
'''INT''' cd_pause ( <'''INT''' cdID> )

Pauses playback of the specified CD/DVD drive.

== Parameters ==
{|
| '''INT''' cdID || - The cdID of the CD/DVD drive to pause playback on.
|}

== Returns ==
'''INT'''
{|
| 0 || - Invalid CD/DVD drive.
|-
| 1 || - Playback of the CD/DVD drive is paused.
|}

{{Funcbox
| category = CD
}}

Cd eject

2008-08-29T20:22:41Z

Summary: New page: [[Category:functions]] [[Category:CD]] ==Definition== '''INT''' cd_eject ( <'''INT''' cdID> ) Ejects the CD/DVD (tray) from the drive. == Parameters == {| | '''INT''' cdID || - The cdID...

[[Category:functions]]
[[Category:CD]]

==Definition==
'''INT''' cd_eject ( <'''INT''' cdID> )

Ejects the CD/DVD (tray) from the drive.

== Parameters ==
{|
| '''INT''' cdID || - The cdID of the CD/DVD drive of which the CD/DVD (tray) is to be ejected.
|}

== Returns ==
'''INT'''
{|
| 0 || - Invalid CD/DVD drive.
|-
| 1 || - The CD/DVD (tray) is ejected.
|}

{{Funcbox
| category = CD
}}

Cd play

2008-08-29T20:16:58Z

Summary:

[[Category:functions]]
[[Category:CD]]

==Definition==
'''INT''' cd_play ( <'''INT''' cdID> , <'''INT''' trackNumber> , [<'''INT''' tracks>] )

Starts playing at the specified track on the specified CD/DVD drive and will keep on playing for the specified number of tracks or one if no number is specified.

== Parameters ==
{|
| '''INT''' cdID || - The cdID of the CD/DVD drive with the CD to play.
|-
| '''INT''' trackNumber || - The track number to play.
|-
| '''INT''' tracks || - The number of tracks to play. Default is ''1''.
|}

== Returns ==
'''INT'''
{|
| 0 || - Invalid CD/DVD drive or CD/DVD.
|-
| 1 || - The CD started playing.
|}

{{Funcbox
| category = CD
}}

Cdinfo

2008-08-29T15:46:55Z

Summary:

[[category:variables]]
[[category:predefined]]
[[category:global variables]]

[[Global variables|'''Up to Global Variables''']]

----

== Definition ==
'''Struct''' cdinfo

cdinfo is a [[global|global variable]] [[struct]], containing information about a CD/DVD drive, last obtained using [[cd_getinfo]]().

== Members ==
''filling this out later...''
{|
| ''Member name'' || - ''Description''
|-
| '''INT''' current_track || -
|-
| '''INT''' current_frame || -
|-
| '''INT''' tracks || -
|-
| '''INT''' minute || -
|-
| '''INT''' second || -
|-
| '''INT''' subframe || -
|-
| '''INT''' minutes || -
|-
| '''INT''' seconds || -
|-
| '''INT''' subframes || -
|-
| '''STRUCT''' track[99]
:{|
| '''INT''' audio || -
|-
| '''INT''' minutes || -
|-
| '''INT''' seconds || -
|-
| '''INT''' subframes || -
|}
|}

== Notes ==

{{Globals}}

Cd getinfo

2008-08-29T15:37:24Z

Summary:

[[Category:functions]]
[[Category:CD]]

==Definition==
'''INT''' cd_getinfo ( <'''INT''' cdID> )

Fills the [[global]] [[structure]] [[cdinfo]] with information about the specified CD/DVD drive.

Returns <code>1</code> if there is a valid CD in the drive and <code>0</code> otherwise.

== Parameters ==
{|
| '''INT''' cdID || - The cdID of the CD/DVD drive of which the info is wanted.
|}

== Returns ==
'''INT'''
{|
| 0 || - Invalid CD/DVD or no CD/DVD in drive.
|-
| 1 || - Valid CD (structure [[cdinfo]] is filled successfully with information about the CD).
|}

{{Funcbox
| category = CD
}}

Cd name

2008-08-29T15:30:04Z

Summary: New page: [[Category:functions]] [[Category:CD]] ==Definition== '''INT''' cd_name ( <'''INT''' cdID> ) Returns the current name of the specified CD/DVD drive. == Parameters == {| | '''INT''' cdID...

[[Category:functions]]
[[Category:CD]]

==Definition==
'''INT''' cd_name ( <'''INT''' cdID> )

Returns the current name of the specified CD/DVD drive.

== Parameters ==
{|
| '''INT''' cdID || - The cdID of the CD/DVD drive of which the name is wanted.
|}

== Returns ==
'''INT''' : The current name of the specified CD/DVD drive.

{{Funcbox
| category = CD
}}

Cd status

2008-08-29T15:27:23Z

Summary: New page: [[Category:functions]] [[Category:CD]] ==Definition== '''INT''' cd_status ( <'''INT''' cdID> ) Returns the current status of the specified CD/DVD drive. See [[CD statuscodes]]. == Para...

[[Category:functions]]
[[Category:CD]]

==Definition==
'''INT''' cd_status ( <'''INT''' cdID> )

Returns the current status of the specified CD/DVD drive.

See [[CD statuscodes]].

== Parameters ==
{|
| '''INT''' cdID || - The cdID of the CD/DVD drive of which the status is wanted.
|}

== Returns ==
'''INT''' : The current status of the specified CD/DVD drive.

{{Funcbox
| category = CD
}}

Cd drives

2008-08-29T15:22:57Z

Summary: New page: [[Category:functions]] [[Category:CD]] ==Definition== '''INT''' cd_drives ( ) Returns the number of CD/DVD drives in the system. == Returns == '''INT''' : The number of CD/DVD drives in...

[[Category:functions]]
[[Category:CD]]

==Definition==
'''INT''' cd_drives ( )

Returns the number of CD/DVD drives in the system.

== Returns ==
'''INT''' : The number of CD/DVD drives in the system.

{{Funcbox
| category = CD
}}

Put screen

2008-08-25T01:05:52Z

Summary:

[[Category:functions]]
[[Category:screen]]

==Definition==
'''INT''' put_screen ( <'''INT''' fileID> , <'''INT''' graphID> )

Clears and draws ([[blit]]s) a [[graph]] onto the [[background]] in the center.

For more advanced blitting, see:
* [[put]]()
* [[xput]]()

== Parameters ==
{|
| '''INT''' fileID || - The [[file]] that holds the graph.
|-
| '''INT''' graphID || - The [[graph]] to draw with.
|}

== Returns ==
'''INT'''
{|
| 0 || - Invalid map.
|-
| 1 || - Success.
|}

== Notes ==
The center of the specified graph influences its placement.

The following codes are equivalent:
<pre>
put_screen(f,g);
</pre>
<pre>
clear_screen();
put(f,g,graphic_info(0,BACKGROUND,G_WIDTH)/2,graphic_info(0,BACKGROUND,G_HEIGHT)/2);
</pre>
See [[clear_screen]](), [[put]]() and [[graphic_info]]().

== Errors ==
{|
| Invalid map || - The specified map is invalid.
|-
| Unsupported color depth || - The origin graph's color depth is greater than the destination graph's.
|}

{{Funcbox
| category = Screen
}}

Import

2008-07-29T15:06:23Z

Summary: New Article: Import

[[Category:General]]
[[Category:Language]]

== Definition ==

'''Import''' "<file name>";

Imports a Fenix [[DLL]] with name <file name> into the program, which allows the usage of additional functions in a Fenix program. For more information, see the [[DLL | article on DLLs]].

== Example ==
<pre>
Import "my_dll.dll";

Process main()
Begin
Loop
Frame;
End
End
</pre>
Used in example: [[import]]

Ln

2008-07-29T14:28:14Z

Summary: /* Definition */

[[Category:functions]]
[[Category:logdll]]
[[Category:dll]]

[[Functioncategory:Logdll|'''Up to Log.dll functions''']]
----

==Definition==
'''FLOAT''' ln ( <'''FLOAT''' n> )

Returns the [http://en.wikipedia.org/wiki/Natural_logarithm natural logarithm] of number ''n'' ([http://en.wikipedia.org/wiki/Logarithm logarithm] with base ε (Euler)).

== Parameters ==
{|
| '''FLOAT''' n || - The number that will be used for the logarithm.
|}

== Returns ==
'''FLOAT''' : The natural logarithm of ''n''.

== Example ==
<pre>
Import "log.dll";

Global
float logarithm=0.0;
End

Process main()
Begin
write_float(0,160,100,4,&logarithm);

While(not(key(_ESC)))
If (key(_1)) logarithm=ln(13.37); End

Frame;
End
End
</pre>
Used in example: [[import]], [[write_float]](), [[key]](), [[ln]]()

{{Logfuncbox}}

Log2

2008-07-29T14:19:51Z

Summary:

[[Category:functions]]
[[Category:logdll]]
[[Category:dll]]

[[Functioncategory:Logdll|'''Up to Log.dll functions''']]
----

==Definition==
'''FLOAT''' log2 ( <'''FLOAT''' n> )

Returns a [http://en.wikipedia.org/wiki/Logarithm logarithm] of number ''n'' with base 2.

== Parameters ==
{|
| '''FLOAT''' n || - The number that will be used for the logarithm.
|}

== Returns ==
'''FLOAT''' : The logarithm of ''n'' with base 2.

== Example ==
<pre>
Import "log.dll";

Global
float logarithm=0.0;
End

Process main()
Begin
write_float(0,160,100,4,&logarithm);

While(not(key(_esc)))
If (key(_1)) logarithm=log2(1024); End

Frame;
End
End
</pre>
Used in example: [[import]], [[write_float]](), [[key]](), [[log2]]()

{{Logfuncbox}}

Log

2008-07-29T14:14:41Z

Summary: combined definition to one, like seen on [[CD]] page

[[Category:functions]]
[[Category:logdll]]
[[Category:dll]]

[[Functioncategory:Logdll|'''Up to Log.dll functions''']]
----

==Definition==
'''FLOAT''' log ( <'''FLOAT''' n> , [<'''FLOAT''' b>] )

Returns a [http://en.wikipedia.org/wiki/Logarithm logarithm] of number ''n'' with base ''b''. If ''b'' is not specified, the number 10 will be used as base.

== Parameters ==
{|
| '''FLOAT''' n || - The number that will be used for the logarithm.
|-
| '''FLOAT''' base || - The base that will be used for the logarithm.
|}

== Returns ==
'''FLOAT''' : The logarithm of ''n''.

== Example ==
<pre>
Import "log.dll";

Global
float logarithm=0.0;
End

Process main()
Begin
write_float(0,160,100,4,&logarithm);

While(not(key(_esc)))
If (key(_1)) logarithm=log(1000,9); End
If (key(_2)) logarithm=log(1000); End

Frame;
End
End
</pre>
Used in example: [[import]], [[write_float]](), [[key]](), [[log]]()

{{Logfuncbox}}

Scroll window

2008-07-28T00:29:38Z

Summary: done; now ctype should be done

[[category:general]]
[[category:scroll]]

== Definition ==
A [[scroll window]] is a [[region]] in which a scroll has been started by [[start_scroll]]() and setup with the [[global variable]] [[scroll]. This scroll window provides a view window into the scroll that has been setup there, with certain background and foreground [[graphics]]. The view window can be 'scrolled' over the scroll (and the graphics).

[[Process]]es can also be added to a scroll (see the [[global variable]] [[ctype]]), in which case a lot of things related to that process change.
* The [[graphic]] of the process is not drawn to the screen, but to the scroll window, using the [[region]] of the scroll.
* The [[z]] of an added process only has a meaning to the scroll window and compared to other processes added to the same scroll, meaning from a user perspective, the process is drawn at the z value of the scroll. If two processes are added to the same scroll, the one with the lower z value will be drawn over the other one.
* The [[x]]- and [[y]]-coordinates are not relative to the upper left corner of the ''screen'', but relative to the upper left corner of the ''scroll''.

You can control scrolls in multiple ways.
* Change the scroll coordinates directly using <code>x0</code>, <code>y0</code>, <code>x1</code>, <code>y1</code> in the [[global variable]] [[scroll]]. Be sure to alter the correct scroll.
* Tell the scroll to 'follow' another scroll, by using <code>[[scroll]].follow</code>.
* Use a 'camera' process, which the scroll try to follow, by using <code>[[scroll]].camera</code>.

More about scrolls:
* A scroll with a lower z value will be drawn over a scroll with a lower z value.
* The foreground is the plane to be controlled and the background moves relative to the foreground.

== Example ==
<pre>
Const
SCREEN_WIDTH = 320;
SCREEN_HEIGHT = 200;
SCREEN_DEPTH = 8;
MAP_WIDTH = 500;
MAP_HEIGHT = 400;
SHIP_WIDTH = 30;
SHIP_HEIGHT = 30;
SHIP_SPEED = 6;
End

Declare Process playership(int x, int y)
End
Declare Function int makeMap(int width, int height, int depth)
End
Declare Function int makeShipGfx(int width, int height, int depth)
End

Process Main()
Private
int map;
Begin
// Setup the screen
set_mode(SCREEN_WIDTH,SCREEN_HEIGHT,SCREEN_DEPTH);

// Create the background graphic
map = makeMap(MAP_WIDTH,MAP_HEIGHT,SCREEN_DEPTH);

// Start a new scroll
// scrollNumber = 0
// fileID = 0
// foregroundGraphID = map
// backgroundGraphID = 0: no background
// region = 0: use entire screen
// lockindicator = 0: don't repeat graphics
start_scroll(0,0,map,0,0,0);

// Start a controllable object on the scroll
playership(320,200);

// Wait till the key ESC is pressed
Repeat
frame;
Until(key(_esc))

OnExit
// Kill all other processes
let_me_alone();

// Clean up memory used for map
unload_map(0,map);
End

Process playership(int x, int y)
Private
int sp = SHIP_SPEED;
int halfWidth;
int halfHeight;
Begin

// This process should be displayed on a scroll only
ctype = c_scroll;

// This process should be tracked by the scroll
Scroll.camera = id;

// Create a graph for this process
graph = makeShipGfx(SHIP_WIDTH,SHIP_HEIGHT,SCREEN_DEPTH);

// Obtain the value of half the width of the graphic
halfWidth = graphic_info(0,graph,G_WIDTH )/2;
halfHeight = graphic_info(0,graph,G_HEIGHT)/2;

// React on keys LEFT and RIGHT
Loop

// Adjust x,y on input
x+=(key(_right)-key(_left))*sp;
y+=(key(_down)-key(_up))*sp;

// Make sure the ship stays on the scroll
if(x > MAP_WIDTH-halfWidth)
x = MAP_WIDTH-halfWidth;
elseif(x < halfWidth)
x = halfWidth;
end
if(y > MAP_HEIGHT-halfHeight)
y = MAP_HEIGHT-halfHeight;
elseif(y < halfHeight)
y = halfHeight;
end

frame;

End

OnExit
// Clean up used memory for graph
unload_map(0,graph);
End

Function int makeMap(int width, int height, int depth)
Private
int n;
int x1,y1;
int m;
Begin

// New map
m = new_map(width,height,depth);

// Put on some pretty stars
rand_seed(100);
for(n=0;n<1000;n++)
map_put_pixel(0,m,rand(0,width),rand(0,height),rgb(150,170,200));
end

// Return it
return m;

End

Function int makeShipGfx(int width, int height, int depth)
Private
int g;
Begin

// Return a map of one color (RGB(150,200,170))
g=new_map(width,height,depth);
map_clear(0,g,rgb(200,100,170));
return g;

End
</pre>
Used in example: [[set_mode]](), [[start_scroll]](), [[key]](), [[let_me_alone]](), [[unload_map]](), [[graphic_info]](), [[new_map]](), [[rand_seed]](), [[rand]](), [[rgb]](), [[map_put_pixel]](), [[map_clear]](), [[ctype]], [[scroll]]

Blur

2008-07-24T09:30:26Z

Summary: /* Returns */

[[Category:functions]]
[[Category:graphical effects]]

==Definition==
'''INT''' blur ( <'''INT''' fileID> , <'''INT''' graphID> , <'''BYTE''' mode> )

This will make the specified [[graphic]] blurry by using a specified mode. It manipulates the graphic directly.

Only 16bit graphics are supported.

== Parameters ==
{|
| '''INT''' fileID || - The [[fileID]] of the [[file]] that holds the graphics.
|-
| '''INT''' graphID || - The [[graphID]] of the [[graphic]] to convert.
|-
| '''BYTE''' mode || - The blur mode that is applied to the [[graphic]] (see [[#Blur Modes|below]]).
|}

== Returns ==
'''INT'''
{|
| 0 || - Invalid graphic or non 16bit graphic used.
|-
| 1 || - Success.
|}

== Errors ==
{|
| Unsupported color depth || - The graphic's color depth is not 16bit.
|}

== Blur Modes ==
{|
| ''Constant'' || - ''Value'' || - ''Description''
|-
| ??? || - 0 || - single pixel: considers pixels located to the left and above of each pixel.
|-
| ??? || - 1 || - 3x3: considers all 8 adjacent pixels.
|-
| ??? || - 2 || - 5x5: considers the 24 pixels that surrounds each pixel.
|-
| ??? || - 3 || - 5x5 with additional map: Just as the previous one but using a temporary map.
|}

{{Funcbox
| category=Graphical effects
}}

Y

2008-06-19T12:20:31Z

Summary:

[[category:variables]]
[[category:predefined]]
[[category:local variables]]

[[Local variables|'''Up to Local Variables''']]

----

== Definition ==
'''INT''' y

'''y''' is a predefined [[local variable]]. It defines y-coordinate of the center of the [[process]] and the process' [[graphic]] will be drawn at this center. The local variable [[resolution]] specifies how accurate the [[y]] is.

== See also ==
* [[x]]
* [[z]]
* [[resolution]]

{{Locals}}

X

2008-06-19T12:19:57Z

Summary:

[[category:variables]]
[[category:predefined]]
[[category:local variables]]

[[Local variables|'''Up to Local Variables''']]

----

== Definition ==
'''INT''' x

'''x''' is a predefined [[local variable]]. It defines x-coordinate of the center of the [[process]] and the process' [[graphic]] will be drawn at this center. The local variable [[resolution]] specifies how accurate the [[x]] is.

== See also ==
* [[y]]
* [[z]]
* [[resolution]]

{{Locals}}

Save

2008-05-23T10:27:24Z

Summary:

[[Category:functions]]
[[Category:files]]

==Definition==
'''INT''' save ( <'''STRING''' filename> , <'''VARSPACE''' data> )

Saves the data from the specified variable to the specified file.

== Parameters ==
{|
| '''STRING''' filename || - The name of the file that will be saved.
|-
| '''VARSPACE''' data || - The variable (of any [[datatype]]) that will be saved in a file.
|}

== Returns ==
'''INT''' : The number of bytes written to the file.

== Notes ==
Attempting to use "?","*","<",">" or "|" in a filename will result in no file at all on Windows, while using ":" in a filename results in everything from the ":" and beyond being cut off from the file name and the resulting file will be of size 0.

Using the characters "/" or "\" in the filename (without directories that can be accessed that way) results in everything from this character and before being cut off from the filename. The file will be saved successfully nonetheless.

== Example ==
<pre>
Program test;
Global
struct My_struct
Level_number="99";
string Map_name="Amazing map";
End
Begin
Save("myfile.sav",My_struct); // The content of My_struct is saved in myfile.sav
Write(0,10,10,0,"Data saved!");

While (!key(_ESC))
Frame;
End
End
</pre>
Used in example: [[save]](), [[write]](), [[key]]()

{{Funcbox
| category = Files
}}

Load

2008-05-23T09:38:06Z

Summary:

[[Category:functions]]
[[Category:files]]

==Definition==
'''INT''' load ( <'''STRING''' filename> , <'''VARSPACE''' data> )

Loads the data read from the specified file into the specified variable.

== Parameters ==
{|
| '''STRING''' filename || - The name of the file to be loaded.
|-
| '''VARSPACE''' data || - The variable (of any [[datatype]]) in which the data read from the file will be loaded.
|}

== Returns ==
'''INT''' : The number of bytes read from the file.

== Notes ==
To check whether a file exists before it is loaded, [[file_exists]]() can be used.

== Example ==
<pre>
Program test;
Global
struct My_struct
Level_number;
string Map_name;
End
Begin
If (file_exists("myfile.sav"))
Load("myfile.sav",My_struct); // Content from myfile.sav is loaded into My_struct
Write(0,10,10,0,My_struct.level_number); // A variable from the loaded struct is shown on screen
Write(0,10,20,0,My_struct.map_name); // Another variable loaded is shown on screen
Else
Write(0,10,10,0,"File couldn't be loaded, it doesn't exist.");
End

While (!key(_esc))
Frame;
End
End
</pre>
Used in example: [[file_exists]](), [[load]](), [[write]](), [[key]]()

{{Funcbox
| category = Files
}}

Debug

2008-04-24T11:03:29Z

Summary: New page: [[Category:reserved]] [[Category:language]] [[Category:Basic statement]] == Definition == '''Debug'''; Debug is a reserved word used to invoke the [[Fenix console]]. When this statement ...

[[Category:reserved]]
[[Category:language]]
[[Category:Basic statement]]

== Definition ==
'''Debug''';

Debug is a reserved word used to invoke the [[Fenix console]]. When this statement is reached, the console is immediately invoked and one can begin tracing from the debug statement.

[[Debugging|Here]]'s a handy page about debugging a [[Fenix]] program.

== Example ==
<pre>
Function int debug_warning(string warning)
Begin
say("Warning: " + warning);
debug;
return 0;
End
</pre>
Used in example: [[say]](), [[debug]]

Return

2008-04-24T10:56:55Z

Summary:

[[Category:reserved]]
[[Category:language]]
[[Category:Basic statement]]

== Definition ==
'''Return''' [<value>];

Return is a reserved word used to return a value in a function. The returned value must be of the datatype specified as the returndatatype (see [[Function]]). By default, the returntype of a process or function is an [[int]]. When this statement is reached, the function in which it resides will stop execution and return the specified value. If a value was not specified, the [[ProcessID]] will be returned.

== Example ==
<pre>
Function string example_function()
Private
string s;
Begin
s = "Some string;
return s;
End
</pre>
Used in example: [[Function]], [[Private]], [[Begin]], [[End]], [[Return]], [[String]]

Grayscale

2008-04-14T19:10:35Z

Summary:

[[Category:functions]]
[[Category:graphical effects]]

==Definition==
'''INT''' grayscale ( <'''INT''' fileID> , <'''INT''' graphID> , <'''BYTE''' method> )

This will convert the specified [[graphic]] by using the specified method; see [[#Notes|notes]] for the details.

== Parameters ==
{|
| '''INT''' fileID || - The [[fileID]] of the [[file]] that holds the graphics.
|-
| '''INT''' graphID || - The [[graphID]] of the [[graphic]] to convert.
|-
| '''BYTE''' method || - The method used (see [[#Notes|notes]]).
|}

== Returns ==
'''INT'''
{|
| -1 || - Invalid graphic.
|-
| 1 || - Success.
|}

== Errors ==
{|
| Unsupported color depth || - The graphic's color depth is not 16bit.
|}

== Notes ==
The exact formula is:
<pre>
c = 0.3 * oldpixel_r + 0.59 * oldpixel_g + 0.11 * oldpixel_b
</pre>

Method <code>0</code>:
<pre>
for every pixel:
newpixel_rgb = (c,c,c)
</pre>

Method <code>1</code>:
<pre>
for every pixel:
newpixel_rgb = (c,0,0)
</pre>

Method <code>2</code>:
<pre>
for every pixel:
newpixel_rgb = (0,c,0)
</pre>

Method <code>3</code>:
<pre>
for every pixel:
newpixel_rgb = (0,0,c)
</pre>

Method <code>4</code>:
<pre>
for every pixel:
newpixel_rgb = (c,c,0)
</pre>

Method <code>5</code>:
<pre>
for every pixel:
newpixel_rgb = (c,0,c)
</pre>

Method <code>6</code>:
<pre>
for every pixel:
newpixel_rgb = (0,c,c)
</pre>

Other methodnumbers:
<pre>
for every pixel:
newpixel_rgb = oldpixel_rgb
</pre>

Note that <code>[[rgbscale]](0,map,1,1,1) = [[grayscale]](0,map,0)</code> for a valid graphic (0,map).

{{Funcbox
| category=Graphical effects
}}

Rgbscale

2008-04-13T22:04:49Z

Summary: /* Notes */

[[Category:functions]]
[[Category:graphical effects]]

==Definition==
'''INT''' rgbscale ( <'''INT''' fileID> , <'''INT''' fraphID> , <'''FLOAT''' r> , <'''FLOAT''' g> , <'''FLOAT''' b> )

This will convert the specified [[graphic]] by using the specified color as a reference. The converted graphic will have only the specified color and lighter/darker colors; see [[#Notes|notes]] for the details.

== Parameters ==
{|
| '''INT''' fileID || - The [[fileID]] of the [[file]] that holds the graphics.
|-
| '''INT''' graphID || - The [[graphID]] of the [[graphic]] to convert.
|-
| '''FLOAT''' r || - The red component of the color to be used for reference.
|-
| '''FLOAT''' g || - The green component of the color to be used for reference.
|-
| '''FLOAT''' b || - The blue component of the color to be used for reference.
|}

== Returns ==
'''INT'''
{|
| -1 || - Invalid graphic.
|-
| 1 || - Success.
|}

== Errors ==
{|
| Unsupported color depth || - The graphic's color depth is not 16bit.
|}

== Notes ==
The exact formula is:
<pre>
for every pixel:
c = 0.3 * oldpixel_r + 0.59 * oldpixel_g + 0.11 * oldpixel_b
newpixel_r = r * c;
newpixel_g = g * c;
newpixel_b = b * c;
</pre>
where r,g,b are the specified r,g,b.

Note that <code>[[rgbscale]](0,map,1,1,1) = [[grayscale]](0,map,0)</code>, for a valid graphic (0,map).

{{Funcbox
| category=Graphical effects
}}

Fenix profiler

2008-04-05T20:04:46Z

Summary:

[[Category:general]]
[[Category:debugging]]

The Fenix profiler is a handy debugging tool. It shows how much power is needed for certain systems of Fenix, most particularly the drawing and the interpreting.

To use the profiler, run in debug mode by compiling your program in FXC.exe with the argument "-g", and then show it in-program with ALT+P.

Shortcuts:
{|
| ALT-P || - Show/hide the Fenix profiler
|-
| ALT-R || - Resets the profile history of the Fenix Profiler.
|-
| ALT-S || - Activate/Deactivate the Fenix Profiler.
|}

== Example ==
<pre>
Process Main()
Begin

// To make sure the profiler is updated every frame
restore_type = COMPLETE_RESTORE;

A();

Loop
frame;
End

End

Process A()
Begin
Loop
frame;
End
End
</pre>
Used in example: [[restore_type]], [[process]], [[frame]]

{{Image
| image = Profiler.png
| caption = A typical profiler window of a program doing nothing
}}

{{Debugging}}

Size

2008-04-03T18:35:44Z

Summary: /* Example */

[[category:variables]]
[[category:predefined]]
[[category:local variables]]

[[Local variables|'''Up to Local Variables''']]

----

== Definition ==
'''INT''' size = 100

Size is a predefined [[local variable]] that can be used to stretch or compress a graphic, equally along the horizontal axis and vertical axis. It is defined as a percentage of the original graphic size. The graphics's center will remain at the drawing coordinates when the graphic is drawn.

This variable only has effect for the appearance of a [[process]]' [[graphic]] when its local variables [[size_x]] and [[size_y]] are both <code>100</code>. When either is not equal to <code>100</code>, [[size]] doesn't affect the appearance of the graphic.

== Example ==

To make the [[graphic]] of a [[process]] continually stretch:
<pre>
Process Main()
Begin
graph = new_map(50,50,8); // Create a new graphic
x = 100; // Position the graphic 100 pixels
y = 100; // from the top and left of the screen
Loop
size += 1; // Increase the height and width of the graphic by 1 percent each frame.
frame;
End
OnExit
unload_map(0,graph);
End
</pre>
Used in example: [[new_map]](), [[x]], [[y]], [[size]], [[unload_map]]()

== See also ==
* [[size_x]]
* [[size_y]]

{{Locals}}

Bennu WIP2

2008-03-28T20:07:27Z

Summary:

[[Bennu]] Work in Progress 2.

== Download ==
* [[Media:BennuGD-core-wip2.zip|Bennu WIP2 Core Files]]
* [[Media:BennuGD-externals-libs.zip|Bennu WIP2 External Libraries]]
* [[Media:BennuGD-modules-wip2.zip|Bennu WIP2 Modules]]

== Bugs ==

== Changelog ==

Include

2008-03-19T14:48:27Z

Summary: /* Example */

[[Category:General]]
[[Category:Language]]

== Definition ==

'''Include''' "<filename>";

When the compiler reaches an [[Include]] statement, it continues compilation at the included file (usually *.[[FH]] or *.[[INC]]) and when it's done resumes compiling from the [[Include]] statement. In other words, these files contain code that gets inserted at the place of inclusion.

This is very handy for breaking up your code into pieces. The handling of video in one include file, audio in another, game logic in another, etc. This makes code more maintainable and understandable; moreover it makes code reusable. The video handling include file you made for one game can be used for another game (if it was coded in a generic fashion) without spitting through the whole sourcecode of the first game.

Also headers can be used to import [[DLL]]s and possibly give a little more functionality to that DLL. For example [[Network.DLL]] uses a .[[FH]] header file to assure the DLL is only imported once during compilation and provides a little more functionality.

== Example ==
'''main.prg'''
<pre>
// The code in "bar.inc" will be processed first:
include "bar.inc";

Process Main()
Private
int barcode;
Begin
write_int(0,100,100,0,&barcode);
barcode = bar();
repeat
frame;
until(key(_ESC))
End
</pre>

'''bar.inc'''
<pre>
Function int bar()
Begin
return 5;
End
</pre>
Used in example: [[Include]], [[write_int]](), [[key]]()

Value

2008-03-01T11:15:32Z

Summary: New page: A value can be in a container, like a [[variable]] or [[constant]]. It can also be returned by a [[process]] or [[function]]. == See Also == * [[Constant]] * [[Variable]]

A value can be in a container, like a [[variable]] or [[constant]]. It can also be returned by a [[process]] or [[function]].

== See Also ==
* [[Constant]]
* [[Variable]]

Argument

2008-03-01T10:49:26Z

Summary:

== Definition ==

An argument is the [[value]] passed on when calling a [[function]] or [[process]]. The [[variable]] and its value inside the definition of a [[function]] or [[process]] is called a [[parameter]].

== Example ==
<pre>
Function int my_proc( int parameter )
Begin
//statements
return 0;
End

Process Main()
Private
int argument = 3;
Begin
my_proc( argument );
my_proc( 4);
End
</pre>
Used in example: [[Function]], [[Process]]

[[Category:General]]

Load ttfaa

2008-02-29T12:57:05Z

Summary:

[[Category:functions]]
[[Category:ttfdll]]
[[Category:dll]]

[[Functioncategory:Ttfdll|'''Up to TTF.DLL Functions''']]
----

==Definition==
'''INT''' load_ttfaa ( <'''STRING''' filename> , <'''INT''' height> , <'''INT''' colordepth> , <'''INT''' backgroundcolor> , <'''INT''' textcolor> )

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

Also called '''TTF_LoadAA'''() (if TTF.fh is included).

== Parameters ==
{|
| '''STRING''' filename || - The filename of the [[TTF]] file that you wish to load (including extension and possible path).
|-
| '''INT''' height || - The height in pixels of the to be created font, a size indication.
|-
| '''INT''' colordepth || - The [[colordepth]] of the to be created font (1,8 or 16).
|-
| '''INT''' backgroundcolor || - The background color of the to be created font.
|-
| '''INT''' textcolor || - The text color of the to be created font.
|}

== 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 || - Invalid filename.
|-
| >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 the specified colours.

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.

The parameters ''backgroundcolor'' and ''textcolor'' only matter for 8 and 16 bit colordepths. If you specify a colordepth of 1, then the returned font will be black (background) and white (textcolour). The advantage of this, is that you can use change the colour any time, even after loading, with [[set_text_color]]().

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

Process Main()
Private
int fontID;
Begin

fontID = load_ttfaa("myttf.ttf",20,1,0,0); // 1bit colordepth
set_text_color(rgb(255,0,255)); // set_text_color() after load_ttfaa()
write(fontID,160,100,4,"Look at my TTF font!");

Repeat
frame;
Until(key(_ESC))

unload_fnt(fontID);

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

{{Ttffuncbox}}

Load ttf

2008-02-29T12:29:11Z

Summary:

[[Category:functions]]
[[Category:ttfdll]]
[[Category:dll]]

[[Functioncategory:Ttfdll|'''Up to TTF.DLL Functions''']]
----

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

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

Also called '''TTF_Load'''() (if TTF.fh is included).

== Parameters ==
{|
| '''STRING''' filename || - The filename of the [[TTF]] file that you wish to load (including extension and possible path).
|-
| '''INT''' height || - The height in pixels of the to be created font, 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 || - Invalid filename.
|-
| >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

set_text_color(rgb(255,0,255));
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: [[set_text_color]](), [[rgb]](), [[load_ttf]](), [[write]](), [[key]](), [[unload_fnt]]()

{{Ttffuncbox}}

TTF Changelog

2008-02-28T12:10:12Z

Summary: New page: [[Category:changelog]] [[Category:ttfdll]] [[Category:dll]] [[TTF.DLL|'''Up to TTF.DLL''']] ---- Changelog of [[TTF.DLL]]. {{Ttfdocbox}}

[[Category:changelog]]
[[Category:ttfdll]]
[[Category:dll]]

[[TTF.DLL|'''Up to TTF.DLL''']]
----

Changelog of [[TTF.DLL]].

{{Ttfdocbox}}

Clear screen

2008-02-25T16:48:02Z

Summary: /* Notes */

[[Category:functions]]
[[Category:screen]]

==Definition==
'''INT''' clear_screen ( )

Clears the [[background]] of the screen.

== Returns ==
'''INT''' : [[true]]

== Notes ==
This is the same as <code>'''[[map_clear]]'''(0,[[BACKGROUND]])</code>. When the background is cleared in either way, Fenix knows the background is empty and will take advantage of this knowledge.

== Errors ==
{|
| Unsupported color depth || - The specified graph has a not supported color depth.
|}

{{Funcbox
| category = Screen
}}

Map block copy

2008-02-17T19:53:49Z

Summary:

[[Category:functions]]
[[Category:maps]]

==Definition==
'''INT''' map_block_copy ( <'''INT''' fileID> , <'''INT''' destinationGraphID> , <'''INT''' destinationX> , <'''INT''' destinationY> , <'''INT''' originGraphID> , <'''INT''' x> , <'''INT''' y> , <'''INT''' width> , <'''INT''' height>, <'''INT''' blitflags> )

Draws ([[blit]]s) a rectangular block from one [[graphic]] onto another graphic.

If the entire graphic is to be blitted, [[map_put]]() or [[map_xput]]() can be used.

== Parameters ==
{|
| '''INT''' fileID || - The [[fileID]] of the [[file]] that holds the destination and origin graphics.
|-
| '''INT''' destinationGraphID || - The [[graphID]] of the [[graphic]] to draw on.
|-
| '''INT''' destinationX || - Where on the destination graph's x-axis to put the block.
|-
| '''INT''' destinationY || - Where on the destination graph's y-axis to put the block.
|-
| '''INT''' originGraphID || - The [[graphID]] of the [[graphic]] to draw with.
|-
| '''INT''' x || - The x-coordinate of the upperleft corner of the origin block.
|-
| '''INT''' y || - The y-coordinate of the upperleft corner of the origin block.
|-
| '''INT''' width || - The width of the block in pixels.
|-
| '''INT''' height|| - The height of the block in pixels.
|-
| '''INT''' blitflags || - What [[blit flags]] to draw the graphic with.
|}

== Returns ==
'''INT''' : [[true]]

== Notes ==
[[Blit flags]] can be used to give the drawing (blitting) a special effect.

== Errors ==
{|
| Invalid origin graph || - The origin graph is invalid.
|-
| Invalid destination graph || - The destination graph is invalid.
|-
| Unsupported color depth || - The origin graphic's color depth is greater than the destination graph's.
|}

{{Funcbox
| category = Maps
}}

Allpages

2008-02-07T20:56:18Z

Summary:

From namespaces other than the general one, including redirects:
<dpl>
notnamespace=
titlematch=%
redirects = include
format = ,,,
resultsheader = %PAGES%\n
</dpl>
From the general namespace, without redirects:
<dpl>
namespace=
titlematch=%
format = ,,,
resultsheader = %PAGES%\n
</dpl>
From the general namespace, the redirects:
<dpl>
namespace=
titlematch=%
redirects = only
format = ,,,
resultsheader = %PAGES%\n
</dpl>
==========
<dpl>
notnamespace=
titlematch=%
redirects = include
format = ,,\n\n[[%PAGE%]],
</dpl>
<dpl>
namespace=
titlematch=%
format = ,,\n\n[[%PAGE%]],
</dpl>
<dpl>
namespace=
titlematch=%
redirects = only
format = ,,\n\n[[%PAGE%]],
</dpl>

LCD ReadButton

2008-01-27T01:41:29Z

Summary: New page: [[Category:functions]] [[Category:lcddll]] [[Category:dll]] [[Functioncategory:Lcddll|'''Up to LCD.DLL Functions''']] ---- ==Definition== '''INT''' LCD_ReadButton ( <'''INT''' device> ,...

[[Category:functions]]
[[Category:lcddll]]
[[Category:dll]]

[[Functioncategory:Lcddll|'''Up to LCD.DLL Functions''']]
----

==Definition==
'''INT''' LCD_ReadButton ( <'''INT''' device> , <'''INT''' button> )

Returns whether a button is being pressed on a device.

This also updates the button integer specified at [[LCD_Open]]().

== Parameters ==
{|
| '''INT''' device || - Number of the device.
|-
| '''INT''' button || - Number of the button.
|}

== Returns ==
'''INT''' : [[LCD_ERRORCODES|LCD.DLL Errorcodes]]
{|
| [[TRUE]] || - 1 || - The button is being pressed.
|-
| [[FALSE]] || - 0 || - The button is not being pressed.
|-
| LCD_ERROR_SERVICEINACTIVE || - -14 || - The service is inactive.
|-
| LCD_ERROR_INVALIDPARAMETER || - -22 || - Invalid parameter.
|}

{{Lcdfuncbox}}

LCD Devices

2008-01-27T01:28:35Z

[[Category:functions]]
[[Category:lcddll]]
[[Category:dll]]

[[Functioncategory:Lcddll|'''Up to LCD.DLL Functions''']]
----

==Definition==
'''INT''' LCD_Devices ( )

Returns the number of devices available.

== Returns ==
'''INT''' : The number of LCD devices available.
{|
| 0 || - No devices or error.
|-
| !0 || - The number of LCD devices available.
|}

{{Lcdfuncbox}}

Delete draw

2008-01-22T20:52:55Z

Summary: Moved here from delete_drawing which does not exist

[[Category:functions]]
[[Category:drawing]]

==Definition==
'''INT''' delete_draw ( <'''INT''' DrawID> )

Deletes a certain [[drawing]] from the screen.

== Parameters ==
{|
| '''INT''' DrawID || - [[DrawID]] of the [[drawing]] to be deleted.
|}

== Returns ==
'''INT''' : [[true]]

== Notes ==
[[Delete_draw]](0) deletes all drawings from the screen.

{{Funcbox
| category=Drawing
}}

Reserved

2008-01-20T23:45:15Z

Summary:

[[category:variables]]
[[category:predefined]]
[[category:local variables]]

[[Local variables|'''Up to Local Variables''']]

----

== Definition ==
'''Struct''' Reserved

Reserved is a [[local|local variable]] [[struct]], containing information that is reserved for [[Fenix]]' internals. However, sometimes you may wish to use certain members of it. Using in the sense of reading only, '''do not under any circumstances alter their values'''.

If it's not documented what these members do, their use is reasonably limited. If you want to know what these members do, your programming goals are of a level, where you can also look in the [[Latest_Fenix_version|sourcecode]]. This is because most of these members would require a lengthy explanation about what they do and why.

== Members ==
{|
| ''Member name'' || - ''Description''
|-
| '''INT''' ID_scan || - Internal use only (formerly [[get_id|got]] [[processID]] from within the [[process]]).
|-
| '''INT''' process_type || - The [[ProcessTypeID]] of the process.
|-
| '''INT''' type_scan || - Internal use only (formerly [[get_id|got]] [[processTypeID]] from within the process).
|-
| '''INT''' status || - The status of the process, containing a [[Process_statuscodes|status code]].
|-
| '''INT''' changed || - Internal use only.
|-
| '''INT''' xgraph_flags || - Internal use only ([[blit flags]] for [[xgraph]]).
|-
| '''INT''' saved_status || - Internal use only (for [[signals]]).
|-
| '''INT''' prev_z || - Previous [[z]] value.
|-
| '''INT''' distance1 || - Not used.
|-
| '''INT''' distance2 || - Not used.
|-
| '''INT''' frame_percent || - Internal use only.
|-
| '''INT''' box_x0 || - The x-coordinate of the topleft corner of the process' [[graphic]] (process.x-graphic.width/2).
|-
| '''INT''' box_y0 || - The y-coordinate of the topleft corner of the process' graphic (process.y-graphic.height/2).
|-
| '''INT''' box_x1 || - The x-coordinate of the bottomright corner of the process' graphic (process.x+graphic.width/2).
|-
| '''INT''' box_y1 || - The y-coordinate of the bottomright corner of the process' graphic (process.y+graphic.height/2).
|}

{{Globals}}

Blend operation

2008-01-17T23:03:53Z

Summary:

[[Category:blendops]]

== Definition ==
A blend operation is the act of executing the blend using a [[blend table]].

This is done when [[blendop_apply]]() is used or each [[frame]] for a certain [[graphic]] when a blend table is [[blendop_assign|assigned]] to that graphic.

Blend table

2008-01-17T22:55:23Z

Summary: /* Example */

[[Category:blendops]]

== Definition ==
A blend table contains the blend data needed to perform the blend between the object (source) and where the object is drawn (destination). The table contains those two sections: source and destination; these section are added together when blending, which cannot be altered, but the sections themselves can be influenced by the [[Functioncategory:Blendops|blend operations]] available.

One can even make homemade blending operations, if one has enough knowledge of the subject, as [[blendop_new]]() returns a pointer to the created blend table. This table is constructed like this:
{|
| ''bytes-start'' || - ''bytes-end'' || - ''total'' || - ''purpose''
|-
| 0 || - 65535 || - 65536 || - Source section
|-
| 65536 || - 131071 || - 65536 || - Destination section
|}
Each pixel of a section represents a colour. When a blend table is initialized, it's done like this:
<pre>
for (i = 0 ; i < 65536 ; i++) source[i] = i ;
for (i = 0 ; i < 65536 ; i++) destination[i] = 0 ;
</pre>
So:
* For the source section the following applies: The ''n''th index has value ''n''.
* For the destination section the following applies: The ''n''th index has value 0.

== Example ==
<pre>
Global
int bo_tintred;
int bo_tintredAndTranslucent;
int bo_intense;
int bo_destintense;
int bo_grayscale;
int bo_destgrayscale;
int map;
End

Process Main()
Begin

// Set mode to 320x200x16
set_mode(320,200,16);

// Init tables
bo_tintred = blendop_new();
bo_tintredAndTranslucent = blendop_new();
bo_intense = blendop_new();
bo_grayscale = blendop_new();
bo_destintense = blendop_new();
bo_destgrayscale = blendop_new();

// Red tint
blendop_tint(bo_tintred,0.5,100,0,0);

// Red tint with translucency
blendop_tint(bo_tintredAndTranslucent,0.5,250,0,0);
blendop_translucency(bo_tintredAndTranslucent,0.5);

// Intense
blendop_intensity(bo_intense,1.5);

// Display the destination intense
blendop_intensity(bo_destintense,1.5);
blendop_swap(bo_destintense);

// Grayscale
blendop_grayscale(bo_grayscale,1);

// Display the destination in grayscale
blendop_grayscale(bo_destgrayscale,3);
blendop_swap(bo_destgrayscale);

// Make a new map
map = some_map(80,80,16);

// Make the background rgb(50,150,150)
map_clear(0,background,rgb(50,150,150));

// Show the four different blend operations
a( 50, 50,map,0,"original");
a(150, 50,map,bo_tintred,"red");
a(250, 50,map,bo_tintredAndTranslucent,"red+transparent");
a( 50,150,map,bo_intense,"intense");
a(150,150,map,bo_destintense,"dest instense");
a(250,150,map,bo_grayscale,"grayscale");

// Give this process one too
blendop_assign(0,map,bo_destgrayscale);
graph = map;

Repeat
x = mouse.x;
y = mouse.y;
if(mouse.left)
z = -1;
else
z = 1;
end
frame;
Until(key(_ESC))

OnExit
let_me_alone();
End

/**
* Description
* Create a new process at the given coordinates.
* Its graph will be cloned from the specified one and the
* specified blendtable will be assigned.
* The specified text will be put on the background below the graph.
*
* Parameters
* int x,y - Coordinates the process will be at.
* int graph - The graph to be cloned (file=0).
* int blendtable - The blendtable to assign to the graph.
* int string text - The text to put on the map.
*
* Returns
* ProcessID
*/
Process a(int x,int y,int graph, int blendtable, string text)
Begin

// Clone the map
graph = map_clone(0,graph);

// Assign the blend table
blendop_assign(0,graph,blendtable);

// Set z=0
z = 0;

// Create text and put it on the background
set_text_color(rgb(100,200,250));
height=write_in_map(0,text,1);
put(0,height,x,y+1+graphic_info(0,graph,G_HEIGHT)/2);
unload_map(0,height);

// Loop
Loop frame; End

End

/**
* Description
* Creates a map with the four corners coloured differently.
*
* Parameters
* int x,y,z - The width, height and depth of the map to be created.
*
* Returns
* The graphID of the created map
*/
Function int some_map(int x, int y, int z)
Begin
height = new_map(x,y,z);
map_clear(0,height,rgb(50,100,150));
drawing_map(0,height);
drawing_color(rgb(200,50,100));
draw_box(0,0,x/2,y/2);
drawing_color(rgb(0,250,100));
draw_box(x/2,0,x,y/2);
drawing_color(rgb(150,50,250));
draw_box(x/2,y/2,x,y);
return height;
End
</pre>
Used in example: [[set_mode]](), [[blendop_new]](), [[blendop_tint]](), [[blendop_translucency]](), [[blendop_intensity]](), [[blendop_swap]](), [[blendop_grayscale]](), [[map_clear]](), [[blendop_assign]](), [[key]](), [[let_me_alone]](), [[map_clone]](), [[set_text_color]](), [[write_in_map]](), [[put]](), [[unload_map]](), [[new_map]](), [[drawing_map]](), [[drawing_color]](), [[draw_box]](), [[mouse]]

This will result in something like:

[[Image:Blendops.PNG]]

Blendop swap

2008-01-17T12:30:09Z

Summary:

[[Category:functions]]
[[Category:Blendops]]

==Definition==
'''INT''' blendop_swap ( <'''INT''' blendTable> )

Modify the [[blend table]] by swapping the source and destination sections. This means that the [[graphic]] the blend operation is assigned to will appear like what is behind the object and the background will look like the object.

This will swap the source and destination section of the [[blend table]].

== Parameters ==
{|
| '''INT''' blendTable || - The [[blend table]] to swap the sections of.
|}

== Returns ==
'''INT''' : [[true]]

== Notes ==
To understand what swapping actually does, consider the following:
* When done a blendop_swap() on a just initialized [[blend table]], the [[graphic]] it is assigned to will 'disappear'.

{{Funcbox
| category = Blendops
}}