fbdocs: wiki snapshot 2021.04.16

Author: jayrm

doc/manual/cache/CatPgDddefines.wakka

@@ -48,6 +48,8 @@ Preprocessor symbols defined by the compiler.
 		Defined if compiling for a 64bit target.
 	=={{fbdoc item="keyword" value="KeyPgDdfbarm|__FB_ARM__"}}==
 		Defined if compiling for the ARM architecture.
+	=={{fbdoc item="keyword" value="KeyPgDdfbx86|__FB_X86__"}}==
+		Defined if compiling for the X86 / X86_64 architecture.
 
 {{anchor name="VERSION"}}{{fbdoc item="section" value="Version Information"}}
 	=={{fbdoc item="keyword" value="KeyPgDdfbversion|__FB_VERSION__"}}==

doc/manual/cache/CatPgFullIndex.wakka

@@ -71,6 +71,7 @@ Alphabetical listing of keywords, macros and procedures.
 	- {{fbdoc item="keyword" value="KeyPgDdFBVerPatch|__FB_VER_PATCH__"}}
 	- {{fbdoc item="keyword" value="KeyPgDdfbversion|__FB_VERSION__"}}
 	- {{fbdoc item="keyword" value="KeyPgDdfbwin32|__FB_WIN32__"}}
+	- {{fbdoc item="keyword" value="KeyPgDdfbx86|__FB_X86__"}}
 	- {{fbdoc item="keyword" value="KeyPgDdfbxbox|__FB_XBOX__"}}
 	- {{fbdoc item="keyword" value="KeyPgDdfile|__FILE__"}}
 	- {{fbdoc item="keyword" value="KeyPgDdfilenq|__FILE_NQ__"}}
@@ -286,7 +287,7 @@ Alphabetical listing of keywords, macros and procedures.
 	- {{fbdoc item="keyword" value="KeyPgFalse|FALSE"}}
 	- {{fbdoc item="keyword" value="KeyPgFBMemcopy|FB_MEMCOPY"}}
 	- {{fbdoc item="keyword" value="KeyPgFBMemcopyclear|FB_MEMCOPYCLEAR"}}
-	- {{fbdoc item="keyword" value="KeyPgFBMEMMOVE|FB_MEMMOVE"}}
+	- {{fbdoc item="keyword" value="KeyPgFBMemmove|FB_MEMMOVE"}}
 	- {{fbdoc item="keyword" value="KeyPgFBArray|FBARRAY (array descriptor structure and access)"}}
 	- {{fbdoc item="keyword" value="KeyPgField|FIELD"}}
 	- {{fbdoc item="keyword" value="KeyPgFileattr|FILEATTR"}}

doc/manual/cache/CatPgFunctIndex.wakka

@@ -309,7 +309,7 @@ List of ""FreeBASIC"" keywords sorted by the function they perform.
 	- {{fbdoc item="keyword" value="KeyPgOpDelete|DELETE"}}
 	- {{fbdoc item="keyword" value="KeyPgFBMemcopy|FB_MEMCOPY"}}
 	- {{fbdoc item="keyword" value="KeyPgFBMemcopyclear|FB_MEMCOPYCLEAR"}}
-	- {{fbdoc item="keyword" value="KeyPgFBMEMMOVE|FB_MEMMOVE"}}
+	- {{fbdoc item="keyword" value="KeyPgFBMemmove|FB_MEMMOVE"}}
 	- {{fbdoc item="keyword" value="KeyPgField|FIELD"}}
 	- {{fbdoc item="keyword" value="KeyPgFre|FRE"}}
 	- {{fbdoc item="keyword" value="KeyPgOpNew|NEW"}}
@@ -466,6 +466,7 @@ List of ""FreeBASIC"" keywords sorted by the function they perform.
 	- {{fbdoc item="keyword" value="KeyPgDdfbversion|__FB_VERSION__"}}
 	- {{fbdoc item="keyword" value="KeyPgDdfbwin32|__FB_WIN32__"}}
 	- {{fbdoc item="keyword" value="KeyPgDdfbxbox|__FB_XBOX__"}}
