This wiki is out of date, use the continuation of this wiki instead

From FenixWiki

Revision as of 13:19, 1 May 2007 (edit) FCR (Talk | contribs) ← Previous diff		Revision as of 13:43, 1 May 2007 (edit) (undo) FCR (Talk | contribs) Next diff →
Line 2:		Line 2:
	==Definition==		==Definition==
-	'''INT''' Get_point ( <'''INT''' library> , )	+	'''INT''' Get_point ( <'''INT''' library> , <'''INT''' graph>, <'''INT''' number>, <'''INT''' x>, <'''INT''' y>)
-	Does something.	+	This command allows you to obtain a control point of a particular graphic file.
-	Here goes a more detailed story about the function.	+	Any graph can contain an undetermined number of control points where control point 0 is the centre of the graphic, and the rest are available to the user. This function allows you to know the location of any control point belonging to any graph.
	== Parameters ==		== Parameters ==
	{|		{|
-	| '''INT''' example_int || - Something about this int.	+	| '''INT''' library || - Number of the FPG library.
	|-		|-
-	| '''WORD''' example_word || - Something about this word.	+	| '''INT''' graph|| - Number of the graph inside the library which you want to use.
	|-		|-
-	| ['''STRING''' example_string] || - Something about this string.	+	| '''INT''' number|| - Number of the control point (where control point 0 is the centre of the graphic).
		+	|-
		+	| '''INT''' x|| - Offset of a variable of entire type (INT) which will hold the horizontal coordinate(X) of the control point.
		+	|-
		+	| '''INT''' y|| - Offset of a variable of entire type (INT) which will hold the vertical coordinate(Y) of the control point.
	|}		|}
	== Returns ==		== Returns ==
-	'''INT''' : Some int.	+	'''INT''' : If the number of the control points specified is out of range, the function returns -1 and the variables x and y will not be modified. But if the control point is in range, but not defined, x and y will have the value -1.
-	== Notes ==	+	==Notes==
-	Here are some notes, which explains some parts in more depth. Mostly not needed, in which case it can be left out.	+	In the rest of the cases, x and y will have the coordinates of the control point, then (0, 0) will represent the pixel located in the top left corner of the graph.
	== Example ==		== Example ==

---

Revision as of 13:43, 1 May 2007

Contents 1 Definition 2 Parameters 3 Returns 4 Notes 5 Example

Definition

INT Get_point ( <INT library> , <INT graph>, <INT number>, <INT x>, <INT y>)

This command allows you to obtain a control point of a particular graphic file.

Any graph can contain an undetermined number of control points where control point 0 is the centre of the graphic, and the rest are available to the user. This function allows you to know the location of any control point belonging to any graph.

Parameters

INT library	- Number of the FPG library.
INT graph	- Number of the graph inside the library which you want to use.
INT number	- Number of the control point (where control point 0 is the centre of the graphic).
INT x	- Offset of a variable of entire type (INT) which will hold the horizontal coordinate(X) of the control point.
INT y	- Offset of a variable of entire type (INT) which will hold the vertical coordinate(Y) of the control point.

Returns

INT : If the number of the control points specified is out of range, the function returns -1 and the variables x and y will not be modified. But if the control point is in range, but not defined, x and y will have the value -1.

Notes

In the rest of the cases, x and y will have the coordinates of the control point, then (0, 0) will represent the pixel located in the top left corner of the graph.

Example

Program example;
Begin
    Loop
        frame;
    End
End