Legacy:SetFrameRate - Revision history

Apollolux: /* Usage */ NTSC/PAL note

2015-06-16T05:25:09Z

‎Usage: NTSC/PAL note

DaVince: Added FPS recommendation notes

2015-06-10T11:01:55Z

Added FPS recommendation notes

DaVince: /* See also */ added map engine framerate functions

2015-06-10T10:53:51Z

‎See also: added map engine framerate functions

Apollolux: filled

2013-06-24T23:18:12Z

filled

Apollolux: created from http://web.archive.org/web/20111228000549/http://www.spheredev.org/wiki/SetFrameRate

2013-06-24T23:06:20Z

created from http://web.archive.org/web/20111228000549/http://www.spheredev.org/wiki/SetFrameRate

New page

Set or unset a limit to the refresh rate of drawing functions outside the map engine.

__TOC__

==Usage==
{{Usage|returns={{{returns}}}|object={{{object}}}|func=SetFrameRate|params=fps}}

* '''param1''' type. param1 description
* '''param2''' type. param2 description
* '''paramN''' type. paramN description

==Examples==
(examples with syntaxhighlighted code)

==Notes==
(notes)

==See also==
* see also
* see also
* see also
* etc

{{API:Video/navbox}}

@@ Line 7: / Line 7: @@
 * '''fps''' integer. Short for '''F'''rames '''P'''er '''S'''econd, which limits how often the screen can be refreshed in one second
-*:	sixty (60) is a common value for this.
+*:	sixty (60) is a common value for this in NTSC regions, fifty (50) in PAL regions.
 *:	If this is set to zero (0), no limit is imposed and the screen will update as fast as possible.

@@ Line 1: / Line 1: @@
-Set or unset a limit to the refresh rate of drawing functions outside the map engine.
+Set or unset a limit to the refresh rate of drawing functions outside the map engine. (So for anything relying on [[API:FlipScreen|FlipScreen]]() to render.)
 __TOC__
@@ Line 7: / Line 7: @@
 * '''fps''' integer. Short for '''F'''rames '''P'''er '''S'''econd, which limits how often the screen can be refreshed in one second
-*:	sixty (60) is a common value for this
+*:	sixty (60) is a common value for this.
 *:	If this is set to zero (0), no limit is imposed and the screen will update as fast as possible.
@@ Line 48: / Line 48: @@
 *	[[API:GetFrameRate|GetFrameRate]]() can be used to obtain the current frame rate.
 *	The frames per second set with this function are completely independent of that of the second argument of [[API:MapEngine|MapEngine]](), and any functions that access or modify the map engine's frame rate.
 ==See also==

@@ Line 51: / Line 51: @@
 ==See also==
 *	[[API:GetFrameRate|GetFrameRate]]()
 *	[[API:ApplyColorMask|ApplyColorMask]]()
 *	[[API:AreKeysLeft|AreKeysLeft]]()

@@ Line 1: / Line 1: @@
 Set or unset a limit to the refresh rate of drawing functions outside the map engine.
@@ Line 6: / Line 4: @@
 ==Usage==
-{{Usage|returns={{{returns}}}|object={{{object}}}|func=SetFrameRate|params=fps}}
+{{Usage|func=SetFrameRate|params=fps}}
-* '''param1''' type. param1 description
+* '''fps''' integer. Short for '''F'''rames '''P'''er '''S'''econd, which limits how often the screen can be refreshed in one second
-* '''param2''' type. param2 description
+*:	sixty (60) is a common value for this
-* '''paramN''' type. paramN description
+*:	If this is set to zero (0), no limit is imposed and the screen will update as fast as possible.
 ==Examples==
-(examples with syntaxhighlighted code)
+<syntaxhighlight>
 ==Notes==
-(notes)
+*	Though the main description implies that all drawing functions are affected by this, in fact only [[API:FlipScreen|FlipScreen]]() is limited, or 'throttled'. For example, if <code>SetFrameRate(30);</code> were executed, <code>FlipScreen()</code> could be called at most 30 times in one second, with small, roughly even pauses to distribute the screen updates evenly.
 ==See also==
-* see also
+*	[[API:GetFrameRate|GetFrameRate]]()
-* see also
+*	[[API:ApplyColorMask|ApplyColorMask]]()
-* see also
+*	[[API:AreKeysLeft|AreKeysLeft]]()
-* etc
+*	[[API:CreateColor|CreateColor]]()
 {{API:Video/navbox}}