+	- {{fbdoc item="keyword" value="KeyPgDdfbx86|__FB_X86__"}}
 	- {{fbdoc item="keyword" value="KeyPgDdfile|__FILE__"}}
 	- {{fbdoc item="keyword" value="KeyPgDdfilenq|__FILE_NQ__"}}
 	- {{fbdoc item="keyword" value="KeyPgDdfunction|__FUNCTION__"}}

doc/manual/cache/KeyPgDdfbarm.wakka

@@ -20,6 +20,7 @@ Intrinsic define set by the compiler
 	- New to ""FreeBASIC""
 
 {{fbdoc item="see"}}
+	- ##[[KeyPgDdfbx86|__FB_X86__]]##
 	- ##[[KeyPgDdfblinux|__FB_LINUX__]]##
 	- ##[[KeyPgDdfbfreebsd|__FB_FREEBSD__]]##
 	- ##[[KeyPgDdfbopenbsd|__FB_OPENBSD__]]##

doc/manual/cache/KeyPgDdfbx86.wakka

@@ -0,0 +1,26 @@
+{{fbdoc item="title" value="__FB_X86__"}}----
+Intrinsic define set by the compiler
+
+{{fbdoc item="syntax"}}##
+	""__FB_X86__""
+##
+{{fbdoc item="desc"}}
+	Define created at compile time if the compilation target uses the X86 or X86_64 CPU architecture, otherwise undefined.
+
+{{fbdoc item="ex"}}
+{{fbdoc item="filename" value="examples/manual/defines/fbx64.bas"}}%%(freebasic)
+#IFDEF __FB_X86__
+  '...instructions for X86 OSes...
+#ELSE
+  '...instructions for other OSes
+#ENDIF 
+%%
+
+{{fbdoc item="diff"}}
+	- New to ""FreeBASIC""
+
+{{fbdoc item="see"}}
+	- ##[[KeyPgDdfbarm|__FB_ARM__]]##
+	- [[CompilerOpttarget|Compiler Option: -target]]
+
+{{fbdoc item="back" value="CatPgDddefines|Intrinsic Defines"}}

doc/manual/cache/KeyPgPoint.wakka

@@ -18,7 +18,7 @@ Returns the color attribute of a specified pixel coordinate
 		the type of screen coordinate to return: one of the values ##0##, ##1##, ##2##, ##3##
 
 {{fbdoc item="ret"}}
-	The return datatype is an ##[[KeyPgInteger|Integer]]## for fbc version < 1.08, or a ##[[KeyPgulong|ULong]]## for fbc version >= 1.08.
+	The return datatype is an ##[[KeyPgInteger|Integer]]## for fbc version < 1.08, or a ##[[KeyPgUlong|ULong]]## for fbc version >= 1.08.
 
 	If the ##//x//, //y//## coordinates of a pixel are provided **##Point##** returns the color attribute at the specified coordinates, as an 8-bit palette index in 8 bpp indexed modes, a 24-bit RGB value in 16 bpp modes (upper 8 bits unused, limited precision of R,G,B), and a 32-bit RGB or RGBA value in 32 bpp modes (upper 8 bits unused or holding Alpha). Note that it does NOT return a 16-bit value (5 bits R + 6 bits G + 5 bits B).
 

doc/manual/cache/KeyPgScreengraphics.wakka

@@ -62,7 +62,7 @@ __Other details__
 
 __Note on using ##Screen 0##__
 	##Screen 0## closes any graphics window, but also clears the console window if it exists.
-	##Screen 0, , , SCREEN_EXIT## (with ##SCREEN_EXIT=&h80000000##) also closes any graphics window, but does not clear the console window if it exists (previous text is preserved).
+	##Screen 0, , , GFX_SCREEN_EXIT## (with ##GFX_SCREEN_EXIT=&h80000000##) also closes any graphics window, but does not clear the console window if it exists (previous text is preserved).
 
 {{fbdoc item="ex"}}
 {{fbdoc item="filename" value="examples/manual/gfx/screen.bas"}}%%(freebasic)

doc/manual/cache/PrintToc.wakka

@@ -68,6 +68,7 @@
 		[[KeyPgDdFBVerPatch|__FB_VER_PATCH__]]
 		[[KeyPgDdfbversion|__FB_VERSION__]]
 		[[KeyPgDdfbwin32|__FB_WIN32__]]
+		[[KeyPgDdfbx86|__FB_X86__]]
 		[[KeyPgDdfbxbox|__FB_XBOX__]]
 		[[KeyPgDdfile|__FILE__]]
 		[[KeyPgDdfilenq|__FILE_NQ__]]
@@ -283,7 +284,7 @@
 		[[KeyPgFalse|FALSE]]
 		[[KeyPgFBMemcopy|FB_MEMCOPY]]
 		[[KeyPgFBMemcopyclear|FB_MEMCOPYCLEAR]]
-		[[KeyPgFBMEMMOVE|FB_MEMMOVE]]
+		[[KeyPgFBMemmove|FB_MEMMOVE]]
 		[[KeyPgFBArray|FBARRAY (array descriptor structure and access)]]
 		[[KeyPgField|FIELD]]
 		[[KeyPgFileattr|FILEATTR]]
@@ -950,6 +951,7 @@
 		[[ExtLibogg|Ogg]]
 		[[ExtLibal|OpenAL]]
 		[[ExtLibPortAudio|PortAudio]]
+		[[ExtLibsfx|sfx]]
 		[[ExtLibsndfile|sndfile]]
 		[[ExtLibVLC|VLC]]
 		[[ExtLibvorbis|Vorbis]]

doc/manual/cache/ProPgMtCriticalSectionsFAQ.wakka

@@ -3006,20 +3006,20 @@ End Destructor
 
 Type ThreadDispatching
 	Public:
-		Declare Constructor(Byval nbSecondaryThread As Integer = 1)
+		Declare Constructor(Byval nbMaxSecondaryThread As Integer = 1)
 		Declare Sub DispatchingSubmit(Byval pThread As Function(Byval As Any Ptr) As String, Byval p As Any Ptr = 0)
 		declare Sub DispatchingWait()
 		Declare Sub DispatchingWait(values() As String)
 		Declare Property DispatchingThread() As Integer
 		Declare destructor()
 	Private:
-		Dim As Integer _nbst
-		Dim AS Integer _dtnb
+		Dim As Integer _nbmst
+		Dim AS Integer _dstnb
 		Dim As ThreadPooling Ptr _tp(Any)
 End Type
 
-Constructor ThreadDispatching(Byval nbSecondaryThread As Integer = 1)
-	This._nbst = nbSecondaryThread
+Constructor ThreadDispatching(Byval nbMaxSecondaryThread As Integer = 1)
+	This._nbmst = nbMaxSecondaryThread
 End Constructor
 
 Sub ThreadDispatching.DispatchingSubmit(Byval pThread As Function(Byval As Any Ptr) As String, Byval p As Any Ptr = 0)
@@ -3029,13 +3029,13 @@ Sub ThreadDispatching.DispatchingSubmit(Byval pThread As Function(Byval As Any P
 			Exit Sub
 		End If
 	Next I
-	If Ubound(This._tp) < This._nbst - 1 Then
+	If Ubound(This._tp) < This._nbmst - 1 Then
 		Redim Preserve This._tp(Ubound(This._tp) + 1)
 		This._tp(Ubound(This._tp)) = New ThreadPooling
 		This._tp(Ubound(This._tp))->PoolingSubmit(pThread, p)
 	Elseif Ubound(This._tp) >= 0 Then
-		This._tp(This._dtnb)->PoolingSubmit(pThread, p)
-		This._dtnb = (This._dtnb + 1) Mod This._nbst
+		This._tp(This._dstnb)->PoolingSubmit(pThread, p)
+		This._dstnb = (This._dstnb + 1) Mod This._nbmst
 	End If
 End Sub