diff --git a/internal/help/$ASSERTS_$1111111.txt b/internal/help/$ASSERTS_$1111111.txt index 71caabf3e..3457b4956 100644 --- a/internal/help/$ASSERTS_$1111111.txt +++ b/internal/help/$ASSERTS_$1111111.txt @@ -1,29 +1,30 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:06:28}} -This metacommand enables debug tests with the [[_ASSERT]] statement. +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:36:10}} +The '''$ASSERTS''' [[metacommand]] enables debug tests with the [[_ASSERT]] macro. {{PageSyntax}} -:[[$ASSERTS]][:CONSOLE] +: '''$ASSERTS''' +: '''$ASSERTS:CONSOLE''' {{PageDescription}} -* The metacommand does not require a comment or [[REM]] before it. There is no space after the colon. -* If this metacommand is used in a program and any of the set [[_ASSERT]] checkpoints will fail, then the program will stop with an '''{{Text|_ASSERT failed|#fc5454}}''' error. -* Detailed error messages passed to the [[_ASSERT]] statement will be displayed in the console window, but only if [[$ASSERTS|$ASSERTS:CONSOLE]] is used. +* This metacommand does not require a comment ''[[Apostrophe|']]'' or [[REM]] before it. There is no space between the metacommand name, the colon and the CONSOLE parameter. +* If this metacommand is used in a program and any of the set [[_ASSERT]] checkpoints will fail, then the program will stop with an '''{{Text|_ASSERT failed|red}}''' error. +* Detailed error messages passed to the [[_ASSERT]] statement will be displayed in the console window, but only if '''$ASSERTS:CONSOLE''' is used. ;Note: This metacommand is the main switch to enable debug tests during development. Later just remove this metacommand to compile the program without debugging code, all the [[_ASSERT]] statements may remain in the code for later debugging sessions, they are simply ignored without this metacommand. {{PageAvailability}} -* '''QB64 1.4 and up''' (QB64 Team) -* '''QBPE 0.5 and up''' (QB64 Phoenix Edition) +* '''QB64 v1.4 and up''' (QB64 Team) +* '''QB64-PE v0.5 and up''' (QB64 Phoenix Edition) {{PageExamples}} ;Example:Adding test checks for parameter inputs in a function. {{CodeStart}} -{{Cl|$ASSERTS}}:CONSOLE +{{Cl|$ASSERTS|$ASSERTS:CONSOLE}} {{Cl|DO}} a = {{Cl|INT}}({{Cl|RND}} * 10) @@ -43,6 +44,7 @@ This metacommand enables debug tests with the [[_ASSERT]] statement. {{PageSeeAlso}} +* [[Metacommand]] * [[_ASSERT]] * [[$CHECKING]] * [[Relational Operations]] @@ -51,3 +53,4 @@ This metacommand enables debug tests with the [[_ASSERT]] statement. {{PageNavigation}} +[[Category:Final]] diff --git a/internal/help/$CHECKING_$11111111.txt b/internal/help/$CHECKING_$11111111.txt index 980126c3d..703068d77 100644 --- a/internal/help/$CHECKING_$11111111.txt +++ b/internal/help/$CHECKING_$11111111.txt @@ -1,5 +1,5 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:06:53}} +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:36:34}} The [[$CHECKING]] metacommand turns C++ event checking ON or OFF. @@ -27,3 +27,4 @@ The [[$CHECKING]] metacommand turns C++ event checking ON or OFF. {{PageNavigation}} +[[Category:Latest]] diff --git a/internal/help/$COLOR_$11111.txt b/internal/help/$COLOR_$11111.txt index 6e83764d9..2b9597d5b 100644 --- a/internal/help/$COLOR_$11111.txt +++ b/internal/help/$COLOR_$11111.txt @@ -1,5 +1,5 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:07:06}} +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:36:45}} [[$COLOR]] is a metacommand that adds named color [[CONST|constants]] in a program. @@ -12,13 +12,14 @@ * [[$COLOR]]:0 adds [[CONST|constants]] for colors 0-15. The actual constant names can be found in the file '''source/utilities/color0.bi'''. * [[$COLOR]]:32 adds [[CONST|constants]] for 32-bit colors, similar to HTML color names. The actual constant names can be found in the file '''source/utilities/color32.bi'''. * [[$COLOR]] is a shorthand to manually using [[$INCLUDE]] pointing to the files listed above. -* Prior to QBPE v0.5 (ü), [[$COLOR]] was not compatible with [[$NOPREFIX]]. +* Prior to QBPE v0.5 ({{Text|ü|red}}), [[$COLOR]] was not compatible with [[$NOPREFIX]]. * Since QBPE v0.5, [[$COLOR]] can now be used with [[$NOPREFIX]], with a few notable differences to three conflicting colors -- Red, Green, Blue. :Red would conflict with [[_RED]], Green would conflict with [[_GREEN]], and Blue would conflict with [[_BLUE]], once the underscore was removed from those commands with [[$NOPREFIX]]. : :To prevent these conflicts, the [[COLOR]] values have had '''NP_''' prepended to the front of them, to distinguish them from the non-prefixed command names. All other color names remain the same, with only the three colors in conflict having to use '''NP_''' (for '''N'''o '''P'''refix) in front of them. -(ü) QBPE = QB64 Phoenix Edition + +({{Text|ü|red}}) QBPE = QB64 Phoenix Edition {{PageExamples}} @@ -58,4 +59,3 @@ {{PageNavigation}} - diff --git a/internal/help/$CONSOLE_$1111111.txt b/internal/help/$CONSOLE_$1111111.txt index 42e8a09fa..224cf0db8 100644 --- a/internal/help/$CONSOLE_$1111111.txt +++ b/internal/help/$CONSOLE_$1111111.txt @@ -1,5 +1,5 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:07:11}} +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:36:50}} The [[$CONSOLE]] [[Metacommand]] creates a console window that can be used throughout a QB64 program module. @@ -59,7 +59,7 @@ Max hex _INTEGER64 = FFFFFFFFFFFFFFFF with 16 digits =-1 Max _INTEGER64 value = 7FFFFFFFFFFFFFFF with 16 digits Min _INTEGER64 value = 8000000000000000 with 16 digits {{OutputEnd}} -: ''Console:'' Right click and select ''Edit'' > ''Select All'' (mouse highlight after) then hit Enter or select ''Edit'' > ''Copy'' to the [[_CLIPBOARD$ (function)|clipboard]]. +: ''Console:'' Right click and select ''Edit'' > ''Select All'' (mouse highlight after) then hit Enter or select ''Edit'' > ''Copy'' to the clipboard. {{TextStart}}Max hex _BYTE = FF with 2 digits = 255 Max hex INTEGER = FFFF with 4 digits = 65535 Max hex LONG = FFFFFFFF with 8 digits = 4294967295 @@ -69,6 +69,7 @@ Max hex _INTEGER64 = FFFFFFFFFFFFFFFF with 16 digits =-1 {{PageSeeAlso}} +* [[_CLIPBOARD$]] (function), [[_CLIPBOARD$ (statement)]] * [[_CONSOLE]] * [[$SCREENHIDE]], [[$SCREENSHOW]] (QB64 [[Metacommand]]s) * [[_SCREENHIDE]], [[_SCREENSHOW]] @@ -76,4 +77,3 @@ Max hex _INTEGER64 = FFFFFFFFFFFFFFFF with 16 digits =-1 {{PageNavigation}} - diff --git a/internal/help/$DEBUG_$11111.txt b/internal/help/$DEBUG_$11111.txt index 762218eab..93528a78b 100644 --- a/internal/help/$DEBUG_$11111.txt +++ b/internal/help/$DEBUG_$11111.txt @@ -1,5 +1,5 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:07:28}} +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:37:05}} '''$DEBUG''' is precompiler [[Metacommand|metacommand]], which enables debugging features, allowing you to step through your code running line by line and to inspect variables and change their values in real time. @@ -42,3 +42,4 @@ {{PageNavigation}} +[[Category:Latest]] diff --git a/internal/help/$DYNAMIC_$1111111.txt b/internal/help/$DYNAMIC_$1111111.txt index 007815cfd..503c6997c 100644 --- a/internal/help/$DYNAMIC_$1111111.txt +++ b/internal/help/$DYNAMIC_$1111111.txt @@ -1,14 +1,14 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:12:56}} -The [[$DYNAMIC]] [[Metacommand|metacommand]] allows the creation of dynamic (changeable) arrays. +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:42:02}} +The [[$DYNAMIC]] [[Metacommand|metacommand]] allows the creation of dynamic (resizable) arrays. {{PageSyntax}} -:{[[REM]] | ' } [[$DYNAMIC]] +:{[[REM]] | [[apostrophe|']] } [[$DYNAMIC]] {{PageDescription}} -* QBasic [[Metacommand|metacommands]] require [[REM]] or [[Apostrophe|apostrophe]] (') before them and are always placed at the start of the main module. +* QBasic [[Metacommand|metacommands]] require [[REM]] or [[Apostrophe|apostrophe]] (') before them and are normally placed at the start of the main module. * Dynamic arrays can be resized using [[REDIM]]. The array's type cannot be changed. * All data in the array will be lost when [[REDIM]]ensioned except when [[_PRESERVE]] is used. * [[REDIM]] [[_PRESERVE]] can preserve and may move the previous array data when the array boundaries change. @@ -47,3 +47,4 @@ The [[$DYNAMIC]] [[Metacommand|metacommand]] allows the creation of dynamic (cha {{PageNavigation}} +[[Category:Latest]] diff --git a/internal/help/$ELSEIF_$111111.txt b/internal/help/$ELSEIF_$111111.txt index 3475ea0e4..3632fe9ae 100644 --- a/internal/help/$ELSEIF_$111111.txt +++ b/internal/help/$ELSEIF_$111111.txt @@ -1,69 +1,5 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:08:03}} -'''$IF''' is precompiler [[Metacommand|metacommand]], which determines which sections of code inside its blocks are included into the final code for compliing. - - -{{PageSyntax}} -:[[$IF]] variable = expression THEN -:. -:[[$ELSEIF]] variable = expression THEN -:. -:[[$ELSE]] -:. -:[[$END IF]] - - -* $IF is the start of a precompiler code block which includes or excludes sections of code from being compiled. -* There is no single line $IF statement. $IF must be in a valid $IF THEN...$END IF block to work properly. -* Like all other metacommands, you can not use more than one metacommand per line. '''Use of : to separate statements in a single line is not allowed.''' -* Variable names can contain numbers, letters, and periods -- in any order. -* Expressions can contain one set of leading and/or trailing quotes; and any number of numbers, letters, and periods, in any order. -* The precompiler comes with some preset values which can be used to help determine which code blocks to include/exclude for us. These are: '''WIN''' or '''WINDOWS''' if the user is running QB64 in a Windows environment. '''LINUX''' if the user is running QB64 in a Linux environment. '''MAC''' or '''MACOSX''' if the user is running QB64 in a macOS environment. '''32BIT''' if the user is running a 32-bit version of QB64. '''64BIT''' if the user is running a 64-bit version of QB64. -* [[$END IF]] denotes the end of a valid precompiler $IF block. -* [[$ELSEIF]] must follow a valid $IF or $ELSEIF statement. -* If [[$ELSE]] is used, it must be used as the last conditional check before $END IF. $ELSEIF cannot come after $ELSE. -** There can only be one $ELSE in an '''$IF-$ELSEIF-$ELSE-$END IF''' block, and it must be the last block selection before the $END IF. $ELSEIF cannot follow $ELSE. - - -{{PageExamples}} -''Example 1:'' -{{CodeStart}} -{{Cl|$LET}} ScreenMode = 32 -{{Cl|$IF}} ScreenMode = 0 THEN - {{Cl|CONST}} Red = 4 -{{Cl|$ELSEIF}} ScreenMode = 32 THEN - {{Cl|CONST}} Red = _RGB32(255,0,0) -{{Cl|$END IF}} - -{{Cl|COLOR}} Red -{{Cl|PRINT}} "Hello World" -{{CodeEnd}} - -''Explanation:'' The same CONST is defined twice inside the program. Normally, defining a CONST more than once generates an error, but the $IF condition here is choosing which CONST will be inside the final program. - -As long as Screenmode is 0, the program will exclude the code where CONST Red is defined as color 4. If Screenmode is 32, CONST Red will be defined as _RGB32(255, 0, 0). - -The [[$LET]] and $IF statements let the programmer control the code that actually gets compiled, while excluding the other blocks completely. - - -''Example 2:'' -{{CodeStart}} -{{Cl|$IF}} WIN THEN - {{Cl|CONST}} Slash = "\" -{{Cl|$ELSE}} - {{Cl|CONST}} Slash = "/" -{{Cl|$END IF}} - -{{Cl|PRINT}} "The proper slash for your operating system is "; Slash -{{CodeEnd}} - -''Explanation:'' For the above, the CONST slash is defined by the automatic internal flags which returns what operating system is being used at compile time. On a Windows PC, the Slash will be the backslash; for any other OS it will be the forward slash. - - -{{PageSeeAlso}} -* [[$LET]] -* [[Metacommand]]s - - -{{PageNavigation}} +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:37:34}} +See page [[$IF]] +[[Category:Final]] diff --git a/internal/help/$ELSE_$1111.txt b/internal/help/$ELSE_$1111.txt index 8fe7ab024..726d44886 100644 --- a/internal/help/$ELSE_$1111.txt +++ b/internal/help/$ELSE_$1111.txt @@ -1,69 +1,5 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:08:02}} -'''$IF''' is precompiler [[Metacommand|metacommand]], which determines which sections of code inside its blocks are included into the final code for compliing. - - -{{PageSyntax}} -:[[$IF]] variable = expression THEN -:. -:[[$ELSEIF]] variable = expression THEN -:. -:[[$ELSE]] -:. -:[[$END IF]] - - -* $IF is the start of a precompiler code block which includes or excludes sections of code from being compiled. -* There is no single line $IF statement. $IF must be in a valid $IF THEN...$END IF block to work properly. -* Like all other metacommands, you can not use more than one metacommand per line. '''Use of : to separate statements in a single line is not allowed.''' -* Variable names can contain numbers, letters, and periods -- in any order. -* Expressions can contain one set of leading and/or trailing quotes; and any number of numbers, letters, and periods, in any order. -* The precompiler comes with some preset values which can be used to help determine which code blocks to include/exclude for us. These are: '''WIN''' or '''WINDOWS''' if the user is running QB64 in a Windows environment. '''LINUX''' if the user is running QB64 in a Linux environment. '''MAC''' or '''MACOSX''' if the user is running QB64 in a macOS environment. '''32BIT''' if the user is running a 32-bit version of QB64. '''64BIT''' if the user is running a 64-bit version of QB64. -* [[$END IF]] denotes the end of a valid precompiler $IF block. -* [[$ELSEIF]] must follow a valid $IF or $ELSEIF statement. -* If [[$ELSE]] is used, it must be used as the last conditional check before $END IF. $ELSEIF cannot come after $ELSE. -** There can only be one $ELSE in an '''$IF-$ELSEIF-$ELSE-$END IF''' block, and it must be the last block selection before the $END IF. $ELSEIF cannot follow $ELSE. - - -{{PageExamples}} -''Example 1:'' -{{CodeStart}} -{{Cl|$LET}} ScreenMode = 32 -{{Cl|$IF}} ScreenMode = 0 THEN - {{Cl|CONST}} Red = 4 -{{Cl|$ELSEIF}} ScreenMode = 32 THEN - {{Cl|CONST}} Red = _RGB32(255,0,0) -{{Cl|$END IF}} - -{{Cl|COLOR}} Red -{{Cl|PRINT}} "Hello World" -{{CodeEnd}} - -''Explanation:'' The same CONST is defined twice inside the program. Normally, defining a CONST more than once generates an error, but the $IF condition here is choosing which CONST will be inside the final program. - -As long as Screenmode is 0, the program will exclude the code where CONST Red is defined as color 4. If Screenmode is 32, CONST Red will be defined as _RGB32(255, 0, 0). - -The [[$LET]] and $IF statements let the programmer control the code that actually gets compiled, while excluding the other blocks completely. - - -''Example 2:'' -{{CodeStart}} -{{Cl|$IF}} WIN THEN - {{Cl|CONST}} Slash = "\" -{{Cl|$ELSE}} - {{Cl|CONST}} Slash = "/" -{{Cl|$END IF}} - -{{Cl|PRINT}} "The proper slash for your operating system is "; Slash -{{CodeEnd}} - -''Explanation:'' For the above, the CONST slash is defined by the automatic internal flags which returns what operating system is being used at compile time. On a Windows PC, the Slash will be the backslash; for any other OS it will be the forward slash. - - -{{PageSeeAlso}} -* [[$LET]] -* [[Metacommand]]s - - -{{PageNavigation}} +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:37:33}} +See page [[$IF]] +[[Category:Final]] diff --git a/internal/help/$END_IF_$111_11.txt b/internal/help/$END_IF_$111_11.txt index a0baddd4c..059b31413 100644 --- a/internal/help/$END_IF_$111_11.txt +++ b/internal/help/$END_IF_$111_11.txt @@ -1,69 +1,5 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:08:05}} -'''$IF''' is precompiler [[Metacommand|metacommand]], which determines which sections of code inside its blocks are included into the final code for compliing. - - -{{PageSyntax}} -:[[$IF]] variable = expression THEN -:. -:[[$ELSEIF]] variable = expression THEN -:. -:[[$ELSE]] -:. -:[[$END IF]] - - -* $IF is the start of a precompiler code block which includes or excludes sections of code from being compiled. -* There is no single line $IF statement. $IF must be in a valid $IF THEN...$END IF block to work properly. -* Like all other metacommands, you can not use more than one metacommand per line. '''Use of : to separate statements in a single line is not allowed.''' -* Variable names can contain numbers, letters, and periods -- in any order. -* Expressions can contain one set of leading and/or trailing quotes; and any number of numbers, letters, and periods, in any order. -* The precompiler comes with some preset values which can be used to help determine which code blocks to include/exclude for us. These are: '''WIN''' or '''WINDOWS''' if the user is running QB64 in a Windows environment. '''LINUX''' if the user is running QB64 in a Linux environment. '''MAC''' or '''MACOSX''' if the user is running QB64 in a macOS environment. '''32BIT''' if the user is running a 32-bit version of QB64. '''64BIT''' if the user is running a 64-bit version of QB64. -* [[$END IF]] denotes the end of a valid precompiler $IF block. -* [[$ELSEIF]] must follow a valid $IF or $ELSEIF statement. -* If [[$ELSE]] is used, it must be used as the last conditional check before $END IF. $ELSEIF cannot come after $ELSE. -** There can only be one $ELSE in an '''$IF-$ELSEIF-$ELSE-$END IF''' block, and it must be the last block selection before the $END IF. $ELSEIF cannot follow $ELSE. - - -{{PageExamples}} -''Example 1:'' -{{CodeStart}} -{{Cl|$LET}} ScreenMode = 32 -{{Cl|$IF}} ScreenMode = 0 THEN - {{Cl|CONST}} Red = 4 -{{Cl|$ELSEIF}} ScreenMode = 32 THEN - {{Cl|CONST}} Red = _RGB32(255,0,0) -{{Cl|$END IF}} - -{{Cl|COLOR}} Red -{{Cl|PRINT}} "Hello World" -{{CodeEnd}} - -''Explanation:'' The same CONST is defined twice inside the program. Normally, defining a CONST more than once generates an error, but the $IF condition here is choosing which CONST will be inside the final program. - -As long as Screenmode is 0, the program will exclude the code where CONST Red is defined as color 4. If Screenmode is 32, CONST Red will be defined as _RGB32(255, 0, 0). - -The [[$LET]] and $IF statements let the programmer control the code that actually gets compiled, while excluding the other blocks completely. - - -''Example 2:'' -{{CodeStart}} -{{Cl|$IF}} WIN THEN - {{Cl|CONST}} Slash = "\" -{{Cl|$ELSE}} - {{Cl|CONST}} Slash = "/" -{{Cl|$END IF}} - -{{Cl|PRINT}} "The proper slash for your operating system is "; Slash -{{CodeEnd}} - -''Explanation:'' For the above, the CONST slash is defined by the automatic internal flags which returns what operating system is being used at compile time. On a Windows PC, the Slash will be the backslash; for any other OS it will be the forward slash. - - -{{PageSeeAlso}} -* [[$LET]] -* [[Metacommand]]s - - -{{PageNavigation}} +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:37:35}} +See page [[$IF]] +[[Category:Final]] diff --git a/internal/help/$ERROR_$11111.txt b/internal/help/$ERROR_$11111.txt index 252e3b1c6..16e4343e4 100644 --- a/internal/help/$ERROR_$11111.txt +++ b/internal/help/$ERROR_$11111.txt @@ -1,21 +1,21 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:08:06}} -The [[$ERROR]] metacommand triggers a compilation error. +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:37:38}} +The '''$ERROR''' [[metacommand]] triggers a compilation error. {{PageSyntax}} -: [[$ERROR]] MESSAGE +: '''$ERROR''' {{Parameter|message}} {{PageDescription}} -* The Metacommand does '''not''' require a comment or REM before it. -* MESSAGE is any text. Quotation marks are not required. -* When QB64 tries to compile an $ERROR metacommand a compilation error is triggered and MESSAGE is shown to the user. This is useful in [[$IF]] blocks. +* This metacommand does not require a comment ''[[Apostrophe|']]'' or [[REM]] before it. +* {{Parameter|message}} is any text. Quotation marks are not required. +* When QB64 tries to compile an '''$ERROR''' metacommand a compilation error is triggered and {{Parameter|message}} is shown to the user. This is useful in [[$IF]] blocks. {{PageDescription}} * If there is a particular situation where you know your program will not work properly, you can prevent the user compiling and give them a helpful error message instead by checking for the condition with [[$IF]]. -* An [[$ERROR]] directive not inside an [[$IF]] (or [[$ELSEIF]]) block is useless because the program will never compile. +* An '''$ERROR''' directive not inside an conditional [[$IF]] (or [[$ELSEIF]]) block is useless because the program will '''never''' compile in that case. {{PageExamples}} @@ -24,7 +24,7 @@ The [[$ERROR]] metacommand triggers a compilation error. {{Cl|$ERROR}} Requires Windows QB64 version 2.1 or above {{Cl|$END IF}} {{CodeEnd}} -''Output'': Compilation check failed: REQUIRES WINDOWS QB64 VERSION 2.1 OR ABOVE on line 2 (assuming your version of QB64 doesn't meet those requirements). +;Output (IDE Status Area):Compilation check failed: REQUIRES WINDOWS QB64 VERSION 2.1 OR ABOVE on line 2 (assuming your version of QB64 doesn't meet those requirements). {{PageSeeAlso}} @@ -34,3 +34,4 @@ The [[$ERROR]] metacommand triggers a compilation error. {{PageNavigation}} +[[Category:Final]] diff --git a/internal/help/$EXEICON_$1111111.txt b/internal/help/$EXEICON_$1111111.txt index cce94514b..3fa2eb93a 100644 --- a/internal/help/$EXEICON_$1111111.txt +++ b/internal/help/$EXEICON_$1111111.txt @@ -1,5 +1,5 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:08:10}} +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:37:41}} '''$EXEICON''' pre-compiler metacommand embeds a designated icon file into the compiled EXE file to be viewed in Windows Explorer. @@ -7,7 +7,7 @@ : [[$EXEICON]]:'{{Parameter|iconfile.ico}}' -{{Parameters}} +{{PageParameters}} * '{{Parameter|iconfile.ico}}' is a valid [https://en.wikipedia.org/wiki/ICO_(file_format) ICO file] @@ -21,7 +21,7 @@ {{PageExamples}} ''Example:'' Embeds a designated icon file into the compiled EXE which can be viewed in Windows Explorer folders. {{CodeStart}} -{{Cl|$EXEICON}}:'myexe.ico' +{{Cl|$EXEICON}}:'mush.ico' {{Cl|_ICON}} {{CodeEnd}}{{small|Code and command by Fellippe Heitor}} @@ -34,3 +34,4 @@ {{PageNavigation}} +[[Category:Latest]] diff --git a/internal/help/$IF_$11.txt b/internal/help/$IF_$11.txt index 64da5e3c8..53ec3082d 100644 --- a/internal/help/$IF_$11.txt +++ b/internal/help/$IF_$11.txt @@ -1,5 +1,5 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:08:38}} +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:38:06}} '''$IF''' is precompiler [[Metacommand|metacommand]], which determines which sections of code inside its blocks are included into the final code for compliing. @@ -13,12 +13,20 @@ :[[$END IF]] +{{PageDescription}} * $IF is the start of a precompiler code block which includes or excludes sections of code from being compiled. * There is no single line $IF statement. $IF must be in a valid $IF THEN...$END IF block to work properly. * Like all other metacommands, you can not use more than one metacommand per line. '''Use of : to separate statements in a single line is not allowed.''' -* Variable names can contain numbers, letters, and periods -- in any order. -* Expressions can contain one set of leading and/or trailing quotes; and any number of numbers, letters, and periods, in any order. -* The precompiler comes with some preset values which can be used to help determine which code blocks to include/exclude for us. These are: '''WIN''' or '''WINDOWS''' if the user is running QB64 in a Windows environment. '''LINUX''' if the user is running QB64 in a Linux environment. '''MAC''' or '''MACOSX''' if the user is running QB64 in a macOS environment. '''32BIT''' if the user is running a 32-bit version of QB64. '''64BIT''' if the user is running a 64-bit version of QB64. +* Variable names can contain numbers, letters and periods, in any order. +* Expressions can contain one set of leading and/or trailing quotes; and any number of numbers, letters and periods, in any order. +* The precompiler comes with some preset values which can be used to help determine which code blocks to include/exclude. These are: +** '''WIN''' or '''WINDOWS''' if the user is running QB64 in a Windows environment. +** '''LINUX''' if the user is running QB64 in a Linux environment. +** '''MAC''' or '''MACOSX''' if the user is running QB64 in a macOS environment. +** '''32BIT''' if the user is running a 32-bit version of QB64. +** '''64BIT''' if the user is running a 64-bit version of QB64. +** '''VERSION''', which is set to the version of the QB64 compiler. This is a number and can be ordered, see example below. +* Special values '''DEFINED''' and '''UNDEFINED''' can be used to check whether a precompiler variable has already been assigned a value. Useful for code in libraries which may be repeated. * [[$END IF]] denotes the end of a valid precompiler $IF block. * [[$ELSEIF]] must follow a valid $IF or $ELSEIF statement. * If [[$ELSE]] is used, it must be used as the last conditional check before $END IF. $ELSEIF cannot come after $ELSE. @@ -60,10 +68,22 @@ The [[$LET]] and $IF statements let the programmer control the code that actuall ''Explanation:'' For the above, the CONST slash is defined by the automatic internal flags which returns what operating system is being used at compile time. On a Windows PC, the Slash will be the backslash; for any other OS it will be the forward slash. +''Example 3:'' +{{CodeStart}} +{{Cl|$IF}} VERSION < 1.5 THEN + {{Cl|$ERROR}} Requires QB64 version 1.5 or greater +{{Cl|$END IF}} +{{CodeEnd}} + +''Explanation:'' VERSION is a predefined variable that holds the QB64 compiler version. If we know our program needs features only available above a certain version, we can check for that and give the user a helpful error message instead of a confusing error elsewhere in the program. + + {{PageSeeAlso}} * [[$LET]] +* [[$ERROR]] * [[Metacommand]]s {{PageNavigation}} +[[Category:Latest]] diff --git a/internal/help/$INCLUDE_$1111111.txt b/internal/help/$INCLUDE_$1111111.txt index 184d7a428..781d36dfd 100644 --- a/internal/help/$INCLUDE_$1111111.txt +++ b/internal/help/$INCLUDE_$1111111.txt @@ -1,10 +1,10 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:13:39}} +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:42:37}} [[$INCLUDE]] is a metacommand that is used to insert a source code file into your program which is then executed at the point of the insertion. {{PageSyntax}} -: {[[REM]] | [[REM|']] } $INCLUDE: '{{Parameter|sourceFile}}' +: {[[REM]] | [[apostrophe|']] } [[$INCLUDE]]''':''' '{{Parameter|sourceFile}}' {{PageDescription}} @@ -43,3 +43,4 @@ {{PageNavigation}} +[[Category:Latest]] diff --git a/internal/help/$LET_$111.txt b/internal/help/$LET_$111.txt index dc5689f3a..7d48a61e3 100644 --- a/internal/help/$LET_$111.txt +++ b/internal/help/$LET_$111.txt @@ -1,6 +1,6 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:08:51}} -[[$LET]] is precompiler command, which is now usable by modern day [[cavemen]] to help include and exclude which sections of code compiles in their program based on OS/bit-size or other predefined conditions. +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:38:18}} +[[$LET]] is a precompiler command, which helps to include and/or exclude sections of code in a program based on OS/bit-size or other predefined conditions. {{PageSyntax}} @@ -10,8 +10,15 @@ {{PageDescription}} * Unlike [[LET]], [[$LET]] is not optional. * $LET a = 12 sets a precompiler variable "a" to the value of 12. This variable is only valid for the precompiler itself and does nothing to affect the values of any variable/constant which might also be called "a" in the program. -* Variable names can contain numbers, letters, and periods in any order. [[$LET]] '''3.2 = TRUE''' is a perfectly valid variable and expression. -* Expressions can contain one set of leading and/or trailing quotes; and any number of numbers, letters, and periods, in any order. [[$LET]] '''3.2 = "TRUE"''' is also perfectly valid, but [[$LET]] '''3.2 = ""TRUE""''' will error because of the double quotes. +* Variable names must follow QB64's variable naming conventions. +* You can check a precompiler variable against special values '''DEFINED''' and '''UNDEFINED''', in order to assess whether the variable has already been assigned a value. Useful for code in libraries which may be repeated. +* The precompiler comes with some preset values which can be used to help determine which code blocks to include/exclude. These are: +** '''WIN''' or '''WINDOWS''' if the user is running QB64 in a Windows environment. +** '''LINUX''' if the user is running QB64 in a Linux environment. +** '''MAC''' or '''MACOSX''' if the user is running QB64 in a macOS environment. +** '''32BIT''' if the user is running a 32-bit version of QB64. +** '''64BIT''' if the user is running a 64-bit version of QB64. +** '''VERSION''', which is set to the version of the QB64 compiler. {{PageExamples}} @@ -23,8 +30,8 @@ * [[$ELSE]] * [[$ELSEIF]] * [[$END IF]] -* [[Cavemen]] {{PageNavigation}} +[[Category:Latest]] diff --git a/internal/help/$NOPREFIX_$11111111.txt b/internal/help/$NOPREFIX_$11111111.txt index 28cafae1d..53b473daf 100644 --- a/internal/help/$NOPREFIX_$11111111.txt +++ b/internal/help/$NOPREFIX_$11111111.txt @@ -1,5 +1,5 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:09:37}} +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:39:01}} The [[$NOPREFIX]] metacommand allows all QB64 functions and statements to be used without the leading underscore (_). @@ -13,7 +13,8 @@ The [[$NOPREFIX]] metacommand allows all QB64 functions and statements to be use * If you are writing new code with QB64, and not importing code from QBasic/QuickBASIC 4.5, [[$NOPREFIX]] allows you to reduce typing by not having to use underscores in modern keywords. * '''SUB _GL''' still must be prefixed. * When [[$NOPREFIX]] is used, QB64 keywords can be used both with or without the leading underscore, so that both [[_DISPLAY]] and [[_DISPLAY|DISPLAY]] are valid in the same program, for example. -* [[$NOPREFIX]] must be the first line in a program. +* [[$NOPREFIX]] must be the first non-comment and non-whitespace line in a program. +** Since QB64 2.0 respectively QBPE 0.5 [[$NOPREFIX]] can be placed anywhere in a program. {{PageAvailability}} @@ -28,3 +29,4 @@ The [[$NOPREFIX]] metacommand allows all QB64 functions and statements to be use {{PageNavigation}} +[[Category:Latest]] diff --git a/internal/help/$RESIZE_$111111.txt b/internal/help/$RESIZE_$111111.txt index 9503913cb..728d1bc64 100644 --- a/internal/help/$RESIZE_$111111.txt +++ b/internal/help/$RESIZE_$111111.txt @@ -1,5 +1,5 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:10:13}} +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:39:36}} The [[$RESIZE]] [[Metacommand|metacommand]] determines if a program window can be resized by the user. @@ -14,8 +14,9 @@ The [[$RESIZE]] [[Metacommand|metacommand]] determines if a program window can b * $RESIZE:SMOOTH the screen will be stretched also, but with linear filtering applied to the pixels. -==Availability== -* '''Version 1.000 and up'''. +{{PageAvailability}} +* '''QB64 1.0 and up''' (QB64 Team) +* '''QBPE 0.5 and up''' (QB64 Phoenix Edition) {{PageExamples}} @@ -115,3 +116,4 @@ DO {{PageNavigation}} +[[Category:Latest]] diff --git a/internal/help/$SCREENHIDE_$1111111111.txt b/internal/help/$SCREENHIDE_$1111111111.txt index 01fb97da1..3923c55b2 100644 --- a/internal/help/$SCREENHIDE_$1111111111.txt +++ b/internal/help/$SCREENHIDE_$1111111111.txt @@ -1,5 +1,5 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:10:28}} +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:39:49}} The [[$SCREENHIDE]] [[Metacommand|metacommand]] can be used to hide the main program window throughout a program. @@ -26,7 +26,7 @@ The [[$SCREENHIDE]] [[Metacommand|metacommand]] can be used to hide the main pro {{Cl|DIM}} s1 {{Cl|AS}} {{Cl|STRING}} s0 = "Text" + {{Cl|CHR$}}(0) s1 = "Caption" + {{Cl|CHR$}}(0) -ExitProcess MessageBoxA(0, {{Cl|_OFFSET (function)|_OFFSET}}(s0), {{Cl|_OFFSET(function)|_OFFSET}}(s1), 0) +ExitProcess MessageBoxA(0, {{Cl|_OFFSET (function)|_OFFSET}}(s0), {{Cl|_OFFSET (function)|_OFFSET}}(s1), 0) {{CodeEnd}}{{small|Code by Michael Calkins}} @@ -38,3 +38,4 @@ ExitProcess MessageBoxA(0, {{Cl|_OFFSET (function)|_OFFSET}}(s0), {{Cl|_OFFSET(f {{PageNavigation}} +[[Category:Latest]] diff --git a/internal/help/$SCREENSHOW_$1111111111.txt b/internal/help/$SCREENSHOW_$1111111111.txt index 09c5b4b40..66f3beee7 100644 --- a/internal/help/$SCREENSHOW_$1111111111.txt +++ b/internal/help/$SCREENSHOW_$1111111111.txt @@ -1,21 +1,25 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:10:36}} -{{DISPLAYTITLE:_SCREENSHOW}} -The [[_SCREENSHOW]] statement can be used to display the main program window in a section of code. +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:39:56}} +The [[$SCREENSHOW]] [[Metacommand|metacommand]] can be used to display the main program window throughout the program. {{PageSyntax}} -: [[_SCREENSHOW]] +: $SCREENSHOW {{PageDescription}} -* [[_SCREENHIDE]] or [[$SCREENHIDE]] must be used before _SCREENSHOW or [[$SCREENSHOW]] can be used! +* The metacommand is intended to be used in a modular program when a screen surface is necessary in one or more modules. +* $SCREENSHOW can only be used after [[$SCREENHIDE]] or [[_SCREENHIDE]] have been used in another program module. +* If [[$SCREENHIDE]] and then [[$SCREENSHOW]] are used in the same program module the window will not be hidden. +* '''QB64 [[Metacommand|metacommand]]s cannot be commented out with [[apostrophe]] or [[REM]].''' {{PageSeeAlso}} -* [[$SCREENHIDE]], [[$SCREENSHOW]], [[$CONSOLE]] (QB64 [[Metacommand]]s) -* [[_SCREENHIDE]], [[_CONSOLE]] +* [[$CONSOLE]], [[$SCREENHIDE]] (QB64 [[Metacommand]]s) +* [[_SCREENHIDE]], [[_SCREENSHOW]] +* [[_CONSOLE]] {{PageNavigation}} +[[Category:Latest]] diff --git a/internal/help/$STATIC_$111111.txt b/internal/help/$STATIC_$111111.txt index 295b692ee..41e945d68 100644 --- a/internal/help/$STATIC_$111111.txt +++ b/internal/help/$STATIC_$111111.txt @@ -1,20 +1,21 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:16:45}} -The '''$STATIC''' Metacommand allows the creation of STATIC(un-changeable) arrays. - +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:45:04}} +The [[$STATIC]] [[Metacommand|metacommand]] allows the creation of static (unresizable) arrays. {{PageSyntax}} -::: REM '''$STATIC''' +:{[[REM]] | [[apostrophe|']] } [[$STATIC]] +{{PageDescription}} * QBasic [[Metacommand]]s require a REM or apostrophy (') before them and are normally placed at the start of the main module. * Static arrays cannot be resized. If a variable is used to size any array, it becomes [[$DYNAMIC]]. -* A [[REDIM]] statement has no effect on [[$STATIC]] arrays except perhaps a [[ERROR Codes|duplicate definition error]] at the [[REDIM]] code. +* A [[REDIM]] statement has no effect on [[$STATIC]] arrays except perhaps a [[ERROR Codes|duplicate definition error]] at the [[REDIM]] statement. * The array's type cannot be changed once [[DIM]] and a literal value sets the dimensions and element size. * [[$STATIC]] defined program [[arrays]] cannot be [[REDIM|re-sized]] or use [[_PRESERVE]]. +{{PageExamples}} ''Example:'' When a variable is used, the array can be resized despite $STATIC. The array becomes [[$DYNAMIC]]. {{CodeStart}} '{{Cl|$STATIC}} @@ -29,10 +30,11 @@ The '''$STATIC''' Metacommand allows the creation of STATIC(un-changeable) array : ''Note:'' [[DIM]] using a literal numerical size will create a Duplicate definition error. -''See also:'' +{{PageSeeAlso}} * [[$DYNAMIC]], [[STATIC]] * [[Arrays]], [[Metacommand]] {{PageNavigation}} +[[Category:Latest]] diff --git a/internal/help/$VERSIONINFO_$11111111111.txt b/internal/help/$VERSIONINFO_$11111111111.txt index aea3abfba..9f8a6e82f 100644 --- a/internal/help/$VERSIONINFO_$11111111111.txt +++ b/internal/help/$VERSIONINFO_$11111111111.txt @@ -1,6 +1,5 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:11:32}} -{{DISPLAYTITLE:$VERSIONINFO}} +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:40:46}} The [[$VERSIONINFO]] [[Metacommand|metacommand]] adds text metadata to the resulting executable for identification purposes across the OS. Windows-only. @@ -8,15 +7,16 @@ The [[$VERSIONINFO]] [[Metacommand|metacommand]] adds text metadata to the resul : [[$VERSIONINFO]]:{{Parameter|key}}={{Parameter|value}} -{{Parameters}} +{{PageParameters}} * Text ''keys'' can be: '''Comments, CompanyName, FileDescription, FileVersion, InternalName, LegalCopyright, LegalTrademarks, OriginalFilename, ProductName, ProductVersion, Web''' * Numeric {{Parameter|keys}} can be:'''FILEVERSION#''' and '''PRODUCTVERSION#''' -**When provided, the numerical keys '''FILEVERSION#''' and '''PRODUCTVERSION#''' will also provide values to the text keys '''FileVersion''' and '''ProductVersion,''' if the text versions are not provided separately. (Phoenix Edition v0.6.0 and above) +**When provided, the numerical keys '''FILEVERSION#''' and '''PRODUCTVERSION#''' will also provide values to the text keys '''FileVersion''' and '''ProductVersion,''' if the text versions are not provided separately. (QBPE 0.6 and up (QB64 Phoenix Edition)) {{PageDescription}} * Text and numerical values are string literals without quotes entered by programmer. '''No variables are accepted.''' (variable names would be interpreted as literals). * Numeric key=''value'' must be 4 comma-separated numerical text values entered by programmer which usually stand for major, minor, revision and build numbers). +* A manifest file is automatically embedded into the resulting .exe file so that Common Controls v6.0 gets linked at runtime, if required. * [[Keywords_currently_not_supported_by_QB64#Keywords_Not_Supported_in_Linux_or_MAC_OSX_versions|Not available in Linux or macOS]]. @@ -42,3 +42,4 @@ The [[$VERSIONINFO]] [[Metacommand|metacommand]] adds text metadata to the resul {{PageNavigation}} +[[Category:Latest]] diff --git a/internal/help/$VIRTUALKEYBOARD_$111111111111111.txt b/internal/help/$VIRTUALKEYBOARD_$111111111111111.txt index a3ea52349..146279e2c 100644 --- a/internal/help/$VIRTUALKEYBOARD_$111111111111111.txt +++ b/internal/help/$VIRTUALKEYBOARD_$111111111111111.txt @@ -1,29 +1,31 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:11:34}} -{{DISPLAYTITLE:$VIRTUALKEYBOARD}} -[DEPRACATED] The [[$VIRTUALKEYBOARD]] [[Metacommand|metacommand]] turns the virtual keyboard ON or OFF. +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:40:48}} +The ({{Text|now deprecated|red}}) '''$VIRTUALKEYBOARD''' [[metacommand]] did turn the virtual keyboard ON or OFF. {{PageSyntax}} -: [[$VIRTUALKEYBOARD]]:{ON|OFF} +: '''$VIRTUALKEYBOARD:ON''' +: '''$VIRTUALKEYBOARD:OFF''' {{PageDescription}} -* Places a virtual keyboard on screen, which can be used in touch-enabled devices like Windows tablets. -* Depracated. +* This metacommand did not require a comment ''[[Apostrophe|']]'' or [[REM]] before it. There was no space between the metacommand name, the colon and the ON/OFF parameter. +* It placed a virtual keyboard on screen, which could be used in touch-enabled devices like Windows tablets. +* {{Text|Deprecated|red}}, in all current versions of QB64 it just generates a warning now, but has no other effect anymore. {{PageExamples}} {{CodeStart}} -{{Cl|$VIRTUALKEYBOARD}}:ON +{{Cl|$VIRTUALKEYBOARD|$VIRTUALKEYBOARD:ON}} {{Cl|DO}}: {{Cl|LOOP}} {{Cl|UNTIL}} {{Cl|INKEY$}} = {{Cl|CHR$}}(27) {{CodeEnd}} {{PageSeeAlso}} -* [[Metacommand]]s +* [[Metacommand]] {{PageNavigation}} +[[Category:Final]] diff --git a/internal/help/%26B_%261.txt b/internal/help/%26B_%261.txt index fb405277d..40cf77283 100644 --- a/internal/help/%26B_%261.txt +++ b/internal/help/%26B_%261.txt @@ -1,141 +1,59 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:24:48}} -The '''&B''' prefix denotes that an integer value is expressed in a binary base 2 format using '''QB64''' only. +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:54:02}} +The [[&B]] prefix denotes that an integer value is expressed in a Binary base 2 format. Every 8 digits represent a [[_BYTE]]. -{{PageSyntax}} -:::: a& = '''&B1110110000111111''' +{{PageSyntax}} +: {{Parameter|a&}} = [[&B]]10010110 -* The base 2 numbering system uses binary digit values of 1 or 0, or bits on or bits off in computer register switches or memory. -* Leading zero values '''can''' be omitted as they add nothing to the byte return value. -* Eight binary digits would represent a one byte value ranging from 0 to 255. Four digit values("nibbles") range from 0 to 15. -* Decimal values returned can be any '''signed''' [[INTEGER]], [[LONG]] integer, or [[_INTEGER64]] value so use those type of variables when converting directly as shown in the Syntax. The program [[ERROR Codes|"overflow"]] error limits are listed as: -** [[INTEGER]]: 16 binary digits or a decimal value range from -32,768 to 32,767 -** [[LONG]]: 32 binary digits or a decimal value range from -2,147,483,648 to 2,147,483,647 -** [[_INTEGER64]]: 64 binary digits or decimal values from -9,223,372,036,854,775,808 to 9,223,372,036,854,775,807. -* [[LONG]] values can be returned by appending the & or ~%([[_UNSIGNED]] [[INTEGER]]) symbols after the binary number. -* [[VAL]] can be used to convert "&B" prefixed string values to decimal. - -
'''[[_BIT|BITS]]'''
-* The '''MSB''' is the most significant(largest) bit value and '''LSB''' is the least significant bit of a binary or register memory address value. The order in which the bits are read determines the binary or decimal byte value. There are two common ways to read a byte: - -:* '''"Big-endian"''': MSB is the first bit encountered, decreasing to the LSB as the last bit by position, memory address or time. -:* '''"Little-endian"''': LSB is the first bit encountered, increasing to the MSB as the last bit by position, memory address or time. -{{WhiteStart}} - '''Offset or Position: 0 1 2 3 4 5 6 7 Example: 11110000''' - ---------------------------------- -------- - '''Big-Endian Bit On Value:''' 128 64 32 16 8 4 2 1 240 - '''Little-Endian Bit On Value:''' 1 2 4 8 16 32 64 128 15 -{{WhiteEnd}} -::The big-endian method compares exponents of 27 down to 20 while the little-endian method does the opposite. - -
'''[[_BYTE|BYTES]]'''
-* [[INTEGER]] values consist of 2 bytes called the '''HI''' and '''LO''' bytes. Anytime that the number of binary digits is a multiple of 16 (2bytes, 4 bytes, etc.) and the HI byte's MSB is on(1), the value returned will be negative. Even with [[SINGLE]] or [[DOUBLE]] values! -{{WhiteStart}} '''16 BIT INTEGER OR REGISTER''' - '''AH (High Byte Bits) AL (Low Byte Bits)''' - BIT: 15 14 13 12 11 10 9 8 | 7 6 5 4 3 2 1 0 - ---------------------------------------|-------------------------------------- - HEX: 8000 4000 2000 1000 800 400 200 100 | 80 40 20 10 8 4 2 1 - | - DEC: -32768 16384 8192 4096 2048 1024 512 256 | 128 64 32 16 8 4 2 1 -{{WhiteEnd}} -::The HI byte's '''MSB''' is often called the '''sign''' bit! When all 16 of the integer binary bits are on, the decimal return is -1. +{{PageDescription}} +* The base 2 numbering system uses binary digit values of 0 and 1 only. +* Leading zero values can be omitted just like in decimal values as they add nothing to the return value. +* Decimal values returned can be any '''signed''' [[INTEGER]], [[LONG]] integer, or [[_INTEGER64]] value so use those type of variables when converting directly as shown above in the Syntax. The program [[ERROR Codes|"overflow"]] error limits are listed as: +:* [[_BYTE]]: 8 binary digits or a decimal value range from -128 to 127. [[_UNSIGNED]]: 0 to 255. +:* [[INTEGER]]: 16 binary digits or a decimal value range from -32,768 to 32,767. [[_UNSIGNED]]: 0 to 65535. +:* [[LONG]]: 32 binary digits or a decimal value range from -2,147,483,648 to 2,147,483,647. [[_UNSIGNED]]: 0 to 4294967295. +:* [[_INTEGER64]]: 64 binary digits or decimal values from -9,223,372,036,854,775,808 to 9,223,372,036,854,775,807. +:* [[_UNSIGNED]] [[_INTEGER64]]: 0 to 18446744073709551615. +* The maximum binary value for each numerical type is the maximum number of digits listed above, each valued at '''1'''. +* Convert binary to [[LONG]] values by appending the values with the suffix '''&'''. Example: [[&B]]1000000000000000 = -32768: [[&B]]1000000000000000'''&''' = 32768 +* To convert binary strings returned from [[_BIN$]] with [[VAL]] you need to prefix the string with [[&B]] (for example, if the string is "1101" you should do {{InlineCode}}{{Cl|VAL}}("&B1101"){{InlineCodeEnd}} or {{InlineCode}}{{Cl|VAL}}("&B" + binvalue$){{InlineCodeEnd}}. -{{TextStart}} '''Comparing the Base Numbering Systems''' - - '''Decimal (base 10) Binary (base 2) Hexadecimal (base 16) Octal (base 8)''' - - 0 0000 0 0 - 1 0001 1 1 - 2 0010 2 2 - 3 0011 3 3 - 4 0100 4 4 - 5 0101 5 5 - 6 0110 6 6 - 7 0111 7 7 -- maxed - 8 1000 8 10 - maxed-- 9 1001 9 11 - 10 1010 A 12 - 11 1011 B 13 - 12 1100 C 14 - 13 1101 D 15 - 14 1110 E 16 - 15 ------------- 1111 <--- Match ---> F ---------------- 17 -- max 2 - 16 10000 10 20 - - When the Decimal value is 15, the other 2 base systems are all maxed out! - The Binary values can be compared to all of the HEX value digit values so - it is possible to convert between the two quite easily. To convert a HEX - value to Binary just add the 4 binary digits for each HEX digit place so: - - F A C E - &HFACE = 1111 + 1010 + 1100 + 1101 = &B1111101011001101 - - To convert a Binary value to HEX you just need to divide the number into - sections of four digits starting from the right(LSB) end. If one has less - than 4 digits on the left end you could add the leading zeros like below: - - &B101011100010001001 = 0010 1011 1000 1000 1001 - hexadecimal = 2 + B + 8 + 8 + 9 = &H2B889 - - See the Decimal to Binary conversion function that uses '''[[HEX$]]''' on the '''[[&H]]''' page. - -{{TextEnd}} - - -''Example 1:'' A Decimal to Binary [[STRING]] function that does not return leading zeroes. +{{PageExamples}} +;Example 1:The maximum binary values of decimal value -1 in each numerical type are: {{CodeStart}} -{{Cl|PRINT}} BIN$(255) '1 byte(8 bits) maximum -{{Cl|PRINT}} BIN$(32767) 'integer(2 byte, 15 bits) maximum -{{Cl|PRINT}} BIN$(-32768) 'integer(2 byte, 16 bits) minimum -{{Cl|PRINT}} BIN$(-1) 'all 16 bits on - -{{Cl|FUNCTION}} BIN$ (n%) - max% = 8 * {{Cl|LEN}}(n%) ': MSB% = 1 'uncomment for 16 (32 or 64) bit returns - {{Cl|FOR...NEXT|FOR}} i = max% - 1 {{Cl|TO}} 0 {{Cl|STEP}} -1 'read as big-endian MSB to LSB - {{Cl|IF...THEN|IF}} (n% {{Cl|AND (boolean)|AND}} 2 ^ i) {{Cl|THEN}} MSB% = 1: B$ = B$ + "1" {{Cl|ELSE}} {{Cl|IF...THEN|IF}} MSB% {{Cl|THEN}} B$ = B$ + "0" - {{Cl|NEXT}} -{{Cl|IF...THEN|IF}} B$ = "" {{Cl|THEN}} BIN$ = "0" {{Cl|ELSE}} BIN$ = B$ 'check for empty string -{{Cl|END FUNCTION}} -{{CodeEnd}} -{{small|Code by Ted Weissgerber}} -{{OutputStart}} -11111111 -111111111111111 -1000000000000000 -1111111111111111 -{{OutputEnd}} -''Note:'' The The MSB% flag allows zeroes to be added. Uncomment the MSB% = 1 statement for returns with leading zeroes. - - -''Example 2:'' QB64 converts the binary values from the example above to [[INTEGER]] decimal values automatically. -{{CodeStart}} -{{Cl|DEFLNG}} A-Z -a = &B11111111 -b = &B111111111111111 -c = &B1000000000000000 '& 'or ~% -d = &B1111111111111111 '& 'or ~% - -{{Cl|PRINT}} a, b, c, d +c&& = -1: d& = -1: e% = -1: f%% = -1 +bi$ = {{Cl|_BIN$}}(f%%) +{{Cl|PRINT}} "Max binary {{Cl|_BYTE}} = "; bi$; " with"; {{Cl|LEN}}(bi$); "digits ="; {{Cl|VAL}}("{{Cl|&B}}" + bi$) +bi$ = {{Cl|_BIN$}}(e%) +{{Cl|PRINT}} "Max binary {{Cl|INTEGER}} = "; bi$; " with"; {{Cl|LEN}}(bi$); "digits ="; {{Cl|VAL}}("{{Cl|&B}}" + bi$) +bi$ = {{Cl|_BIN$}}(d&) +{{Cl|PRINT}} "Max binary {{Cl|LONG}} = "; bi$; " with"; {{Cl|LEN}}(bi$); "digits ="; {{Cl|VAL}}("{{Cl|&B}}" + bi$) +bi$ = {{Cl|_BIN$}}(c&&) +{{Cl|PRINT}} "Max binary {{Cl|_INTEGER64}} = "; bi$; " with"; {{Cl|LEN}}(bi$); "digits ="; {{Cl|VAL}}("{{Cl|&B}}" + bi$) +bi$ = {{Cl|_BIN$}}(9223372036854775807) +{{Cl|PRINT}} "Max {{Cl|_INTEGER64}} value = "; bi$; " with"; {{Cl|LEN}}(bi$); "digits" +bi$ = {{Cl|_BIN$}}(-9223372036854775808) +{{Cl|PRINT}} "Min {{Cl|_INTEGER64}} value = "; bi$; " with"; {{Cl|LEN}}(bi$); "digits" {{CodeEnd}} {{OutputStart}} -255 32767 -32768 -1 +Max binary _BYTE = 11111111 with 8 digits = 255 +Max binary INTEGER = 1111111111111111 with 16 digits = 65535 +Max binary LONG = 11111111111111111111111111111111 with 32 digits = 4294967295 +Max binary _INTEGER64 = 1111111111111111111111111111111111111111111111111111111111111111 with 64 digits =-1 +Max _INTEGER64 value = 111111111111111111111111111111111111111111111111111111111111111 with 63 digits +Min _INTEGER64 value = 1000000000000000000000000000000000000000000000000000000000000000 with 64 digits {{OutputEnd}} -:''Bonus example:'' Add an '''&''' symbol after the negative binary numbers to see the [[LONG]] decimal values below. -{{OutputStart}} -255 32767 32768 65535 -{{OutputEnd}} -: ''Note:'' The [[LONG]] values returned are the same as the values you can get using [[_UNSIGNED]] [[INTEGER]] (~%). {{PageSeeAlso}} -* [[_BIT]], [[_BYTE]] -* [[_SHL]], [[_SHR]] -* [[OCT$]], [[&O]] {{text|(octal)}} -* [[HEX$]], [[&H]] {{text|(hexadecimal)}} +* [[_BIN$]], [[HEX$]], [[OCT$]], [[STR$]] +* [[&H]] (hexadecimal), [[&O]] (octal), [[VAL]] +* [[Base Comparisons]] {{PageNavigation}} +[[Category:Final]] diff --git a/internal/help/%26H_%261.txt b/internal/help/%26H_%261.txt index 67ca32109..198b5464a 100644 --- a/internal/help/%26H_%261.txt +++ b/internal/help/%26H_%261.txt @@ -1,29 +1,31 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:24:51}} -The '''&H''' prefix denotes that an integer value is expressed in a Hexadecimal base 16 format. Every 2 digits represent a [[_BYTE]]. +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:54:05}} +The [[&H]] prefix denotes that an integer value is expressed in a Hexadecimal base 16 format. Every 2 digits represent a [[_BYTE]]. -{{PageSyntax}} -:::: a& = &HFACE +{{PageSyntax}} +: {{Parameter|a&}} = [[&H]]C0DEBA5E -* The base 16 numbering system uses hexadecimal digit values of 0 to F. A = 10, B = 11, C = 12, D = 13, E = 14 and F = 15. +{{PageDescription}} +* The base 16 numbering system uses hexadecimal digit values of 0 to F, where '''A''' = 10, '''B''' = 11, '''C''' = 12, '''D''' = 13, '''E''' = 14 and '''F''' = 15. * Leading zero values can be omitted just like in decimal values as they add nothing to the return value. * Decimal values returned can be any '''signed''' [[INTEGER]], [[LONG]] integer, or [[_INTEGER64]] value so use those type of variables when converting directly as shown above in the Syntax. The program [[ERROR Codes|"overflow"]] error limits are listed as: -::* [[_BYTE]]: 2 hex digits or a decimal value range from -128 to 127. [[_UNSIGNED]]: 0 to 255. -::* [[INTEGER]]: 4 hex digits or a decimal value range from -32,768 to 32,767. [[_UNSIGNED]]: 0 to 65535. -::* [[LONG]]: 8 hex digits or a decimal value range from -2,147,483,648 to 2,147,483,647. [[_UNSIGNED]]: 0 to 4294967295. -::* [[_INTEGER64]]: 16 hex digits or decimal values from -9,223,372,036,854,775,808 to 9,223,372,036,854,775,807. -::* [[_UNSIGNED]] [[_INTEGER64]]: 0 to 18446744073709551615. -* The maximum hexadecimal value for each numerical type is the maximum number of digits listed above, each valued at F. -* Convert hexadecimal to [[LONG]] values by appending the values with &. Example: &H8000 = -32768: &H8000& = 32768 -* [[LONG]] 32 bit [[_RGB]] values can be made using hexadecimal values from '''&HFF{{text|00|red}}{{text|00|green}}{{text|00|blue}}''' to '''&HFF{{text|FF|red}}{{text|FF|green}}{{text|FF|blue}}''' with full [[_ALPHA]] only. -* [[LONG]] 32 bit [[_RGBA]] values can be made using hexadecimal values from '''&H00{{text|00|red}}{{text|00|green}}{{text|00|blue}}''' to '''&HFF{{text|FF|red}}{{text|FF|green}}{{text|FF|blue}}''' with any [[_ALPHA]]. -* Hexadecimal '''0x''' is often used to prefix [[HEX$]] port addresses in documentation. Replace 0x with [[&H]] in QB64 or QBasic. -* To convert hex strings returned from [[HEX$]] with [[VAL]] you need to prefix the string with &H (for example; if the string is "FF" you should do VAL("&HFF") or VAL("&H" + hexvalue$). +:* [[_BYTE]]: 2 hex digits or a decimal value range from -128 to 127. [[_UNSIGNED]]: 0 to 255. +:* [[INTEGER]]: 4 hex digits or a decimal value range from -32,768 to 32,767. [[_UNSIGNED]]: 0 to 65535. +:* [[LONG]]: 8 hex digits or a decimal value range from -2,147,483,648 to 2,147,483,647. [[_UNSIGNED]]: 0 to 4294967295. +:* [[_INTEGER64]]: 16 hex digits or decimal values from -9,223,372,036,854,775,808 to 9,223,372,036,854,775,807. +:* [[_UNSIGNED]] [[_INTEGER64]]: 0 to 18446744073709551615. +* The maximum hexadecimal value for each numerical type is the maximum number of digits listed above, each valued at '''F'''. +* Convert hexadecimal to [[LONG]] values by appending the values with the suffix '''&'''. Example: [[&H]]8000 = -32768: [[&H]]8000'''&''' = 32768 +* [[LONG]] 32 bit [[_RGB]] values can be made using hexadecimal values from '''&HFF{{Text|00|red}}{{Text|00|green}}{{Text|00|blue}}''' to '''&HFF{{Text|FF|red}}{{Text|FF|green}}{{Text|FF|blue}}''' with full [[_ALPHA]] only. +* [[LONG]] 32 bit [[_RGBA]] values can be made using hexadecimal values from '''&H00{{Text|00|red}}{{Text|00|green}}{{Text|00|blue}}''' to '''&HFF{{Text|FF|red}}{{Text|FF|green}}{{Text|FF|blue}}''' with any [[_ALPHA]]. +* Hexadecimal '''0x''' is often used to prefix [[HEX$]] port addresses in documentation. Replace '''0x''' with [[&H]] in QB64 or QBasic. +* To convert hexadecimal strings returned from [[HEX$]] with [[VAL]] you need to prefix the string with [[&H]] (for example, if the string is "FF" you should do {{InlineCode}}{{Cl|VAL}}("&HFF"){{InlineCodeEnd}} or {{InlineCode}}{{Cl|VAL}}("&H" + hexvalue$){{InlineCodeEnd}}. -''Example 1:'' The maximum octal values of decimal value -1 in each numerical type are: +{{PageExamples}} +;Example 1:The maximum hexadecimal values of decimal value -1 in each numerical type are: {{CodeStart}} c&& = -1: d& = -1: e% = -1: f%% = -1 hx$ = {{Cl|HEX$}}(f%%) @@ -37,9 +39,10 @@ hx$ = {{Cl|HEX$}}(c&&) hx$ = {{Cl|HEX$}}(9223372036854775807) {{Cl|PRINT}} "Max {{Cl|_INTEGER64}} value = "; hx$; " with"; {{Cl|LEN}}(hx$); "digits" hx$ = {{Cl|HEX$}}(-9223372036854775808) -{{Cl|PRINT}} "Min {{Cl|_INTEGER64}} value = "; hx$; " with"; {{Cl|LEN}}(hx$); "digits" +{{Cl|PRINT}} "Min {{Cl|_INTEGER64}} value = "; hx$; " with"; {{Cl|LEN}}(hx$); "digits" {{CodeEnd}} -{{OutputStart}}Max hex _BYTE = FF with 2 digits = 255 +{{OutputStart}} +Max hex _BYTE = FF with 2 digits = 255 Max hex INTEGER = FFFF with 4 digits = 65535 Max hex LONG = FFFFFFFF with 8 digits = 4294967295 Max hex _INTEGER64 = FFFFFFFFFFFFFFFF with 16 digits =-1 @@ -48,43 +51,46 @@ Min _INTEGER64 value = 8000000000000000 with 16 digits {{OutputEnd}} -''Example 2:'' Converting a decimal number to a binary string value using [[HEX$]]. +;Example 2:Converting a decimal number to a binary string value using [[HEX$]]. {{CodeStart}} -FUNCTION BIN$ (n&) +{{Cl|FUNCTION}} BIN$ (n&) h$ = {{Cl|HEX$}}(n&) 'get hexadecimal string value - FOR i = 1 TO {{Cl|LEN}}(h$) 'scan the HEX$ digits - SELECT CASE {{Cl|MID$}}(h$, i, 1) 'read each HEX$ digit - CASE "0": b$ = b$ + "0000" - CASE "1": b$ = b$ + "0001" - CASE "2": b$ = b$ + "0010" - CASE "3": b$ = b$ + "0011" - CASE "4": b$ = b$ + "0100" - CASE "5": b$ = b$ + "0101" - CASE "6": b$ = b$ + "0110" - CASE "7": b$ = b$ + "0111" - CASE "8": b$ = b$ + "1000" - CASE "9": b$ = b$ + "1001" - CASE "A": b$ = b$ + "1010" - CASE "B": b$ = b$ + "1011" - CASE "C": b$ = b$ + "1100" - CASE "D": b$ = b$ + "1101" - CASE "E": b$ = b$ + "1110" - CASE "F": b$ = b$ + "1111" - END SELECT - NEXT i - b$ = {{Cl|RIGHT$}}(b$, LEN(b$) - {{Cl|INSTR}}(b$, "1") + 1) 'eliminate leading zeroes - IF {{Cl|VAL}}(b$) THEN BIN$ = b$ ELSE BIN$ = "0" 'return zero if n& = 0 -END FUNCTION + {{Cl|FOR}} i = 1 {{Cl|TO}} {{Cl|LEN}}(h$) 'scan the HEX$ digits + {{Cl|SELECT CASE}} {{Cl|MID$}}(h$, i, 1) 'read each HEX$ digit + {{Cl|CASE}} "0": b$ = b$ + "0000" + {{Cl|CASE}} "1": b$ = b$ + "0001" + {{Cl|CASE}} "2": b$ = b$ + "0010" + {{Cl|CASE}} "3": b$ = b$ + "0011" + {{Cl|CASE}} "4": b$ = b$ + "0100" + {{Cl|CASE}} "5": b$ = b$ + "0101" + {{Cl|CASE}} "6": b$ = b$ + "0110" + {{Cl|CASE}} "7": b$ = b$ + "0111" + {{Cl|CASE}} "8": b$ = b$ + "1000" + {{Cl|CASE}} "9": b$ = b$ + "1001" + {{Cl|CASE}} "A": b$ = b$ + "1010" + {{Cl|CASE}} "B": b$ = b$ + "1011" + {{Cl|CASE}} "C": b$ = b$ + "1100" + {{Cl|CASE}} "D": b$ = b$ + "1101" + {{Cl|CASE}} "E": b$ = b$ + "1110" + {{Cl|CASE}} "F": b$ = b$ + "1111" + {{Cl|END SELECT}} + {{Cl|NEXT}} i + b$ = {{Cl|RIGHT$}}(b$, {{Cl|LEN}}(b$) - {{Cl|INSTR}}(b$, "1") + 1) 'eliminate leading zeroes + {{Cl|IF}} {{Cl|VAL}}(b$) {{Cl|THEN}} BIN$ = b$ {{Cl|ELSE}} BIN$ = "0" 'return zero if n& = 0 +{{Cl|END FUNCTION}} {{CodeEnd}} {{small|Code by CodeGuy}} -:''Explanation:'' Hexadecimal digits can be any value up to 15 which also corresponds to all four bits on in binary. The function above just adds every four bit binary string value together to return the binary value. After they are concatenated, the leading bit on is found by [[INSTR]] and everything from that point is kept removing the leading "0"'s. +;Explanation: Hexadecimal digits can be any value up to 15 which also corresponds to all four bits on in binary. The function above just adds every four bit binary string value together to return the binary value. After they are concatenated, the leading bit on is found by [[INSTR]] and everything from that point is kept removing the leading "0"'s. +;Note: Since QB64 2.1 (QB64 Team) respectively QBPE 0.5 (QB64 Phoenix Edition) the built-in [[_BIN$]] function should be used instead. -''See also:'' -* [[HEX$]], [[OCT$]] -* [[&B]] {{text|(binary)}}, [[&O]] {{text|(octal)}} +{{PageSeeAlso}} +* [[_BIN$]], [[HEX$]], [[OCT$]], [[STR$]] +* [[&B]] (binary), [[&O]] (octal), [[VAL]] * [[Base Comparisons]] +* [[HEX$ 32 Bit Values]] {{PageNavigation}} +[[Category:Final]] diff --git a/internal/help/%26O_%261.txt b/internal/help/%26O_%261.txt index 9a15b01b3..a6afba18e 100644 --- a/internal/help/%26O_%261.txt +++ b/internal/help/%26O_%261.txt @@ -1,22 +1,29 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:24:49}} -The '''&O''' prefix denotes that a integer value is expressed in an Octal base 8 format. +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:54:03}} +The [[&O]] prefix denotes that an integer value is expressed in a Octal base 8 format. {{PageSyntax}} -:::: a& = &O12345671234 +: {{Parameter|a&}} = [[&O]]377 -* The base eight numbering system only uses octal digit values of 0 to 7. -* Leading zero values '''can''' be omitted as they add nothing to the return value. -* Decimal values returned can be any '''signed''' [[INTEGER]], [[LONG]] integer, or [[_INTEGER64]] value so use those type of variables when converting directly as shown above. The program [[ERROR Codes|"overflow"]] error limits are listed as: -:: * [[INTEGER]]: 6 octal digits or a decimal value range from -32,768 to 32,767 -:: * [[LONG]]: 11 octal digits or a decimal value range from -2,147,483,648 to 2,147,483,647 -:: * [[_INTEGER64]]: 22 octal digits or decimal values from -9,223,372,036,854,775,808 to 9,223,372,036,854,775,807. -* [[LONG]] Octal values can be expressed by appending & after the number. Example: &O100000& = 32768 +{{PageDescription}} +* The base 8 numbering system uses octal digit values of 0 to 7 only. +* Leading zero values can be omitted just like in decimal values as they add nothing to the return value. +* Decimal values returned can be any '''signed''' [[INTEGER]], [[LONG]] integer, or [[_INTEGER64]] value so use those type of variables when converting directly as shown above in the Syntax. The program [[ERROR Codes|"overflow"]] error limits are listed as: +:* [[_BYTE]]: 3 octal digits or a decimal value range from -128 to 127. [[_UNSIGNED]]: 0 to 255. +:* [[INTEGER]]: 6 octal digits or a decimal value range from -32,768 to 32,767. [[_UNSIGNED]]: 0 to 65535. +:* [[LONG]]: 11 octal digits or a decimal value range from -2,147,483,648 to 2,147,483,647. [[_UNSIGNED]]: 0 to 4294967295. +:* [[_INTEGER64]]: 22 octal digits or decimal values from -9,223,372,036,854,775,808 to 9,223,372,036,854,775,807. +:* [[_UNSIGNED]] [[_INTEGER64]]: 0 to 18446744073709551615. +* The maximum octal value for each numerical type is the maximum number of digits listed above, each valued at '''7''' (except the first digit). +** If the maximum number of digits is used, then the first digit (usually the highest significant position) may not be maxed out to '''7''', but only up to '''3''' ([[_BYTE]] and [[LONG]]) and up to '''1''' ([[INTEGER]] and [[_INTEGER64]]). +* Convert octal to [[LONG]] values by appending the values with the suffix '''&'''. Example: [[&O]]100000 = -32768: [[&O]]100000'''&''' = 32768 +* To convert octal strings returned from [[OCT$]] with [[VAL]] you need to prefix the string with [[&O]] (for example, if the string is "377" you should do {{InlineCode}}{{Cl|VAL}}("&O377"){{InlineCodeEnd}} or {{InlineCode}}{{Cl|VAL}}("&O" + octvalue$){{InlineCodeEnd}}. -''Example:'' The maximum octal values of decimal value -1 in each numerical type are: +{{PageExamples}} +;Example 1:The maximum octal values of decimal value -1 in each numerical type are: {{CodeStart}} c&& = -1: d& = -1: e% = -1: f%% = -1 oc$ = {{Cl|OCT$}}(f%%) @@ -26,20 +33,28 @@ oc$ = {{Cl|OCT$}}(e%) oc$ = {{Cl|OCT$}}(d&) {{Cl|PRINT}} "Max octal {{Cl|LONG}} = "; oc$; " with"; {{Cl|LEN}}(oc$); "digits ="; {{Cl|VAL}}("{{Cl|&O}}" + oc$) oc$ = {{Cl|OCT$}}(c&&) -{{Cl|PRINT}} "Max octal {{Cl|_INTEGER64}} = "; oc$; " with"; {{Cl|LEN}}(oc$); "digits ="; {{Cl|VAL}}("{{Cl|&O}}" + oc$) +{{Cl|PRINT}} "Max octal {{Cl|_INTEGER64}} = "; oc$; " with"; {{Cl|LEN}}(oc$); "digits ="; {{Cl|VAL}}("{{Cl|&O}}" + oc$) +oc$ = {{Cl|OCT$}}(9223372036854775807) +{{Cl|PRINT}} "Max {{Cl|_INTEGER64}} value = "; oc$; " with"; {{Cl|LEN}}(oc$); "digits" +oc$ = {{Cl|OCT$}}(-9223372036854775808) +{{Cl|PRINT}} "Min {{Cl|_INTEGER64}} value = "; oc$; " with"; {{Cl|LEN}}(oc$); "digits" {{CodeEnd}} -{{OutputStart}}Max octal _BYTE = 377 with 3 digits = 255 +{{OutputStart}} +Max octal _BYTE = 377 with 3 digits = 255 Max octal INTEGER = 177777 with 6 digits = 65535 Max octal LONG = 37777777777 with 11 digits = 4294967295 Max octal _INTEGER64 = 1777777777777777777777 with 22 digits =-1 +Max _INTEGER64 value = 777777777777777777777 with 21 digits +Min _INTEGER64 value = 1000000000000000000000 with 22 digits {{OutputEnd}} -''See also:'' -* [[OCT$]], [[HEX$]], [[VAL]] -* [[&B]] (binary), [[&H]] (hexadecimal) +{{PageSeeAlso}} +* [[_BIN$]], [[HEX$]], [[OCT$]], [[STR$]] +* [[&B]] (binary), [[&H]] (hexadecimal), [[VAL]] * [[Base Comparisons]] {{PageNavigation}} +[[Category:Final]] diff --git a/internal/help/%2A_%21.txt b/internal/help/%2A_%21.txt index 22a338998..3be90ef1e 100644 --- a/internal/help/%2A_%21.txt +++ b/internal/help/%2A_%21.txt @@ -1,25 +1,23 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:24:53}} -The '''*''' mathematical operator performs the multiplication of two values. +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:54:07}} +The [[*]] mathematical operator performs the multiplication of two values. -''Syntax:'' return_value = number1 * number2 +{{PageSyntax}} +: {{Parameter|return_value}} = {{Parameter|number1}} [[*]] {{Parameter|number2}} {{PageDescription}} - * Multiplication can use any two literal or variable numerical type values. -* Multiplication of two negative numbers returns a positive result. One negative number will always return a negative value. +* Multiplication of two negative numbers returns a positive result. One negative number will always return a negative value. * Return values may exceed certain numerical variable type limits creating an [[ERROR Codes|"Overflow" error.]] * Division and multiplication operations are performed before addition and subtraction in QBasic's order of operations. - -''See also:'' - -[[Mathematical Operations]] - +{{PageSeeAlso}} +* [[Mathematical Operations]] {{PageNavigation}} +[[Category:Final]] diff --git a/internal/help/%2B_%21.txt b/internal/help/%2B_%21.txt new file mode 100644 index 000000000..5b4e5dcb9 --- /dev/null +++ b/internal/help/%2B_%21.txt @@ -0,0 +1,30 @@ +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:54:00}} +The '''+''' plus mathematical operator performs addition on two numerical values or [[concatenation|concatenate]] [[STRING]] values. + + + +''Syntax:'' return_value = number1 + number2 + + + +{{PageDescription}} +* A [[+]] sign also can indicate a positive numerical value, but it is not required. +* Numbers used can be any literal or variable numerical value type. +* Adding one negative value will actually perform subtraction on the other value. +* Adding two negative values will make the return value more negative. +* Addition and subtraction are the last operations performed in QBasic's normal order of operations. +* The [[+|plus(+)]] operator can also be used to add ([[concatenation|concatenate]]) literal or variable [[STRING]] values. +* [[PRINT]] can also use + operations on string values ONLY! Numerical values will need to be converted to strings first or be included using [[semicolon]]s or [[comma]]s instead. + + + +''See also:'' + +[[-|- minus]] (subtraction or [[negation]] operator) + +[[Mathematical Operations]] + + + +{{PageNavigation}} diff --git a/internal/help/%2F_%21.txt b/internal/help/%2F_%21.txt index 57acae287..0961ab356 100644 --- a/internal/help/%2F_%21.txt +++ b/internal/help/%2F_%21.txt @@ -1,30 +1,24 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:24:54}} -The '''/''' mathematical operator performs decimal point division on a numerical value. - +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:54:08}} +The [[/]] mathematical operator performs decimal point division on a numerical value. {{PageSyntax}} -::: return_value = number '''/''' divisor - +: {{Parameter|return_value}} = {{Parameter|number}} [[/]] {{Parameter|divisor}} {{PageDescription}} - * Number value can be any literal or variable numerical type. -* '''Divisor (second value) must not be a value of 0 to .5'''. This will create a [[ERROR Codes|"Division by zero" error!]] due to [[CINT]] rounding. * Return values can be any literal or variable numerical type, but [[SINGLE]] or [[DOUBLE]] type decimal point returns are likely. * Values returned may be expressed using exponential or [[scientific notation]] using '''E''' for SINGLE or '''D''' for DOUBLE precision. * Use the [[\|\ integer division]] operator to guarantee [[INTEGER]] or [[LONG]] return values. -* Division and multiplication operations are performed before addition and subtraction in Qbasic's order of operations. +* Division and multiplication operations are performed before addition and subtraction in QBasic's order of operations. -''See also:'' -* [[MOD|MOD (remainder division operator)]] -* [[\|\ (integer division operator)]] -* [[INT]], [[CINT]], [[FIX]], [[_ROUND]] +{{PageSeeAlso}} * [[Mathematical Operations]] {{PageNavigation}} +[[Category:Final]] diff --git a/internal/help/%5C_%51.txt b/internal/help/%5C_%51.txt index 2f3c1033e..c92db6196 100644 --- a/internal/help/%5C_%51.txt +++ b/internal/help/%5C_%51.txt @@ -1,25 +1,23 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:24:56}} -The '''\''' mathematical operator performs [[INTEGER]] division on a numerical value. - +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:54:09}} +The [[\]] mathematical operator performs [[INTEGER]] division on a numerical value. {{PageSyntax}} -::: return_value = number '''\''' divisor - +: {{Parameter|return_value}} = {{Parameter|number}} [[\]] {{Parameter|divisor}} {{PageDescription}} - * Number value can be any literal or variable numerical type. * '''Divisor (second value) must not be a value of 0 to .5'''. This will create a [[ERROR Codes|"Division by zero" error!]] due to [[CINT]] rounding. * Return values will be [[INTEGER]] or [[LONG]] value types only. * Rounding is done to the closest EVEN [[INTEGER|integer]] or [[LONG|long integer]] value. -* Use the [[/]] integer division operator for [[SINGLE]] or [[DOUBLE]] floating decimal point return values. +* Use the [[/|/ normal division]] operator for [[SINGLE]] or [[DOUBLE]] floating decimal point return values. * Division and multiplication operations are performed before addition and subtraction in QBasic's order of operations. -''Example:'' Displays how floating decimal point values are rounded to the closest even [[INTEGER|integer]] value. +{{PageExamples}} +;Example:Displays how floating decimal point values are rounded to the closest even [[INTEGER|integer]] value. {{CodeStart}} {{Cl|PRINT}} 0.5 \ 1 {{Cl|PRINT}} 1.5 \ 1 @@ -37,12 +35,10 @@ The '''\''' mathematical operator performs [[INTEGER]] division on a numerical v {{OutputEnd}} -''See also:'' -* [[MOD|MOD (remainder division operator)]] -* [[/|/ (normal division operator)]] -* [[INT]], [[CINT]], [[FIX]], [[_ROUND]] +{{PageSeeAlso}} * [[Mathematical Operations]] {{PageNavigation}} +[[Category:Final]] diff --git a/internal/help/-_-.txt b/internal/help/-_-.txt index 6bfc341d9..3dad9b83b 100644 --- a/internal/help/-_-.txt +++ b/internal/help/-_-.txt @@ -1,5 +1,5 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:24:52}} +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:54:06}} The '''-''' mathematical operator performs subtraction on two numerical values or [[negation|negates]] a single value. @@ -27,4 +27,3 @@ The '''-''' mathematical operator performs subtraction on two numerical values o {{PageNavigation}} - diff --git a/internal/help/ABS_111.txt b/internal/help/ABS_111.txt index e0289fa3c..d8c114754 100644 --- a/internal/help/ABS_111.txt +++ b/internal/help/ABS_111.txt @@ -1,5 +1,5 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:11:40}} +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:40:54}} The [[ABS]] function returns the unsigned numerical value of a variable or literal value. @@ -38,3 +38,4 @@ c = {{Cl|ABS}}(c) {{PageNavigation}} +[[Category:Latest]] diff --git a/internal/help/ACCESS_111111.txt b/internal/help/ACCESS_111111.txt index 798d73e8f..26bd18809 100644 --- a/internal/help/ACCESS_111111.txt +++ b/internal/help/ACCESS_111111.txt @@ -1,5 +1,5 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:11:42}} +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:40:56}} The [[OPEN]] statement is used to open a file or [[OPEN_COM|COM]] serial communications port for program input or output. @@ -161,4 +161,3 @@ It was overwritten with this and deleted. {{PageNavigation}} - diff --git a/internal/help/ALIAS_11111.txt b/internal/help/ALIAS_11111.txt index 6ecf6ef63..dad2c07e0 100644 --- a/internal/help/ALIAS_11111.txt +++ b/internal/help/ALIAS_11111.txt @@ -1,4 +1,3 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:11:44}} +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:40:57}} See page [[DECLARE LIBRARY]] - diff --git a/internal/help/AND_(boolean)_111_(0000000).txt b/internal/help/AND_(boolean)_111_(0000000).txt index 5c0f814f4..9105e204b 100644 --- a/internal/help/AND_(boolean)_111_(0000000).txt +++ b/internal/help/AND_(boolean)_111_(0000000).txt @@ -1,5 +1,5 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:11:46}} +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:40:59}} The [[AND (boolean)|AND]] conditonal operator is used to include another evaluation in an [[IF...THEN]] or [[Boolean]] statement. @@ -17,7 +17,7 @@ The [[AND (boolean)|AND]] conditonal operator is used to include another evaluat * Not to be confused with the [[AND]] and [[OR]] numerical operations. -{{Template:RelationalTable}} +{{RelationalTable}} {{PageExamples}} @@ -63,4 +63,3 @@ True {{PageNavigation}} - diff --git a/internal/help/AND_111.txt b/internal/help/AND_111.txt index 07a4f4213..d506595c2 100644 --- a/internal/help/AND_111.txt +++ b/internal/help/AND_111.txt @@ -1,5 +1,5 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:11:45}} +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:40:58}} The logical [[AND]] numerical operator compares two values in respect of their bits. If both bits at a certain position in both values are set, then that bit position is set in the result. @@ -15,7 +15,7 @@ The logical [[AND]] numerical operator compares two values in respect of their b * Can turn off a bit by subtracting the bit on value from 255 and using that value to AND a byte value. -{{Template:LogicalTruthTable}} +{{LogicalTruthTable}} {{PageExamples}} @@ -76,4 +76,3 @@ The logical [[AND]] numerical operator compares two values in respect of their b {{PageNavigation}} - diff --git a/internal/help/APPEND_111111.txt b/internal/help/APPEND_111111.txt index 1af34cc3f..d78874d36 100644 --- a/internal/help/APPEND_111111.txt +++ b/internal/help/APPEND_111111.txt @@ -1,5 +1,5 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:11:47}} +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:41:03}} The [[OPEN]] statement is used to open a file or [[OPEN_COM|COM]] serial communications port for program input or output. @@ -161,4 +161,3 @@ It was overwritten with this and deleted. {{PageNavigation}} - diff --git a/internal/help/ASC_(statement)_111_(000000000).txt b/internal/help/ASC_(statement)_111_(000000000).txt index 49247607a..f5b65609c 100644 --- a/internal/help/ASC_(statement)_111_(000000000).txt +++ b/internal/help/ASC_(statement)_111_(000000000).txt @@ -1,5 +1,5 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:11:51}} +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:41:06}} The [[ASC (statement)|ASC]] statement allows a '''QB64''' program to change a character at any position of a [[STRING]] variable. @@ -46,3 +46,4 @@ The [[ASC (statement)|ASC]] statement allows a '''QB64''' program to change a ch {{PageNavigation}} +[[Category:Latest]] diff --git a/internal/help/ASC_111.txt b/internal/help/ASC_111.txt index bab044a9c..0d97e929a 100644 --- a/internal/help/ASC_111.txt +++ b/internal/help/ASC_111.txt @@ -1,5 +1,5 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:11:50}} +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:41:05}} The [[ASC]] function returns the [[ASCII]] code number of a certain [[STRING]] text character or a keyboard press. @@ -7,11 +7,11 @@ The [[ASC]] function returns the [[ASCII]] code number of a certain [[STRING]] t : {{Parameter|code%}} = [[ASC]]({{Parameter|text$}}[, {{Parameter|position%}}]) -* {{Parameter|text$}} [[STRING|string]] character parameter must have a length of at least 1 byte or an error occurs. +* {{Parameter|text$}} [[STRING|string]] character parameter must have a length of at least 1 byte or an error occurs. * '''In QB64''' the optional byte {{Parameter|position%}} [[INTEGER]] parameter greater than 0 can specify the ASCII code of any character in a string to be returned. * If the optional {{Parameter|position%}} parameter is omitted, ASC will return the [[ASCII]] code of the first [[STRING]] character. -* [[ASCII]] code [[INTEGER]] or [[_UNSIGNED]] [[_BYTE]] values returned range from 0 to 255. -* ASC returns 0 when reading [[ASCII]] 2 byte codes returned by [[INKEY$]] when the arrow, function, Home/Page keys are used. +* [[ASCII]] code [[INTEGER]] or [[_UNSIGNED]] [[_BYTE]] values returned range from 0 to 255. +* ASC returns 0 when reading [[ASCII]] 2 byte codes returned by [[INKEY$]] when the arrow, function, Home/Page keys are used. ** Use QB64's {{Parameter|position%}} parameter to read the second byte if necessary. {{Text|IF ASC(key$) = 0 THEN byte2 = ASC(key$, 2)|green}} * In '''QB64''' ASC string byte position reads are about '''5 times faster''' than [[MID$]] when parsing strings. See [[MID$]] ''Example 2''. @@ -23,34 +23,34 @@ The [[ASC]] function returns the [[ASCII]] code number of a certain [[STRING]] t {{WhiteStart}}' '''ASCII Keyboard Codes''' ' -'''' Esc F1 F2 F3 F4 F5 F6 F7 F8 F9 F10 F11 F12 Sys ScL Pause''' +'''' Esc F1 F2 F3 F4 F5 F6 F7 F8 F9 F10 F11 F12 Sys ScL Pause''' ' 27 +59 +60 +61 +62 +63 +64 +65 +66 +67 +68 +133 +134 - - - -'''' `~ 1! 2@ 3# 4$ 5% 6^ 7& 8* 9( 0) -_ =+ BkSp Ins Hme PUp NumL / * -''' +'''' `~ 1! 2@ 3# 4$ 5% 6^ 7& 8* 9( 0) -_ =+ BkSp Ins Hme PUp NumL / * -''' ' 126 33 64 35 36 37 94 38 42 40 41 95 43 8 +82 +71 +73 - 47 42 45 ''' 96 49 50 51 52 53 54 55 56 57 48 45 61'' '''' Tab Q W E R T Y U I O P [{ ]} \| Del End PDn 7Hme 8/â–² 9PU + ''' ' 9 81 87 69 82 84 89 85 73 79 80 123 125 124 +83 +79 +81 +71 +72 +73 43 ''' 113 119 101 114 116 121 117 105 111 112 91 93 92 55 56 57 '' -'''' CapL A S D F G H J K L ;: '" Enter 4/â—„- 5 6/-â–º +'''' CapL A S D F G H J K L ;: '" Enter 4/â—„- 5 6/-â–º ' - 65 83 68 70 71 72 74 75 76 58 34 13 +75 +76 +77 '''E''' -''' 97 115 100 102 103 104 106 107 108 59 39 52 53 54 '' '''n''' +''' 97 115 100 102 103 104 106 107 108 59 39 52 53 54 '' '''n''' '''' Shift Z X C V B N M ,< .> /? Shift â–² 1End 2/â–¼ 3PD t''' ' * 90 88 67 86 66 78 77 60 62 63 * +72 +79 +80 +81 '''e''' ''' 122 120 99 118 98 110 109 44 46 47 49 50 51 '' '''r''' '''' Ctrl Win Alt Spacebar Alt Win Menu Ctrl â—„- â–¼ -â–º 0Ins .Del ''' -' * - * 32 * - - * +75 +80 +77 +82 +83 13 +' * - * 32 * - - * +75 +80 +77 +82 +83 13 ' '' 48 46'' ' ' ''' ''Italics'' = LCase/NumLock On ____________ + = 2 Byte: CHR$(0) + CHR$(code)''' '{{small|NOTE: The above commented table can be copied and pasted directly into the QB64 IDE}} -{{WhiteEnd}} +{{WhiteEnd}}
'''[[ASCII#Two_Byte_Codes|Two Byte Ctrl, Alt and Shift + Function key combinations]]'''
{{WhiteStart}} '''Two Byte Characters    Key                 CHR$(0) + "?" ''' - CHR$(0) + CHR$(16-50) [Alt] + letter + CHR$(0) + CHR$(16-50) [Alt] + letter CHR$(0) + CHR$(59) [F1] ";" CHR$(0) + CHR$(60) [F2] "<" CHR$(0) + CHR$(61) [F3] "=" @@ -75,7 +75,7 @@ The [[ASC]] function returns the [[ASCII]] code number of a certain [[STRING]] t CHR$(0) + CHR$(84-93) [Shift] + F1-10 CHR$(0) + CHR$(94-103) [Ctrl] + F1-10 CHR$(0) + CHR$(104-113) [Alt] + F1-10 - CHR$(0) + CHR$(114-119) [Ctrl] + keypad + CHR$(0) + CHR$(114-119) [Ctrl] + keypad CHR$(0) + CHR$(120-129) [Alt] + number CHR$(0) + CHR$(130 or 131) [Alt] + _/- or +/= "é" or "â" CHR$(0) + CHR$(133) [F11] "à" @@ -93,9 +93,9 @@ The [[ASC]] function returns the [[ASCII]] code number of a certain [[STRING]] t {{PageExamples}} ''Example 1:'' How ASC can be used to find any ASCII code in a string of characters using QB64. {{CodeStart}} - {{Cl|PRINT}} ASC("A") - {{Cl|PRINT}} ASC("Be a rockstar") - {{Cl|PRINT}} ASC("QB64 is not only COMPATIBLE, it can find any part of the string!", 18) + {{Cl|PRINT}} {{Cl|ASC}}("A") + {{Cl|PRINT}} {{Cl|ASC}}("Be a rockstar") + {{Cl|PRINT}} {{Cl|ASC}}("QB64 is not only COMPATIBLE, it can find any part of the string!", 18) {{CodeEnd}} ''Returns:'' @@ -116,13 +116,13 @@ The [[ASC]] function returns the [[ASCII]] code number of a certain [[STRING]] t Q$ = {{Cl|CHR$}}(34) ' quote character {{Cl|COLOR}} 10: {{Cl|LOCATE}} 5, 22: {{Cl|PRINT}} "Press some keys or combinations!" {{Cl|COLOR}} 13: {{Cl|LOCATE}} 23, 30: {{Cl|PRINT}} "Escape key Quits" -DO - DO: {{Cl|SLEEP}}: key$ = {{Cl|INKEY$}}: {{Cl|LOOP}} {{Cl|UNTIL}} key$ <> "" ' prevent ASC empty string read error +{{Cl|DO}} + {{Cl|DO}}: {{Cl|SLEEP}}: key$ = {{Cl|INKEY$}}: {{Cl|LOOP}} {{Cl|UNTIL}} key$ <> "" ' prevent ASC empty string read error code% = {{Cl|ASC}}(key$): {{Cl|COLOR}} 11: {{Cl|LOCATE}} 10, 10 {{Cl|IF...THEN|IF}} code% {{Cl|THEN}} ' ASC returns any value greater than 0 - {{Cl|PRINT}} "{{Cl|CHR$}}(" + {{Cl|LTRIM$}}({{Cl|STR$}}(code%)) + ")" + {{Cl|SPACE$}}(13): + {{Cl|PRINT}} "{{Cl|CHR$}}(" + {{Cl|LTRIM$}}({{Cl|STR$}}(code%)) + ")" + {{Cl|SPACE$}}(13): {{Cl|IF...THEN|IF}} code% > 8 {{Cl|AND (boolean)|AND}} code% < 14 {{Cl|THEN}} code% = 32 ' unprintable control codes - {{Cl|COLOR}} 14: {{Cl|LOCATE}} 10, 50: {{Cl|PRINT}} {{Cl|CHR$}}(code%) + {{Cl|SPACE$}}(13) + {{Cl|COLOR}} 14: {{Cl|LOCATE}} 10, 50: {{Cl|PRINT}} {{Cl|CHR$}}(code%) + {{Cl|SPACE$}}(13) {{Cl|ELSE}}: {{Cl|PRINT}} "{{Cl|CHR$}}(0) + {{Cl|CHR$}}(" + {{Cl|LTRIM$}}({{Cl|STR$}}({{Cl|ASC}}(key$, 2))) + ")" {{Cl|COLOR}} 14: {{Cl|LOCATE}} 10, 50: {{Cl|PRINT}} "{{Cl|CHR$}}(0) + " + Q$ + {{Cl|CHR$}}({{Cl|ASC}}(key$, 2)) + Q$ {{Cl|END IF}} @@ -135,22 +135,22 @@ DO ''Example 3:'' Reading only numerical values input by a program user. {{CodeStart}} - DO: {{Cl|SLEEP}} ' requires a keypress to run loop once - K$ = {{Cl|{{Cl|INKEY$}}}} + {{Cl|DO}}: {{Cl|SLEEP}} ' requires a keypress to run loop once + K$ = {{Cl|INKEY$}} code = {{Cl|ASC}}(K$) - {{Cl|IF...THEN|IF}} code >= 48 {{Cl|AND (boolean)|AND}} code <= 57 {{Cl|THEN}} entry$ = entry$ + {{Cl|{{Cl|CHR$}}}}(code) ' numbers only - {{Cl|IF...THEN|IF}} code = 46 {{Cl|AND (boolean)|AND}} flag = 0 {{Cl|THEN}} + {{Cl|IF}} code >= 48 {{Cl|AND (boolean)|AND}} code <= 57 {{Cl|THEN}} entry$ = entry$ + {{Cl|CHR$}}(code) ' numbers only + {{Cl|IF}} code = 46 {{Cl|AND (boolean)|AND}} flag = 0 {{Cl|THEN}} entry$ = entry$ + K$: flag = 1: mark = {{Cl|LEN}}(entry$) ' decimal point {{Cl|END IF}} - L = {{Cl|{{Cl|LEN}}}}(entry$) ' check entry length for possible backspace - {{Cl|IF...THEN|IF}} code = 8 {{Cl|AND (boolean)|AND}} L > 0 {{Cl|THEN}} ' backspace pressed and entry has a length - entry$ = {{Cl|{{Cl|MID$}}}}(entry$, 1, L - 1) ' remove one character from entry$ - {{Cl|IF...THEN|IF}} L - 1 < mark {{Cl|THEN}} flag = 0 ' allow another decimal point if removed. - {{Cl|LOCATE}} 10, {{Cl|POS}}(0) - 1: {{Cl|PRINT}} {{Cl|{{Cl|SPACE$}}}}(1); ' remove character from screen + L = {{Cl|LEN}}(entry$) ' check entry length for possible backspace + {{Cl|IF}} code = 8 {{Cl|AND (boolean)|AND}} L > 0 {{Cl|THEN}} ' backspace pressed and entry has a length + entry$ = {{Cl|MID$}}(entry$, 1, L - 1) ' remove one character from entry$ + {{Cl|IF}} L - 1 < mark {{Cl|THEN}} flag = 0 ' allow another decimal point if removed. + {{Cl|LOCATE}} 10, {{Cl|POS}}(0) - 1: {{Cl|PRINT}} {{Cl|SPACE$}}(1); ' remove character from screen {{Cl|END IF}} - {{Cl|LOCATE}} 10, 10: {{Cl|PRINT}} entry$; + {{Cl|LOCATE}} 10, 10: {{Cl|PRINT}} entry$; ' display present entry to user(semicolon required for correct POS return) - {{Cl|LOOP}} {{Cl|UNTIL}} code = 13 {{Cl|AND}} L + {{Cl|LOOP}} {{Cl|UNTIL}} code = 13 {{Cl|AND}} L {{CodeEnd}} ''Explanation:'' [[SLEEP]] waits for a keypress allowing background programs to use the processor time. It also keeps the press in the keyboard buffer for [[INKEY$]] to read and guarantees that ASC will not read an empty string value to create an error. Filtered codes 48 to 57 are only number characters. One decimal point is allowed by using the flag. Code 8 is a backspace request which is ignored if the entry has no characters. If it is allowed it removes the last character from the entry and the screen. The loop exits when the user presses the [Enter] key and the entry has a length. @@ -167,3 +167,4 @@ DO {{PageNavigation}} +[[Category:Latest]] diff --git a/internal/help/AS_11.txt b/internal/help/AS_11.txt index 2da04d377..b75fc8111 100644 --- a/internal/help/AS_11.txt +++ b/internal/help/AS_11.txt @@ -1,5 +1,5 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:11:49}} +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:41:04}} The [[AS]] keyword defines a variable data [[type]]. @@ -33,4 +33,3 @@ The [[AS]] keyword defines a variable data [[type]]. {{PageNavigation}} - diff --git a/internal/help/ATN_111.txt b/internal/help/ATN_111.txt index 1929b1fce..fa7cc3a3d 100644 --- a/internal/help/ATN_111.txt +++ b/internal/help/ATN_111.txt @@ -1,5 +1,5 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:11:52}} +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:41:08}} The [[ATN]] or arctangent function returns the angle in radians of a numerical [[TAN|tangent]] value. @@ -88,4 +88,3 @@ DO {{PageNavigation}} - diff --git a/internal/help/Apostrophe_1000000000.txt b/internal/help/Apostrophe_1000000000.txt index ae8e850f6..c7f266b3c 100644 --- a/internal/help/Apostrophe_1000000000.txt +++ b/internal/help/Apostrophe_1000000000.txt @@ -1,5 +1,5 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:24:40}} +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:53:55}} The '''apostrophe''' is used to tell the compiler to ignore a statement or programmer comment. {{PageDescription}} @@ -25,4 +25,3 @@ COLOR 11: PRINT "Print this...." ' PRINT "Don't print this program comment!" {{PageNavigation}} - diff --git a/internal/help/BEEP_1111.txt b/internal/help/BEEP_1111.txt index 2e3a226c0..ceda13137 100644 --- a/internal/help/BEEP_1111.txt +++ b/internal/help/BEEP_1111.txt @@ -1,5 +1,5 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:11:54}} +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:41:09}} The [[BEEP]] statement produces a beep sound through the sound card. @@ -24,4 +24,3 @@ The [[BEEP]] statement produces a beep sound through the sound card. {{PageNavigation}} - diff --git a/internal/help/BINARY_111111.txt b/internal/help/BINARY_111111.txt index aa9c2bf36..2121e10d5 100644 --- a/internal/help/BINARY_111111.txt +++ b/internal/help/BINARY_111111.txt @@ -1,5 +1,5 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:11:55}} +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:41:10}} The [[OPEN]] statement is used to open a file or [[OPEN_COM|COM]] serial communications port for program input or output. @@ -161,4 +161,3 @@ It was overwritten with this and deleted. {{PageNavigation}} - diff --git a/internal/help/BLOAD_11111.txt b/internal/help/BLOAD_11111.txt index 17522b4a0..32dad0055 100644 --- a/internal/help/BLOAD_11111.txt +++ b/internal/help/BLOAD_11111.txt @@ -1,12 +1,12 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:11:56}} +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:41:11}} [[BLOAD]] loads a binary graphics file created by [[BSAVE]] to an array. {{PageSyntax}} : [[BLOAD]] {{Parameter|fileName$}}, [[VARPTR]]({{Parameter|imageArray%({{Parameter|index}})}}) -{{PageLegacySupport}} +===Legacy support=== * '''QB64''' can load larger arrays directly from binary files using [[PUT]] # and [[GET]] # without '''BLOAD'''. For that reason, '''BLOAD''' isn't recommended practice anymore and is supported to maintain compatibility with legacy code. @@ -55,4 +55,3 @@ {{PageNavigation}} - diff --git a/internal/help/BSAVE_11111.txt b/internal/help/BSAVE_11111.txt index f85e40ad2..6cb0d3b32 100644 --- a/internal/help/BSAVE_11111.txt +++ b/internal/help/BSAVE_11111.txt @@ -1,5 +1,5 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:11:57}} +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:41:12}} [[BSAVE]] saves the contents of an image array to a [[BINARY]] file. @@ -7,7 +7,7 @@ : [[BSAVE]] {{Parameter|saveFile$}}, [[VARPTR]]({{Parameter|array(index)}}), {{Parameter|fileSize&}} -{{PageLegacySupport}} +===Legacy support=== * '''QB64''' can save larger arrays directly to binary files using [[PUT]] # and [[GET]] # without '''BSAVE'''. For that reason, '''BSAVE''' isn't recommended practice anymore and is supported to maintain compatibility with legacy code. @@ -104,4 +104,3 @@ K$ = {{Cl|INPUT$}}(1) 'Press any key {{PageNavigation}} - diff --git a/internal/help/BYVAL_11111.txt b/internal/help/BYVAL_11111.txt index 11e4bc35a..fee236b51 100644 --- a/internal/help/BYVAL_11111.txt +++ b/internal/help/BYVAL_11111.txt @@ -1,5 +1,5 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:11:59}} +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:41:14}} The '''DECLARE LIBRARY''' declaration allows the use of external library [[SUB]] and [[FUNCTION]] procedures supported by QB64. @@ -102,4 +102,3 @@ MouseMove 200, 200 {{PageNavigation}} - diff --git a/internal/help/CALL_1111.txt b/internal/help/CALL_1111.txt index d1a0d04ce..2555f19e3 100644 --- a/internal/help/CALL_1111.txt +++ b/internal/help/CALL_1111.txt @@ -1,5 +1,5 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:12:00}} +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:41:15}} [[CALL]] sends code execution to a subroutine procedure in a program. In '''QB64''' the subroutine doesn't need to be declared. @@ -60,8 +60,6 @@ Hello World! {{PageSeeAlso}} * [[SUB]], [[FUNCTION]] -* DECLARE, [[DECLARE (non-BASIC statement)]] {{PageNavigation}} - diff --git a/internal/help/CALL_ABSOLUTE_1111_11111111.txt b/internal/help/CALL_ABSOLUTE_1111_11111111.txt index 107bbc025..662ddb6bb 100644 --- a/internal/help/CALL_ABSOLUTE_1111_11111111.txt +++ b/internal/help/CALL_ABSOLUTE_1111_11111111.txt @@ -1,5 +1,5 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:11:41}} +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:40:55}} [[CALL ABSOLUTE]] is used to access interrupts on the computer or execute assembly type procedures. @@ -7,7 +7,7 @@ : [[CALL ABSOLUTE]]([{{Parameter|argumentList}},] {{Parameter|integerOffset}}) -{{PageLegacySupport}} +===Legacy support=== * [[CALL ABSOLUTE]] is implemented to support older code and is not recommended practice. To handle mouse input, use [[_MOUSEINPUT]] and related functions. @@ -21,9 +21,7 @@ {{PageSeeAlso}} * [[SADD]], [[INTERRUPT]] -* [[DECLARE (non-BASIC statement)]] * [[_MOUSEINPUT]] {{PageNavigation}} - diff --git a/internal/help/CASE_1111.txt b/internal/help/CASE_1111.txt index 67cfe4510..ac22cdee3 100644 --- a/internal/help/CASE_1111.txt +++ b/internal/help/CASE_1111.txt @@ -1,4 +1,3 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:12:03}} +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:41:16}} See page [[SELECT CASE]] - diff --git a/internal/help/CASE_ELSE_1111_1111.txt b/internal/help/CASE_ELSE_1111_1111.txt index bc00e5c76..972d3c775 100644 --- a/internal/help/CASE_ELSE_1111_1111.txt +++ b/internal/help/CASE_ELSE_1111_1111.txt @@ -1,4 +1,3 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:12:04}} +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:41:17}} See page [[SELECT CASE]] - diff --git a/internal/help/CASE_IS_1111_11.txt b/internal/help/CASE_IS_1111_11.txt index 335bcbe8d..e80002c74 100644 --- a/internal/help/CASE_IS_1111_11.txt +++ b/internal/help/CASE_IS_1111_11.txt @@ -1,4 +1,3 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:12:05}} +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:41:18}} See page [[SELECT CASE]] - diff --git a/internal/help/CDBL_1111.txt b/internal/help/CDBL_1111.txt index eec685ed3..220ee963e 100644 --- a/internal/help/CDBL_1111.txt +++ b/internal/help/CDBL_1111.txt @@ -1,5 +1,5 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:12:06}} +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:41:19}} [[CDBL]] converts a value to the closest [[DOUBLE]]-precision value. @@ -34,4 +34,3 @@ {{PageNavigation}} - diff --git a/internal/help/CHAIN_11111.txt b/internal/help/CHAIN_11111.txt index 78ea10f72..a2fcecf94 100644 --- a/internal/help/CHAIN_11111.txt +++ b/internal/help/CHAIN_11111.txt @@ -1,5 +1,5 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:12:09}} +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:41:20}} [[CHAIN]] is used to change seamlessly from one module to another one in a program. @@ -7,7 +7,7 @@ : [[CHAIN]] {{Parameter|moduleName$}} -{{PageLegacySupport}} +===Legacy support=== * The multi-modular technique goes back to when '''QBasic''' and '''QuickBASIC''' had module size constraints. In '''QB64''' the [[CHAIN]] statement has been implemented so that that older code can still be compiled, though it is advisable to use single modules for a single project (not counting [[$INCLUDE]] libraries), for ease of sharing and also because the module size constraints no longer exist. @@ -43,8 +43,6 @@ * [[RUN]] * [[COMMON]], [[COMMON SHARED]] * [[SHARED]] -* [[LINKed or Merged Modules]] {{PageNavigation}} - diff --git a/internal/help/CHDIR_11111.txt b/internal/help/CHDIR_11111.txt index 3651503f7..c9633f91f 100644 --- a/internal/help/CHDIR_11111.txt +++ b/internal/help/CHDIR_11111.txt @@ -1,5 +1,5 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:12:10}} +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:41:22}} The [[CHDIR]] statement changes the program's location from one working directory to another by specifying a literal or variable [[STRING]] path. @@ -62,4 +62,3 @@ Result = GetModuleFileNameA(0, FileName$, {{Cl|LEN}}(FileName$)) '0 designates {{PageNavigation}} - diff --git a/internal/help/CHR$_111$.txt b/internal/help/CHR$_111$.txt index 300258084..fecbad850 100644 --- a/internal/help/CHR$_111$.txt +++ b/internal/help/CHR$_111$.txt @@ -1,5 +1,5 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:12:12}} +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:41:23}} The [[CHR$]] function returns the character associated with a certain [[ASCII|character code]] as a [[STRING]]. @@ -86,4 +86,3 @@ Send$ = "" {{PageNavigation}} - diff --git a/internal/help/CINT_1111.txt b/internal/help/CINT_1111.txt index bb9593e73..8b30d7000 100644 --- a/internal/help/CINT_1111.txt +++ b/internal/help/CINT_1111.txt @@ -1,5 +1,5 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:12:13}} +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:41:24}} The [[CINT]] function rounds decimal point numbers up or down to the nearest [[INTEGER]] value. @@ -35,4 +35,3 @@ a% = {{Cl|CINT}}(1.49): b% = {{Cl|CINT}}(1.50): c = 11.5 {{PageNavigation}} - diff --git a/internal/help/CIRCLE_111111.txt b/internal/help/CIRCLE_111111.txt index 9fba0ccd0..3274f5b6e 100644 --- a/internal/help/CIRCLE_111111.txt +++ b/internal/help/CIRCLE_111111.txt @@ -1,5 +1,5 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:12:14}} +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:41:25}} The [[CIRCLE]] statement is used in graphic [[SCREEN (statement)|SCREEN]] modes to create circles, arcs or ellipses. @@ -144,4 +144,3 @@ previoushour% = hours% 'hold current hour for later use * [[Alternative circle routine]] {{text|(member-contributed program)}} {{PageNavigation}} - diff --git a/internal/help/CLEAR_11111.txt b/internal/help/CLEAR_11111.txt index 70b28690c..ecccf140e 100644 --- a/internal/help/CLEAR_11111.txt +++ b/internal/help/CLEAR_11111.txt @@ -1,5 +1,5 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:12:15}} +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:41:27}} The [[CLEAR]] statement clears all variable and array element values in a program. @@ -38,4 +38,3 @@ array(5) = 23 {{PageNavigation}} - diff --git a/internal/help/CLNG_1111.txt b/internal/help/CLNG_1111.txt index 7e90f6ea8..4c0411f26 100644 --- a/internal/help/CLNG_1111.txt +++ b/internal/help/CLNG_1111.txt @@ -1,5 +1,5 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:12:17}} +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:41:28}} The [[CLNG]] function rounds decimal point numbers up or down to the nearest [[LONG]] integer value. @@ -36,4 +36,3 @@ The [[CLNG]] function rounds decimal point numbers up or down to the nearest [[L {{PageNavigation}} - diff --git a/internal/help/CLOSE_11111.txt b/internal/help/CLOSE_11111.txt index e33c360f8..27a5eb93f 100644 --- a/internal/help/CLOSE_11111.txt +++ b/internal/help/CLOSE_11111.txt @@ -1,5 +1,5 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:12:18}} +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:41:29}} [[CLOSE]] closes an open file or port using the number(s) assigned in an [[OPEN]] statement. @@ -29,4 +29,3 @@ {{PageNavigation}} - diff --git a/internal/help/CLS_111.txt b/internal/help/CLS_111.txt index 782ff3987..89f0c0884 100644 --- a/internal/help/CLS_111.txt +++ b/internal/help/CLS_111.txt @@ -1,5 +1,5 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:12:19}} +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:41:30}} The [[CLS]] statement clears the [[_DEST|current write page]]. @@ -58,4 +58,3 @@ i = {{Cl|_LOADIMAGE}}('''"qb64_trans.png"''') 'see note below examples to get th {{PageNavigation}} - diff --git a/internal/help/COLOR_11111.txt b/internal/help/COLOR_11111.txt index 71b037411..364ae0e08 100644 --- a/internal/help/COLOR_11111.txt +++ b/internal/help/COLOR_11111.txt @@ -1,5 +1,5 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:12:21}} +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:41:31}} The [[COLOR]] statement is used to change the foreground and background colors for printing text. {{PageSyntax}} @@ -193,4 +193,3 @@ alpha$ = "FF" 'solid alpha colors only {{PageNavigation}} - diff --git a/internal/help/COMMAND$_1111111$.txt b/internal/help/COMMAND$_1111111$.txt index 88479e171..57ebb988c 100644 --- a/internal/help/COMMAND$_1111111$.txt +++ b/internal/help/COMMAND$_1111111$.txt @@ -1,5 +1,5 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:12:22}} +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:41:33}} The '''COMMAND$''' function returns the command line argument(s) passed when a program is run. @@ -73,4 +73,3 @@ count = count - 1 'save the number of parameters sent to this program when run {{PageNavigation}} - diff --git a/internal/help/COMMON_111111.txt b/internal/help/COMMON_111111.txt index f1e16bd44..0d18d8156 100644 --- a/internal/help/COMMON_111111.txt +++ b/internal/help/COMMON_111111.txt @@ -1,12 +1,12 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:12:23}} +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:41:34}} [[COMMON]] shares common variable values with other linked or [[CHAIN]]ed modules. {{PageSyntax}} : [[COMMON]] [SHARED] variableList -{{PageLegacySupport}} +===Legacy support=== * The multi-modular technique goes back to when '''QBasic''' and '''QuickBASIC''' had module size constraints. In '''QB64''' the [[COMMON]] statement has been implemented so that that older code can still be compiled, though it is advisable to use single modules for a single project (not counting [[$INCLUDE]] libraries), for ease of sharing and also because the module size constraints no longer exist. @@ -25,4 +25,3 @@ * [[DEFSTR]], [[DEFLNG]], [[DEFINT]], [[DEFSNG]], [[DEFDBL]] {{PageNavigation}} - diff --git a/internal/help/CONST_11111.txt b/internal/help/CONST_11111.txt index 9a271aa4a..e978aabab 100644 --- a/internal/help/CONST_11111.txt +++ b/internal/help/CONST_11111.txt @@ -1,5 +1,5 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:12:24}} +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:41:35}} The [[CONST]] statement globally defines one or more named numeric or string values which will not change while the program is running. @@ -71,4 +71,3 @@ Enter the radius of a circle or zero to quit? ''0'' {{PageNavigation}} - diff --git a/internal/help/COS_111.txt b/internal/help/COS_111.txt index fd8640a5c..288831705 100644 --- a/internal/help/COS_111.txt +++ b/internal/help/COS_111.txt @@ -1,5 +1,5 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:12:25}} +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:41:36}} The [[COS]] function returns the horizontal component or the cosine of an angle measured in radians. @@ -106,4 +106,3 @@ DEGREES% = RADIANS * 180 / PI = 45 {{PageNavigation}} - diff --git a/internal/help/CSNG_1111.txt b/internal/help/CSNG_1111.txt index 80dc9d073..c717929a0 100644 --- a/internal/help/CSNG_1111.txt +++ b/internal/help/CSNG_1111.txt @@ -1,5 +1,5 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:12:27}} +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:41:37}} [[CSNG]] converts a numerical value to the closest [[SINGLE]]-precision number. @@ -32,4 +32,3 @@ {{PageNavigation}} - diff --git a/internal/help/CSRLIN_111111.txt b/internal/help/CSRLIN_111111.txt index 5788b2697..33f66b14c 100644 --- a/internal/help/CSRLIN_111111.txt +++ b/internal/help/CSRLIN_111111.txt @@ -1,5 +1,5 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:12:28}} +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:41:39}} The [[CSRLIN]] function returns the current text row position of the [[PRINT]] cursor. @@ -50,4 +50,3 @@ The [[CSRLIN]] function returns the current text row position of the [[PRINT]] c {{PageNavigation}} - diff --git a/internal/help/CVDMBF_111111.txt b/internal/help/CVDMBF_111111.txt index 92da9e86c..b4801bec8 100644 --- a/internal/help/CVDMBF_111111.txt +++ b/internal/help/CVDMBF_111111.txt @@ -1,5 +1,5 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:12:31}} +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:41:41}} The [[CVDMBF]] function decodes an 8-byte [[STRING]] generated by [[MKDMBF$]] (or read from a file) to [[DOUBLE]] numeric values. @@ -39,4 +39,3 @@ The string above, decoded using CVDMBF: 77000.24523213 {{PageNavigation}} - diff --git a/internal/help/CVD_111.txt b/internal/help/CVD_111.txt index d96ef9128..4f85aa3aa 100644 --- a/internal/help/CVD_111.txt +++ b/internal/help/CVD_111.txt @@ -1,5 +1,5 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:12:29}} +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:41:40}} The [[CVD]] function decodes an 8-byte [[STRING]] generated by [[MKD$]] (or read from a file) to [[DOUBLE]] numeric values. @@ -50,4 +50,3 @@ The string above, decoded using CVD: 77000.24523213 {{PageNavigation}} - diff --git a/internal/help/CVI_111.txt b/internal/help/CVI_111.txt index c333a7a88..9a5ef463d 100644 --- a/internal/help/CVI_111.txt +++ b/internal/help/CVI_111.txt @@ -1,5 +1,5 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:12:32}} +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:41:42}} The [[CVI]] function decodes a 2-byte [[STRING]] generated by [[MKI$]] (or read from a file) to [[INTEGER]] numeric values. @@ -65,4 +65,3 @@ tmp4$ = " CVI Total = ##### " {{PageNavigation}} - diff --git a/internal/help/CVL_111.txt b/internal/help/CVL_111.txt index b9b0c8f8c..51262cf26 100644 --- a/internal/help/CVL_111.txt +++ b/internal/help/CVL_111.txt @@ -1,5 +1,5 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:12:33}} +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:41:43}} The [[CVL]] function decodes a 4-byte [[STRING]] generated by [[MKL$]] (or read from a file) to [[LONG]] numeric values. @@ -42,4 +42,3 @@ Y& = {{Cl|CVL}}(N$) {{PageNavigation}} - diff --git a/internal/help/CVSMBF_111111.txt b/internal/help/CVSMBF_111111.txt index 1bac30ebe..37e780216 100644 --- a/internal/help/CVSMBF_111111.txt +++ b/internal/help/CVSMBF_111111.txt @@ -1,5 +1,5 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:12:36}} +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:41:47}} The [[CVDMBF]] function decodes a 4-byte [[STRING]] generated by [[MKSMBF$]] (or read from a file) to [[SINGLE]] numeric values. @@ -37,4 +37,3 @@ The string above, decoded using CVSMBF: 700.2213 {{PageNavigation}} - diff --git a/internal/help/CVS_111.txt b/internal/help/CVS_111.txt index 3ffb47b2d..bd192153e 100644 --- a/internal/help/CVS_111.txt +++ b/internal/help/CVS_111.txt @@ -1,5 +1,5 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:12:34}} +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:41:46}} The [[CVS]] function decodes a 4-byte [[STRING]] generated by [[MKS$]] (or read from a file) to [[SINGLE]] numeric values. @@ -37,4 +37,3 @@ The string above, decoded using CVS: 700.2213 {{PageNavigation}} - diff --git a/internal/help/Colon_10000.txt b/internal/help/Colon_10000.txt index f61c345c0..76933b66a 100644 --- a/internal/help/Colon_10000.txt +++ b/internal/help/Colon_10000.txt @@ -1,5 +1,5 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:24:41}} +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:53:56}} A '''colon''' can be used to separate two unrelated procedure statements on the same line. @@ -22,4 +22,3 @@ A '''colon''' can be used to separate two unrelated procedure statements on the {{PageNavigation}} - diff --git a/internal/help/DATA_1111.txt b/internal/help/DATA_1111.txt index 2555ecacc..f533b8332 100644 --- a/internal/help/DATA_1111.txt +++ b/internal/help/DATA_1111.txt @@ -1,5 +1,5 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:12:37}} +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:41:48}} The [[DATA]] statement creates a line of fixed program information separated by commas. The DATA can be later READ by the program at runtime. @@ -81,4 +81,3 @@ mydata2: {{PageNavigation}} - diff --git a/internal/help/DATE$_1111$.txt b/internal/help/DATE$_1111$.txt index 694cf32c3..97cf07f47 100644 --- a/internal/help/DATE$_1111$.txt +++ b/internal/help/DATE$_1111$.txt @@ -1,5 +1,5 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:12:38}} +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:41:49}} The [[DATE$]] function returns the current computer date as a string in the format "mm-dd-yyyy". @@ -70,4 +70,3 @@ Today is Wednesday, June 2, 2010 {{PageNavigation}} - diff --git a/internal/help/DECLARE_DYNAMIC_LIBRARY_1111111_1111111_1111111.txt b/internal/help/DECLARE_DYNAMIC_LIBRARY_1111111_1111111_1111111.txt index d84722c3e..b135934b0 100644 --- a/internal/help/DECLARE_DYNAMIC_LIBRARY_1111111_1111111_1111111.txt +++ b/internal/help/DECLARE_DYNAMIC_LIBRARY_1111111_1111111_1111111.txt @@ -1,5 +1,5 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:07:31}} +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:37:08}} '''DECLARE DYNAMIC LIBRARY''' allows you to dynamically link your program to functions in dynamically linkable libraries. At present, only ''.DLL'' files are supported (support for ''.so'' will be added soon). These libraries are loaded when your program begins. @@ -104,4 +104,3 @@ QuickUTF16toUTF32$ = b$ {{PageNavigation}} - diff --git a/internal/help/DECLARE_LIBRARY_1111111_1111111.txt b/internal/help/DECLARE_LIBRARY_1111111_1111111.txt index 1740dcbe2..4e4bd7a91 100644 --- a/internal/help/DECLARE_LIBRARY_1111111_1111111.txt +++ b/internal/help/DECLARE_LIBRARY_1111111_1111111.txt @@ -1,5 +1,5 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:07:30}} +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:37:06}} The '''DECLARE LIBRARY''' declaration allows the use of external library [[SUB]] and [[FUNCTION]] procedures supported by QB64. @@ -102,4 +102,3 @@ MouseMove 200, 200 {{PageNavigation}} - diff --git a/internal/help/DEFDBL_111111.txt b/internal/help/DEFDBL_111111.txt index 63930def7..0ff17635e 100644 --- a/internal/help/DEFDBL_111111.txt +++ b/internal/help/DEFDBL_111111.txt @@ -1,5 +1,5 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:12:45}} +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:41:51}} The [[DEFDBL]] statement defines all variables with names starting with the specified letter (or letter range) AS [[DOUBLE]] variables instead of the [[SINGLE]] type default. @@ -7,7 +7,7 @@ The [[DEFDBL]] statement defines all variables with names starting with the spec : [[DEFDBL]] {{Parameter|letter}}[-{{Parameter|range}}], {{Parameter|letter2}}[-{{Parameter|range2}}], [...] -{{PageLegacySupport}} +===Legacy support=== * '''DEF''' statements ([[DEFDBL]], [[DEFSNG]], [[DEFLNG]], [[DEFINT]], [[DEFSTR]]) were used when storage space was a concern in older computers, as their usage could save up typing. Instead of {{InlineCode}}DIM a AS DOUBLE, a2 AS DOUBLE, a3 AS DOUBLE{{InlineCodeEnd}}, simply having {{InlineCode}}DEFDBL A{{InlineCodeEnd}} in the code before using variables starting with letter '''A''' would do the same job. * For clarity, it is recommended to declare variables with meaningful names. @@ -40,4 +40,3 @@ The [[DEFDBL]] statement defines all variables with names starting with the spec {{PageNavigation}} - diff --git a/internal/help/DEFINT_111111.txt b/internal/help/DEFINT_111111.txt index de6eac48a..da51160e4 100644 --- a/internal/help/DEFINT_111111.txt +++ b/internal/help/DEFINT_111111.txt @@ -1,5 +1,5 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:12:46}} +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:41:53}} The [[DEFINT]] statement defines all variables with names starting with the specified letter (or letter range) AS [[INTEGER]] variables instead of the [[SINGLE]] type default. @@ -7,7 +7,7 @@ The [[DEFINT]] statement defines all variables with names starting with the spec : [[DEFINT]] {{Parameter|letter}}[-{{Parameter|range}}], {{Parameter|letter2}}[-{{Parameter|range2}}], [...] -{{PageLegacySupport}} +===Legacy support=== * '''DEF''' statements ([[DEFDBL]], [[DEFSNG]], [[DEFLNG]], [[DEFINT]], [[DEFSTR]]) were used when storage space was a concern in older computers, as their usage could save up typing. Instead of {{InlineCode}}DIM a AS INTEGER, a2 AS INTEGER, a3 AS INTEGER{{InlineCodeEnd}}, simply having {{InlineCode}}DEFINT A{{InlineCodeEnd}} in the code before using variables starting with letter '''A''' would do the same job. * For clarity, it is recommended to declare variables with meaningful names. @@ -41,4 +41,3 @@ The [[DEFINT]] statement defines all variables with names starting with the spec {{PageNavigation}} - diff --git a/internal/help/DEFLNG_111111.txt b/internal/help/DEFLNG_111111.txt index b405d8f55..519e27f50 100644 --- a/internal/help/DEFLNG_111111.txt +++ b/internal/help/DEFLNG_111111.txt @@ -1,5 +1,5 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:12:47}} +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:41:54}} The [[DEFLNG]] statement defines all variables with names starting with the specified letter (or letter range) AS [[LONG]] variables instead of the [[SINGLE]] type default. @@ -7,7 +7,7 @@ The [[DEFLNG]] statement defines all variables with names starting with the spec : [[DEFLNG]] {{Parameter|letter}}[-{{Parameter|range}}], {{Parameter|letter2}}[-{{Parameter|range2}}], [...] -{{PageLegacySupport}} +===Legacy support=== * '''DEF''' statements ([[DEFDBL]], [[DEFSNG]], [[DEFLNG]], [[DEFINT]], [[DEFSTR]]) were used when storage space was a concern in older computers, as their usage could save up typing. Instead of {{InlineCode}}DIM a AS LONG, a2 AS LONG, a3 AS LONG{{InlineCodeEnd}}, simply having {{InlineCode}}DEFLNG A{{InlineCodeEnd}} in the code before using variables starting with letter '''A''' would do the same job. * For clarity, it is recommended to declare variables with meaningful names. @@ -41,4 +41,3 @@ The [[DEFLNG]] statement defines all variables with names starting with the spec {{PageNavigation}} - diff --git a/internal/help/DEFSNG_111111.txt b/internal/help/DEFSNG_111111.txt index 986e1d7c7..51e5f1e5a 100644 --- a/internal/help/DEFSNG_111111.txt +++ b/internal/help/DEFSNG_111111.txt @@ -1,5 +1,5 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:12:48}} +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:41:55}} The [[DEFSNG]] statement defines all variables with names starting with the specified letter (or letter range) AS [[SINGLE]] variables. @@ -7,7 +7,7 @@ The [[DEFSNG]] statement defines all variables with names starting with the spec : [[DEFSNG]] {{Parameter|letter}}[-{{Parameter|range}}], {{Parameter|letter2}}[-{{Parameter|range2}}], [...] -{{PageLegacySupport}} +===Legacy support=== * '''DEF''' statements ([[DEFDBL]], [[DEFSNG]], [[DEFLNG]], [[DEFINT]], [[DEFSTR]]) were used when storage space was a concern in older computers, as their usage could save up typing. Instead of {{InlineCode}}DIM a AS SINGLE, a2 AS SINGLE, a3 AS SINGLE{{InlineCodeEnd}}, simply having {{InlineCode}}DEFSNG A{{InlineCodeEnd}} in the code before using variables starting with letter '''A''' would do the same job. * For clarity, it is recommended to declare variables with meaningful names. @@ -41,4 +41,3 @@ The [[DEFSNG]] statement defines all variables with names starting with the spec {{PageNavigation}} - diff --git a/internal/help/DEFSTR_111111.txt b/internal/help/DEFSTR_111111.txt index f9397bd53..5abd37b33 100644 --- a/internal/help/DEFSTR_111111.txt +++ b/internal/help/DEFSTR_111111.txt @@ -1,5 +1,5 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:12:49}} +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:41:56}} The [[DEFSTR]] statement defines all variables with names starting with the specified letter (or letter range) AS [[STRING]] variables instead of the [[SINGLE]] type default. @@ -7,7 +7,7 @@ The [[DEFSTR]] statement defines all variables with names starting with the spec : [[DEFSTR]] {{Parameter|letter}}[-{{Parameter|range}}], {{Parameter|letter2}}[-{{Parameter|range2}}], [...] -{{PageLegacySupport}} +===Legacy support=== * '''DEF''' statements ([[DEFDBL]], [[DEFSNG]], [[DEFLNG]], [[DEFINT]], [[DEFSTR]]) were used when storage space was a concern in older computers, as their usage could save up typing. Instead of {{InlineCode}}DIM a AS STRING, a2 AS STRING, a3 AS STRING{{InlineCodeEnd}}, simply having {{InlineCode}}DEFSTR A{{InlineCodeEnd}} in the code before using variables starting with letter '''A''' would do the same job. * For clarity, it is recommended to declare variables with meaningful names. @@ -40,4 +40,3 @@ The [[DEFSTR]] statement defines all variables with names starting with the spec {{PageNavigation}} - diff --git a/internal/help/DEF_SEG_111_111.txt b/internal/help/DEF_SEG_111_111.txt index 91cdb6a35..9222b25c8 100644 --- a/internal/help/DEF_SEG_111_111.txt +++ b/internal/help/DEF_SEG_111_111.txt @@ -1,16 +1,16 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:12:44}} +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:41:50}} [[DEF SEG]] is used to define the area in memory to access QB64's emulated conventional memory. -{{PageLegacySupport}} -* '''QB64 implements memory access using [[_MEM]] and related functions. For that reason, [[DEF SEG]] isn't recommended practice anymore and is supported to maintain compatibility with legacy code.''' - - {{PageSyntax}} : [[DEF SEG]] [=][{segment|VARSEG(variable}] +===Legacy support=== +* '''QB64 implements memory access using [[_MEM]] and related functions. For that reason, [[DEF SEG]] isn't recommended practice anymore and is supported to maintain compatibility with legacy code.''' + + {{PageDescription}} * Used to set the pointer to a memory area of a variable/array or register. * [[PEEK]] and [[POKE]] require a segment memory address (often just 0) without using VARSEG. @@ -72,4 +72,3 @@ filename = file + {{Cl|CHR$}}(0) 'create zero string name for DOS {{PageNavigation}} - diff --git a/internal/help/DIM_111.txt b/internal/help/DIM_111.txt index 2e01b2219..3848e00d1 100644 --- a/internal/help/DIM_111.txt +++ b/internal/help/DIM_111.txt @@ -1,5 +1,5 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:12:51}} +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:41:57}} The [[DIM]] statement is used to declare a variable or a list of variables as a specified data type or to dimension [[$STATIC]] or [[$DYNAMIC]] [[Arrays|arrays]]. @@ -109,4 +109,3 @@ x = 1 'x is a {{Cl|SINGLE}} variable {{PageNavigation}} - diff --git a/internal/help/DO...LOOP_11...1111.txt b/internal/help/DO...LOOP_11...1111.txt index a77652b71..092b0f442 100644 --- a/internal/help/DO...LOOP_11...1111.txt +++ b/internal/help/DO...LOOP_11...1111.txt @@ -1,5 +1,5 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:12:52}} +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:41:59}} '''DO...LOOP''' statements are used in programs to repeat code or return to the start of a procedure. @@ -31,7 +31,7 @@ * If a loop never meets an exit condition requirement, it will never stop. -{{Template:RelationalTable}} +{{RelationalTable}} {{PageExamples}} @@ -150,4 +150,3 @@ COLOR 14: LOCATE 10, 25 {{PageNavigation}} - diff --git a/internal/help/DOUBLE_111111.txt b/internal/help/DOUBLE_111111.txt index f99bc7d3b..36884f847 100644 --- a/internal/help/DOUBLE_111111.txt +++ b/internal/help/DOUBLE_111111.txt @@ -1,5 +1,5 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:12:53}} +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:42:00}} [[DOUBLE]] type floating point numerical values use 8 bytes per value. @@ -31,4 +31,3 @@ {{PageNavigation}} - diff --git a/internal/help/DRAW_1111.txt b/internal/help/DRAW_1111.txt index 87973d8a0..58f8f3cba 100644 --- a/internal/help/DRAW_1111.txt +++ b/internal/help/DRAW_1111.txt @@ -1,5 +1,5 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:12:54}} +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:42:01}} The [[DRAW]] statement uses a [[STRING]] expression to draw lines on the screen. @@ -168,4 +168,3 @@ k = {{Cl|_RGB}}(80, 255, 80) {{PageNavigation}} - diff --git a/internal/help/Dollar_Sign_100000_1000.txt b/internal/help/Dollar_Sign_100000_1000.txt index e545428ef..56e4caa19 100644 --- a/internal/help/Dollar_Sign_100000_1000.txt +++ b/internal/help/Dollar_Sign_100000_1000.txt @@ -1,5 +1,5 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:24:43}} +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:53:58}} The '''$''' is used to denote QBasic [[Metacommand]]s or as a [[STRING]] variable type suffix. @@ -20,4 +20,3 @@ The '''$''' is used to denote QBasic [[Metacommand]]s or as a [[STRING]] variabl {{PageNavigation}} - diff --git a/internal/help/ELSEIF_111111.txt b/internal/help/ELSEIF_111111.txt index c344668ff..058b7f588 100644 --- a/internal/help/ELSEIF_111111.txt +++ b/internal/help/ELSEIF_111111.txt @@ -1,5 +1,5 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:12:59}} +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:42:05}} [[ELSEIF]] is used in an [[IF...THEN]] block statement to offer an alternative condition. @@ -24,7 +24,7 @@ * You can use [[SELECT CASE]] when IF blocks have a long list of alterative ELSEIF conditions. -{{Template:RelationalTable}} +{{RelationalTable}} {{PageExamples}} @@ -55,4 +55,3 @@ END IF {{PageNavigation}} - diff --git a/internal/help/ELSE_1111.txt b/internal/help/ELSE_1111.txt index 5b498c80d..35d337543 100644 --- a/internal/help/ELSE_1111.txt +++ b/internal/help/ELSE_1111.txt @@ -1,5 +1,5 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:12:57}} +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:42:03}} [[ELSE]] is used in [[IF...THEN]] or [[SELECT CASE]] statements to offer an alternative to other conditional statements. @@ -62,4 +62,3 @@ IF a = 3 THEN a = 5 ELSE a = 3 {{PageNavigation}} - diff --git a/internal/help/END_111.txt b/internal/help/END_111.txt index 8779e4a49..1a6062722 100644 --- a/internal/help/END_111.txt +++ b/internal/help/END_111.txt @@ -1,5 +1,5 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:13:00}} +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:42:06}} The [[END]] statement terminates a program without an immediate exit or ends a procedure or statement block. @@ -52,4 +52,3 @@ Press any key to continue... {{PageNavigation}} - diff --git a/internal/help/ENVIRON$_1111111$.txt b/internal/help/ENVIRON$_1111111$.txt index 68f6b4026..47c951e50 100644 --- a/internal/help/ENVIRON$_1111111$.txt +++ b/internal/help/ENVIRON$_1111111$.txt @@ -1,5 +1,5 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:13:04}} +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:42:09}} The [[ENVIRON$]] function returns a [[STRING]] environmental value from '''Windows'''' environmental settings list. @@ -127,4 +127,3 @@ Q$ = {{Cl|CHR$}}(34) '=== Write URL Shortcut file info. {{PageNavigation}} - diff --git a/internal/help/ENVIRON_1111111.txt b/internal/help/ENVIRON_1111111.txt index 7378f2b41..712780f26 100644 --- a/internal/help/ENVIRON_1111111.txt +++ b/internal/help/ENVIRON_1111111.txt @@ -1,5 +1,5 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:13:02}} +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:42:08}} The [[ENVIRON]] statement is used to temporarily set or change an environmental string value. @@ -22,4 +22,3 @@ The [[ENVIRON]] statement is used to temporarily set or change an environmental {{PageNavigation}} - diff --git a/internal/help/EOF_111.txt b/internal/help/EOF_111.txt index 02a0fd5dc..2f46a4446 100644 --- a/internal/help/EOF_111.txt +++ b/internal/help/EOF_111.txt @@ -1,5 +1,5 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:13:05}} +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:42:10}} The [[EOF]] function indicates that the end of a file has been reached. @@ -24,4 +24,3 @@ The [[EOF]] function indicates that the end of a file has been reached. {{PageNavigation}} - diff --git a/internal/help/EQV_111.txt b/internal/help/EQV_111.txt index e67dd6ad8..ad9d8a295 100644 --- a/internal/help/EQV_111.txt +++ b/internal/help/EQV_111.txt @@ -1,5 +1,5 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:13:06}} +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:42:11}} The [[EQV]] operator returns a value based on the ''equivalence'' of two conditions or values. @@ -12,7 +12,7 @@ The [[EQV]] operator returns a value based on the ''equivalence'' of two conditi * Turns a bit on if both bits are the same, turns a bit off if both bits are different. -{{Template:LogicalTruthTable}} +{{LogicalTruthTable}} {{PageSeeAlso}} @@ -21,4 +21,3 @@ The [[EQV]] operator returns a value based on the ''equivalence'' of two conditi {{PageNavigation}} - diff --git a/internal/help/ERASE_11111.txt b/internal/help/ERASE_11111.txt index 5fdfdda76..6783432dd 100644 --- a/internal/help/ERASE_11111.txt +++ b/internal/help/ERASE_11111.txt @@ -1,5 +1,5 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:13:07}} +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:42:13}} The [[ERASE]] statement is used to clear all data from an array. [[$STATIC]] [[Arrays|array]] dimensions are not affected. @@ -24,4 +24,3 @@ The [[ERASE]] statement is used to clear all data from an array. [[$STATIC]] [[A {{PageNavigation}} - diff --git a/internal/help/ERL_111.txt b/internal/help/ERL_111.txt index 361aa557d..9c1048afa 100644 --- a/internal/help/ERL_111.txt +++ b/internal/help/ERL_111.txt @@ -1,5 +1,5 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:13:11}} +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:42:14}} The [[ERL]] function returns the closest previous line number before the last error. @@ -43,4 +43,3 @@ errorfix: {{PageNavigation}} - diff --git a/internal/help/ERROR_11111.txt b/internal/help/ERROR_11111.txt index 1da8bcb1e..a0cbd6514 100644 --- a/internal/help/ERROR_11111.txt +++ b/internal/help/ERROR_11111.txt @@ -1,5 +1,5 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:13:14}} +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:42:16}} The [[ERROR]] statement is used to simulate a program error or to troubleshoot error handling procedures. @@ -41,4 +41,3 @@ handler: {{PageNavigation}} - diff --git a/internal/help/ERR_111.txt b/internal/help/ERR_111.txt index f4d8dd59e..61375c39b 100644 --- a/internal/help/ERR_111.txt +++ b/internal/help/ERR_111.txt @@ -1,5 +1,5 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:13:13}} +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:42:15}} The [[ERR]] function returns the last QBasic error code number. @@ -44,4 +44,3 @@ handler: {{PageNavigation}} - diff --git a/internal/help/EXIT_1111.txt b/internal/help/EXIT_1111.txt index 43e06acf8..396b30940 100644 --- a/internal/help/EXIT_1111.txt +++ b/internal/help/EXIT_1111.txt @@ -1,5 +1,5 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:13:15}} +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:42:17}} The [[EXIT]] statement is used to exit certain QBasic procedures. @@ -35,4 +35,3 @@ The [[EXIT]] statement is used to exit certain QBasic procedures. {{PageNavigation}} - diff --git a/internal/help/EXP_111.txt b/internal/help/EXP_111.txt index 79e8dac10..fbecd8385 100644 --- a/internal/help/EXP_111.txt +++ b/internal/help/EXP_111.txt @@ -1,5 +1,5 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:13:17}} +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:42:18}} The [[EXP]] math function calculates the exponential function ('''e''' raised to the power of a {{Parameter|numericExpression}}). @@ -23,4 +23,3 @@ The [[EXP]] math function calculates the exponential function ('''e''' raised to {{PageNavigation}} - diff --git a/internal/help/Equal_10000.txt b/internal/help/Equal_10000.txt index c84e5e09c..0ca01c988 100644 --- a/internal/help/Equal_10000.txt +++ b/internal/help/Equal_10000.txt @@ -1,5 +1,5 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:24:58}} +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:54:11}} View source for Equal @@ -50,4 +50,3 @@ Related changes Special pages Page information Privacy policyAbout QB64 WikiDisclaimersPowered by MediaWiki - diff --git a/internal/help/FIELD_11111.txt b/internal/help/FIELD_11111.txt index 7a96865b4..d53574574 100644 --- a/internal/help/FIELD_11111.txt +++ b/internal/help/FIELD_11111.txt @@ -1,5 +1,5 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:13:18}} +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:42:19}} The [[FIELD]] statement creates a [[STRING]] type definition for a [[RANDOM|random]]-access file buffer. @@ -90,4 +90,3 @@ Demo using the FIELD statement to read the file: {{PageNavigation}} - diff --git a/internal/help/FILES_11111.txt b/internal/help/FILES_11111.txt index 021316fd3..e406998f8 100644 --- a/internal/help/FILES_11111.txt +++ b/internal/help/FILES_11111.txt @@ -1,5 +1,5 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:13:20}} +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:42:20}} The [[FILES]] statement is used to print a list of files in the current directory using a file specification. @@ -25,28 +25,8 @@ The [[FILES]] statement is used to print a list of files in the current director ''Example 1:'' Finding a list of all BAS files in the current folder. {{CodeStart}}{{Cl|FILES}} "*.BAS" {{CodeEnd}} - - - ==Alternative file list solutions== ''Alternative 1:'' The DIR$ function adapted from PDS (7.1) returns a filename or a list when more than one exist. The file spec can use a path and/or wildcards. {{CodeStart}} @@ -98,7 +78,6 @@ DIR$ = DirList$(Index%) ''Alternative 2:'' * The member-contributed [[FILELIST$]] function uses the mouse and does not affect your program screens. It can verify that a file name exists or display a list of long and short file names to choose from. It also avoids program errors when a file name does not exist. - {{PageSeeAlso}} * [[SHELL]], [[SCREEN (function)]] {{text|(See Example 3)}} @@ -112,4 +91,3 @@ DIR$ = DirList$(Index%) {{PageNavigation}} - diff --git a/internal/help/FIX_111.txt b/internal/help/FIX_111.txt index 3965e995d..7d99bd1aa 100644 --- a/internal/help/FIX_111.txt +++ b/internal/help/FIX_111.txt @@ -1,5 +1,5 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:13:22}} +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:42:22}} The [[FIX]] function rounds a numerical value to the next whole number closest to zero. @@ -59,4 +59,3 @@ The [[FIX]] function rounds a numerical value to the next whole number closest t {{PageNavigation}} - diff --git a/internal/help/FOR...NEXT_111...1111.txt b/internal/help/FOR...NEXT_111...1111.txt index 6f585151c..f4432e5e2 100644 --- a/internal/help/FOR...NEXT_111...1111.txt +++ b/internal/help/FOR...NEXT_111...1111.txt @@ -1,5 +1,5 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:13:23}} +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:42:23}} The [[FOR]] statement creates a counter loop using specified start and stop numerical boundaries. The default increment is + 1. @@ -71,4 +71,3 @@ bye {{OutputEnd}} {{PageNavigation}} - diff --git a/internal/help/FOR_(file_statement)_111_(0000_000000000).txt b/internal/help/FOR_(file_statement)_111_(0000_000000000).txt index 3351cb40a..17e2f780e 100644 --- a/internal/help/FOR_(file_statement)_111_(0000_000000000).txt +++ b/internal/help/FOR_(file_statement)_111_(0000_000000000).txt @@ -1,5 +1,5 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:13:24}} +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:42:24}} The [[OPEN]] statement is used to open a file or [[OPEN_COM|COM]] serial communications port for program input or output. @@ -161,4 +161,3 @@ It was overwritten with this and deleted. {{PageNavigation}} - diff --git a/internal/help/FREEFILE_11111111.txt b/internal/help/FREEFILE_11111111.txt index 5abad8f88..b3edcad5f 100644 --- a/internal/help/FREEFILE_11111111.txt +++ b/internal/help/FREEFILE_11111111.txt @@ -1,5 +1,5 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:13:28}} +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:42:26}} The [[FREEFILE]] function returns a [[LONG]] value that is an unused file access number. @@ -21,4 +21,3 @@ The [[FREEFILE]] function returns a [[LONG]] value that is an unused file access {{PageNavigation}} - diff --git a/internal/help/FUNCTION_11111111.txt b/internal/help/FUNCTION_11111111.txt index b2928488b..83d3429a9 100644 --- a/internal/help/FUNCTION_11111111.txt +++ b/internal/help/FUNCTION_11111111.txt @@ -1,5 +1,5 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:13:29}} +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:42:27}} A [[FUNCTION]] block statement is used to create a function procedure to return a calculated value to a program. @@ -84,4 +84,3 @@ IntegerArray& = ImageBufferSize&(wide&, deep&, mode%) \ 2 ' returns size of an { {{PageNavigation}} - diff --git a/internal/help/GET_(TCP%2FIP_statement)_111_(111%2111_000000000).txt b/internal/help/GET_(TCP%2FIP_statement)_111_(111%2111_000000000).txt index 41ade186f..f0737c6d4 100644 --- a/internal/help/GET_(TCP%2FIP_statement)_111_(111%2111_000000000).txt +++ b/internal/help/GET_(TCP%2FIP_statement)_111_(111%2111_000000000).txt @@ -1,5 +1,5 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:13:32}} +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:42:30}} '''GET''' reads unformatted (raw) data from an open TCP/IP connection opened with [[_OPENCLIENT]], [[_OPENHOST]] or [[_OPENCONNECTION]]. @@ -50,4 +50,3 @@ {{PageNavigation}} - diff --git a/internal/help/GET_(graphics_statement)_111_(00000000_000000000).txt b/internal/help/GET_(graphics_statement)_111_(00000000_000000000).txt index 774391b04..ff4a76933 100644 --- a/internal/help/GET_(graphics_statement)_111_(00000000_000000000).txt +++ b/internal/help/GET_(graphics_statement)_111_(00000000_000000000).txt @@ -1,12 +1,12 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:13:33}} +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:42:31}} The [[GET (graphics statement)|GET]] statement is used in graphics to store a box area image of the screen into an [[INTEGER]] array. {{PageSyntax}} : [[GET]] [STEP] ({{Parameter|column1}}, {{Parameter|row1}})-[STEP]({{Parameter|column2}}, {{Parameter|row2}}), {{Parameter|array}}([{{Parameter|index}}])[, {{Parameter|offscreenColor}}] -{{PageLegacySupport}} +===Legacy support=== * '''QB64''' can manipulate parts of an image using [[_PUTIMAGE]]. For that reason, '''GET''' isn't recommended practice anymore and is supported to maintain compatibility with legacy code. @@ -109,4 +109,3 @@ a& = {{Cl|_NEWIMAGE}}(800, 600, 13) 'larger surface a& emulates screen 13 co {{PageNavigation}} - diff --git a/internal/help/GET_111.txt b/internal/help/GET_111.txt index 5a38251cf..661487515 100644 --- a/internal/help/GET_111.txt +++ b/internal/help/GET_111.txt @@ -1,5 +1,5 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:13:30}} +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:42:29}} The [[GET #]] statement reads data from a file or port device by bytes or record positions. @@ -108,4 +108,3 @@ showme 'display array after transfer from file {{PageNavigation}} - diff --git a/internal/help/GOSUB_11111.txt b/internal/help/GOSUB_11111.txt index f36d07f30..8d6c9b534 100644 --- a/internal/help/GOSUB_11111.txt +++ b/internal/help/GOSUB_11111.txt @@ -1,5 +1,5 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:13:34}} +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:42:32}} [[GOSUB]] sends the program flow to a sub procedure identified by a line number or label. @@ -13,7 +13,7 @@ * GOSUB and GOTO can be used '''within''' [[SUB]] or [[FUNCTION]] procedures, but cannot refer to a label located outside the procedure. -{{PageQBasic}} +===QBasic/QuickBASIC=== * Too many GOSUBs without a [[RETURN]] can eventually cause "Out of Stack Errors" in QBasic as each GOSUB uses memory to store the location to return to. Each [[RETURN]] frees the memory of the GOSUB it returns to. @@ -77,4 +77,3 @@ It returned to IF a = 1 {{PageNavigation}} - diff --git a/internal/help/GOTO_1111.txt b/internal/help/GOTO_1111.txt index 0d6d49735..95ffa529e 100644 --- a/internal/help/GOTO_1111.txt +++ b/internal/help/GOTO_1111.txt @@ -1,5 +1,5 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:13:36}} +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:42:33}} The [[GOTO]] statement sends the procedure to a line label or a line number in the program. @@ -48,4 +48,3 @@ second line {{PageNavigation}} - diff --git a/internal/help/Greater_Than_1000000_1000.txt b/internal/help/Greater_Than_1000000_1000.txt index b070dff39..6e875ba21 100644 --- a/internal/help/Greater_Than_1000000_1000.txt +++ b/internal/help/Greater_Than_1000000_1000.txt @@ -1,5 +1,5 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:25:01}} +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:54:14}} The '''>''' condition symbol denotes that a value must be greater than another value for the condition to be True. @@ -19,4 +19,3 @@ The '''>''' condition symbol denotes that a value must be greater than another v {{PageNavigation}} - diff --git a/internal/help/Greater_Than_Or_Equal_1000000_1000_10_10000.txt b/internal/help/Greater_Than_Or_Equal_1000000_1000_10_10000.txt index fe4787115..c72ed17fa 100644 --- a/internal/help/Greater_Than_Or_Equal_1000000_1000_10_10000.txt +++ b/internal/help/Greater_Than_Or_Equal_1000000_1000_10_10000.txt @@ -1,5 +1,5 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:25:03}} +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:54:16}} The '''>=''' condition symbol denotes that a value must be greater than or equal to another value for the condition to be True. @@ -15,4 +15,3 @@ The '''>=''' condition symbol denotes that a value must be greater than or equal {{PageNavigation}} - diff --git a/internal/help/HEX$_111$.txt b/internal/help/HEX$_111$.txt index c0d5d5027..d6126e293 100644 --- a/internal/help/HEX$_111$.txt +++ b/internal/help/HEX$_111$.txt @@ -1,5 +1,5 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:13:37}} +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:42:35}} This function returns the hexadecimal (base 16) representation of any numeric value. @@ -16,11 +16,11 @@ This function returns the hexadecimal (base 16) representation of any numeric va * The function returns the base 16 (hexadecimal) representation of the given {{Parameter|number}} as [[STRING]]. * Different from [[STR$]], this function does not return a leading sign placeholder space, so no [[LTRIM$]] to strip that space from positive numbers is necessary. * [[VAL]] can convert the returned hex string value back to a decimal value by prefixing the string with "[[&H]]". -** Eg. {{InlineCode}}decimal = VAL("&H" + hexvalue$){{InlineCodeEnd}}. +** Eg. {{InlineCode}}decimal = {{Cl|VAL}}("&H" + hexvalue$){{InlineCodeEnd}}. {{PageExamples}} -;Example 1: Comparing decimal, hexadecimal, octal and binary string values from 0 to 15. +;Example 1:Comparing decimal, hexadecimal, octal and binary string values from 0 to 15. {{CodeStart}} tabletop$ = " Decimal | Hexadecimal | Octal | Binary " tablesep$ = "---------+-------------+-------+--------" @@ -68,11 +68,12 @@ Converting Hex value to Decimal: 255 {{PageSeeAlso}} -* [[_BIN$]], [[OCT$]], [[STR$]], [[VAL]] -* [[&B]] {{text|(binary)}}, [[&H]] {{text|(hexadecimal)}}, [[&O]] {{text|(octal)}} +* [[_BIN$]], [[OCT$]], [[STR$]] +* [[&B]] (binary), [[&H]] (hexadecimal), [[&O]] (octal), [[VAL]] * [[Base Comparisons]] * [[HEX$ 32 Bit Values]] {{PageNavigation}} +[[Category:Final]] diff --git a/internal/help/IF...THEN_11...1111.txt b/internal/help/IF...THEN_11...1111.txt index 893c9bff7..fb71b6446 100644 --- a/internal/help/IF...THEN_11...1111.txt +++ b/internal/help/IF...THEN_11...1111.txt @@ -1,5 +1,5 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:13:01}} +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:42:07}} [[IF...THEN]] statements make boolean (true or false) evaluations to automate program decision making. {{PageSyntax}} @@ -37,10 +37,10 @@ -{{Template:RelationalTable}} +{{RelationalTable}} -
When evaluating a number value, no IF value > 0 operation is necessary for values not 0. Use: IF value THEN
+
When evaluating a number value, no IF value > 0 operation is necessary for values not 0. Use: IF value THEN
'''Boolean Conditional Operators:'''
@@ -55,7 +55,7 @@
* Truth table of the 6 BASIC Logical Operators:
-{{Template:LogicalTruthTable}} +{{LogicalTruthTable}}
* '''Note that Basic returns -1 for True and 0 for False.'''
@@ -135,4 +135,3 @@ z# = x# + y# {{PageNavigation}} - diff --git a/internal/help/IMP_111.txt b/internal/help/IMP_111.txt index 19533d91d..bfd35dd53 100644 --- a/internal/help/IMP_111.txt +++ b/internal/help/IMP_111.txt @@ -1,5 +1,5 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:13:38}} +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:42:36}} The [[IMP]] logical operator converts the result of two comparative values and returns a bit result. @@ -14,7 +14,7 @@ The [[IMP]] logical operator converts the result of two comparative values and r **So if {{Parameter|firstValue}} is true, and {{Parameter|secondValue}} false, then the condition is false, otherwise it is true (see table below). -{{Template:LogicalTruthTable}} +{{LogicalTruthTable}} {{PageSeeAlso}} @@ -23,4 +23,3 @@ The [[IMP]] logical operator converts the result of two comparative values and r {{PageNavigation}} - diff --git a/internal/help/INKEY$_11111$.txt b/internal/help/INKEY$_11111$.txt index 6c951c09e..b4b87eb96 100644 --- a/internal/help/INKEY$_11111$.txt +++ b/internal/help/INKEY$_11111$.txt @@ -1,5 +1,5 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:13:41}} +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:42:38}} The [[INKEY$]] function returns user input as [[ASCII]] [[STRING]] character(s) from the keyboard buffer. @@ -232,4 +232,3 @@ DO {{PageNavigation}} - diff --git a/internal/help/INPUT$_11111$.txt b/internal/help/INPUT$_11111$.txt index 0a4f3b202..43c4a4774 100644 --- a/internal/help/INPUT$_11111$.txt +++ b/internal/help/INPUT$_11111$.txt @@ -1,5 +1,5 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:13:47}} +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:42:45}} The [[INPUT$]] function is used to receive data from the user's keyboard, an open file or an open port. @@ -58,4 +58,3 @@ IF {{Cl|LOF}}(1) <= 32767 THEN Text$ = {{Cl|INPUT$}}(LOF(1), 1) {{PageNavigation}} - diff --git a/internal/help/INPUT_(file_mode)_11111_(0000_0000).txt b/internal/help/INPUT_(file_mode)_11111_(0000_0000).txt index 8cde11b96..2cf5c09e3 100644 --- a/internal/help/INPUT_(file_mode)_11111_(0000_0000).txt +++ b/internal/help/INPUT_(file_mode)_11111_(0000_0000).txt @@ -1,5 +1,5 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:13:45}} +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:42:42}} The [[OPEN]] statement is used to open a file or [[OPEN_COM|COM]] serial communications port for program input or output. @@ -161,4 +161,3 @@ It was overwritten with this and deleted. {{PageNavigation}} - diff --git a/internal/help/INPUT_(file_statement)_11111_(0000_000000000).txt b/internal/help/INPUT_(file_statement)_11111_(0000_000000000).txt index 318d616cb..000427daf 100644 --- a/internal/help/INPUT_(file_statement)_11111_(0000_000000000).txt +++ b/internal/help/INPUT_(file_statement)_11111_(0000_000000000).txt @@ -1,5 +1,5 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:13:46}} +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:42:43}} The [[INPUT #]] file or port statement reads sequential data using one variable or a comma separated list of matching variable types. @@ -88,4 +88,3 @@ y$ = "I'm fine." {{PageNavigation}} - diff --git a/internal/help/INPUT_11111.txt b/internal/help/INPUT_11111.txt index 86f59b918..4e3576f8f 100644 --- a/internal/help/INPUT_11111.txt +++ b/internal/help/INPUT_11111.txt @@ -1,5 +1,5 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:13:43}} +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:42:41}} The [[INPUT]] statement requests a [[STRING]] or numerical keyboard entry from the user. @@ -86,4 +86,3 @@ n$ = {{Cl|UCASE$}}(name$) ' convert search name to upper case {{PageNavigation}} - diff --git a/internal/help/INP_111.txt b/internal/help/INP_111.txt index 7347da131..92c654596 100644 --- a/internal/help/INP_111.txt +++ b/internal/help/INP_111.txt @@ -1,5 +1,5 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:13:42}} +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:42:39}} [[INP]] returns a value from a computer register or port values at a specified physical address. @@ -120,4 +120,3 @@ ScanKey% = keyflags%(scancode%) {{PageNavigation}} - diff --git a/internal/help/INSTR_11111.txt b/internal/help/INSTR_11111.txt index 6d9c281b7..811c1ff94 100644 --- a/internal/help/INSTR_11111.txt +++ b/internal/help/INSTR_11111.txt @@ -1,5 +1,5 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:13:48}} +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:42:46}} The [[INSTR]] function searches for the first occurence of a search [[STRING]] within a base string and returns the position it was found. @@ -54,4 +54,3 @@ There is 'cats' in the string at position: 62 {{PageNavigation}} - diff --git a/internal/help/INTEGER_1111111.txt b/internal/help/INTEGER_1111111.txt index 945a27ebc..86c705811 100644 --- a/internal/help/INTEGER_1111111.txt +++ b/internal/help/INTEGER_1111111.txt @@ -1,5 +1,5 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:13:51}} +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:42:48}} [[INTEGER]] is a 2-byte number type definition that can hold whole numerical values. @@ -61,4 +61,3 @@ i~% = 70000 {{PageNavigation}} - diff --git a/internal/help/INTERRUPTX_1111111111.txt b/internal/help/INTERRUPTX_1111111111.txt index 611de9d8d..99bad390b 100644 --- a/internal/help/INTERRUPTX_1111111111.txt +++ b/internal/help/INTERRUPTX_1111111111.txt @@ -1,5 +1,5 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:13:53}} +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:42:51}} The [[INTERRUPTX]] statement is an assembly routine for accessing computer information registers. @@ -7,7 +7,7 @@ The [[INTERRUPTX]] statement is an assembly routine for accessing computer infor : [[CALL]] [[INTERRUPTX]]({{Parameter|intNum}}, {{Parameter|inRegs}}, {{Parameter|outRegs}}) -{{PageLegacySupport}} +===Legacy support=== * Registers are emulated in '''QB64''' to allow older programs to be compiled. To enable mouse input in your programs, the recommended practice is to use [[_MOUSEINPUT]] and related functions. @@ -49,4 +49,3 @@ The [[INTERRUPTX]] statement is an assembly routine for accessing computer infor {{PageNavigation}} - diff --git a/internal/help/INTERRUPT_111111111.txt b/internal/help/INTERRUPT_111111111.txt index 1d7514fab..32245400e 100644 --- a/internal/help/INTERRUPT_111111111.txt +++ b/internal/help/INTERRUPT_111111111.txt @@ -1,5 +1,5 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:13:52}} +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:42:50}} The [[INTERRUPT]] statement is an assembly routine for accessing computer information registers. @@ -7,7 +7,7 @@ The [[INTERRUPT]] statement is an assembly routine for accessing computer inform : [[CALL]] [[INTERRUPT]]({{Parameter|intNum}}, {{Parameter|inRegs}}, {{Parameter|outRegs}}) -{{PageLegacySupport}} +===Legacy support=== * Registers are emulated in '''QB64''' to allow older programs to be compiled. To enable mouse input in your programs, the recommended practice is to use [[_MOUSEINPUT]] and related functions. @@ -49,4 +49,3 @@ The [[INTERRUPT]] statement is an assembly routine for accessing computer inform {{PageNavigation}} - diff --git a/internal/help/INT_111.txt b/internal/help/INT_111.txt index b6ddd6a5b..d3a1b9ec5 100644 --- a/internal/help/INT_111.txt +++ b/internal/help/INT_111.txt @@ -1,5 +1,5 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:13:49}} +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:42:47}} The [[INT]] function rounds a numeric value down to the next whole number. @@ -36,4 +36,3 @@ PRINT INT(-2.5) {{PageNavigation}} - diff --git a/internal/help/KEY(n)_111(0).txt b/internal/help/KEY(n)_111(0).txt index 7a31979da..4f6397231 100644 --- a/internal/help/KEY(n)_111(0).txt +++ b/internal/help/KEY(n)_111(0).txt @@ -1,5 +1,5 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:13:58}} +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:42:53}} '''KEY(n)''' assigns, enables, disables or suspends event trapping of a keypress by setting the flag [[ON]], [[STOP]] or [[OFF]]. @@ -69,4 +69,3 @@ SLEEP {{PageNavigation}} - diff --git a/internal/help/KEY_LIST_111_1111.txt b/internal/help/KEY_LIST_111_1111.txt index c1f97c7e2..0a2c0b6d9 100644 --- a/internal/help/KEY_LIST_111_1111.txt +++ b/internal/help/KEY_LIST_111_1111.txt @@ -1,5 +1,5 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:14:00}} +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:42:54}} The [[KEY n]] statement is used to assign a "soft key" string or a flag and scan code to a function key or display function soft key assignments. {{PageSyntax}} @@ -213,4 +213,3 @@ COLOR 11: LOCATE 11, 26: PRINT "Down number pad " {{PageNavigation}} - diff --git a/internal/help/KEY_n_111_0.txt b/internal/help/KEY_n_111_0.txt index 144701372..8f6716cf8 100644 --- a/internal/help/KEY_n_111_0.txt +++ b/internal/help/KEY_n_111_0.txt @@ -1,5 +1,5 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:13:57}} +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:42:52}} The [[KEY n]] statement is used to assign a "soft key" string or a flag and scan code to a function key or display function soft key assignments. {{PageSyntax}} @@ -213,4 +213,3 @@ COLOR 11: LOCATE 11, 26: PRINT "Down number pad " {{PageNavigation}} - diff --git a/internal/help/KILL_1111.txt b/internal/help/KILL_1111.txt index 17dd23e7a..20cc9b040 100644 --- a/internal/help/KILL_1111.txt +++ b/internal/help/KILL_1111.txt @@ -1,5 +1,5 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:14:01}} +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:42:56}} The [[KILL]] statement deletes a file designated by a [[STRING]] value or variable. @@ -33,4 +33,3 @@ KILL "C:\QBasic\data\2000data.dat" {{PageNavigation}} - diff --git a/internal/help/Keyword_Reference_-_Alphabetical_1000000_100000000_-_100000000000.txt b/internal/help/Keyword_Reference_-_Alphabetical_1000000_100000000_-_100000000000.txt index e139a6683..19bed1f4c 100644 --- a/internal/help/Keyword_Reference_-_Alphabetical_1000000_100000000_-_100000000000.txt +++ b/internal/help/Keyword_Reference_-_Alphabetical_1000000_100000000_-_100000000000.txt @@ -1,35 +1,31 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:06:11}} -__NOEDITSECTION__ +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:35:52}} __NOTOC__ -


'''Alphabetical QB64 Keyword Listings'''

    '''QB 64:'''  [[#uA|_A]] [[#uB|_B]] [[#uC|_C]] [[#uD|_D]] [[#uE|_E]] [[#uF|_F]] [[#uG|_G]] [[#uH|_H]] [[#uI|_I]] [[#uK|_K]] [[#uL|_L]] [[#uM|_M]] [[#uN|_N]] [[#uO|_O]] [[#uP|_P]] [[#uR|_R]] [[#uS|_S]] [[#uT|_T]] [[#uU|_U]] [[#uV|_V]] [[#uW|_W]]                

'''QBasic:'''  [[#A|A]]   [[#B|B]]   [[#C|C]]   [[#D|D]]   [[#E|E]]    [[#F|F]]   [[#G|G]]   [[#H|H]]    [[#I| I]]    [[#K|K]]   [[#L|L]]   [[#M|M]]   [[#N|N]]    [[#O|O]]   [[#P|P]]    [[#R|R]]   [[#S|S]]    [[#T|T]]   [[#U|U]]   [[#V|V]]   [[#W|W]]   [[#X|X]]   

'''OpenGL:'''   [[#glA|A]]    [[#glB|B]]    [[#glC|C]]    [[#glD|D]]    [[#glE|E]]     [[#glF|F]]    [[#glG|G]]    [[#glH|H]]    [[#glI| I  ]]   [[#glL|L]]    [[#glM|M]]    [[#glN|N]]     [[#glO|O]]    [[#glP|P]]     [[#glR|R]]    [[#glS|S]]     [[#glT|T]]    [[#glV|V]]      

[[#symbols|Symbols]] '''   -   ''' [[#references|References]]

{{small|Menu Created by Cyperium}}

- +

'''Alphabetical QB64 Keyword Listings'''

    '''[[#QB64 specific keywords|QB64:]]'''  [[#uA|_A]] [[#uB|_B]] [[#uC|_C]] [[#uD|_D]] [[#uE|_E]] [[#uF|_F]] [[#uG|_G]] [[#uH|_H]] [[#uI|_I]] [[#uK|_K]] [[#uL|_L]] [[#uM|_M]] [[#uN|_N]] [[#uO|_O]] [[#uP|_P]] [[#uR|_R]] [[#uS|_S]] [[#uT|_T]] [[#uU|_U]] [[#uV|_V]] [[#uW|_W]]                

'''[[#Original QBasic keywords|QBasic:]]'''  [[#A|A]]   [[#B|B]]   [[#C|C]]   [[#D|D]]   [[#E|E]]    [[#F|F]]   [[#G|G]]   [[#H|H]]    [[#I| I]]    [[#K|K]]   [[#L|L]]   [[#M|M]]   [[#N|N]]    [[#O|O]]   [[#P|P]]    [[#R|R]]   [[#S|S]]    [[#T|T]]   [[#U|U]]   [[#V|V]]   [[#W|W]]   [[#X|X]]   

'''[[#OpenGL specific keywords|OpenGL:]]'''   [[#glA|A]]    [[#glB|B]]    [[#glC|C]]    [[#glD|D]]    [[#glE|E]]     [[#glF|F]]    [[#glG|G]]    [[#glH|H]]    [[#glI| I  ]]   [[#glL|L]]    [[#glM|M]]    [[#glN|N]]     [[#glO|O]]    [[#glP|P]]     [[#glR|R]]    [[#glS|S]]     [[#glT|T]]    [[#glV|V]]      

[[#Symbols|Symbols]] '''   -   ''' [[#References|References]]

[[QB64 FAQ|Go to Frequently Asked Questions about QB64]]
-

[[Keyword Reference - By usage|Go to keywords by Usage]]

+
[[Keyword Reference - By usage|Go to keywords by Usage]]
-

Keywords beginning with _underscores are QB64 specific. '''To use them without the prefix, use [[$NOPREFIX]].'''

+
Keywords beginning with _underscores are QB64 specific. '''To use them without the prefix, use [[$NOPREFIX]].'''
-

[[Keywords currently not supported by QB64]]

+
[[Keywords currently not supported by QB64]]
-

[[Keywords currently not supported by QB64#Keywords_Not_Supported_in_Linux_or_MAC_OSX_versions|Keywords Not Supported in Linux or MAC versions]]

+
[[Keywords currently not supported by QB64#Keywords_Not_Supported_in_Linux_or_MAC_OSX_versions|Keywords Not Supported in Linux or MAC versions]]
-

Keywords without the underscore at the beginning should work with both QB 4.5 and QB64.

+
Keywords without the underscore at the beginning should work with both QB 4.5 and QB64.
-

For comments or suggestions about this WIKI goto the [http://qb64phoenix.com/forum/index.php QB64 Forum].

+
For comments or suggestions about this WIKI goto the [https://qb64phoenix.com/forum/forumdisplay.php?fid=25 Wiki Discussion Forum].
-
'''If code examples only display partial code, use the browser Refresh button'''
- -
[[Main Page|Main Page with Appendix and Tutorials]]
+
[[Main_Page|Main Page with Articles and Tutorials]]
+== QB64 specific keywords == +
'''The underscore prefix is reserved for QB64 _KEYWORDS only.'''
-==QB64 specific keywords:== - -

The underscore prefix is reserved for QB64 _KEYWORDS only.

+----
_A
* [[_ACCEPTFILEDROP]] (statement) {{text|turns a program window into a valid drop destination for dragging files from Windows Explorer.}} * [[_ACOS]] (function) {{text|arccosine function returns the angle in radians based on an input [[COS]]ine value range from -1 to 1.}} @@ -37,22 +33,21 @@ __NOTOC__ * [[_ALLOWFULLSCREEN]] (statement) {{text|allows setting the behavior of the ALT+ENTER combo.}} * [[_ALPHA]] (function) {{text|returns the alpha channel transparency level of a color value used on a screen page or image.}} * [[_ALPHA32]] (function) {{text|returns the alpha channel transparency level of a color value used on a 32 bit screen page or image.}} -* [[Mathematical Operations#Derived Mathematical Functions|_ARCCOT]] (function) {{text|is the inverse function of the cotangent. . http://mathworld.wolfram.com/InverseCosecant.html}} -* [[Mathematical Operations#Derived Mathematical Functions|_ARCCSC]] (function) {{text|is the inverse function of the cosecant. http://mathworld.wolfram.com/InverseCosecant.html}} -* [[Mathematical Operations#Derived Mathematical Functions|_ARCSEC]] (function) {{text|is the inverse function of the secant. http://mathworld.wolfram.com/InverseSecant.html}} +* [[Mathematical Operations#Derived Mathematical Functions|_ARCCOT]] (function) {{text|is the inverse function of the cotangent.}} +* [[Mathematical Operations#Derived Mathematical Functions|_ARCCSC]] (function) {{text|is the inverse function of the cosecant.}} +* [[Mathematical Operations#Derived Mathematical Functions|_ARCSEC]] (function) {{text|is the inverse function of the secant.}} * [[_ASIN]] (function) {{text|Returns the principal value of the arc sine of x, expressed in radians.}} * [[_ASINH]] (function) {{text|Returns the arc hyperbolic sine of x, expressed in radians.}} * [[_ASSERT]] (statement) {{text|Performs debug tests.}} -* [[$ASSERTS]] (metacommand) {{text|Enables the [[_ASSERT]] macro}} +* [[$ASSERTS]] (metacommand) {{text|enables debug tests with the [[_ASSERT]] macro.}} * [[_ATAN2]] (function) {{text|Returns the principal value of the [[ATN|arc tangent]] of y/x, expressed in radians.}} * [[_ATANH]] (function) {{text|Returns the arc hyperbolic tangent of x, expressed in radians.}} * [[_AUTODISPLAY]] (statement) {{text|enables the automatic display of the screen image changes previously disabled by [[_DISPLAY]].}} * [[_AUTODISPLAY (function)]] {{text|returns the current display mode as true (-1) if automatic or false (0) if per request using [[_DISPLAY]].}} * [[_AXIS]] (function) {{text|returns a [[SINGLE]] value between -1 and 1 indicating the maximum distance from the device axis center, 0.}} +
([[#toc|Return to Table of Contents]])
---- - -
_B
* [[_BACKGROUNDCOLOR]] (function) {{text|returns the current [[SCREEN|screen page]] background color.}} * [[_BIT]] (` numerical type) {{text|can return only signed values of 0 (bit off) and -1 (bit on). Unsigned 0 or 1.}} @@ -67,15 +62,12 @@ __NOTOC__ * [[_BUTTONCHANGE]] (function) {{text|returns -1 when a device button has been pressed and 1 when released. Zero indicates no change.}} * [[_BYTE]] (%% numerical type) {{text|can hold signed values from -128 to 127 (one byte or _BIT * 8). Unsigned from 0 to 255.}} -

([[#toc|Return to Table of Contents]])

- +
([[#toc|Return to Table of Contents]])
---- - -
_C
* [[_CAPSLOCK (function)]] {{text|returns -1 when Caps Lock is on}} * [[_CAPSLOCK]] (statement) {{text|sets Caps Lock key state}} -* [[$CHECKING]] (QB64 C++ [[Metacommand]]) {{text|turns event error checking OFF or ON.}} +* [[$CHECKING]] (QB64 C++ [[Metacommand]]) {{text|turns event and error checking OFF or ON.}} * [[_CEIL]] (function) {{text|Rounds x upward, returning the smallest integral value that is not less than x.}} * [[_CINP]] (function) {{text|Returns a key code from $CONSOLE input}} * [[_CLEARCOLOR (function)]] {{text|returns the current transparent color of an image.}} @@ -85,7 +77,7 @@ __NOTOC__ * [[_CLIPBOARD$ (statement)]] {{text|sets and overwrites the [[STRING]] value in the operating system's clipboard.}} * [[_CLIPBOARDIMAGE (function)]] {{text|pastes an image from the clipboard into a new QB64 image in memory.}} * [[_CLIPBOARDIMAGE]] {{text|(statement) copies a valid QB64 image to the clipboard.}} -* [[$COLOR]] (metacommand) {{text|includes named color constants in a program}} +* [[$COLOR]] (metacommand) {{text|includes named color constants in a program.}} * [[_COMMANDCOUNT]] (function) {{text|returns the number of arguments passed to the compiled program from the command line.}} * [[_CONNECTED]] (function) {{text|returns the status of a TCP/IP connection handle.}} * [[_CONNECTIONADDRESS$]] (TCP/IP function) {{text|returns a connected user's STRING IP address value using the handle.}} @@ -98,23 +90,20 @@ __NOTOC__ * [[_CONTROLCHR (function)]] {{text| returns the current state of _CONTROLCHR as 1 when OFF and 0 when ON.}} * [[_COPYIMAGE]] (function) {{text|copies an image handle value to a new designated handle.}} * [[_COPYPALETTE]] (statement) {{text|copies the color palette intensities from one 4 or 8 BPP image to another image.}} -* [[Mathematical_Operations|_COT]] (function) {{text| the mathematical function cotangent defined by 1/TAN. http://mathworld.wolfram.com/Cotangent.html}} -* [[Mathematical_Operations|_COTH]] (function) {{text|Returns the hyperbolic cotangent. http://mathworld.wolfram.com/HyperbolicCotangent.html}} -* [[Mathematical_Operations|_COSH]] (function) {{text|Returns the hyperbolic cosine of x radians. http://mathworld.wolfram.com/HyperbolicCosine.html}} -* [[Mathematical_Operations|_CSC]] (function) {{text| the mathematical function cosecant defined by 1/SIN. http://mathworld.wolfram.com/Cosecant.html}} -* [[Mathematical_Operations|_CSCH]] (function) {{text|Returns the hyperbolic cosecant. http://mathworld.wolfram.com/HyperbolicCosecant.html}} +* [[Mathematical Operations#Derived Mathematical Functions|_COT]] (function) {{text|the mathematical function cotangent defined by 1/TAN.}} +* [[Mathematical Operations#Derived Mathematical Functions|_COTH]] (function) {{text|Returns the hyperbolic cotangent.}} +* [[Mathematical Operations#Derived Mathematical Functions|_COSH]] (function) {{text|Returns the hyperbolic cosine of x radians.}} +* [[Mathematical Operations#Derived Mathematical Functions|_CSC]] (function) {{text|the mathematical function cosecant defined by 1/SIN.}} +* [[Mathematical Operations#Derived Mathematical Functions|_CSCH]] (function) {{text|Returns the hyperbolic cosecant.}} * [[_CV]] (function) {{text|converts any [[_MK$]] [[STRING]] value to the designated numerical type value.}} * [[_CWD$]] (function) {{text|returns the current working directory as a [[STRING]] value.}} -

([[#toc|Return to Table of Contents]])

- +
([[#toc|Return to Table of Contents]])
---- - -
_D
* [[_D2G]] (function) {{text|converts degrees to gradient angle values.}} * [[_D2R]] (function) {{text|converts degrees to radian angle values.}} -* [[$DEBUG]] (metacommand) {{text|enables debugging features, allowing you to step through your code line by line}} +* [[$DEBUG]] (metacommand) {{text|enables debugging features, allowing you to step through your code line by line.}} * [[DECLARE LIBRARY|DECLARE LIBRARY (QB64 statement block)]] {{text|declares a C++, SDL or Operating System [[SUB]] or [[FUNCTION]] to be used.}} * [[DECLARE DYNAMIC LIBRARY|DECLARE DYNAMIC LIBRARY (QB64 statement)]] {{text|declares DYNAMIC, CUSTOMTYPE or STATIC library (DLL) [[SUB]] or [[FUNCTION]].}} * [[_DEFAULTCOLOR]] (function) {{text|returns the current default text color for an image handle or page.}} @@ -138,26 +127,22 @@ __NOTOC__ * [[_DONTWAIT]] ([[SHELL]] action) {{text|specifies that the program should not wait until the shelled command/program is finished.}} * [[_DROPPEDFILE]] (function) {{text| returns the list of items (files or folders) dropped in a program's window after [[_ACCEPTFILEDROP]] is enabled.}} - +
([[#toc|Return to Table of Contents]])
---- - -
_E
* [[_ECHO]] (statement) {{text|used in conjunction with $IF for the precompiler.}} -* [[$ELSE]] (Pre-Compiler [[Metacommand]]) {{text|used in conjunction with $IF for the precompiler.}} -* [[$ELSEIF]] (Pre-Compiler [[Metacommand]]) {{text|used in conjunction with $IF for the precompiler.}} -* [[$END IF]] (Pre-Compiler [[Metacommand]]) {{text|used in conjunction with $IF for the precompiler.}} -* [[$ERROR]] (precompiler [[metacommand]]) {{text|used to trigger compiler errors.}} +* [[$ELSE]] (Pre-Compiler [[Metacommand]]) {{text|used in conjunction with [[$IF]] for the precompiler.}} +* [[$ELSEIF]] (Pre-Compiler [[Metacommand]]) {{text|used in conjunction with [[$IF]] for the precompiler.}} +* [[$END IF]] (Pre-Compiler [[Metacommand]]) {{text|used in conjunction with [[$IF]] for the precompiler.}} +* [[_ENVIRONCOUNT]] (function) {{text|returns the number of key/value pairs currently exist in the environment table.}} +* [[$ERROR]] (precompiler [[metacommand]]) {{text|used to trigger compiler errors from within the precompiling pass.}} * [[_ERRORLINE]] (function) {{text|returns the source code line number that caused the most recent runtime error.}} * [[_ERRORMESSAGE$]] (function) {{text|returns a human-readable message describing the most recent runtime error.}} -* [[$EXEICON]] (Pre-Compiler [[Metacommand]]) {{text|used with a .ICO icon file name to embed the image into the QB64 executable.}} +* [[$EXEICON]] (QB64 [[Metacommand]]) {{text|used with a .ICO icon file name to embed the image into the QB64 executable.}} * [[_EXIT (function)]] {{text|prevents a user exit and indicates if a user has clicked the close X window button or CTRL + BREAK.}} -

([[#toc|Return to Table of Contents]])

- +
([[#toc|Return to Table of Contents]])
---- - -
_F
* [[_FILEEXISTS]] (function) {{text|returns -1 if the file name [[STRING|string]] parameter exists. Zero if it does not.}} * [[_FINISHDROP]] (statement) {{text| resets [[_TOTALDROPPEDFILES]] and clears the [[_DROPPEDFILE]] list of items (files/folders).}} @@ -172,9 +157,8 @@ __NOTOC__ * [[_FULLSCREEN]] (statement) {{text|sets the program window to full screen or OFF. Alt + Enter does it manually.}} * [[_FULLSCREEN (function)]] {{text|returns the fullscreen mode in use by the program.}} +
([[#toc|Return to Table of Contents]])
---- - -
_G
* [[_G2D]] (function) {{text|converts gradient to degree angle values.}} * [[_G2R]] (function) {{text|converts gradient to radian angle values.}} @@ -182,22 +166,17 @@ __NOTOC__ * [[_GREEN]] (function) {{text|function returns the palette or the green component intensity of a 32-bit image color.}} * [[_GREEN32]] (function) {{text|returns the green component intensity of a 32-bit color value.}} -

([[#toc|Return to Table of Contents]])

- +
([[#toc|Return to Table of Contents]])
---- - -
_H
* [[_HEIGHT]] (function) {{text|returns the height of a designated image handle.}} * [[_HIDE]] ([[SHELL]] action) {{text| hides the command line display during a shell.}} * [[_HYPOT]] (function) {{text|Returns the hypotenuse of a right-angled triangle whose legs are x and y.}} - +
([[#toc|Return to Table of Contents]])
---- - -
_I
-* [[$IF]] (Pre-Compiler [[Metacommand]]) {{text|used to set an IF condition for the precompiler.}} +* [[$IF]] (Pre-Compiler [[Metacommand]]) {{text|used to set an [[IF]] condition for the precompiler.}} * [[_ICON]] (statement) {{text|designates a [[_LOADIMAGE]] image file handle to be used as the program's icon or loads the embedded icon (see [[$EXEICON]]).}} * [[_INCLERRORFILE$]] {function) {{text|returns the name of the original source code $INCLUDE module that caused the most recent error.}} * [[_INCLERRORLINE]] (function) {{text|returns the line number in an included file that caused the most recent error.}} @@ -205,23 +184,17 @@ __NOTOC__ * [[_INSTRREV]] (function) {{text|allows searching for a substring inside another string, but unlike [[INSTR]] it returns the last occurrence instead of the first one.}} * [[_INTEGER64]] (&& numerical type) {{text|can hold whole numerical values from -9223372036854775808 to 9223372036854775807.}} -

([[#toc|Return to Table of Contents]])

- - +
([[#toc|Return to Table of Contents]])
---- - -
_K
*[[_KEYCLEAR]] (statement) {{text|clears the keyboard buffers for INKEY$, _KEYHIT, and INP.}} *[[_KEYHIT]] (function) {{text|returns [[ASCII]] one and two byte, SDL Virtual Key and [[Unicode]] keyboard key press codes.}} *[[_KEYDOWN]] (function) {{text|returns whether CTRL, ALT, SHIFT, combinations and other keys are pressed.}} - +
([[#toc|Return to Table of Contents]])
---- - -
_L
-* [[$LET]] (Pre-Compiler [[Metacommand]]) {{text|used to set a flag variable for the precompiler.}} +* [[$LET]] (Pre-Compiler [[Metacommand]]) {{text|used to set a variable for the precompiler.}} * [[_LASTAXIS]] (function) {{text|returns the number of axis available on a specified number device listed by [[_DEVICE$]].}} * [[_LASTBUTTON]] (function) {{text|returns the number of buttons available on a specified number device listed by [[DEVICE$]].}} * [[_LASTWHEEL]] (function) {{text|returns the number of scroll wheels available on a specified number device listed by [[_DEVICE$]].}} @@ -229,11 +202,8 @@ __NOTOC__ * [[_LOADFONT]] (function) {{text|designates a [[_FONT|font]] TTF file to load and returns a handle value.}} * [[_LOADIMAGE]] (function) {{text|designates an image file to load and returns a handle value.}} -

([[#toc|Return to Table of Contents]])

- +
([[#toc|Return to Table of Contents]])
---- - -
_M
* [[_MAPTRIANGLE]] (statement) {{text|maps a triangular image source area to put on a destination area.}} * [[_MAPUNICODE]] (statement) {{text|maps a [[Unicode]] value to an [[ASCII]] code number.}} @@ -250,6 +220,7 @@ __NOTOC__ * [[_MEMIMAGE]] (function) {{text|returns a [[_MEM]] block referring to a designated image handle's memory}} * [[_MEMNEW]] (function) {{text|allocates new memory with a designated SIZE and returns a [[_MEM]] block referring to it.}} * [[_MEMPUT]] (statement) {{text|places a designated value into a designated memory block OFFSET}} +* [[_MEMSOUND]] (function) {{text|returns a [[_MEM]] block referring to a designated sound handle's memory}} * [[_SCREENMOVE|_MIDDLE]] (_SCREENMOVE parameter) {{text|centers the program window on the desktop in any screen resolution.}} * [[_MK$]] (function) {{text|converts a numerical value to a designated [[ASCII]] [[STRING]] value.}} * [[_MOUSEBUTTON]] (function) {{text|returns the status of a designated mouse button.}} @@ -258,27 +229,21 @@ __NOTOC__ * [[_MOUSEMOVE]] (statement) {{text|moves the mouse pointer to a designated position on the program [[SCREEN]].}} * [[_MOUSEMOVEMENTX]] (function) {{text|returns the relative horizontal position of the mouse cursor compared to the previous position.}} * [[_MOUSEMOVEMENTY]] (function) {{text|returns the relative vertical position of the mouse cursor compared to the previous position.}} -* [[_MOUSEPIPEOPEN]] (function) {{text|creates a pipe handle value for a mouse when using a virtual keyboard.}} * [[_MOUSESHOW]] (statement) {{text|displays the mouse cursor after it has been hidden or can change the cursor shape.}} * [[_MOUSEWHEEL]] (function) {{text|returns the number of mouse scroll wheel "clicks" since last read.}} * [[_MOUSEX]] (function) {{text|returns the current horizontal position of the mouse cursor.}} * [[_MOUSEY]] (function) {{text|returns the current vertical position of the mouse cursor.}} - +
([[#toc|Return to Table of Contents]])
---- - -
_N
* [[_NEWIMAGE]] (function) {{text|creates a designated size program [[SCREEN]] or page image and returns a handle value.}} * [[$NOPREFIX]] (metacommand) {{text|allows QB64-specific keywords to be used without the underscore prefix.}} * [[_NUMLOCK (function)]] {{text|returns -1 when Num Lock is on}} * [[_NUMLOCK]] (statement) {{text|sets Num Lock key state}} -

([[#toc|Return to Table of Contents]])

- +
([[#toc|Return to Table of Contents]])
---- - -
_O
* [[_OFFSET (function)]] {{text|returns the memory offset of a variable when used with [[DECLARE LIBRARY]] or [[_MEM]] only.}} * [[_OFFSET]] (%& numerical type) {{text|can be used store the value of an offset in memory when using [[DECLARE LIBRARY]] or [[MEM]] only.}} @@ -289,10 +254,8 @@ __NOTOC__ * [[OPTION _EXPLICITARRAY]] (Pre-compiler directive) {{text|instructs the compiler to require array declaration with [[DIM]] or an equivalent statement.}} * [[_OS$]] (function) {{text|returns the QB64 compiler version in which the program was compiled as [WINDOWS], [LINUX] or [MACOSX] and [32BIT] or [64BIT].}} - +
([[#toc|Return to Table of Contents]])
---- - -
_P
* [[_PALETTECOLOR]] (statement) {{text|sets the color value of a palette entry of an image using 256 colors or less palette modes.}} * [[_PALETTECOLOR (function)]] {{text|return the 32 bit attribute color setting of an image or screen page handle's palette.}} @@ -306,11 +269,8 @@ __NOTOC__ * [[_PRINTWIDTH]] (function) {{text|returns the pixel width of a text string to be printed using [[_PRINTSTRING]].}} * [[_PUTIMAGE]] (statement) {{text|maps a rectangular image source area to an image destination area.}} -

([[#toc|Return to Table of Contents]])

- +
([[#toc|Return to Table of Contents]])
---- - -
_R
* [[_R2D]] (function) {{text|converts radians to degree angle values.}} * [[_R2G]] (function) {{text|converts radians to gradient angle values.}} @@ -329,14 +289,11 @@ __NOTOC__ * [[_RGBA32]] (function) {{text|returns the [[LONG]] 32 bit color value in 32 bit screens only with the [[ALPHA]]}} * [[_ROUND]] (function) {{text|rounds to the closest [[INTEGER]], [[LONG]] or [[_INTEGER64]] numerical value.}} -

([[#toc|Return to Table of Contents]])

- +
([[#toc|Return to Table of Contents]])
---- - -
_S
-* [[Mathematical_Operations#Derived_Mathematical_Functions|_SEC]] (function) {{text| the mathematical function secant defined by 1/COS. http://mathworld.wolfram.com/Secant.html}} -* [[Mathematical_Operations#Derived_Mathematical_Functions|_SECH]] (function) {{text|Returns the hyperbolic secant. http://mathworld.wolfram.com/HyperbolicSecant.html}} +* [[Mathematical Operations#Derived Mathematical Functions|_SEC]] (function) {{text|the mathematical function secant defined by 1/COS.}} +* [[Mathematical Operations#Derived Mathematical Functions|_SECH]] (function) {{text|Returns the hyperbolic secant.}} * [[_SCREENCLICK]] (statement) {{text|simulates clicking on a point on the desktop screen with the left mouse button.}} * [[_SCREENEXISTS]] (function) {{text|returns a -1 value once a screen has been created.}} * [[$SCREENHIDE]] ([QB64 [Metacommand]]) {{text|hides the program window from view.}} @@ -346,19 +303,18 @@ __NOTOC__ * [[_SCREENIMAGE]] (function) {{text|creates an image of the current desktop and returns an image handle.}} * [[_SCREENMOVE]] (statement) {{text|positions program window on the desktop using designated coordinates or the _MIDDLE option.}} * [[_SCREENPRINT]] (statement) {{text|simulates typing text into a Windows program using the keyboard.}} -* [[$SCREENSHOW]] (QB64 [[Metacommand]]) {{text|displays that program window after it was hidden by [[$SCREENHIDE]].}} +* [[$SCREENSHOW]] (QB64 [[Metacommand]]) {{text|displays the program window after it was hidden.}} * [[_SCREENSHOW]] (statement) {{text|displays the program window after it has been hidden by [[_SCREENHIDE]].}} * [[_SCREENX]] (function) {{text|returns the program window's upper left corner horizontal position on the desktop.}} * [[_SCREENY]] (function) {{text|returns the program window's upper left corner vertical position on the desktop.}} * [[_SCROLLLOCK (function)]] {{text|returns -1 when Scroll Lock is on}} * [[_SCROLLLOCK]] (statement) {{text|sets Scroll Lock key state}} - * [[_SETALPHA]] (statement) {{text|sets the alpha channel transparency level of some or all of the pixels of an image.}} * [[_SETBIT]] (function) {{text|is used to set the specified bit of an integer variable to 1.}} * [[_SHELLHIDE]] (function) {{text|returns the code sent by a program exit using [[END]] or [[SYSTEM]] followed by an [[INTEGER]] value.}} * [[_SHL]] (function) {{text|used to shift the bits of a numerical value to the left}} * [[_SHR]] (function) {{text|used to shift the bits of a numerical value to the right.}} -* [[Mathematical_Operations|_SINH]] (function) {{text|Returns the hyperbolic sine of x radians.}} +* [[Mathematical Operations#Derived Mathematical Functions|_SINH]] (function) {{text|Returns the hyperbolic sine of x radians.}} * [[_SNDBAL]] (statement) {{text|attempts to set the balance or 3D position of a sound file.}} * [[_SNDCLOSE]] (statement) {{text|frees and unloads an open sound using the sound handle created by [[_SNDOPEN]].}} * [[_SNDCOPY]] (function) {{text|copies a sound handle value to a new designated handle.}} @@ -387,56 +343,45 @@ __NOTOC__ * [[_STRCMP]] (function) {{text|compares the relationship between two strings.}} * [[_STRICMP]] (function) {{text|compares the relationship between two strings, without regard for case-sensitivity.}} -

([[#toc|Return to Table of Contents]])

- +
([[#toc|Return to Table of Contents]])
---- - -
_T
- -* [[Mathematical_Operations|_TANH]] (function) {{text|Returns the hyperbolic tangent of x radians.}} +* [[Mathematical Operations#Derived Mathematical Functions|_TANH]] (function) {{text|Returns the hyperbolic tangent of x radians.}} * [[_TITLE]] (statement) {{text|sets the program title [[STRING|string]] value.}} * [[_TITLE$]] (function) {{text|gets the program title [[STRING|string]] value.}} * [[_TOGGLEBIT]] (function) {{text|is used to toggle the specified bit of an integer variable from 1 to 0 or 0 to 1.}} * [[_TOTALDROPPEDFILES]] (function) {{text| returns the number of items (files or folders) dropped in a program's window after [[_ACCEPTFILEDROP]] is enabled.}} * [[_TRIM$]] (function) {{text|shorthand to [[LTRIM$]]([[RTRIM$]]("text"))}} - +
([[#toc|Return to Table of Contents]])
---- - -
_U
- * [[_UNSIGNED]] (numerical type) {{text|expands the positive range of numerical [[INTEGER]], [[LONG]] or [[_INTEGER64]] values returned.}} - +
([[#toc|Return to Table of Contents]])
---- - -
_V
- * [[$VERSIONINFO]] ([[Metacommand]]) {{text|adds metadata to Windows only binaries for identification purposes across the OS.}} -* [[$VIRTUALKEYBOARD]] ([[Metacommand]] - Deprecated) {{text|turns the virtual keyboard ON or OFF for use in touch-enabled devices}} - +* [[$VIRTUALKEYBOARD]] ([[Metacommand]]) ({{text|deprecated|red}}) {{text|turns the virtual keyboard ON or OFF for use in touch-enabled devices.}} +
([[#toc|Return to Table of Contents]])
---- - -
_W
- * [[_WHEEL]] (function) {{text|returns -1 when a control device wheel is scrolled up and 1 when scrolled down. Zero indicates no activity.}} * [[_WIDTH (function)]] {{text|returns the width of a [[SCREEN]] or image handle.}} * [[_WINDOWHANDLE]] (function) {{text|returns the window handle assigned to the current program by the OS. Windows-only.}} * [[_WINDOWHASFOCUS]] (function) {{text|returns true (-1) if the current program's window has focus. Windows-only.}} -

([[#toc|Return to Table of Contents]])

+
([[#toc|Return to Table of Contents]])
+ +
([[#QB64 specific keywords|Go to Top of QB64 specific keywords]])
-
([[Keyword Reference - Alphabetical#QB64 specific keywords:|Go to Top of QB64 specific keywords]])
+== Original QBasic keywords == +
'''These QBasic keywords (with a few noted exceptions) will work in all versions of QB64.'''
-==Original QBasic keywords:== -'''

These QBasic keywords (with a few noted exceptions) will work in all versions of QB64.

''' +----
A
* [[ABS]] (function) {{text|converts any negative numerical value to a positive value.}} * [[CALL ABSOLUTE|ABSOLUTE]] (statement) {{text|is used to access computer interrupt registers.}} @@ -450,10 +395,8 @@ __NOTOC__ * [[ASC (statement)]] (QB64 only) {{text|sets the code value of an [[ASCII]] text character at a designated [[STRING|string]] position.}} * [[ATN]] (function) {{text|or arctangent returns the angle in radians of a numerical [[TAN|tangent]] value.}} - +
([[#toc|Return to Table of Contents]])
---- - -
B
* [[BEEP]] (statement) {{text|creates an error sound of a fixed duration.}} * [[BINARY]] (file mode) {{text|creates or opens an existing file for [[GET|read]] and [[PUT|write]] byte-wise access.}} @@ -461,20 +404,15 @@ __NOTOC__ * [[BSAVE]] (statement) {{text|transfers the contents of an [[Arrays|array]] to a specified size [[BINARY]] file.}} * [[BYVAL]] (statement) {{text|assigns a numerical variable value by its value, not the name.}} -

([[#toc|Return to Table of Contents]])

- +
([[#toc|Return to Table of Contents]])
---- - -
C
* [[CALL]] (statement) {{text|optional statement that sends the program to a [[SUB]] procedure. Requires parameters be enclosed in brackets(parenthesis).}} * [[CALL ABSOLUTE]] (statement) {{text|is used to access computer interrupt registers.}} -* [[CALLS]] (non-BASIC call statement) * [[CASE]] ([[SELECT CASE]] condition) {{text|designates specific conditions in a [[SELECT CASE]] statement block.}} * [[CASE ELSE]] ([[SELECT CASE]] condition) {{text|designates an alternative condition to be evaluated in a [[SELECT CASE]] statement block.}} * [[CASE IS]] ([[SELECT CASE]] condition) {{text|designates specific conditions in a [[SELECT CASE]] statement block.}} * [[CDBL]] (function) {{text|returns the closest [[DOUBLE]] value of a number.}} -* [[CDECL]] ([[DECLARE (non-BASIC statement)]]) * [[CHAIN]] (statement) {{text|sends a program to another specified program module or compiled program.}} * [[CHDIR]] (statement) {{text|changes the current program path for file access.}} * [[CHR$]] (function) {{text|returns a text [[STRING|string]] character by the specified [[ASCII]] code number.}} @@ -498,17 +436,11 @@ __NOTOC__ * [[CVS]] (function) {{text|returns the [[SINGLE]] numerical value of a 4 byte [[MKS$]] [[STRING|string]].}} * [[CVSMBF]] (function) {{text|returns the [[SINGLE]] numerical value of a [[MKSMBF$|Microsoft Binary Format]] [[STRING|string]].}} -

([[#toc|Return to Table of Contents]])

- +
([[#toc|Return to Table of Contents]])
---- - -
D
* [[DATA]] (statement) {{text|creates a line of fixed program information separated by commas.}} * [[DATE$]] (function) {{text|returns the present Operating System date [[STRING|string]] formatted as mm-dd-yyyy.}} -* [[DATE$ (statement)]] {{text|sets the date of the Operating System using a mm-dd-yyyy [[STRING|string]] format.}} -* DECLARE (BASIC statement) {{text|declares a [[SUB]] or [[FUNCTION]] procedure at the start of a program. Not required in QB64.}} -* [[DECLARE (non-BASIC statement)]] {{text|declares non-basic [[SUB]] or [[FUNCTION]] procedures. Not implemented in QB64.}} * [[DECLARE LIBRARY|DECLARE LIBRARY (QB64 statement block)]] {{text|declares a C++, SDL or Operating System [[SUB]] or [[FUNCTION]] to be used.}} * [[DECLARE DYNAMIC LIBRARY|DECLARE DYNAMIC LIBRARY (QB64 statement)]] {{text|declares DYNAMIC, CUSTOMTYPE or STATIC library(DLL) [[SUB]] or [[FUNCTION]].}} * [[DEF SEG]] (statement) {{text|defines a segment in memory to be accessed by a memory procedure.}} @@ -523,11 +455,8 @@ __NOTOC__ * [[DRAW]] (statement) {{text|uses a special [[STRING|string]] format that draws graphical lines in specific directions.}} * [[$DYNAMIC]] ([[Metacommand]]) {{text|used at the start of a program to set all program arrays as changeable in size using [[REDIM]].}} -

([[#toc|Return to Table of Contents]])

- +
([[#toc|Return to Table of Contents]])
---- - -
E
* [[ELSE]] ([[IF...THEN]] statement) {{text|is used to direct program flow when no other condition is evaluated as true.}} * [[ELSEIF]] ([[IF...THEN]] statement) {{text|is used with [[THEN]] to set alternate conditional evaluations.}} @@ -538,35 +467,26 @@ __NOTOC__ * [[EOF]] (file function) {{text|returns -1 when a file [[INPUT (file statement)|INPUT]] or [[GET]] has reached the end of a file.}} * [[EQV]] (logic operator) {{text|is used to compare two numerical values bitwise.}} * [[ERASE]] (statement) {{text|clears the values from [[$STATIC]] arrays and completely removes [[$DYNAMIC]] arrays.}} -* [[ERDEV]] (function) {{text|returns an error code from the last device to create an error.}} -* [[ERDEV$]] (function) {{text|returns the 8 character name of the last device to declare an error as a [[STRING|string]].}} * [[ERL]] (error function) {{text|returns the closest line number before an error occurred if line numbers are used.}} * [[ERR]] (function) {{text|returns the [[ERROR Codes|ERROR code]] when a program error occurs.}} * [[ERROR]] (statement) {{text|sets a specific [[ERROR Codes|ERROR code]] to be simulated.}} * [[EXIT]] (statement) {{text|immediately exits a program [[FOR...NEXT]], [[DO...LOOP]], [[SUB]] or [[FUNCTION]] procedure.}} * [[EXP]] (function) {{text|returns the value of e to the exponential power specified.}} -

([[#toc|Return to Table of Contents]])

- +
([[#toc|Return to Table of Contents]])
---- - -
F
* [[FIELD]] (statement) {{text|defines the variable sizes to be written or read from a file.}} -* [[FILEATTR]] (function) {{text|returns the current file access mode.}} * [[FILES]] (statement) {{text|returns a list of files in the current directory path to the [[SCREEN]].}} * [[FIX]] (function) {{text|returns the rounded [[INTEGER]] value of a numerical value.}} * [[FOR...NEXT]] (statement) {{text|creates a recursive loop procedure that loop a specified number of times.}} * [[FOR (file statement)]] {{text|used in an [[OPEN]] file or device statement to indicate the access mode.}} -* [[FRE]] (function) {{text|returns the number of bytes of Memory available to running programs.}} * [[TIMER (statement)|FREE (QB64 TIMER statement)]] {{text|frees a numbered TIMER event in QB64.}} * [[FREEFILE]] (file function) {{text|returns a file number that is currently not in use by the Operating System.}} * [[FUNCTION]] (procedure block) {{text|sub-procedure that can calculate and return one value to a program in its name.}} - +
([[#toc|Return to Table of Contents]])
---- - -
G
* [[GET]] (file statement) {{text|reads a file sequencially or at a specific position and returns the value as the variable type used.}} * [[GET (TCP/IP statement)|GET (QB64 TCP/IP statement)]] {{text|reads a connection port to return a value.}} @@ -574,18 +494,13 @@ __NOTOC__ * [[GOSUB]] (statement) {{text|sends the program to a designated line label procedure in the main program.}} * [[GOTO]] (statement) {{text|sends the program to a designated line number or line label in a procedure.}} -

([[#toc|Return to Table of Contents]])

- +
([[#toc|Return to Table of Contents]])
---- - -
H
* [[HEX$]] (function) {{text|returns the hexadecimal (base 16) [[STRING]] representation of the [[INTEGER]] part of any value.}} - +
([[#toc|Return to Table of Contents]])
---- - -
I
* [[IF...THEN]] (statement) {{text|a conditional block statement used control program flow.}} * [[IMP]] (logic operator) {{text|is used to compare two numerical values bitwise.}} @@ -601,26 +516,17 @@ __NOTOC__ * [[INTEGER]] (% numerical type) {{text|2 byte whole values from -32768 to 32767.}} * [[INTERRUPT]] (statement) {{text|is used to access computer interrupt registers.}} * [[INTERRUPTX]] (statement) {{text|is used to access computer interrupt registers.}} -* [[IOCTL]] (statement) -* [[IOCTL$]] (function) - - -

([[#toc|Return to Table of Contents]])

+
([[#toc|Return to Table of Contents]])
---- - -
K
* [[KEY n]] (statement) {{text|used with [[ON KEY(n)]] events to assign a "softkey" string to a key or create a user defined key.}} * [[KEY(n)]] (statement) {{text|used with [[ON KEY(n)]] events to assign, enable, disable or suspend event trapping.}} * [[KEY LIST]] (statement) {{text|lists the 12 Function key soft key string assignments going down left side of screen.}} * [[KILL]] (statement) {{text|deletes the specified file without a warning. Remove empty folders with [[RMDIR]].}} -

([[#toc|Return to Table of Contents]])

- +
([[#toc|Return to Table of Contents]])
---- - -
L
* [[LBOUND]] (function) {{text|returns the lower boundary of the specified array.}} * [[LCASE$]] (function) {{text|returns the lower case value of a [[STRING]].}} @@ -644,11 +550,8 @@ __NOTOC__ * [[LSET]] (statement) {{text|left justifies the text in a string so that there are no leading spaces.}} * [[LTRIM$]] (function) {{text|returns a [[STRING|string]] value with no leading spaces.}} -

([[#toc|Return to Table of Contents]])

- +
([[#toc|Return to Table of Contents]])
---- - -
M
* [[MID$]] (function) {{text|returns a designated portion of a [[STRING]].}} * [[MID$ (statement)]] {{text|redefines existing characters in a [[STRING]].}} @@ -661,20 +564,15 @@ __NOTOC__ * [[MKSMBF$]] (function) {{text|returns an 8 byte Microsoft Binary Format [[STRING]] representation of a [[DOUBLE]] numerical value.}} * [[MOD]] (math operator) {{text|performs integer remainder division on a numerical value.}} - +
([[#toc|Return to Table of Contents]])
---- - -
N
* [[NAME]] (statement) {{text|names an existing file name [[AS]] a new file name.}} * [[NEXT]] (statement) {{text|bottom end of a [[FOR...NEXT]] counter loop to returns to the start or a [[RESUME|RESUME NEXT]] error.}} * [[NOT]] (logical operator) {{text|inverts the value of a logic operation or returns True when a [[boolean]] evaluation is False.}} -

([[#toc|Return to Table of Contents]])

- +
([[#toc|Return to Table of Contents]])
---- - -
O
* [[OCT$]] (function) {{text|returns the octal (base 8) [[STRING]] representation of the [[INTEGER]] part of any value.}} * [[OFF]] (event statement) {{text|turns off all [[ON]] event checking.}} @@ -696,11 +594,8 @@ __NOTOC__ * [[OUT]] (statement) {{text|writes numerical data to a specified register port.}} * [[OUTPUT]] (file mode) {{text|creates a new file or clears all data from an existing file to acess the file sequencially.}} -

([[#toc|Return to Table of Contents]])

- +
([[#toc|Return to Table of Contents]])
---- - -
P
* [[PAINT]] (statement) {{text|fills an enclosed area of a graphics [[SCREEN|screen]] with a color until it encounters a specific colored border.}} * [[PALETTE]] (statement) {{text|sets the Red, Green and Blue color attribute intensities using a RGB multiplier calculation.}} @@ -725,11 +620,8 @@ __NOTOC__ * [[PUT (TCP/IP statement)|PUT (QB64 TCP/IP statement)]] {{text|sends raw data to a user's connection handle.}} * [[PUT (graphics statement)]] {{text|places pixel data stored in an [[INTEGER]] array to a specified area of the [[SCREEN]].}} -

([[#toc|Return to Table of Contents]])

- +
([[#toc|Return to Table of Contents]])
---- - -
R
* [[RANDOM]] (file mode) {{text|creates a file or opens an existing file to [[GET|read]] and [[PUT|write]] records of a set byte size.}} * [[RANDOMIZE]] (statement) {{text|sets the random seed value for a specific sequence of random [[RND]] values.}} @@ -748,11 +640,8 @@ __NOTOC__ * [[RTRIM$]] (function) {{text|returns a [[STRING|string]] with all spaces removed from the right end.}} * [[RUN]] (statement) {{text|clears and restarts the program currently in memory or executes another specified program.}} -

([[#toc|Return to Table of Contents]])

- +
([[#toc|Return to Table of Contents]])
---- - -
S
* [[SADD]] (function) {{text|returns the address of a STRING variable as an offset from the current data segment.}} * [[SCREEN (function)]] {{text|can return the [[ASCII]] character code or color of the text at a text designated coordinate.}} @@ -760,12 +649,10 @@ __NOTOC__ * [[SEEK]] (function) {{text|returns the present byte position in an [[OPEN|opened]] file.}} * [[SEEK (statement)]] {{text|moves to a specified position in an [[OPEN|opened]] file.}} * [[SELECT CASE]] (statement) {{text|a program flow block that can handle numerous conditional evaluations.}} -* [[SETMEM]] (function) {{text|sets the memory to use.}} * [[SGN]] (function) {{text|returns -1 for negative, 0 for zero, and 1 for positive numerical values.}} * [[SHARED]] (statement) {{text|designates that a variable can be used by other procedures or the main procedure when in a sub-procedure.}} * [[SHELL]] (statement) {{text|sends [[STRING]] commands to the command line. SHELL calls will not affect the current path.}} * [[SHELL (function)|SHELL (QB64 function)]] {{text|executes an external command or calls another program. Returns codes sent by [[END]] or [[SYSTEM]].}} -* [[SIGNAL]] (OS 2 event) * [[SIN]] (function) {{text|returns the sine of a radian angle.}} * [[SINGLE]] (! numerical type) {{text|4 byte floating decimal point values up to 7 decimal places.}} * [[SLEEP]] (statement) {{text|pauses the program for a designated number of seconds or until a key is pressed.}} @@ -787,11 +674,8 @@ __NOTOC__ * [[SWAP]] (statement) {{text|swaps two [[STRING|string]] or numerical values.}} * [[SYSTEM]] (statement) {{text|ends a program immediately.}} -

([[#toc|Return to Table of Contents]])

- +
([[#toc|Return to Table of Contents]])
---- - -
T
* [[TAB]] (function) {{text|moves a designated number of columns on the [[SCREEN|screen]].}} * [[TAN]] (function) {{text|returns the ratio of [[SIN]]e to [[COS]]ine or tangent value of an angle measured in radians.}} @@ -802,10 +686,8 @@ __NOTOC__ * [[TO]] {{text|indicates a range of numerical values or an assignment of one value to another.}} * [[TYPE]] (definition) {{text|defines a variable type or file record that can include any [[STRING]] or numerical types.}} - +
([[#toc|Return to Table of Contents]])
---- - -
U
* [[UBOUND]] (function) {{text|returns the upper-most index number of a designated [[arrays|array]].}} * [[UCASE$]] (function) {{text|returns an uppercase representation of a specified [[STRING]].}} @@ -813,11 +695,8 @@ __NOTOC__ * [[UNLOCK]] (statement) {{text|unlocks a designated file or portions of it.}} * [[UNTIL]] (condition) {{text|evaluates a [[DO...LOOP]] condition until it is True.}} -

([[#toc|Return to Table of Contents]])

- +
([[#toc|Return to Table of Contents]])
---- - -
V
* [[VAL]] (function) {{text|returns the numerical value of a [[STRING|string]] number.}} * [[VARPTR]] (function) {{text|returns the [[segment]] pointer address in memory.}} @@ -826,10 +705,8 @@ __NOTOC__ * [[VIEW]] (graphics statement) {{text|sets up a graphic view port area of the [[SCREEN|screen]].}} * [[VIEW PRINT]] (statement) {{text|sets up a text viewport area of the [[SCREEN|screen]].}} - +
([[#toc|Return to Table of Contents]])
---- - -
W
* [[WAIT]] (statement) {{text|waits until a vertical retrace is started or a [[SCREEN|screen]] draw ends.}} * [[WEND]] (statement) {{text|the bottom end of a [[WHILE...WEND]] loop.}} @@ -840,126 +717,120 @@ __NOTOC__ * [[WRITE]] (screen I/O statement) {{text|prints variable values to the screen with commas separating each value.}} * [[WRITE (file statement)]] {{text|writes data to a file with each variable value separated by commas.}} - +
([[#toc|Return to Table of Contents]])
---- - -
X
- * [[XOR]] (logic operator) {{text|is used to compare two numerical values bitwise.}} +
([[#toc|Return to Table of Contents]])
-

([[#toc|Return to Table of Contents]])

+
([[#Original QBasic keywords|Go to Top of Original QBasic keywords]])
-
([[Keyword Reference - Alphabetical#Original QBasic keywords:|Go to Top of Original QB keywords]])
- - - -
_glA
-==OpenGL specific keywords:== +== OpenGL specific keywords ==
'''All QB64 OpenGL keywords must use the underscore _gl prefix with the alphabetically listed function names.'''
Use [[$NOPREFIX]] to enable these to be used without the leading underscore.
-* Important: See [[SUB _GL]] +* Important: See [[_GL|SUB _GL]] ---- +
_glA
+* [[_glAccum]] (statement) {{text|operates on the accumulation buffer}} +* [[_glAlphaFunc]] (statement) {{text|enables your application to set the alpha test function.}} +* [[_glAreTexturesResident]] (function) {{text|determines whether specified texture objects are resident in texture memory.}} +* [[_glArrayElement]] (statement) {{text|specifies the array elements used to render a vertex.}} -* [[_glAccum]] (statement) {{text|OpenGL command}} -* [[_glAlphaFunc]] (statement) {{text|OpenGL command}} -* [[_glAreTexturesResident]] (statement) {{text|OpenGL command}} -* [[_glArrayElement]] (statement) {{text|OpenGL command}} - - +
([[#toc|Return to Table of Contents]])
----
_glB
-* [[_glBegin]] (statement) {{text|OpenGL command}} -* [[_glBindTexture]] (statement) {{text|OpenGL command binds a named texture to a texturing target}} -* [[_glBitmap]] (statement) {{text|OpenGL command}} -* [[_glBlendFunc]] (statement) {{text|OpenGL command}} +* [[_glBegin]] (statement) {{text|the '''_glBegin''' and '''_glEnd''' statements delimit the vertices of a primitive or a group of like primitives.}} +* [[_glBindTexture]] (statement) {{text|enables the creation of a named texture that is bound to a texture target}} +* [[_glBitmap]] (statement) {{text|draws a bitmap.}} +* [[_glBlendFunc]] (statement) {{text|specifies pixel arithmetic.}} -

([[#toc|Return to Table of Contents]])

+
([[#toc|Return to Table of Contents]])
----
_glC
-* [[_glCallList]] (statement) {{text|OpenGL command}} -* [[_glCallLists]] (statement) {{text|OpenGL command}} -* [[_glClear]] (statement) {{text|OpenGL command clears buffers to preset values}} -* [[_glClearAccum]] (statement) {{text|OpenGL command}} -* [[_glClearColor]] (statement) {{text|OpenGL command specifies clear values for the color buffers}} -* [[_glClearDepth]] (statement) {{text|OpenGL command specifies the depth value used when the depth buffer is cleared. Initial value is 1.}} -* [[_glClearIndex]] (statement) {{text|OpenGL command}} -* [[_glClearStencil]] (statement) {{text|OpenGL command specifies the index used when the stencil buffer is cleared. Initial value is 0.}} -* [[_glClipPlane]] (statement) {{text|OpenGL command}} -* [[_glColor3b]] (statement) {{text|OpenGL command}} -* [[_glColor3bv]] (statement) {{text|OpenGL command}} -* [[_glColor3d]] (statement) {{text|OpenGL command}} -* [[_glColor3dv]] (statement) {{text|OpenGL command}} -* [[_glColor3f]] (statement) {{text|OpenGL command}} -* [[_glColor3fv]] (statement) {{text|OpenGL command}} -* [[_glColor3i]] (statement) {{text|OpenGL command}} -* [[_glColor3iv]] (statement) {{text|OpenGL command}} -

([[#toc|Return to Table of Contents]])

-* [[_glColor3s]] (statement) {{text|OpenGL command}} -* [[_glColor3sv]] (statement) {{text|OpenGL command}} -* [[_glColor3ub]] (statement) {{text|OpenGL command}} -* [[_glColor3ubv]] (statement) {{text|OpenGL command}} -* [[_glColor3ui]] (statement) {{text|OpenGL command}} -* [[_glColor3uiv]] (statement) {{text|OpenGL command}} -* [[_glColor3us]] (statement) {{text|OpenGL command}} -* [[_glColor3usv]] (statement) {{text|OpenGL command}} -* [[_glColor4b]] (statement) {{text|OpenGL command}} -* [[_glColor4bv]] (statement) {{text|OpenGL command}} -* [[_glColor4d]] (statement) {{text|OpenGL command}} -* [[_glColor4dv]] (statement) {{text|OpenGL command}} -* [[_glColor4f]] (statement) {{text|OpenGL command}} -* [[_glColor4fv]] (statement) {{text|OpenGL command}} -* [[_glColor4i]] (statement) {{text|OpenGL command}} -* [[_glColor4iv]] (statement) {{text|OpenGL command}} -* [[_glColor4s]] (statement) {{text|OpenGL command}} -* [[_glColor4sv]] (statement) {{text|OpenGL command}} -* [[_glColor4ub]] (statement) {{text|OpenGL command}} -* [[_glColor4ubv]] (statement) {{text|OpenGL command}} -* [[_glColor4ui]] (statement) {{text|OpenGL command}} -* [[_glColor4uiv]] (statement) {{text|OpenGL command}} -* [[_glColor4us]] (statement) {{text|OpenGL command}} -* [[_glColor4usv]] (statement) {{text|OpenGL command}} -* [[_glColorMask]] (statement) {{text|OpenGL command enables and disables writing of frame buffer color components}} -* [[_glColorMaterial]] (statement) {{text|OpenGL command}} -* [[_glColorPointer]] (statement) {{text|OpenGL command}} -* [[_glCopyPixels]] (statement) {{text|OpenGL command}} -* [[_glCopyTexImage1D]] (statement) {{text|OpenGL command copies pixels into a 1D texture image}} -* [[_glCopyTexImage2D]] (statement) {{text|OpenGL command copies pixels into a 2D texture image}} -* [[_glCopyTexSubImage1D]] (statement) {{text|OpenGL command copies a one-dimensional texture subimage}} -* [[_glCopyTexSubImage2D]] (statement) {{text|OpenGL command copiess a two-dimensional texture subimage}} -* [[_glCullFace]] (statement) {{text|OpenGL command}} +* [[_glCallList]] (statement) {{text|executes a display list.}} +* [[_glCallLists]] (statement) {{text|executes a list of display lists.}} +* [[_glClear]] (statement) {{text|clears buffers to preset values.}} +* [[_glClearAccum]] (statement) {{text|specifies the clear values for the accumulation buffer.}} +* [[_glClearColor]] (statement) {{text|specifies clear values for the color buffers.}} +* [[_glClearDepth]] (statement) {{text|specifies the clear value for the depth buffer.}} +* [[_glClearIndex]] (statement) {{text|specifies the clear value for the color-index buffers.}} +* [[_glClearStencil]] (statement) {{text|specifies the clear value for the stencil buffer.}} +* [[_glClipPlane]] (statement) {{text|specifies a plane against which all geometry is clipped.}} +'''----- Set three component (RGB) colors sort by used data type. -----''' +* [[_glColor3b]] (statement) {{text|sets the current color.}} +* [[_glColor3bv]] (statement) {{text|sets the current color from an already existing array of color values.}} +* [[_glColor3d]] (statement) {{text|sets the current color.}} +* [[_glColor3dv]] (statement) {{text|sets the current color from an already existing array of color values.}} +* [[_glColor3f]] (statement) {{text|sets the current color.}} +* [[_glColor3fv]] (statement) {{text|sets the current color from an already existing array of color values.}} +* [[_glColor3i]] (statement) {{text|sets the current color.}} +* [[_glColor3iv]] (statement) {{text|sets the current color from an already existing array of color values.}} +* [[_glColor3s]] (statement) {{text|sets the current color.}} +* [[_glColor3sv]] (statement) {{text|sets the current color from an already existing array of color values.}} +* [[_glColor3ub]] (statement) {{text|sets the current color.}} +* [[_glColor3ubv]] (statement) {{text|sets the current color from an already existing array of color values.}} +* [[_glColor3ui]] (statement) {{text|sets the current color.}} +* [[_glColor3uiv]] (statement) {{text|sets the current color from an already existing array of color values.}} +* [[_glColor3us]] (statement) {{text|sets the current color.}} +* [[_glColor3usv]] (statement) {{text|sets the current color from an already existing array of color values.}} +'''----- Set four component (RGBA) colors sort by used data type. -----''' +* [[_glColor4b]] (statement) {{text|sets the current color.}} +* [[_glColor4bv]] (statement) {{text|sets the current color from an already existing array of color values.}} +* [[_glColor4d]] (statement) {{text|sets the current color.}} +* [[_glColor4dv]] (statement) {{text|sets the current color from an already existing array of color values.}} +* [[_glColor4f]] (statement) {{text|sets the current color.}} +* [[_glColor4fv]] (statement) {{text|sets the current color from an already existing array of color values.}} +* [[_glColor4i]] (statement) {{text|sets the current color.}} +* [[_glColor4iv]] (statement) {{text|sets the current color from an already existing array of color values.}} +* [[_glColor4s]] (statement) {{text|sets the current color.}} +* [[_glColor4sv]] (statement) {{text|sets the current color from an already existing array of color values.}} +* [[_glColor4ub]] (statement) {{text|sets the current color.}} +* [[_glColor4ubv]] (statement) {{text|sets the current color from an already existing array of color values.}} +* [[_glColor4ui]] (statement) {{text|sets the current color.}} +* [[_glColor4uiv]] (statement) {{text|sets the current color from an already existing array of color values.}} +* [[_glColor4us]] (statement) {{text|sets the current color.}} +* [[_glColor4usv]] (statement) {{text|sets the current color from an already existing array of color values.}} +'''----- End of set colors. -------------------------------------------''' +* [[_glColorMask]] (statement) {{text|enables and disables writing of frame-buffer color components.}} +* [[_glColorMaterial]] (statement) {{text|causes a material color to track the current color.}} +* [[_glColorPointer]] (statement) {{text|defines an array of colors.}} +* [[_glCopyPixels]] (statement) {{text|copies pixels in the framebuffer.}} +* [[_glCopyTexImage1D]] (statement) {{text|copies pixels from the framebuffer into a one-dimensional texture image.}} +* [[_glCopyTexImage2D]] (statement) {{text|copies pixels from the framebuffer into a two-dimensional texture image.}} +* [[_glCopyTexSubImage1D]] (statement) {{text|copies a sub-image of a one-dimensional texture image from the framebuffer.}} +* [[_glCopyTexSubImage2D]] (statement) {{text|copies a sub-image of a two-dimensional texture image from the framebuffer.}} +* [[_glCullFace]] (statement) {{text|specifies whether front-facing or back-facing facets can be culled.}} -

([[#toc|Return to Table of Contents]])

+
([[#toc|Return to Table of Contents]])
----
_glD
-* [[_glDeleteLists]] (statement) {{text|OpenGL command}} -* [[_glDeleteTextures]] (statement) {{text|OpenGL command deletes named textures}} -* [[_glDepthFunc]] (statement) {{text|OpenGL command specifies the value used for depth buffer comparisons}} -* [[_glDepthMask]] (statement) {{text|OpenGL command enables or disables writing into the depth buffer}} -* [[_glDepthRange]] (statement) {{text|OpenGL command specifies mapping of near clipping plane to window coordinates. Initial value 0.}} -* [[_glDisable]] (statement) {{text|OpenGL command}} -* [[_glDisableClientState]] (statement) {{text|OpenGL command}} -* [[_glDrawArrays]] (statement) {{text|OpenGL command}} -* [[_glDrawBuffer]] (statement) {{text|OpenGL command}} -* [[_glDrawElements]] (statement) {{text|OpenGL command}} -* [[_glDrawPixels]] (statement) {{text|OpenGL command}} - +* [[_glDeleteLists]] (statement) {{text|deletes a contiguous group of display lists.}} +* [[_glDeleteTextures]] (statement) {{text|deletes named textures.}} +* [[_glDepthFunc]] (statement) {{text|specifies the value used for depth-buffer comparisons.}} +* [[_glDepthMask]] (statement) {{text|enables or disables writing into the depth buffer.}} +* [[_glDepthRange]] (statement) {{text|specifies the mapping of z values from normalized device coordinates to window coordinates.}} +* [[_glDisable]] (statement) {{text|the '''_glEnable''' and '''_glDisable''' statements enable or disable OpenGL capabilities.}} +* [[_glDisableClientState]] (statement) {{text|the '''_glEnableClientState''' and '''_glDisableClientState''' statements enable and disable arrays respectively.}} +* [[_glDrawArrays]] (statement) {{text|specifies multiple primitives to render.}} +* [[_glDrawBuffer]] (statement) {{text|specifies which color buffers are to be drawn into.}} +* [[_glDrawElements]] (statement) {{text|renders primitives from array data.}} +* [[_glDrawPixels]] (statement) {{text|writes a block of pixels to the framebuffer.}} +
([[#toc|Return to Table of Contents]])
----
_glE
-* [[_glEdgeFlag]] (statement) {{text|OpenGL command}} -* [[_glEdgeFlagPointer]] (statement) {{text|OpenGL command}} -* [[_glEdgeFlagv]] (statement) {{text|OpenGL command}} -* [[_glEnable]] (statement) {{text|OpenGL command}} -* [[_glEnableClientState]] (statement) {{text|OpenGL command}} -* [[_glEnd]] (statement) {{text|OpenGL command}} -* [[_glEndList]] (statement) {{text|OpenGL command}} +* [[_glEdgeFlag]] (statement) {{text|flags edges as either boundary or nonboundary.}} +* [[_glEdgeFlagv]] (statement) {{text|flags edges as either boundary or nonboundary.}} +* [[_glEdgeFlagPointer]] (statement) {{text|defines an array of edge flags.}} +* [[_glEnable]] (statement) {{text|the '''_glEnable''' and '''_glDisable''' statements enable or disable OpenGL capabilities.}} +* [[_glEnableClientState]] (statement) {{text|the '''_glEnableClientState''' and '''_glDisableClientState''' statements enable and disable arrays respectively.}} +* [[_glEnd]] (statement) {{text|the '''_glBegin''' and '''_glEnd''' statements delimit the vertices of a primitive or a group of like primitives.}} +* [[_glEndList]] (statement) {{text|the '''_glNewList''' and '''_glEndList''' statements create or replace a display list.}} * [[_glEvalCoord1d]] (statement) {{text|OpenGL command}} * [[_glEvalCoord1dv]] (statement) {{text|OpenGL command}} * [[_glEvalCoord1f]] (statement) {{text|OpenGL command}} @@ -973,28 +844,28 @@ __NOTOC__ * [[_glEvalPoint1]] (statement) {{text|OpenGL command}} * [[_glEvalPoint2]] (statement) {{text|OpenGL command}} -

([[#toc|Return to Table of Contents]])

+
([[#toc|Return to Table of Contents]])
----
_glF
-* [[_glFeedbackBuffer]] (statement) {{text|OpenGL command}} -* [[_glFinish]] (statement) {{text|OpenGL command}} -* [[_glFlush]] (statement) {{text|OpenGL command}} +* [[_glFeedbackBuffer]] (statement) {{text|controls feedback mode.}} +* [[_glFinish]] (statement) {{text|blocks until all OpenGL execution is complete.}} +* [[_glFlush]] (statement) {{text|forces execution of OpenGL functions in finite time.}} * [[_glFogf]] (statement) {{text|OpenGL command}} * [[_glFogfv]] (statement) {{text|OpenGL command}} * [[_glFogi]] (statement) {{text|OpenGL command}} * [[_glFogiv]] (statement) {{text|OpenGL command}} -* [[_glFrontFace]] (statement) {{text|OpenGL command}} -* [[_glFrustum]] (statement) {{text|OpenGL command}} +* [[_glFrontFace]] (statement) {{text|defines front-facing and back-facing polygons.}} +* [[_glFrustum]] (statement) {{text|multiplies the current matrix by a perspective matrix.}} -

([[#toc|Return to Table of Contents]])

+
([[#toc|Return to Table of Contents]])
----
_glG
* [[_glGenLists]] (statement) {{text|OpenGL command}} -* [[_glGenTextures]] (statement) {{text|OpenGL command}} +* [[_glGenTextures]] (statement) {{text|generates texture names.}} * [[_glGetBooleanv]] (statement) {{text|OpenGL command}} * [[_glGetClipPlane]] (statement) {{text|OpenGL command}} * [[_glGetDoublev]] (statement) {{text|OpenGL command}} -* [[_glGetError]] (statement) {{text|OpenGL command}} +* [[_glGetError]] (function) {{text|returns error information.}} * [[_glGetFloatv]] (statement) {{text|OpenGL command}} * [[_glGetIntegerv]] (statement) {{text|OpenGL command}} * [[_glGetLightfv]] (statement) {{text|OpenGL command}} @@ -1009,24 +880,24 @@ __NOTOC__ * [[_glGetPixelMapusv]] (statement) {{text|OpenGL command}} * [[_glGetPointerv]] (statement) {{text|OpenGL command}} * [[_glGetPolygonStipple]] (statement) {{text|OpenGL command}} -* [[_glGetString]] (statement) {{text|OpenGL command}} +* [[_glGetString]] (function) {{text|returns a string describing the current OpenGL connection.}} * [[_glGetTexEnvfv]] (statement) {{text|OpenGL command}} * [[_glGetTexEnviv]] (statement) {{text|OpenGL command}} * [[_glGetTexGendv]] (statement) {{text|OpenGL command}} * [[_glGetTexGenfv]] (statement) {{text|OpenGL command}} * [[_glGetTexGeniv]] (statement) {{text|OpenGL command}} -* [[_glGetTexImage]] (statement) {{text|OpenGL command}} +* [[_glGetTexImage]] (statement) {{text|returns a texture image.}} * [[_glGetTexLevelParameterfv]] (statement) {{text|OpenGL command}} * [[_glGetTexLevelParameteriv]] (statement) {{text|OpenGL command}} * [[_glGetTexParameterfv]] (statement) {{text|OpenGL command}} * [[_glGetTexParameteriv]] (statement) {{text|OpenGL command}} -

([[#toc|Return to Table of Contents]])

+
([[#toc|Return to Table of Contents]])
----
_glH
-* [[_glHint]] (statement) {{text|OpenGL command}} - +* [[_glHint]] (statement) {{text|specifies implementation-specific hints.}} +
([[#toc|Return to Table of Contents]])
----
_glI
* [[_glIndexMask]] (statement) {{text|OpenGL command}} @@ -1043,11 +914,11 @@ __NOTOC__ * [[_glIndexubv]] (statement) {{text|OpenGL command}} * [[_glInitNames]] (statement) {{text|OpenGL command}} * [[_glInterleavedArrays]] (statement) {{text|OpenGL command}} -* [[_glIsEnabled]] (statement) {{text|OpenGL command}} +* [[_glIsEnabled]] (function) {{text|tests whether a capability is enabled.}} * [[_glIsList]] (statement) {{text|OpenGL command}} -* [[_glIsTexture]] (statement) {{text|OpenGL command}} +* [[_glIsTexture]] (function) {{text|determines if a name corresponds to a texture.}} -

([[#toc|Return to Table of Contents]])

+
([[#toc|Return to Table of Contents]])
----
_glL
* [[_glLightModelf]] (statement) {{text|OpenGL command}} @@ -1059,15 +930,15 @@ __NOTOC__ * [[_glLighti]] (statement) {{text|OpenGL command}} * [[_glLightiv]] (statement) {{text|OpenGL command}} * [[_glLineStipple]] (statement) {{text|OpenGL command}} -* [[_glLineWidth]] (statement) {{text|OpenGL command}} +* [[_glLineWidth]] (statement) {{text|specifies the width of rasterized lines.}} * [[_glListBase]] (statement) {{text|OpenGL command}} * [[_glLoadIdentity]] (statement) {{text|OpenGL command}} * [[_glLoadMatrixd]] (statement) {{text|OpenGL command}} * [[_glLoadMatrixf]] (statement) {{text|OpenGL command}} * [[_glLoadName]] (statement) {{text|OpenGL command}} -* [[_glLogicOp]] (statement) {{text|OpenGL command}} +* [[_glLogicOp]] (statement) {{text|specifies a logical pixel operation for color index rendering.}} -

([[#toc|Return to Table of Contents]])

+
([[#toc|Return to Table of Contents]])
----
_glM
* [[_glMap1d]] (statement) {{text|OpenGL command}} @@ -1086,10 +957,10 @@ __NOTOC__ * [[_glMultMatrixd]] (statement) {{text|OpenGL command}} * [[_glMultMatrixf]] (statement) {{text|OpenGL command}} - +
([[#toc|Return to Table of Contents]])
----
_glN
-* [[_glNewList]] (statement) {{text|OpenGL command}} +* [[_glNewList]] (statement) {{text|the '''_glNewList''' and '''_glEndList''' statements create or replace a display list.}} * [[_glNormal3b]] (statement) {{text|OpenGL command}} * [[_glNormal3bv]] (statement) {{text|OpenGL command}} * [[_glNormal3d]] (statement) {{text|OpenGL command}} @@ -1102,12 +973,12 @@ __NOTOC__ * [[_glNormal3sv]] (statement) {{text|OpenGL command}} * [[_glNormalPointer]] (statement) {{text|OpenGL command}} -

([[#toc|Return to Table of Contents]])

+
([[#toc|Return to Table of Contents]])
----
_glO
* [[_glOrtho]] (statement) {{text|OpenGL command}} - +
([[#toc|Return to Table of Contents]])
----
_glP
* [[_glPassThrough]] (statement) {{text|OpenGL command}} @@ -1119,9 +990,9 @@ __NOTOC__ * [[_glPixelTransferf]] (statement) {{text|OpenGL command}} * [[_glPixelTransferi]] (statement) {{text|OpenGL command}} * [[_glPixelZoom]] (statement) {{text|OpenGL command}} -* [[_glPointSize]] (statement) {{text|OpenGL command}} -* [[_glPolygonMode]] (statement) {{text|OpenGL command}} -* [[_glPolygonOffset]] (statement) {{text|OpenGL command}} +* [[_glPointSize]] (statement) {{text|specifies the diameter of rasterized points.}} +* [[_glPolygonMode]] (statement) {{text|selects a polygon rasterization mode.}} +* [[_glPolygonOffset]] (statement) {{text|sets the scale and units OpenGL uses to calculate depth values.}} * [[_glPolygonStipple]] (statement) {{text|OpenGL command}} * [[_glPopAttrib]] (statement) {{text|OpenGL command}} * [[_glPopClientAttrib]] (statement) {{text|OpenGL command}} @@ -1133,7 +1004,7 @@ __NOTOC__ * [[_glPushMatrix]] (statement) {{text|OpenGL command}} * [[_glPushName]] (statement) {{text|OpenGL command}} -

([[#toc|Return to Table of Contents]])

+
([[#toc|Return to Table of Contents]])
----
_glR
* [[_glRasterPos2d]] (statement) {{text|OpenGL command}} @@ -1154,15 +1025,14 @@ __NOTOC__ * [[_glRasterPos3sv]] (statement) {{text|OpenGL command}} * [[_glRasterPos4d]] (statement) {{text|OpenGL command}} * [[_glRasterPos4dv]] (statement) {{text|OpenGL command}} -

([[#toc|Return to Table of Contents]])

* [[_glRasterPos4f]] (statement) {{text|OpenGL command}} * [[_glRasterPos4fv]] (statement) {{text|OpenGL command}} * [[_glRasterPos4i]] (statement) {{text|OpenGL command}} * [[_glRasterPos4iv]] (statement) {{text|OpenGL command}} * [[_glRasterPos4s]] (statement) {{text|OpenGL command}} * [[_glRasterPos4sv]] (statement) {{text|OpenGL command}} -* [[_glReadBuffer]] (statement) {{text|OpenGL command}} -* [[_glReadPixels]] (statement) {{text|OpenGL command}} +* [[_glReadBuffer]] (statement) {{text|selects a color buffer source for pixels.}} +* [[_glReadPixels]] (statement) {{text|reads a block of pixels from the framebuffer.}} * [[_glRectd]] (statement) {{text|OpenGL command}} * [[_glRectdv]] (statement) {{text|OpenGL command}} * [[_glRectf]] (statement) {{text|OpenGL command}} @@ -1175,19 +1045,19 @@ __NOTOC__ * [[_glRotated]] (statement) {{text|OpenGL command}} * [[_glRotatef]] (statement) {{text|OpenGL command}} -

([[#toc|Return to Table of Contents]])

+
([[#toc|Return to Table of Contents]])
----
_glS
* [[_glScaled]] (statement) {{text|OpenGL command}} * [[_glScalef]] (statement) {{text|OpenGL command}} -* [[_glScissor]] (statement) {{text|OpenGL command}} +* [[_glScissor]] (statement) {{text|defines the scissor box.}} * [[_glSelectBuffer]] (statement) {{text|OpenGL command}} * [[_glShadeModel]] (statement) {{text|OpenGL command}} -* [[_glStencilFunc]] (statement) {{text|OpenGL command}} -* [[_glStencilMask]] (statement) {{text|OpenGL command}} -* [[_glStencilOp]] (statement) {{text|OpenGL command}} - +* [[_glStencilFunc]] (statement) {{text|sets the function and reference value for stencil testing.}} +* [[_glStencilMask]] (statement) {{text|controls the writing of individual bits in the stencil planes.}} +* [[_glStencilOp]] (statement) {{text|sets the stencil test actions.}} +
([[#toc|Return to Table of Contents]])
----
_glT
* [[_glTexCoord1d]] (statement) {{text|OpenGL command}} @@ -1211,7 +1081,6 @@ __NOTOC__ * [[_glTexCoord3f]] (statement) {{text|OpenGL command}} * [[_glTexCoord3fv]] (statement) {{text|OpenGL command}} * [[_glTexCoord3i]] (statement) {{text|OpenGL command}} -

([[#toc|Return to Table of Contents]])

* [[_glTexCoord3iv]] (statement) {{text|OpenGL command}} * [[_glTexCoord3s]] (statement) {{text|OpenGL command}} * [[_glTexCoord3sv]] (statement) {{text|OpenGL command}} @@ -1234,18 +1103,18 @@ __NOTOC__ * [[_glTexGenfv]] (statement) {{text|OpenGL command}} * [[_glTexGeni]] (statement) {{text|OpenGL command}} * [[_glTexGeniv]] (statement) {{text|OpenGL command}} -* [[_glTexImage1D]] (statement) {{text|OpenGL command}} -* [[_glTexImage2D]] (statement) {{text|OpenGL command}} +* [[_glTexImage1D]] (statement) {{text|specifies a one-dimensional texture image.}} +* [[_glTexImage2D]] (statement) {{text|specifies a two-dimensional texture image.}} * [[_glTexParameterf]] (statement) {{text|OpenGL command}} * [[_glTexParameterfv]] (statement) {{text|OpenGL command}} * [[_glTexParameteri]] (statement) {{text|OpenGL command}} * [[_glTexParameteriv]] (statement) {{text|OpenGL command}} -* [[_glTexSubImage1D]] (statement) {{text|OpenGL command}} -* [[_glTexSubImage2D]] (statement) {{text|OpenGL command}} +* [[_glTexSubImage1D]] (statement) {{text|specifies a portion of an existing one-dimensional texture image.}} +* [[_glTexSubImage2D]] (statement) {{text|specifies a portion of an existing one-dimensional texture image.}} * [[_glTranslated]] (statement) {{text|OpenGL command}} * [[_glTranslatef]] (statement) {{text|OpenGL command}} -

([[#toc|Return to Table of Contents]])

+
([[#toc|Return to Table of Contents]])
----
_glV
* [[_glVertex2d]] (statement) {{text|OpenGL command}} @@ -1273,16 +1142,14 @@ __NOTOC__ * [[_glVertex4s]] (statement) {{text|OpenGL command}} * [[_glVertex4sv]] (statement) {{text|OpenGL command}} * [[_glVertexPointer]] (statement) {{text|OpenGL command}} -* [[_glViewport]] (statement) {{text|OpenGL command}} +* [[_glViewport]] (statement) {{text|sets the viewport.}} + +
([[#toc|Return to Table of Contents]])
+ +
([[#OpenGL specific keywords|Go to Top of OpenGL specific keywords]])
- -

([[#toc|Return to Table of Contents]])

- - -
- -==Symbols:== +== Symbols ==
'''QB64 and QB Symbols:'''
''[Note: All symbols below can also be used inside of literal quoted strings except for quotation marks.]''
@@ -1293,7 +1160,7 @@ __NOTOC__ * [[Comma|, Comma]] after a [[PRINT]] tabs invisible cursor past end of printed value. After the [[INPUT]] prompt text a [[comma]] displays no [[Question mark]]. * [[Quotation mark|" Quotation mark]] delimits the ends of a literal [[STRING]] value in a [[PRINT]], [[INPUT]] or [[LINE INPUT]] statement. * [[Question mark|? Question mark]] is a shortcut substitute for the [[PRINT]] keyword. Will change to PRINT when cursor leaves the code line. - +
([[#toc|Return to Table of Contents]])
:'''Program Code Markers''' * [[Apostrophe|' Apostrophe]] ignores a line of code or program comment and MUST be used before a [[Metacommand]]. Same as using [[REM]]. @@ -1304,7 +1171,7 @@ __NOTOC__ * [[+|+ Plus]] [[concatenation]] operator MUST be used to combine literal string values in a variable definition. * [[Quotation mark|" Quotation mark]] designates the ends of a literal [[STRING]] value. Use [[CHR$]](34) to insert quotes in a text [[STRING]]. * [[Underscore|_ Underscore]] can be used to continue a line of code to the next program line in '''QB64'''. -

([[#toc|Return to Table of Contents]])

+
([[#toc|Return to Table of Contents]])
:'''Variable Name Type Suffixes''' * [[STRING|$ STRING]] text character type: 1 byte @@ -1318,14 +1185,13 @@ __NOTOC__ * [[_BIT|` _BIT]] '''QB64''' [[INTEGER|whole]] numerical type (1 bit) (Key below tilde (~) or [[CHR$]](96)) * [[_BYTE|%% _BYTE]] '''QB64''' [[INTEGER|whole]] numerical type (1 byte) * [[_OFFSET|%& _OFFSET]] '''QB64''' [[INTEGER|whole]] numerical pointer address type (any byte size required) - -

([[#toc|Return to Table of Contents]])

+
([[#toc|Return to Table of Contents]])
:'''Numerical Base Prefixes''' * [[&B|&B Binary]] Base 2: Digits 0 or 1 ['''QB64'''] * [[&O|&O Octal]] Base 8: Digits 0 to 7 * [[&H|&H Hexadecimal]] Base 16: Digits 0 to F - +
([[#toc|Return to Table of Contents]])
:'''[[Mathematical Operations]]''' *[[+|+ Addition]] operator or sign @@ -1335,7 +1201,7 @@ __NOTOC__ *[[\|\ Integer division]] operator *[[^|^ Exponential]] operator *[[MOD|MOD Integer Remainder division]] operator - +
([[#toc|Return to Table of Contents]])
:'''[[Relational Operations]]''' * [[Equal|=]] Equal to condition @@ -1344,42 +1210,38 @@ __NOTOC__ * [[Less_Than|<]] Less than condition * [[Greater_Than_Or_Equal|>=]] Greater than or equal to condition * [[Less_Than_Or_Equal|<=]] Less than or equal to condition - -

([[#toc|Return to Table of Contents]])

- -==References:== -
- -
'''WIKI Pages''' - -[[Keyword Reference - Alphabetical#QB64 specific keywords:|Go to QB64 specific keywords]] - -[[Keyword Reference - Alphabetical#Original QBasic keywords:|Go to Top of Original QB keywords]] - -[[Keyword Reference - By usage|Go to keywords by Usage]] - -[[Main_Page#Appendix:|Main Page with Appendix and Tutorials]] +
([[#toc|Return to Table of Contents]])
-'''Got a question about something?''' +== References == -[[QB64 FAQ|Visit the QB64 FAQ]] +
'''WIKI Pages'''
-[http://qb64phoenix.com Visit the QB64 Main Site] +
[[#QB64 specific keywords|Go to Top of QB64 specific keywords]]
-[http://qb64phoenix.com/forum/index.php Visit QB64 Community Forum] +
[[#Original QBasic keywords|Go to Top of Original QBasic keywords]]
+ +
[[#OpenGL specific keywords|Go to Top of OpenGL specific keywords]]
+ +
[[Keyword Reference - By usage|Go to keywords by Usage]]
+ +
[[Main_Page|Main Page with Articles and Tutorials]]
-'''Links to other QBasic Sites:''' +
'''Got a question about something?'''
-[http://qbasicstation.com/index.php?c=p_member Member programs at QBasic Station] +
[[QB64 FAQ|Visit the QB64 FAQ]]
-[http://www.network54.com/Index/10167 QBasic Forum at Network 54] +
[http://qb64phoenix.com Visit the QB64-PE Main Site]
-[http://www.petesqbsite.com/forum/ Pete's QBasic Forum] - -[http://www.petesqbsite.com/downloads/downloads.shtml Pete's QBasic Downloads]
+
[http://qb64phoenix.com/forum/index.php Visit QB64-PE Community Forum]
-

([[#toc|Return to Table of Contents]])

+
'''Links to other QBasic Sites:'''
+
[http://www.petesqbsite.com/phpBB3/ Pete's QBasic Forum]
+ +
[http://www.petesqbsite.com/downloads/downloads.shtml Pete's QBasic Downloads]
+ + +
([[#toc|Return to Table of Contents]])
diff --git a/internal/help/Keyword_Reference_-_By_usage_1000000_100000000_-_10_00000.txt b/internal/help/Keyword_Reference_-_By_usage_1000000_100000000_-_10_00000.txt index beabc16a8..95fc8a86c 100644 --- a/internal/help/Keyword_Reference_-_By_usage_1000000_100000000_-_10_00000.txt +++ b/internal/help/Keyword_Reference_-_By_usage_1000000_100000000_-_10_00000.txt @@ -1,5 +1,5 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:06:15}} +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:35:56}} __NOEDITSECTION__ {|align="Right" |__TOC__ @@ -112,7 +112,7 @@ __NOEDITSECTION__ * [[XOR (boolean)]] {{text|returns True if only one of two arguments are True.}} -{{Template:RelationalOperationsTable}} +{{RelationalOperationsTable}}
See also: [[#Logical Bitwise Operations|Logical Operations]] and [[Relational Operations]]
@@ -184,6 +184,7 @@ __NOEDITSECTION__ * [[COMMAND$]] (function) {{text|returns command line parameters sent when a program is started.}} * [[ENVIRON]] (statement) {{text|temporarily sets an environmental key/pair value.}} * [[ENVIRON$]] (function) {{text|returns the environmental settings of the computer.}} +* [[_ENVIRONCOUNT]] (function) {{text|returns the number of key/value pairs currently exist in the environment table.}} * [[FILES]] (statement) {{text|displays a specified list of files.}} * [[MKDIR]] (statement) {{text|creates a new directory folder in the designated path.}} * [[NAME]] (statement) {{text|renames a file.}} @@ -579,7 +580,7 @@ The following table describes the error codes that are reported by the '''QB64'' * [[XOR]] (operator) {{text|the bit is set when just one of the bits are set.}} -{{Template:LogicalTruthTable}} +{{LogicalTruthTable}}

([[#toc|Return to Table of Contents]])

@@ -614,13 +615,13 @@ The following table describes the error codes that are reported by the '''QB64'' * [[TAN]] (function) {{text|returns the ratio of [[SIN]]e to [[COS]]ine or tangent value of an angle measured in radians.}} -
See also: [[Mathematical Operations]] and [[#Logical Bitwise Operations:|Logical Operations:]]
+
See also: [[Mathematical Operations]] and [[#Logical Bitwise Operations:|Logical Operations:]]

([[#toc|Return to Table of Contents]])

== Memory Handling and Clipboard == -* [[_CLIPBOARD$ (function)]] {{text|returns the current [[STRING]] contents of the system Clipboard.}} +* [[_CLIPBOARD$]] (function) {{text|returns the current [[STRING]] contents of the system Clipboard.}} * [[_CLIPBOARD$ (statement)]] {{text|sets and overwrites the [[STRING]] contents of the current system Clipboard.}} * [[_MEM (function)]] {{text|returns _MEM block referring to the largest continuous memory region beginning at a designated variable's offset.}} * [[_MEM]] (variable type) {{text|contains read only dot elements for the OFFSET, SIZE, TYPE and ELEMENTSIZE of a block of memory.}} @@ -634,6 +635,7 @@ The following table describes the error codes that are reported by the '''QB64'' * [[_MEMIMAGE]] (function) {{text|returns a [[_MEM]] block referring to a designated image handle's memory}} * [[_MEMNEW]] (function) {{text|allocates new memory with a designated SIZE and returns a [[_MEM]] block referring to it.}} * [[_MEMPUT]] (statement) {{text|places a designated value into a designated memory [[_OFFSET]]}} +* [[_MEMSOUND]] (function) {{text|returns a [[_MEM]] block referring to a designated sound handle's memory}} * [[_OFFSET (function)]] {{text|returns the memory offset of a variable when used with [[DECLARE LIBRARY]] or [[_MEM]] only.}} * [[_OFFSET]](%& numerical type) {{text|can be used store the value of an offset in memory when using [[DECLARE LIBRARY]] or [[_MEM]] only.}} @@ -770,7 +772,7 @@ The following table describes the error codes that are reported by the '''QB64'' * [[PRINT USING (file statement)]] {{text|prints template formatted [[STRING]] text to a text file.}} -{{PrintUsing}} +{{PrintUsingTable}}

([[#toc|Return to Table of Contents]])

@@ -851,7 +853,7 @@ The following table describes the error codes that are reported by the '''QB64'' * [[_SNDRAW]] (statement) {{text|plays sound wave sample frequencies created by a program.}} * [[_SNDRAWDONE]] (statement) {{text|pads a [[_SNDRAW]] stream so the final (partially filled) buffer section is played.}} * [[_SNDRAWLEN]] (function) {{text|returns the length, in seconds, of a _SNDRAW sound currently queued.}} -* [[_SNDRAWOPEN]] (function) {{text|returns a handle to a new, separate [[_SNDRAW]] audio stream.}} +* [[_SNDOPENRAW]] (function) {{text|returns a handle to a new, separate [[_SNDRAW]] audio stream.}} * [[_SNDSETPOS]] (statement) {{text|changes the current/starting playing position of a sound in seconds.}} * [[_SNDSTOP]] (statement) {{text|stops a playing or paused sound handle.}} * [[_SNDVOL]] (statement) {{text|sets the volume of a sound handle being played.}} @@ -984,7 +986,7 @@ The following table describes the error codes that are reported by the '''QB64'' * [[WRITE]] (screen I/O statement) {{text|writes a comma-separated list of values to the screen.}} -
See also: [[#Fonts and Unicode:|Fonts and Unicode]] or [[ASCII|ASCII Code Table]]
+
See also: [[#Fonts and Unicode:|Fonts and Unicode]] or [[ASCII|ASCII Code Table]]

([[#toc|Return to Table of Contents]])

@@ -1142,4 +1144,3 @@ The following table describes the error codes that are reported by the '''QB64''

([[#toc|Return to Table of Contents]])

- diff --git a/internal/help/LBOUND_111111.txt b/internal/help/LBOUND_111111.txt index 0c58ef742..8ccb40398 100644 --- a/internal/help/LBOUND_111111.txt +++ b/internal/help/LBOUND_111111.txt @@ -1,5 +1,5 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:14:02}} +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:42:57}} The [[LBOUND]] function returns the smallest valid index (lower bound) of an array dimension. @@ -33,4 +33,3 @@ The [[LBOUND]] function returns the smallest valid index (lower bound) of an arr {{PageNavigation}} - diff --git a/internal/help/LCASE$_11111$.txt b/internal/help/LCASE$_11111$.txt index eff558676..09c81d2ce 100644 --- a/internal/help/LCASE$_11111$.txt +++ b/internal/help/LCASE$_11111$.txt @@ -1,5 +1,5 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:14:03}} +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:42:58}} The [[LCASE$]] function outputs an all-lowercase version of a [[STRING]]. @@ -29,4 +29,3 @@ The [[LCASE$]] function outputs an all-lowercase version of a [[STRING]]. {{PageNavigation}} - diff --git a/internal/help/LEFT$_1111$.txt b/internal/help/LEFT$_1111$.txt index b4dc9c5d4..efcbec2f4 100644 --- a/internal/help/LEFT$_1111$.txt +++ b/internal/help/LEFT$_1111$.txt @@ -1,5 +1,5 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:14:05}} +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:42:59}} The [[LEFT$]] string function returns a number of characters from the left of a [[STRING]]. @@ -69,4 +69,3 @@ This is your sentence to change your words.{{OutputEnd}} {{PageNavigation}} - diff --git a/internal/help/LEN_111.txt b/internal/help/LEN_111.txt index 809dd8f43..1e559e9bf 100644 --- a/internal/help/LEN_111.txt +++ b/internal/help/LEN_111.txt @@ -1,5 +1,5 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:14:06}} +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:43:00}} The [[LEN]] function returns the number of bytes used by a variable value and the number of characters in a [[STRING]]. @@ -120,4 +120,3 @@ PRINT NumRecords%; "records" {{PageNavigation}} - diff --git a/internal/help/LET_111.txt b/internal/help/LET_111.txt index 930d08793..d9f7b70a5 100644 --- a/internal/help/LET_111.txt +++ b/internal/help/LET_111.txt @@ -1,22 +1,21 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:14:07}} -The [[LET]] is a useless statement designed by [[cavemen]] when they started programming. +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:43:01}} +[[LET]] is a (more or less) needless statement designed for the very early BASIC dialects. {{PageSyntax}} -: '''[LET]''' {{Parameter|variable}} = {{Parameter|expression}} +: [[LET]] {{Parameter|variable}} = {{Parameter|expression}} {{PageDescription}} -* {{InlineCode}}LET a = 12{{InlineCodeEnd}} is the same as {{InlineCode}}a = 12{{InlineCodeEnd}}, but wastes 4 extra bytes of program space. - -''Notes:'' LET is '''optional''', it's the only keyword where the '''entire keyword''' is optional :-) +* {{InlineCode}}{{Cl|LET}} a = 12{{InlineCodeEnd}} is the very same as {{InlineCode}}a = 12{{InlineCodeEnd}}, but wastes 4 extra bytes of program space. +* That said, [[LET]] is '''optional''', it's the only keyword where the '''entire keyword''' is optional.😀 {{PageSeeAlso}} -* [[Cavemen]] * [[Variable]] {{PageNavigation}} +[[Category:Final]] diff --git a/internal/help/LINE_1111.txt b/internal/help/LINE_1111.txt index 05c530c6a..25a5acb34 100644 --- a/internal/help/LINE_1111.txt +++ b/internal/help/LINE_1111.txt @@ -1,5 +1,5 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:14:08}} +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:43:02}} The [[LINE]] statement is used in graphic [[SCREEN (statement)|SCREEN]] modes to create lines or boxes. @@ -88,4 +88,3 @@ The [[LINE]] statement is used in graphic [[SCREEN (statement)|SCREEN]] modes to {{PageNavigation}} - diff --git a/internal/help/LINE_INPUT_(file_statement)_1111_11111_(0000_000000000).txt b/internal/help/LINE_INPUT_(file_statement)_1111_11111_(0000_000000000).txt index f563846fb..78c79e78d 100644 --- a/internal/help/LINE_INPUT_(file_statement)_1111_11111_(0000_000000000).txt +++ b/internal/help/LINE_INPUT_(file_statement)_1111_11111_(0000_000000000).txt @@ -1,5 +1,5 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:14:11}} +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:43:05}} The '''LINE INPUT #''' file statement reads an entire line from a text file into a string variable. @@ -54,4 +54,3 @@ The '''LINE INPUT #''' file statement reads an entire line from a text file into {{PageNavigation}} - diff --git a/internal/help/LINE_INPUT_1111_11111.txt b/internal/help/LINE_INPUT_1111_11111.txt index 312cbee62..f58d6d7f6 100644 --- a/internal/help/LINE_INPUT_1111_11111.txt +++ b/internal/help/LINE_INPUT_1111_11111.txt @@ -1,5 +1,5 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:14:10}} +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:43:04}} The [[LINE INPUT]] statement requests a [[STRING]] keyboard entry from a program user. @@ -52,4 +52,3 @@ n$ = {{Cl|UCASE$}}(name$) ' convert search name to upper case {{PageNavigation}} - diff --git a/internal/help/LOCATE_111111.txt b/internal/help/LOCATE_111111.txt index 9ff8b5ffe..813059621 100644 --- a/internal/help/LOCATE_111111.txt +++ b/internal/help/LOCATE_111111.txt @@ -1,5 +1,5 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:14:14}} +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:43:07}} The [[LOCATE]] statement locates the screen text row and column positions for a [[PRINT]] or [[INPUT]] procedure. @@ -55,4 +55,3 @@ LOOP {{PageNavigation}} - diff --git a/internal/help/LOCK_1111.txt b/internal/help/LOCK_1111.txt index bd4ff9c8b..8b9778f7a 100644 --- a/internal/help/LOCK_1111.txt +++ b/internal/help/LOCK_1111.txt @@ -1,5 +1,5 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:14:15}} +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:43:08}} The [[LOCK]] statement restricts access to parts of a file by other programs or processes. @@ -31,4 +31,3 @@ The [[LOCK]] statement restricts access to parts of a file by other programs or {{PageNavigation}} - diff --git a/internal/help/LOC_111.txt b/internal/help/LOC_111.txt index 91bbbe0f5..b951dcec5 100644 --- a/internal/help/LOC_111.txt +++ b/internal/help/LOC_111.txt @@ -1,5 +1,5 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:14:12}} +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:43:06}} The [[LOC]] function returns the status of a serial (COM) port received buffer or the current byte position in an open file. @@ -34,4 +34,3 @@ The [[LOC]] function returns the status of a serial (COM) port received buffer o * [[SEEK]] {{PageNavigation}} - diff --git a/internal/help/LOF_111.txt b/internal/help/LOF_111.txt index e59e35471..520b06716 100644 --- a/internal/help/LOF_111.txt +++ b/internal/help/LOF_111.txt @@ -1,5 +1,5 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:14:16}} +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:43:09}} The [[LOF]] function is used to find the length of an [[OPEN]] file in bytes. @@ -30,4 +30,3 @@ The [[LOF]] function is used to find the length of an [[OPEN]] file in bytes. {{PageNavigation}} - diff --git a/internal/help/LOG_111.txt b/internal/help/LOG_111.txt index c14cb70fe..5f3e8d24d 100644 --- a/internal/help/LOG_111.txt +++ b/internal/help/LOG_111.txt @@ -1,5 +1,5 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:14:18}} +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:43:10}} The [[LOG]] math function returns the natural logarithm of a specified numerical value. @@ -45,4 +45,3 @@ END FUNCTION {{PageNavigation}} - diff --git a/internal/help/LONG_1111.txt b/internal/help/LONG_1111.txt index 415c65a06..39a5a9d1f 100644 --- a/internal/help/LONG_1111.txt +++ b/internal/help/LONG_1111.txt @@ -1,5 +1,5 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:14:19}} +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:43:11}} [[LONG]] defines a variable as a 4 byte number type definition for larger [[INTEGER]] values. @@ -29,4 +29,3 @@ {{PageNavigation}} - diff --git a/internal/help/LPOS_1111.txt b/internal/help/LPOS_1111.txt index 6f285a4a3..8fd0e1321 100644 --- a/internal/help/LPOS_1111.txt +++ b/internal/help/LPOS_1111.txt @@ -1,5 +1,5 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:14:20}} +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:43:15}} The [[LPOS]] function returns the current LPT printer head position. @@ -46,4 +46,3 @@ The [[LPOS]] function returns the current LPT printer head position. {{PageNavigation}} - diff --git a/internal/help/LPRINT_111111.txt b/internal/help/LPRINT_111111.txt index 779b036e6..80bd6d5a1 100644 --- a/internal/help/LPRINT_111111.txt +++ b/internal/help/LPRINT_111111.txt @@ -1,5 +1,5 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:14:22}} +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:43:16}} The [[LPRINT]] statement sends string text or numerical values to a parallel port (LPT1) printer in QBasic or a USB printer in '''QB64'''. @@ -26,4 +26,3 @@ The [[LPRINT]] statement sends string text or numerical values to a parallel por {{PageNavigation}} - diff --git a/internal/help/LPRINT_USING_111111_11111.txt b/internal/help/LPRINT_USING_111111_11111.txt index 26d3e8036..936f1b823 100644 --- a/internal/help/LPRINT_USING_111111_11111.txt +++ b/internal/help/LPRINT_USING_111111_11111.txt @@ -1,5 +1,5 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:14:23}} +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:43:18}} The [[LPRINT USING]] statement sends formatted data to LPT1, the parallel port printer. @@ -23,7 +23,7 @@ The [[LPRINT USING]] statement sends formatted data to LPT1, the parallel port p * '''NOTE:''' If the numerical value exceeds the template's digit range a % symbol will appear in the leftmost digit area. -{{PrintUsing}} +{{PrintUsingTable}} {{PageSeeAlso}} @@ -33,4 +33,3 @@ The [[LPRINT USING]] statement sends formatted data to LPT1, the parallel port p {{PageNavigation}} - diff --git a/internal/help/LSET_1111.txt b/internal/help/LSET_1111.txt index c3b6057da..9e3d8d58f 100644 --- a/internal/help/LSET_1111.txt +++ b/internal/help/LSET_1111.txt @@ -1,5 +1,5 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:14:24}} +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:43:19}} [[LSET]] left-justifies a fixed length string expression based on the size of the [[STRING]] variable and string expression. @@ -61,4 +61,3 @@ you.head: ACHES {{PageNavigation}} - diff --git a/internal/help/LTRIM$_11111$.txt b/internal/help/LTRIM$_11111$.txt index d53ad74e3..f79f64a74 100644 --- a/internal/help/LTRIM$_11111$.txt +++ b/internal/help/LTRIM$_11111$.txt @@ -1,5 +1,5 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:14:25}} +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:43:20}} The [[LTRIM$]] function removes leading space characters from a [[STRING]] value. @@ -55,4 +55,3 @@ TRIM$ = {{Cl|LTRIM$}}({{Cl|RTRIM$}}(text$)) {{PageNavigation}} - diff --git a/internal/help/Less_Than_1000_1000.txt b/internal/help/Less_Than_1000_1000.txt index 861e231f3..6e7d5884e 100644 --- a/internal/help/Less_Than_1000_1000.txt +++ b/internal/help/Less_Than_1000_1000.txt @@ -1,5 +1,5 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:25:02}} +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:54:15}} The '''<''' condition symbol denotes that a value must be less than another value for the condition to be True. @@ -19,4 +19,3 @@ The '''<''' condition symbol denotes that a value must be less than another valu {{PageNavigation}} - diff --git a/internal/help/Less_Than_Or_Equal_1000_1000_10_10000.txt b/internal/help/Less_Than_Or_Equal_1000_1000_10_10000.txt index 0a00a54b6..4c4d24b5c 100644 --- a/internal/help/Less_Than_Or_Equal_1000_1000_10_10000.txt +++ b/internal/help/Less_Than_Or_Equal_1000_1000_10_10000.txt @@ -1,5 +1,5 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:25:04}} +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:54:17}} The '''<=''' condition symbol denotes that a value must be less than or equal to another value for the condition to be True. @@ -15,4 +15,3 @@ The '''<=''' condition symbol denotes that a value must be less than or equal to {{PageNavigation}} - diff --git a/internal/help/MID$_(statement)_111$_(000000000).txt b/internal/help/MID$_(statement)_111$_(000000000).txt index b52551df4..2cf6dff3b 100644 --- a/internal/help/MID$_(statement)_111$_(000000000).txt +++ b/internal/help/MID$_(statement)_111$_(000000000).txt @@ -1,5 +1,5 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:14:28}} +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:43:22}} The [[MID$]] statement substitutes one or more new characters for existing characters of a previously defined [[STRING]]. @@ -46,4 +46,3 @@ The cats and rats were playing, even though rats don't like cats. {{PageNavigation}} - diff --git a/internal/help/MID$_111$.txt b/internal/help/MID$_111$.txt index 4333e2c43..a25b2d19c 100644 --- a/internal/help/MID$_111$.txt +++ b/internal/help/MID$_111$.txt @@ -1,5 +1,5 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:14:27}} +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:43:21}} The [[MID$]] function returns a portion of a [[STRING|string]]. @@ -109,4 +109,3 @@ t5# = {{Cl|TIMER}} {{PageNavigation}} - diff --git a/internal/help/MKD$_111$.txt b/internal/help/MKD$_111$.txt index ceaf250a4..a005336b1 100644 --- a/internal/help/MKD$_111$.txt +++ b/internal/help/MKD$_111$.txt @@ -1,5 +1,5 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:14:42}} +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:43:24}} The [[MKD$]] function encodes a [[DOUBLE]] numerical value into an 8-byte [[ASCII]] [[STRING]] value. @@ -20,4 +20,3 @@ The [[MKD$]] function encodes a [[DOUBLE]] numerical value into an 8-byte [[ASCI * [[_MK$]], [[_CV]] {{PageNavigation}} - diff --git a/internal/help/MKDIR_11111.txt b/internal/help/MKDIR_11111.txt index b7cb0cc3f..18fae9ee6 100644 --- a/internal/help/MKDIR_11111.txt +++ b/internal/help/MKDIR_11111.txt @@ -1,5 +1,5 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:14:43}} +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:43:25}} The [[MKDIR]] statement creates a new folder ('''dir'''ectory) at a specified path. @@ -24,4 +24,3 @@ The [[MKDIR]] statement creates a new folder ('''dir'''ectory) at a specified pa {{PageNavigation}} - diff --git a/internal/help/MKDMBF$_111111$.txt b/internal/help/MKDMBF$_111111$.txt index 69af6e152..94e1a719d 100644 --- a/internal/help/MKDMBF$_111111$.txt +++ b/internal/help/MKDMBF$_111111$.txt @@ -1,5 +1,5 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:14:44}} +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:43:26}} The [[MKDMBF$]] function encodes a double-precision IEEE number to a string value in the Microsoft Binary format. @@ -18,4 +18,3 @@ The [[MKDMBF$]] function encodes a double-precision IEEE number to a string valu {{PageNavigation}} - diff --git a/internal/help/MKI$_111$.txt b/internal/help/MKI$_111$.txt index 0a5f8abcf..f19ba7f48 100644 --- a/internal/help/MKI$_111$.txt +++ b/internal/help/MKI$_111$.txt @@ -1,5 +1,5 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:14:46}} +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:43:27}} The [[MKI$]] function encodes an [[INTEGER]] numerical value into a 2-byte [[ASCII]] [[STRING]] value. @@ -46,4 +46,3 @@ DO {{PageNavigation}} - diff --git a/internal/help/MKL$_111$.txt b/internal/help/MKL$_111$.txt index 6a0e5353f..e89575f07 100644 --- a/internal/help/MKL$_111$.txt +++ b/internal/help/MKL$_111$.txt @@ -1,5 +1,5 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:14:47}} +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:43:28}} The [[MKL$]] function encodes a [[LONG]] numerical value into a 4-byte [[ASCII]] [[STRING]] value. @@ -29,4 +29,3 @@ See examples in: {{PageNavigation}} - diff --git a/internal/help/MKS$_111$.txt b/internal/help/MKS$_111$.txt index 2e54d1015..182b38ed6 100644 --- a/internal/help/MKS$_111$.txt +++ b/internal/help/MKS$_111$.txt @@ -1,5 +1,5 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:14:48}} +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:43:29}} The [[MKS$]] function encodes a [[SINGLE]] numerical value into a 4-byte [[ASCII]] [[STRING]] value. @@ -21,4 +21,3 @@ The [[MKS$]] function encodes a [[SINGLE]] numerical value into a 4-byte [[ASCII {{PageNavigation}} - diff --git a/internal/help/MKSMBF$_111111$.txt b/internal/help/MKSMBF$_111111$.txt index 5b1208290..676808c25 100644 --- a/internal/help/MKSMBF$_111111$.txt +++ b/internal/help/MKSMBF$_111111$.txt @@ -1,5 +1,5 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:14:49}} +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:43:30}} The [[MKSMBF$]] function encodes a single-precision IEEE number to a string value in the Microsoft Binary format. @@ -18,4 +18,3 @@ The [[MKSMBF$]] function encodes a single-precision IEEE number to a string valu {{PageNavigation}} - diff --git a/internal/help/MOD_111.txt b/internal/help/MOD_111.txt index 1804c8da3..5b55315a7 100644 --- a/internal/help/MOD_111.txt +++ b/internal/help/MOD_111.txt @@ -1,5 +1,5 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:14:51}} +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:43:31}} The [[MOD]] operator gives the remainder after division of one number by another (sometimes called modulus). @@ -103,4 +103,3 @@ BASEN$ = BN$ {{PageNavigation}} - diff --git a/internal/help/Mathematical_Operations_100000000000_1000000000.txt b/internal/help/Mathematical_Operations_100000000000_1000000000.txt index 1943a0771..d7b61bc11 100644 --- a/internal/help/Mathematical_Operations_100000000000_1000000000.txt +++ b/internal/help/Mathematical_Operations_100000000000_1000000000.txt @@ -1,5 +1,5 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:07:22}} +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:36:05}} __NOEDITSECTION__ {|align="right" |__TOC__ @@ -139,7 +139,7 @@ Sometimes a calculation may need BASIC to do them in another order or the calcul | [[TAN]](angle*) || returns the tangent of an angle in radians |} -
'''* angles measured in radians'''
+
'''* angles measured in radians'''
{{TextStart}} '''Degree to Radian Conversion:''' @@ -309,7 +309,7 @@ The following logical operators compare numerical values using bitwise operation
'''Truth table of the 6 BASIC Logical Operators'''
-{{Template:LogicalTruthTable}} +{{LogicalTruthTable}}
BASIC can accept any + or - value that is not 0 to be True when used in an evaluation.
@@ -320,7 +320,7 @@ The following logical operators compare numerical values using bitwise operation Relational Operations are used to compare values in a Conditional [[IF...THEN]], [[SELECT CASE]], [[UNTIL]] or [[WHILE]] statement. -{{Template:RelationalTable}} +{{RelationalTable}}
[[#toc|Return to Top]]
@@ -515,4 +515,3 @@ Relational Operations are used to compare values in a Conditional [[IF...THEN]], * [[TYPE]] {{PageNavigation}} - diff --git a/internal/help/NAME_1111.txt b/internal/help/NAME_1111.txt index 515337bd1..c8edbbd89 100644 --- a/internal/help/NAME_1111.txt +++ b/internal/help/NAME_1111.txt @@ -1,5 +1,5 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:14:52}} +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:43:33}} The [[NAME]] statement changes the name of a file or directory to a new name. @@ -30,4 +30,3 @@ The [[NAME]] statement changes the name of a file or directory to a new name. {{PageNavigation}} - diff --git a/internal/help/NEXT_1111.txt b/internal/help/NEXT_1111.txt index 2fdc3ad96..df3a376a3 100644 --- a/internal/help/NEXT_1111.txt +++ b/internal/help/NEXT_1111.txt @@ -1,5 +1,5 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:14:53}} +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:43:34}} [[NEXT]] is used in a [[FOR...NEXT|FOR]] counter loop to progress through the loop count. @@ -41,4 +41,3 @@ PRINT "AFTER the LOOP, NEXT makes the value of i ="; i {{PageNavigation}} - diff --git a/internal/help/NOT_111.txt b/internal/help/NOT_111.txt index b13afa966..3a3ca78e8 100644 --- a/internal/help/NOT_111.txt +++ b/internal/help/NOT_111.txt @@ -1,5 +1,5 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:14:55}} +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:43:35}} [[NOT]] is a [[Boolean|boolean]] logical operator that will change a false statement to a true one and vice-versa. @@ -14,10 +14,10 @@ * Values are changed by their bit values so that each bit is changed to the opposite of on or off. See example 3 below. -{{Template:RelationalTable}} +{{RelationalTable}} -{{Template:LogicalTruthTable}} +{{LogicalTruthTable}} {{PageExamples}} @@ -82,4 +82,3 @@ b%% = {{Cl|&B}}11111010 {{PageNavigation}} - diff --git a/internal/help/Not_Equal_100_10000.txt b/internal/help/Not_Equal_100_10000.txt index beaeef3ff..b2d3c4ae3 100644 --- a/internal/help/Not_Equal_100_10000.txt +++ b/internal/help/Not_Equal_100_10000.txt @@ -1,5 +1,5 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:24:59}} +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:54:12}} The '''<>''' condition symbol denotes that a value must not equal another value for the condition to be True. @@ -19,4 +19,3 @@ The '''<>''' condition symbol denotes that a value must not equal another value {{PageNavigation}} - diff --git a/internal/help/OCT$_111$.txt b/internal/help/OCT$_111$.txt index 11f9936bf..18b4cbdb9 100644 --- a/internal/help/OCT$_111$.txt +++ b/internal/help/OCT$_111$.txt @@ -1,5 +1,5 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:14:56}} +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:43:36}} This function returns the octal (base 8) representation of any numeric value. @@ -16,11 +16,11 @@ This function returns the octal (base 8) representation of any numeric value. * The function returns the base 8 (octal) representation of the given {{Parameter|number}} as [[STRING]]. * Different from [[STR$]], this function does not return a leading sign placeholder space, so no [[LTRIM$]] to strip that space from positive numbers is necessary. * [[VAL]] can convert the returned oct string value back to a decimal value by prefixing the string with "[[&O]]". -** Eg. {{InlineCode}}decimal = VAL("&O" + octvalue$){{InlineCodeEnd}}. +** Eg. {{InlineCode}}decimal = {{Cl|VAL}}("&O" + octvalue$){{InlineCodeEnd}}. {{PageExamples}} -;Example 1: Comparing decimal, hexadecimal, octal and binary string values from 0 to 15. +;Example 1:Comparing decimal, hexadecimal, octal and binary string values from 0 to 15. {{CodeStart}} tabletop$ = " Decimal | Hexadecimal | Octal | Binary " tablesep$ = "---------+-------------+-------+--------" @@ -68,10 +68,11 @@ Converting Oct value to Decimal: 255 {{PageSeeAlso}} -* [[_BIN$]], [[HEX$]], [[STR$]], [[VAL]] -* [[&B]] {{text|(binary)}}, [[&H]] {{text|(hexadecimal)}}, [[&O]] {{text|(octal)}} +* [[_BIN$]], [[HEX$]], [[STR$]] +* [[&B]] (binary), [[&H]] (hexadecimal), [[&O]] (octal), [[VAL]] * [[Base Comparisons]] {{PageNavigation}} +[[Category:Final]] diff --git a/internal/help/OFF_111.txt b/internal/help/OFF_111.txt index f558ffa16..7cdecfcce 100644 --- a/internal/help/OFF_111.txt +++ b/internal/help/OFF_111.txt @@ -1,5 +1,5 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:14:57}} +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:43:37}} [[OFF]] is a flag that disables event-trappping for [[KEY(n)]], [[ON COM (n)|COM(n)]], [[PEN]], [[PLAY]], [[STRIG(n)]], [[TIMER]], [[UEVENT]]. @@ -14,4 +14,3 @@ {{PageNavigation}} - diff --git a/internal/help/ON...GOSUB_11...11111.txt b/internal/help/ON...GOSUB_11...11111.txt index 2073b58f6..67e43cbfa 100644 --- a/internal/help/ON...GOSUB_11...11111.txt +++ b/internal/help/ON...GOSUB_11...11111.txt @@ -1,5 +1,5 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:15:09}} +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:43:47}} [[ON...GOSUB]] is a control-flow statement that branches to a line or label in a list depending on a numerical expression. @@ -54,4 +54,3 @@ Also notice the RETURN statement that can be used with GOSUB! {{PageNavigation}} - diff --git a/internal/help/ON...GOTO_11...1111.txt b/internal/help/ON...GOTO_11...1111.txt index 75e4db8f1..f2269a0aa 100644 --- a/internal/help/ON...GOTO_11...1111.txt +++ b/internal/help/ON...GOTO_11...1111.txt @@ -1,5 +1,5 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:15:10}} +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:43:48}} [[ON...GOTO]] is a control-flow statement that branches to a line or label in a list depending on a numerical expression. @@ -49,4 +49,3 @@ And here we are... {{PageNavigation}} - diff --git a/internal/help/ON_ERROR_11_11111.txt b/internal/help/ON_ERROR_11_11111.txt index 81bc47d86..d4cef0ddc 100644 --- a/internal/help/ON_ERROR_11_11111.txt +++ b/internal/help/ON_ERROR_11_11111.txt @@ -1,5 +1,5 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:15:00}} +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:43:39}} [[ON ERROR]] is used with [[GOTO]] to handle errors in a program. @@ -70,4 +70,3 @@ hand: {{PageNavigation}} - diff --git a/internal/help/ON_KEY(n)_11_111(0).txt b/internal/help/ON_KEY(n)_11_111(0).txt index 188b29da9..6b1e2b404 100644 --- a/internal/help/ON_KEY(n)_11_111(0).txt +++ b/internal/help/ON_KEY(n)_11_111(0).txt @@ -1,5 +1,5 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:15:01}} +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:43:41}} The [[ON KEY(n)]] statement defines a line number or label to go to (or a [[SUB]] to run) when a specified key is pressed. @@ -62,4 +62,3 @@ trap: {{PageNavigation}} - diff --git a/internal/help/ON_STRIG(n)_11_11111(0).txt b/internal/help/ON_STRIG(n)_11_11111(0).txt index 0811c3edc..8322de60b 100644 --- a/internal/help/ON_STRIG(n)_11_11111(0).txt +++ b/internal/help/ON_STRIG(n)_11_11111(0).txt @@ -1,5 +1,5 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:15:05}} +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:43:44}} The [[ON STRIG(n)]] statement is an event procedure that directs program flow upon the press of a specified joystick button. @@ -73,4 +73,3 @@ a$ = "[STRIG 0 EVENT]" {{PageNavigation}} - diff --git a/internal/help/ON_TIMER(n)_11_11111(0).txt b/internal/help/ON_TIMER(n)_11_11111(0).txt index fb2a58822..821e45fe4 100644 --- a/internal/help/ON_TIMER(n)_11_11111(0).txt +++ b/internal/help/ON_TIMER(n)_11_11111(0).txt @@ -1,5 +1,5 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:15:06}} +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:43:45}} The [[ON_TIMER(n)|ON TIMER]] statement sets up a timed event to be repeated at specified intervals throughout a program when enabled. @@ -79,4 +79,3 @@ DO {{PageNavigation}} - diff --git a/internal/help/OPEN_1111.txt b/internal/help/OPEN_1111.txt index 31773d3f1..796d8ab96 100644 --- a/internal/help/OPEN_1111.txt +++ b/internal/help/OPEN_1111.txt @@ -1,5 +1,5 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:15:11}} +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:43:50}} The [[OPEN]] statement is used to open a file or [[OPEN_COM|COM]] serial communications port for program input or output. @@ -161,4 +161,3 @@ It was overwritten with this and deleted. {{PageNavigation}} - diff --git a/internal/help/OPEN_COM_1111_111.txt b/internal/help/OPEN_COM_1111_111.txt index aa336a11d..de1cc0dcd 100644 --- a/internal/help/OPEN_COM_1111_111.txt +++ b/internal/help/OPEN_COM_1111_111.txt @@ -1,5 +1,5 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:15:13}} +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:43:51}} The [[OPEN COM]] statement is used to access a computer's serial port COM. @@ -129,4 +129,3 @@ Start# = {{Cl|TIMER}} {{PageNavigation}} - diff --git a/internal/help/OPTION_BASE_111111_1111.txt b/internal/help/OPTION_BASE_111111_1111.txt index 4d72d4f1b..34f616e02 100644 --- a/internal/help/OPTION_BASE_111111_1111.txt +++ b/internal/help/OPTION_BASE_111111_1111.txt @@ -1,5 +1,5 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:15:14}} +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:43:52}} The [[OPTION BASE]] statement is used to set the default lower bound of arrays. @@ -50,4 +50,3 @@ The [[OPTION BASE]] statement is used to set the default lower bound of arrays. {{PageNavigation}} - diff --git a/internal/help/OPTION__EXPLICITARRAY_111111__1111111111111.txt b/internal/help/OPTION__EXPLICITARRAY_111111__1111111111111.txt index 2285a27ee..236ee3acd 100644 --- a/internal/help/OPTION__EXPLICITARRAY_111111__1111111111111.txt +++ b/internal/help/OPTION__EXPLICITARRAY_111111__1111111111111.txt @@ -1,5 +1,5 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:09:48}} +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:39:11}} {{DISPLAYTITLE:OPTION _EXPLICITARRAY}} [[OPTION _EXPLICITARRAY]] instructs the compiler to require arrays be declared with [[DIM]], [[REDIM]] or equivalent. @@ -39,4 +39,3 @@ y(2) = 3 'This now generates an error {{PageNavigation}} - diff --git a/internal/help/OPTION__EXPLICIT_111111__11111111.txt b/internal/help/OPTION__EXPLICIT_111111__11111111.txt index d0de7e582..506697bbf 100644 --- a/internal/help/OPTION__EXPLICIT_111111__11111111.txt +++ b/internal/help/OPTION__EXPLICIT_111111__11111111.txt @@ -1,5 +1,5 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:09:47}} +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:39:10}} {{DISPLAYTITLE:OPTION _EXPLICIT}} [[OPTION _EXPLICIT]] instructs the compiler to require variable declaration with [[DIM]], [[REDIM]] or an equivalent statement. @@ -41,4 +41,3 @@ myVariable = 5 {{PageNavigation}} - diff --git a/internal/help/OR_(boolean)_11_(0000000).txt b/internal/help/OR_(boolean)_11_(0000000).txt index 7a85ecf0a..7aba8c3a2 100644 --- a/internal/help/OR_(boolean)_11_(0000000).txt +++ b/internal/help/OR_(boolean)_11_(0000000).txt @@ -1,5 +1,5 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:15:20}} +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:43:55}} The '''OR''' conditional operator evaluates an expression to true (-1) if any of the arguments is also true. @@ -13,7 +13,7 @@ The '''OR''' conditional operator evaluates an expression to true (-1) if any of * Not to be confused with the [[AND]] and [[OR]] numerical operations. -{{Template:RelationalTable}} +{{RelationalTable}} {{PageExamples}} @@ -37,4 +37,3 @@ True {{PageNavigation}} - diff --git a/internal/help/OR_11.txt b/internal/help/OR_11.txt index 0b5969503..526bd7c5a 100644 --- a/internal/help/OR_11.txt +++ b/internal/help/OR_11.txt @@ -1,5 +1,5 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:15:15}} +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:43:53}} The [[OR]] numerical operator returns a comparative bit value of 1 if either value's bit is on. @@ -14,7 +14,7 @@ The [[OR]] numerical operator returns a comparative bit value of 1 if either val * [[OR]] never turns off a bit and can be used only to turn a bit on. -{{Template:LogicalTruthTable}} +{{LogicalTruthTable}} {{PageExamples}} @@ -47,4 +47,3 @@ The [[OR]] numerical operator returns a comparative bit value of 1 if either val {{PageNavigation}} - diff --git a/internal/help/OUTPUT_111111.txt b/internal/help/OUTPUT_111111.txt index 64a00bcea..747c3385f 100644 --- a/internal/help/OUTPUT_111111.txt +++ b/internal/help/OUTPUT_111111.txt @@ -1,5 +1,5 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:15:26}} +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:43:57}} The [[OPEN]] statement is used to open a file or [[OPEN_COM|COM]] serial communications port for program input or output. @@ -161,4 +161,3 @@ It was overwritten with this and deleted. {{PageNavigation}} - diff --git a/internal/help/OUT_111.txt b/internal/help/OUT_111.txt index ea8a5ff6f..6901063ef 100644 --- a/internal/help/OUT_111.txt +++ b/internal/help/OUT_111.txt @@ -1,5 +1,5 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:15:21}} +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:43:56}} [[OUT]] writes values to register and port hardware addresses. @@ -101,4 +101,3 @@ PRINT red%, green%, blue% {{PageNavigation}} - diff --git a/internal/help/PAINT_11111.txt b/internal/help/PAINT_11111.txt index 3445053a3..527269e53 100644 --- a/internal/help/PAINT_11111.txt +++ b/internal/help/PAINT_11111.txt @@ -1,5 +1,5 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:15:28}} +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:43:58}} The [[PAINT]] statement is used to fill a delimited area in a graphic screen mode with color. @@ -146,4 +146,3 @@ ptndata: {{PageNavigation}} - diff --git a/internal/help/PALETTE_1111111.txt b/internal/help/PALETTE_1111111.txt index f91ba2111..5d4a2dfe9 100644 --- a/internal/help/PALETTE_1111111.txt +++ b/internal/help/PALETTE_1111111.txt @@ -1,5 +1,5 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:15:29}} +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:43:59}} The [[PALETTE]] statement can swap color settings, set colors to default or set the red, green and blue color components of palette colors. @@ -45,4 +45,3 @@ The [[PALETTE]] statement can swap color settings, set colors to default or set {{PageNavigation}} - diff --git a/internal/help/PALETTE_USING_1111111_11111.txt b/internal/help/PALETTE_USING_1111111_11111.txt index c09f01ef9..2c88e52f1 100644 --- a/internal/help/PALETTE_USING_1111111_11111.txt +++ b/internal/help/PALETTE_USING_1111111_11111.txt @@ -1,5 +1,5 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:15:30}} +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:44:00}} The [[PALETTE USING]] statement sets all RGB screen color intensities using values from an [[Arrays|array]]. @@ -34,4 +34,3 @@ The [[PALETTE USING]] statement sets all RGB screen color intensities using valu {{PageNavigation}} - diff --git a/internal/help/PCOPY_11111.txt b/internal/help/PCOPY_11111.txt index a9c8e0e33..2d4d5c9c2 100644 --- a/internal/help/PCOPY_11111.txt +++ b/internal/help/PCOPY_11111.txt @@ -1,5 +1,5 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:15:32}} +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:44:02}} The [[PCOPY]] statement copies one source screen page to a destination page in memory. @@ -82,4 +82,3 @@ SetupCursor {{PageNavigation}} - diff --git a/internal/help/PEEK_1111.txt b/internal/help/PEEK_1111.txt index 144d0bd9d..b3133a7c1 100644 --- a/internal/help/PEEK_1111.txt +++ b/internal/help/PEEK_1111.txt @@ -1,5 +1,5 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:15:33}} +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:44:03}} The '''PEEK''' function returns the value that is contained at a certain memory address offset. '''QB64 currently has limited access!''' @@ -66,4 +66,3 @@ The '''PEEK''' function returns the value that is contained at a certain memory {{PageNavigation}} - diff --git a/internal/help/PLAY_1111.txt b/internal/help/PLAY_1111.txt index afae27d64..30a6dea66 100644 --- a/internal/help/PLAY_1111.txt +++ b/internal/help/PLAY_1111.txt @@ -1,5 +1,5 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:15:38}} +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:44:07}} '''PLAY''' is a statement that plays notes of sound through the sound card in QB64 using a command [[STRING]]. @@ -334,4 +334,3 @@ x$ = x$ + " f1 ,mn>f.d8dc l1 ml f, c, {{PageNavigation}} - diff --git a/internal/help/PMAP_1111.txt b/internal/help/PMAP_1111.txt index c1623e6ed..80a733295 100644 --- a/internal/help/PMAP_1111.txt +++ b/internal/help/PMAP_1111.txt @@ -1,5 +1,5 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:15:39}} +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:44:09}} The '''PMAP''' statement returns the physical or [[WINDOW]] view port coordinates. @@ -63,4 +63,3 @@ Y = {{Cl|PMAP}}(479, 3) ' Y = 200 {{PageNavigation}} - diff --git a/internal/help/POINT_11111.txt b/internal/help/POINT_11111.txt index 86d4dbbdd..d0ac9a618 100644 --- a/internal/help/POINT_11111.txt +++ b/internal/help/POINT_11111.txt @@ -1,5 +1,5 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:15:41}} +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:44:10}} The '''POINT''' function returns the pixel [[COLOR]] attribute at a specified graphics coordinate or the current graphic cursor position. @@ -153,4 +153,3 @@ BG$ = {{Cl|UCASE$}}({{Cl|INPUT$}}(1)) {{PageNavigation}} - diff --git a/internal/help/POKE_1111.txt b/internal/help/POKE_1111.txt index d9fc4127a..36208a6e3 100644 --- a/internal/help/POKE_1111.txt +++ b/internal/help/POKE_1111.txt @@ -1,5 +1,5 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:15:42}} +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:44:11}} The '''POKE''' statement sets the value of a specified memory address offset. '''QB64 currently has limited access!''' @@ -105,4 +105,3 @@ addr& = (x1 - 1 + (y - 1) * {{Cl|_WIDTH (function)|_WIDTH}}) * 2 + 1 {{PageNavigation}} - diff --git a/internal/help/POS_111.txt b/internal/help/POS_111.txt index 6c5ec7e09..cb6fab1f4 100644 --- a/internal/help/POS_111.txt +++ b/internal/help/POS_111.txt @@ -1,5 +1,5 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:15:43}} +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:44:12}} The '''POS''' function returns the current print cursor text column position. @@ -35,4 +35,3 @@ The '''POS''' function returns the current print cursor text column position. {{PageNavigation}} - diff --git a/internal/help/PRESET_111111.txt b/internal/help/PRESET_111111.txt index 6ef7f6ac3..e6ea8bc40 100644 --- a/internal/help/PRESET_111111.txt +++ b/internal/help/PRESET_111111.txt @@ -1,5 +1,5 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:15:45}} +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:44:13}} The '''PRESET''' graphic [[SCREEN]] statement turns a pixel at a coordinate to the background color or a designated color attribute. @@ -142,4 +142,3 @@ c% = 1 {{PageNavigation}} - diff --git a/internal/help/PRINT_(file_statement)_11111_(0000_000000000).txt b/internal/help/PRINT_(file_statement)_11111_(0000_000000000).txt index 1a11481a8..0d1519fa0 100644 --- a/internal/help/PRINT_(file_statement)_11111_(0000_000000000).txt +++ b/internal/help/PRINT_(file_statement)_11111_(0000_000000000).txt @@ -1,5 +1,5 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:15:48}} +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:44:16}} The [[PRINT (file statement)|PRINT #]] statement prints numeric or string expressions to a sequential file, IO port or device. @@ -76,4 +76,3 @@ K$ = {{Cl|INPUT$}}(1) 'press a key {{PageNavigation}} - diff --git a/internal/help/PRINT_11111.txt b/internal/help/PRINT_11111.txt index d23826c2f..c0dd3022c 100644 --- a/internal/help/PRINT_11111.txt +++ b/internal/help/PRINT_11111.txt @@ -1,5 +1,5 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:15:46}} +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:44:15}} The {{KW|PRINT}} statement prints numeric or string expressions to the program screen. Typing shortcut '''?''' will convert to PRINT. @@ -87,4 +87,3 @@ Hello city! {{PageNavigation}} - diff --git a/internal/help/PRINT_USING_(file_statement)_11111_11111_(0000_000000000).txt b/internal/help/PRINT_USING_(file_statement)_11111_11111_(0000_000000000).txt index 2611df5c8..cb28a87d8 100644 --- a/internal/help/PRINT_USING_(file_statement)_11111_11111_(0000_000000000).txt +++ b/internal/help/PRINT_USING_(file_statement)_11111_11111_(0000_000000000).txt @@ -1,5 +1,5 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:15:51}} +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:44:18}} The '''PRINT #, USING''' statement is used to [[PRINT]] formatted text data to a file. @@ -26,7 +26,7 @@ The '''PRINT #, USING''' statement is used to [[PRINT]] formatted text data to a * '''WARNING: The numbers displayed are rounded so the actual values are never changed and are actually more accurate.''' -{{PrintUsing}} +{{PrintUsingTable}} ''See also:'' @@ -35,4 +35,3 @@ The '''PRINT #, USING''' statement is used to [[PRINT]] formatted text data to a {{PageNavigation}} - diff --git a/internal/help/PRINT_USING_11111_11111.txt b/internal/help/PRINT_USING_11111_11111.txt index 2c7633805..6f56dec25 100644 --- a/internal/help/PRINT_USING_11111_11111.txt +++ b/internal/help/PRINT_USING_11111_11111.txt @@ -1,6 +1,6 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:15:49}} -The '''PRINT USING''' statement is used to [[PRINT]] formatted data to the Screen or a file using a [[STRING]] template. +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:44:17}} +The '''PRINT USING''' statement is used to [[PRINT]] formatted data to the Screen using a [[STRING]] template. {{PageSyntax}} @@ -24,7 +24,7 @@ The '''PRINT USING''' statement is used to [[PRINT]] formatted data to the Scree * '''WARNING: The numbers displayed are rounded so the actual values are never changed and are actually more accurate.''' -{{PrintUsing}} +{{PrintUsingTable}} ''Example 1:'' Printing formatted data using a predefined [[STRING|string]] template variable. @@ -85,4 +85,3 @@ tmp$ = "$$#######,.##" {{PageNavigation}} - diff --git a/internal/help/PSET_1111.txt b/internal/help/PSET_1111.txt index 621119871..2f15bb63c 100644 --- a/internal/help/PSET_1111.txt +++ b/internal/help/PSET_1111.txt @@ -1,5 +1,5 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:15:52}} +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:44:19}} The '''PSET''' grahics [[SCREEN (statement)|SCREEN]] statement sets a pixel to a coordinate with a default or designated color attribute. @@ -159,4 +159,3 @@ y={{Cl|_MOUSEY}} {{PageNavigation}} - diff --git a/internal/help/PUT_(TCP%2FIP_statement)_111_(111%2111_000000000).txt b/internal/help/PUT_(TCP%2FIP_statement)_111_(111%2111_000000000).txt index 60e90cb63..7d5598e50 100644 --- a/internal/help/PUT_(TCP%2FIP_statement)_111_(111%2111_000000000).txt +++ b/internal/help/PUT_(TCP%2FIP_statement)_111_(111%2111_000000000).txt @@ -1,5 +1,5 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:15:55}} +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:44:22}} The '''PUT #''' TCP/IP statement sends unformatted(raw) data to an open connection using a user's handle. @@ -38,4 +38,3 @@ The '''PUT #''' TCP/IP statement sends unformatted(raw) data to an open connect {{PageNavigation}} - diff --git a/internal/help/PUT_(graphics_statement)_111_(00000000_000000000).txt b/internal/help/PUT_(graphics_statement)_111_(00000000_000000000).txt index 9e6bebf80..2441ceba1 100644 --- a/internal/help/PUT_(graphics_statement)_111_(00000000_000000000).txt +++ b/internal/help/PUT_(graphics_statement)_111_(00000000_000000000).txt @@ -1,5 +1,5 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:15:57}} +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:44:23}} The '''PUT''' graphics statement is used to place [[GET (graphics statement)|GET]] or [[BSAVE]] file images stored in the designated array. @@ -90,4 +90,3 @@ K$ = {{Cl|INPUT$}}(1) {{PageNavigation}} - diff --git a/internal/help/PUT_111.txt b/internal/help/PUT_111.txt index 51a50bdba..ca71e9e85 100644 --- a/internal/help/PUT_111.txt +++ b/internal/help/PUT_111.txt @@ -1,5 +1,5 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:15:54}} +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:44:21}} The '''PUT #''' file or port statement writes data to a specific byte or record location. @@ -91,4 +91,3 @@ showme 'display array after transfer from file {{PageNavigation}} - diff --git a/internal/help/Parenthesis_10000000000.txt b/internal/help/Parenthesis_10000000000.txt index 003d5d78b..fba0384f1 100644 --- a/internal/help/Parenthesis_10000000000.txt +++ b/internal/help/Parenthesis_10000000000.txt @@ -1,5 +1,5 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:24:44}} +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:53:59}} '''Parenthesis''' are used to enclose [[SUB]] and [[FUNCTION]] parameters or to set the operation order in [[Mathematical Operations]]. @@ -34,4 +34,3 @@ nmb$ = {{Cl|LTRIM$}}((({{Cl|RTRIM$}}(nmb$)))) 'extra bracket pairs do not affec {{PageNavigation}} - diff --git a/internal/help/QB64_FAQ_1164_111.txt b/internal/help/QB64_FAQ_1164_111.txt index 8ab074d54..884c71105 100644 --- a/internal/help/QB64_FAQ_1164_111.txt +++ b/internal/help/QB64_FAQ_1164_111.txt @@ -1,5 +1,5 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:06:13}} +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:35:54}} __NOEDITSECTION__ {| align="center" |__TOC__ @@ -300,4 +300,3 @@ Look in the QB64 '''internal\temp''' folder for '''main.txt''' to get the C code {{PageNavigation}} - diff --git a/internal/help/QB64_Help_Menu_1164_1000_1000.txt b/internal/help/QB64_Help_Menu_1164_1000_1000.txt index 492412f67..cbfa08169 100644 --- a/internal/help/QB64_Help_Menu_1164_1000_1000.txt +++ b/internal/help/QB64_Help_Menu_1164_1000_1000.txt @@ -1,15 +1,16 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:06:14}} -__NOEDITSECTION__ -This is QB64's built-in help system. It's data is based on the QB64 Wiki. In fact, the pages in this build-in help are downloaded copies of the online Wiki and are displayed here in a '''simplified''' form. It should be obvious, that we can't reproduce the detailed output of a full fledged web browser here, especially tables are a bit too complex to handle it here. However, you can click the cyan colored '''View on Wiki''' button at any time to open the original online Wiki page in your standard browser. +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:35:55}} +This is QB64's built-in help system. It's data is based on the QB64 Wiki. In fact, the pages shown here are cached copies of the online Wiki pages and are displayed here in a '''simplified''' form. Obviously we can't reproduce the detailed output of a full fledged web browser here, especially tables are too complex to handle it here. However, you can click the cyan colored '''View on Wiki''' button at any time to open the original online Wiki page in your standard browser. -;Note:As the QB64 Wiki is a vital resource maintained by our community, it might be a good idea to periodically use the '''Update All Pages...''' command from the '''Help''' menu to fetch the latest changes done in the online Wiki. +== Help Topics == * [[Keyword Reference - Alphabetical]] * [[Keyword Reference - By usage]] * [[QB64 FAQ|Frequently asked questions about QB64]] +;Note:As the QB64 Wiki is a vital resource maintained by our community, it might be a good idea to periodically use the '''Update All Pages...''' command from the '''Help''' menu to fetch the latest changes done in the online Wiki. + +== Community Links == * [https://qb64phoenix.com/forum/index.php QB64 Phoenix Edition Forum] -* [https://qb64phoenix.com/qb64wiki/index.php QB64 Phoenix Edition Wiki] '''(source of this help)''' -* [https://discord.gg/D2M7hepTSx QB64 Discord invitation] - +* [https://qb64phoenix.com/qb64wiki/index.php QB64 Phoenix Edition Wiki] '''(the source of this help)''' +* [https://discord.gg/D2M7hepTSx QB64 Phoenix Edition Discord] diff --git a/internal/help/Question_mark_10000000_0000.txt b/internal/help/Question_mark_10000000_0000.txt index 861035a73..12474d7f4 100644 --- a/internal/help/Question_mark_10000000_0000.txt +++ b/internal/help/Question_mark_10000000_0000.txt @@ -1,5 +1,5 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:24:39}} +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:53:54}} A '''question mark''' can be used as a substitute shortcut to typing PRINT when creating code. @@ -22,4 +22,3 @@ A '''question mark''' can be used as a substitute shortcut to typing PRINT when {{PageNavigation}} - diff --git a/internal/help/Quotation_mark_100000000_0000.txt b/internal/help/Quotation_mark_100000000_0000.txt index 84d172eb8..bb7a893dd 100644 --- a/internal/help/Quotation_mark_100000000_0000.txt +++ b/internal/help/Quotation_mark_100000000_0000.txt @@ -1,5 +1,5 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:24:38}} +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:53:53}} A '''quotation mark''' delimits the start and end of a literal [[STRING]] value. @@ -24,4 +24,3 @@ A '''quotation mark''' delimits the start and end of a literal [[STRING]] value. {{PageNavigation}} - diff --git a/internal/help/RANDOMIZE_111111111.txt b/internal/help/RANDOMIZE_111111111.txt index 54f447dbc..d2844238a 100644 --- a/internal/help/RANDOMIZE_111111111.txt +++ b/internal/help/RANDOMIZE_111111111.txt @@ -1,5 +1,5 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:16:01}} +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:44:25}} '''RANDOMIZE''' is used with a seed value to generate different random number sequences using the [[RND]] function. @@ -104,4 +104,3 @@ DO {{PageNavigation}} - diff --git a/internal/help/RANDOM_111111.txt b/internal/help/RANDOM_111111.txt index 32cc6c493..d72af1001 100644 --- a/internal/help/RANDOM_111111.txt +++ b/internal/help/RANDOM_111111.txt @@ -1,5 +1,5 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:15:58}} +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:44:24}} '''RANDOM''' is used in an [[OPEN]] statement to read([[GET]]) from or write([[PUT]]) to a file. @@ -105,4 +105,3 @@ ABCDEFGHI 9 {{PageNavigation}} - diff --git a/internal/help/READ_1111.txt b/internal/help/READ_1111.txt index 9aeb45963..5ed8af288 100644 --- a/internal/help/READ_1111.txt +++ b/internal/help/READ_1111.txt @@ -1,5 +1,5 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:16:02}} +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:44:27}} The '''READ''' statement reads values from a [[DATA]] field and assigns them to one or a comma separated list of variables. @@ -67,4 +67,3 @@ The '''READ''' statement reads values from a [[DATA]] field and assigns them to {{PageNavigation}} - diff --git a/internal/help/REDIM_11111.txt b/internal/help/REDIM_11111.txt index e69381e7e..a5d934f2a 100644 --- a/internal/help/REDIM_11111.txt +++ b/internal/help/REDIM_11111.txt @@ -1,5 +1,5 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:16:04}} +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:44:29}} A {{KW|REDIM}} statement can re-dimension one [[$DYNAMIC|dynamic]](flexible) [[Arrays|array]] or a [[comma]] separated list of arrays. @@ -66,4 +66,3 @@ array(10) = 24 {{PageNavigation}} - diff --git a/internal/help/REM_111.txt b/internal/help/REM_111.txt index 53011276f..5bd150615 100644 --- a/internal/help/REM_111.txt +++ b/internal/help/REM_111.txt @@ -1,5 +1,5 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:16:05}} +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:44:30}} '''REM''' or an apostrophe is used for programmer remarks, comments or to stop the execution of program code. @@ -30,4 +30,3 @@ {{PageNavigation}} - diff --git a/internal/help/RESET_11111.txt b/internal/help/RESET_11111.txt index 10a2c76ac..4bebc10b7 100644 --- a/internal/help/RESET_11111.txt +++ b/internal/help/RESET_11111.txt @@ -1,5 +1,5 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:16:06}} +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:44:32}} The '''RESET''' statement closes all files and writes the directory information to a diskette before it is removed from a disk drive. @@ -17,4 +17,3 @@ The '''RESET''' statement closes all files and writes the directory information {{PageNavigation}} - diff --git a/internal/help/RESTORE_1111111.txt b/internal/help/RESTORE_1111111.txt index caa06ba2c..c2d4f2384 100644 --- a/internal/help/RESTORE_1111111.txt +++ b/internal/help/RESTORE_1111111.txt @@ -1,5 +1,5 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:16:08}} +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:44:33}} The '''RESTORE''' statement is used to reset the DATA pointer to the beginning of the data. @@ -89,4 +89,3 @@ entry3 {{PageNavigation}} - diff --git a/internal/help/RESUME_111111.txt b/internal/help/RESUME_111111.txt index 4e16a1f1a..fbcb961c5 100644 --- a/internal/help/RESUME_111111.txt +++ b/internal/help/RESUME_111111.txt @@ -1,5 +1,5 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:16:09}} +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:44:34}} The '''RESUME''' statement is used with '''NEXT''' or a line number or label in an error handling routine. @@ -21,4 +21,3 @@ The '''RESUME''' statement is used with '''NEXT''' or a line number or label in {{PageNavigation}} - diff --git a/internal/help/RETURN_111111.txt b/internal/help/RETURN_111111.txt index 3b1abe6f2..7e932ee25 100644 --- a/internal/help/RETURN_111111.txt +++ b/internal/help/RETURN_111111.txt @@ -1,5 +1,5 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:16:10}} +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:44:35}} '''RETURN''' is used in [[GOSUB]] procedures to return to the original call code line or a specified line label. @@ -73,4 +73,3 @@ it went here. {{PageNavigation}} - diff --git a/internal/help/RIGHT$_11111$.txt b/internal/help/RIGHT$_11111$.txt index 33d166627..c16d0e8de 100644 --- a/internal/help/RIGHT$_11111$.txt +++ b/internal/help/RIGHT$_11111$.txt @@ -1,5 +1,5 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:16:11}} +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:44:36}} The '''RIGHT$''' function returns a set number of characters in a [[STRING]] variable starting from the end and counting backwards. @@ -59,4 +59,3 @@ hexadecimal$ = "{{Cl|&H}}FF" + {{Cl|RIGHT$}}("0" + {{Cl|HEX$}}(R), 2) + {{Cl|RIG {{PageNavigation}} - diff --git a/internal/help/RMDIR_11111.txt b/internal/help/RMDIR_11111.txt index 29df2d5de..42ff66181 100644 --- a/internal/help/RMDIR_11111.txt +++ b/internal/help/RMDIR_11111.txt @@ -1,5 +1,5 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:16:13}} +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:44:37}} The {{KW|RMDIR}} statement deletes an empty directory using a designated path relative to the present path location. @@ -63,4 +63,3 @@ C:\temp is not empty! {{PageNavigation}} - diff --git a/internal/help/RND_111.txt b/internal/help/RND_111.txt index 3359dad30..1595b8f94 100644 --- a/internal/help/RND_111.txt +++ b/internal/help/RND_111.txt @@ -1,5 +1,5 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:16:14}} +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:44:38}} The '''RND''' function returns a random number with a value between 0 (inclusive) and 1 (exclusive). @@ -108,4 +108,3 @@ DO {{PageNavigation}} - diff --git a/internal/help/RSET_1111.txt b/internal/help/RSET_1111.txt index c2c43ff74..9622ee282 100644 --- a/internal/help/RSET_1111.txt +++ b/internal/help/RSET_1111.txt @@ -1,5 +1,5 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:16:15}} +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:44:40}} The '''RSET''' statement right-justifies a string according to length of the string expression. @@ -43,4 +43,3 @@ Over ten c {{PageNavigation}} - diff --git a/internal/help/RTRIM$_11111$.txt b/internal/help/RTRIM$_11111$.txt index 947ecb95b..029901836 100644 --- a/internal/help/RTRIM$_11111$.txt +++ b/internal/help/RTRIM$_11111$.txt @@ -1,5 +1,5 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:16:17}} +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:44:41}} The {{KW|RTRIM$}} function removes trailing space characters from a {{KW|STRING}} value. @@ -38,4 +38,3 @@ Tommy {{PageNavigation}} - diff --git a/internal/help/RUN_111.txt b/internal/help/RUN_111.txt index 86fa2953f..c26e140a2 100644 --- a/internal/help/RUN_111.txt +++ b/internal/help/RUN_111.txt @@ -1,5 +1,5 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:16:18}} +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:44:42}} '''RUN''' is a control flow statement that clears and restarts the program currently in memory or executes another specified program. The multi-modular technique goes back to when QBasic and QuickBASIC had module size constraints. In QB64 it has been implemented so that that older code can still be compiled, though '''it is advisable to use single modules for a single project (not counting [[$INCLUDE]] libraries), for ease of sharing and also because the module size constraints no longer exist.''' @@ -62,4 +62,3 @@ Do you want to quit?(Y/N)_ {{PageNavigation}} - diff --git a/internal/help/SADD_1111.txt b/internal/help/SADD_1111.txt index 44b38bf38..212f6ee42 100644 --- a/internal/help/SADD_1111.txt +++ b/internal/help/SADD_1111.txt @@ -1,5 +1,5 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:16:19}} +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:44:43}} The '''SADD''' function returns the address of a [[STRING]] variable as an offset from the current data segment. @@ -17,4 +17,3 @@ The '''SADD''' function returns the address of a [[STRING]] variable as an offse {{PageNavigation}} - diff --git a/internal/help/SCREEN_(function)_111111_(00000000).txt b/internal/help/SCREEN_(function)_111111_(00000000).txt index 290bfd724..534041720 100644 --- a/internal/help/SCREEN_(function)_111111_(00000000).txt +++ b/internal/help/SCREEN_(function)_111111_(00000000).txt @@ -1,5 +1,5 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:16:20}} +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:44:44}} The '''SCREEN''' function returns the [[ASCII]] code of a text character or the color attribute at a set text location on the screen. @@ -91,4 +91,3 @@ a$ = {{Cl|RTRIM$}}(a$) {{PageNavigation}} - diff --git a/internal/help/SCREEN_111111.txt b/internal/help/SCREEN_111111.txt index 57bce443b..4b826ea18 100644 --- a/internal/help/SCREEN_111111.txt +++ b/internal/help/SCREEN_111111.txt @@ -1,5 +1,5 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:16:22}} +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:44:45}} {| align="Right" | __TOC__ |} @@ -8,7 +8,7 @@ The [[SCREEN]] statement sets the video display mode and size of the program win {{PageSyntax}} -::: '''SCREEN''' {''mode%''|''imagehandle&''} [, , active_page, visual_page] +: [[SCREEN]] {''mode%''|''imagehandle&''} [, , active_page, visual_page] {{Parameters}} @@ -43,14 +43,13 @@ The [[SCREEN]] statement sets the video display mode and size of the program win '''QB64 allows video paging and [[PCOPY]] in ALL screen modes!''' {{WhiteEnd}} -:::::::::'''QB64 Custom Screen Modes''' -:'''QB64''' {{PageSyntax}}   +==QB64 Custom Screen Modes== -::::::[[SCREEN]] ''imagehandle&'' [, , ''active_page'', ''visual_page''] +: [[SCREEN]] ''imagehandle&'' [, , ''active_page'', ''visual_page''] -::::::[[SCREEN]] [[_NEWIMAGE]](''wide&'', ''high&''[, {''mode''|''256''|''32''}]) [, , ''active_page'', ''visual_page''] +: [[SCREEN]] [[_NEWIMAGE]](''wide&'', ''high&''[, {''mode''|''256''|''32''}]) [, , ''active_page'', ''visual_page''] -::::::[[SCREEN]] [[_LOADIMAGE]](''file$''[, {''mode''|''256''|''32''}]) [, , ''active_page'', ''visual_page''] +: [[SCREEN]] [[_LOADIMAGE]](''file$''[, {''mode''|''256''|''32''}]) [, , ''active_page'', ''visual_page''] * Custom screen modes can be created using a [[_NEWIMAGE]] or [[_LOADIMAGE]] function ''imagehandle'' return value. @@ -193,4 +192,3 @@ This is SCREEN 0 - only text is allowed! {{PageNavigation}} - diff --git a/internal/help/SEEK_(statement)_1111_(000000000).txt b/internal/help/SEEK_(statement)_1111_(000000000).txt index 54b57f0ba..e1c805a5f 100644 --- a/internal/help/SEEK_(statement)_1111_(000000000).txt +++ b/internal/help/SEEK_(statement)_1111_(000000000).txt @@ -1,5 +1,5 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:16:24}} +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:44:48}} The '''SEEK''' statement sets the next byte or record position of a file for a read or write. @@ -31,4 +31,3 @@ The '''SEEK''' statement sets the next byte or record position of a file for a r {{PageNavigation}} - diff --git a/internal/help/SEEK_1111.txt b/internal/help/SEEK_1111.txt index db16a9f22..dabf3ecbc 100644 --- a/internal/help/SEEK_1111.txt +++ b/internal/help/SEEK_1111.txt @@ -1,5 +1,5 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:16:23}} +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:44:47}} The '''SEEK''' function returns the current byte or record position in a file. @@ -21,4 +21,3 @@ The '''SEEK''' function returns the current byte or record position in a file. {{PageNavigation}} - diff --git a/internal/help/SELECT_CASE_111111_1111.txt b/internal/help/SELECT_CASE_111111_1111.txt index 116a210d0..454995cd4 100644 --- a/internal/help/SELECT_CASE_111111_1111.txt +++ b/internal/help/SELECT_CASE_111111_1111.txt @@ -1,5 +1,5 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:16:26}} +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:44:49}} [[SELECT CASE]] is used to determine the program flow by comparing the value of a variable to specific CASE values. @@ -169,4 +169,3 @@ DO {{PageNavigation}} - diff --git a/internal/help/SGN_111.txt b/internal/help/SGN_111.txt index 370216529..f7955fedd 100644 --- a/internal/help/SGN_111.txt +++ b/internal/help/SGN_111.txt @@ -1,5 +1,5 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:16:28}} +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:44:50}} The '''SGN''' function returns the sign of a number value. @@ -32,4 +32,3 @@ PRINT n {{PageNavigation}} - diff --git a/internal/help/SHARED_111111.txt b/internal/help/SHARED_111111.txt index f71cd1274..193938a92 100644 --- a/internal/help/SHARED_111111.txt +++ b/internal/help/SHARED_111111.txt @@ -1,5 +1,5 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:16:29}} +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:44:51}} The '''SHARED''' statement allows variables to be passed automatically to any [[SUB]] or [[FUNCTION]] procedure. @@ -70,4 +70,3 @@ DIR$ = DirList$(Index%) {{PageNavigation}} - diff --git a/internal/help/SHELL_(function)_11111_(00000000).txt b/internal/help/SHELL_(function)_11111_(00000000).txt index a2c591fe3..7c1eb7760 100644 --- a/internal/help/SHELL_(function)_11111_(00000000).txt +++ b/internal/help/SHELL_(function)_11111_(00000000).txt @@ -1,5 +1,5 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:16:32}} +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:44:54}} The '''SHELL''' function displays the console and returns the [[INTEGER]] code value sent when the external program exits. @@ -60,4 +60,3 @@ returncode% = {{Cl|SHELL (function)|SHELL}}("DesktopSize") 'replace call with na {{PageNavigation}} - diff --git a/internal/help/SHELL_11111.txt b/internal/help/SHELL_11111.txt index f28574c01..a8c3b1aae 100644 --- a/internal/help/SHELL_11111.txt +++ b/internal/help/SHELL_11111.txt @@ -1,5 +1,5 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:16:31}} +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:44:52}} The [[SHELL]] statement allows a program to run external programs or command line statements in Windows, macOS and Linux. @@ -154,4 +154,3 @@ PathExist% = 0 {{PageNavigation}} - diff --git a/internal/help/SINGLE_111111.txt b/internal/help/SINGLE_111111.txt index f68bb00e3..15157327e 100644 --- a/internal/help/SINGLE_111111.txt +++ b/internal/help/SINGLE_111111.txt @@ -1,5 +1,5 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:16:36}} +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:44:56}} '''SINGLE''' variables are 4 byte floating decimal point numerical values up to seven digits in length. @@ -26,4 +26,3 @@ {{PageNavigation}} - diff --git a/internal/help/SIN_111.txt b/internal/help/SIN_111.txt index d4f8eb38c..6534084f2 100644 --- a/internal/help/SIN_111.txt +++ b/internal/help/SIN_111.txt @@ -1,5 +1,5 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:16:35}} +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:44:55}} The {{KW|SIN}} function returns the vertical component or sine of an angle measured in radians. @@ -119,4 +119,3 @@ The value of 2 {{PageNavigation}} - diff --git a/internal/help/SLEEP_11111.txt b/internal/help/SLEEP_11111.txt index bdf7e5b2e..f7b2264cb 100644 --- a/internal/help/SLEEP_11111.txt +++ b/internal/help/SLEEP_11111.txt @@ -1,5 +1,5 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:16:37}} +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:44:57}} SLEEP pauses the program indefinitely or for a specified number of seconds, program is unpaused when the user presses a key or when the specified number of seconds has passed. @@ -39,4 +39,3 @@ You've waited for 2 seconds. {{PageNavigation}} - diff --git a/internal/help/SOUND_11111.txt b/internal/help/SOUND_11111.txt index 9e0790e59..d5221dd11 100644 --- a/internal/help/SOUND_11111.txt +++ b/internal/help/SOUND_11111.txt @@ -1,5 +1,5 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:16:38}} +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:44:58}} '''SOUND''' sets frequency and duration of sounds from the internal PC speaker if the computer has one or the sound card in QB64. @@ -137,4 +137,3 @@ Octaves: {{PageNavigation}} - diff --git a/internal/help/SPACE$_11111$.txt b/internal/help/SPACE$_11111$.txt index 0e6d2b678..f789ed2a4 100644 --- a/internal/help/SPACE$_11111$.txt +++ b/internal/help/SPACE$_11111$.txt @@ -1,5 +1,5 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:16:40}} +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:45:00}} The {{KW|SPACE$}} function returns a {{KW|STRING}} consisting of a number of space characters. @@ -103,4 +103,3 @@ DO {{PageNavigation}} - diff --git a/internal/help/SPC_111.txt b/internal/help/SPC_111.txt index 4ea8360ee..9bf6c5342 100644 --- a/internal/help/SPC_111.txt +++ b/internal/help/SPC_111.txt @@ -1,5 +1,5 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:16:41}} +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:45:01}} The {{KW|SPC}} function is used in [[PRINT]] and [[LPRINT]] statements to print or output a number of space characters. @@ -35,4 +35,3 @@ abc 123 {{PageNavigation}} - diff --git a/internal/help/SQR_111.txt b/internal/help/SQR_111.txt index f612ab7f4..6741c1ff7 100644 --- a/internal/help/SQR_111.txt +++ b/internal/help/SQR_111.txt @@ -1,5 +1,5 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:16:42}} +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:45:02}} The '''SQR''' function returns the square root of a numerical value. @@ -78,4 +78,3 @@ PRIME! How'd you find me? {{PageNavigation}} - diff --git a/internal/help/STATIC_111111.txt b/internal/help/STATIC_111111.txt index 77f0dbc68..0c9cd4e4f 100644 --- a/internal/help/STATIC_111111.txt +++ b/internal/help/STATIC_111111.txt @@ -1,5 +1,5 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:16:43}} +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:45:03}} The {{KW|STATIC}} keyword is used in declaration statements to control where variables are stored. @@ -98,4 +98,3 @@ The {{KW|STATIC}} keyword is used in declaration statements to control where var {{PageNavigation}} - diff --git a/internal/help/STEP_1111.txt b/internal/help/STEP_1111.txt index d9bf5c131..adef70187 100644 --- a/internal/help/STEP_1111.txt +++ b/internal/help/STEP_1111.txt @@ -1,5 +1,5 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:16:46}} +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:45:06}} The '''STEP''' keyword is used in [[FOR...NEXT]] loops to skip through the count or to count down instead of up. Used in graphics to designate a relative coordinate position of a graphics object function. @@ -56,4 +56,3 @@ The '''STEP''' keyword is used in [[FOR...NEXT]] loops to skip through the count {{PageNavigation}} - diff --git a/internal/help/STICK_11111.txt b/internal/help/STICK_11111.txt index 0655bea0b..c5359cd64 100644 --- a/internal/help/STICK_11111.txt +++ b/internal/help/STICK_11111.txt @@ -1,5 +1,5 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:16:47}} +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:45:07}} The '''STICK''' function returns the directional axis coordinate move of game port (&H201) joystick or USB controller devices. @@ -88,7 +88,7 @@ Buttons: 9 -0 -1 █ 0 0 █ 0 0 █ 0 0 █ 0 0 █ 0 0 █ 0 0 █ 0 0 █ 0 0 █ {{OutputEnd}} : ''Note:'' A Sidewinder Precision Pro requires that pins 2 and 7(blue and purple) be connected together for digital USB recognition. -
[http://www.amazon.com/Belkin-F3U200-08INCH-Joystick-Adapter-SideWinder/dp/B000067RIV Sidewinder Precision Pro game port to USB adapter]
+
[http://www.amazon.com/Belkin-F3U200-08INCH-Joystick-Adapter-SideWinder/dp/B000067RIV Sidewinder Precision Pro game port to USB adapter]
''See also:'' @@ -99,4 +99,3 @@ Buttons: 9 {{PageNavigation}} - diff --git a/internal/help/STOP_1111.txt b/internal/help/STOP_1111.txt index 9f4b347a3..53e4efd84 100644 --- a/internal/help/STOP_1111.txt +++ b/internal/help/STOP_1111.txt @@ -1,5 +1,5 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:16:48}} +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:45:08}} The '''STOP''' statement is used to stop program execution when troubleshooting a program or to suspend event trapping. @@ -32,4 +32,3 @@ The '''STOP''' statement is used to stop program execution when troubleshooting {{PageNavigation}} - diff --git a/internal/help/STR$_111$.txt b/internal/help/STR$_111$.txt index 743bfe4e9..65c8dc500 100644 --- a/internal/help/STR$_111$.txt +++ b/internal/help/STR$_111$.txt @@ -1,5 +1,5 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:16:50}} +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:45:09}} The '''STR$''' function returns the [[STRING]] representation of a numerical value. @@ -46,4 +46,3 @@ a = 33 {{PageNavigation}} - diff --git a/internal/help/STRIG(n)_11111(0).txt b/internal/help/STRIG(n)_11111(0).txt index 9e877bce6..8f76e088e 100644 --- a/internal/help/STRIG(n)_11111(0).txt +++ b/internal/help/STRIG(n)_11111(0).txt @@ -1,5 +1,5 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:16:52}} +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:45:12}} The {{KW|STRIG(n)}} statement controls event trapping for a particular joystick or game pad device button. @@ -48,4 +48,3 @@ a$ = "[STRIG 0 EVENT]" {{PageNavigation}} - diff --git a/internal/help/STRIG_11111.txt b/internal/help/STRIG_11111.txt index bdb5f1777..863394f49 100644 --- a/internal/help/STRIG_11111.txt +++ b/internal/help/STRIG_11111.txt @@ -1,5 +1,5 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:16:51}} +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:45:10}} The '''STRIG''' function returns button press True or False status of game port (&H201) or USB joystick control device(s). @@ -66,4 +66,3 @@ STRIG(2, 4): STRIG(3, 4): STRIG(6, 4): STRIG(7, 4): STRIG(10, 4): STRIG(11, 4) ' {{PageNavigation}} - diff --git a/internal/help/STRING$_111111$.txt b/internal/help/STRING$_111111$.txt index e4cab5bad..89f1b2aab 100644 --- a/internal/help/STRING$_111111$.txt +++ b/internal/help/STRING$_111111$.txt @@ -1,5 +1,5 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:16:55}} +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:45:14}} The {{KW|STRING$}} function returns a {{KW|STRING}} consisting of a single character repeated a number of times. @@ -50,4 +50,3 @@ The {{KW|STRING$}} function returns a {{KW|STRING}} consisting of a single chara {{PageNavigation}} - diff --git a/internal/help/STRING_111111.txt b/internal/help/STRING_111111.txt index 0fde75f4f..ac905e618 100644 --- a/internal/help/STRING_111111.txt +++ b/internal/help/STRING_111111.txt @@ -1,5 +1,5 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:16:54}} +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:45:13}} '''STRING''' variables or literal values are one byte per character length text or [[ASCII]] characters. @@ -110,4 +110,3 @@ value3$ = "z" {{PageNavigation}} - diff --git a/internal/help/SUB_111.txt b/internal/help/SUB_111.txt index 7636b63cc..dd37d9a63 100644 --- a/internal/help/SUB_111.txt +++ b/internal/help/SUB_111.txt @@ -1,5 +1,5 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:16:56}} +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:45:15}} A '''SUB''' procedure is a procedure within a program that can calculate and return multiple parameter values just like a full program. @@ -84,4 +84,3 @@ exit 1 {{PageNavigation}} - diff --git a/internal/help/SWAP_1111.txt b/internal/help/SWAP_1111.txt index d07ae7cd4..7c15329f2 100644 --- a/internal/help/SWAP_1111.txt +++ b/internal/help/SWAP_1111.txt @@ -1,5 +1,5 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:16:58}} +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:45:16}} The {{KW|SWAP}} statement is used to exchange two variable or array element values. @@ -127,4 +127,3 @@ Middle = array((Lo + Hi) / 2) 'find middle of array {{PageNavigation}} - diff --git a/internal/help/SYSTEM_111111.txt b/internal/help/SYSTEM_111111.txt index a5abc0ecc..5e6c82923 100644 --- a/internal/help/SYSTEM_111111.txt +++ b/internal/help/SYSTEM_111111.txt @@ -1,5 +1,5 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:16:59}} +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:45:17}} The {{KW|SYSTEM}} statement immediately closes a program and returns control to the operating system. @@ -31,4 +31,3 @@ The {{KW|SYSTEM}} statement immediately closes a program and returns control to {{PageNavigation}} - diff --git a/internal/help/Semicolon_100000000.txt b/internal/help/Semicolon_100000000.txt index 31c3855b5..5be258503 100644 --- a/internal/help/Semicolon_100000000.txt +++ b/internal/help/Semicolon_100000000.txt @@ -1,5 +1,5 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:24:36}} +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:53:52}} The '''semicolon''' is used in a [[PRINT]] statement to stop the screen print cursor immediately after the printed value. @@ -30,4 +30,3 @@ The '''semicolon''' is used in a [[PRINT]] statement to stop the screen print cu {{PageNavigation}} - diff --git a/internal/help/TAB_111.txt b/internal/help/TAB_111.txt index e42da79ca..154eca74c 100644 --- a/internal/help/TAB_111.txt +++ b/internal/help/TAB_111.txt @@ -1,5 +1,5 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:17:00}} +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:45:19}} The {{KW|TAB}} function is used in [[PRINT]] and [[LPRINT]] statements to move to a specified column position. @@ -45,4 +45,3 @@ The {{KW|TAB}} function is used in [[PRINT]] and [[LPRINT]] statements to move t {{PageNavigation}} - diff --git a/internal/help/TAN_111.txt b/internal/help/TAN_111.txt index 5f6d9621e..c9624837c 100644 --- a/internal/help/TAN_111.txt +++ b/internal/help/TAN_111.txt @@ -1,5 +1,5 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:17:01}} +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:45:20}} The [[TAN]] function returns the ratio of [[SIN]]e to [[COS]]ine or tangent value of an angle measured in radians. @@ -90,4 +90,3 @@ DO {{PageNavigation}} - diff --git a/internal/help/THEN_1111.txt b/internal/help/THEN_1111.txt index 77f7ed9c4..ec6c83707 100644 --- a/internal/help/THEN_1111.txt +++ b/internal/help/THEN_1111.txt @@ -1,5 +1,5 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:17:02}} +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:45:21}} '''THEN''' is required in [[IF...THEN]] conditional evaluation statements. @@ -19,4 +19,3 @@ {{PageNavigation}} - diff --git a/internal/help/TIME$_1111$.txt b/internal/help/TIME$_1111$.txt index f5983481a..978b94c53 100644 --- a/internal/help/TIME$_1111$.txt +++ b/internal/help/TIME$_1111$.txt @@ -1,5 +1,5 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:17:04}} +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:45:22}} The '''TIME$''' Function returns a [[STRING]] representation of the current computer time in a 24 hour format. @@ -66,4 +66,3 @@ END FUNCTION {{PageNavigation}} - diff --git a/internal/help/TIMER_(statement)_11111_(000000000).txt b/internal/help/TIMER_(statement)_11111_(000000000).txt index 2b21ec756..cb78aa153 100644 --- a/internal/help/TIMER_(statement)_11111_(000000000).txt +++ b/internal/help/TIMER_(statement)_11111_(000000000).txt @@ -1,5 +1,5 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:13:27}} +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:42:25}} A '''TIMER''' statement enables, turns off or stops timer event trapping. QBasic only uses the base timer, but '''QB64''' can run many. @@ -59,4 +59,3 @@ QB64 {{PageSyntax}} {{PageNavigation}} - diff --git a/internal/help/TIMER_11111.txt b/internal/help/TIMER_11111.txt index d84b07da0..2c44e0471 100644 --- a/internal/help/TIMER_11111.txt +++ b/internal/help/TIMER_11111.txt @@ -1,5 +1,5 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:17:05}} +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:45:23}} The '''TIMER''' function returns the number of seconds past the previous midnite down to an accuracy of 1/18th of a second. @@ -86,4 +86,3 @@ start! = {{Cl|TIMER}} {{PageNavigation}} - diff --git a/internal/help/TO_11.txt b/internal/help/TO_11.txt index f8c84dd4a..ee14cd960 100644 --- a/internal/help/TO_11.txt +++ b/internal/help/TO_11.txt @@ -1,5 +1,5 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:17:06}} +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:45:24}} [[TO]] {{text|indicates a range of numerical values or an assignment of one value to another.}} @@ -27,4 +27,3 @@ {{PageNavigation}} - diff --git a/internal/help/TYPE_1111.txt b/internal/help/TYPE_1111.txt index f3bf8c58c..d8fb54573 100644 --- a/internal/help/TYPE_1111.txt +++ b/internal/help/TYPE_1111.txt @@ -1,5 +1,5 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:17:08}} +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:45:26}} '''TYPE''' definitions are used to create variables that can hold more than one variable type of a fixed byte length. @@ -122,10 +122,10 @@ PRINT foobar.a, foobar.c.b Res2 AS INTEGER ' Reserved 2 should be 0 2 Offset AS LONG ' Start position of pixel data 4 Hsize AS LONG ' Information header size 4 - PWidth AS LONG ' Image width 4 {{Cl|_WIDTH (QB64)}} - PDepth AS LONG ' Image height 4 {{Cl|_HEIGHT}} + PWidth AS LONG ' Image width 4 {{Cb|_WIDTH (function)}} + PDepth AS LONG ' Image height 4 {{Cb|_HEIGHT}} Planes AS INTEGER ' Number of planes 2 - BPP AS INTEGER ' Bits per pixel(palette) 2 {{Cl|_PIXELSIZE}} + BPP AS INTEGER ' Bits per pixel(palette) 2 {{Cb|_PIXELSIZE}} Compress AS LONG ' Compression 4 ImageBytes AS LONG ' Width * Height = ImageSIZE 4 Xres AS LONG ' Width in PELS per metre 4 @@ -165,4 +165,3 @@ PRINT foobar.a, foobar.c.b {{PageNavigation}} - diff --git a/internal/help/Template%3AOpenGLTypesPlugin_10000000%3110001110000100000.txt b/internal/help/Template%3AOpenGLTypesPlugin_10000000%3110001110000100000.txt new file mode 100644 index 000000000..2a97da05e --- /dev/null +++ b/internal/help/Template%3AOpenGLTypesPlugin_10000000%3110001110000100000.txt @@ -0,0 +1,33 @@ +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:53:51}} +{{TextStart}} + '''OpenGL''' | '''C/C++''' | '''QB64''' + ------------+------------------+---------------------- + GLenum | unsigned int | [[_UNSIGNED]] [[LONG]] + GLboolean | unsigned char | [[_UNSIGNED]] [[_BYTE]] + GLbitfield | unsigned int | [[_UNSIGNED]] [[LONG]] + GLbyte | signed char | [[_BYTE]] + GLshort | short | [[INTEGER]] + GLint | int | [[LONG]] + GLsizei | int | [[LONG]] + GLubyte | unsigned char | [[_UNSIGNED]] [[_BYTE]] + GLushort | unsigned short | [[_UNSIGNED]] [[INTEGER]] + GLuint | unsigned int | [[_UNSIGNED]] [[LONG]] + GLfloat | float | [[SINGLE]] + GLclampf | float | [[SINGLE]] + GLdouble | double | [[DOUBLE]] + GLclampd | double | [[DOUBLE]] + GLvoid '''(1)'''| void | [[_OFFSET]](any fixed lenght string or [[_BYTE]] + array element) + + '''Note:''' If a parameter has an asterisk (*) in front, then it's a pointer to + the designated OpenGL variable type, rather than a value of that type. + Those must be passed using the [[_OFFSET]](...) notation. + + '''E.g.''' GLuint *anyParam is actually the offset of a [[_UNSIGNED]] [[LONG]] (~&) + variable or array, which must be passed as [[_OFFSET]](anyVar~&) or + [[_OFFSET]](anyArr~&()) respectively. + + '''(1)''' This type is regularly only used for pointers (with asterisk (*)) to + any byte sized memory data, hence _BYTE or fixed length strings. +{{TextEnd}} diff --git a/internal/help/UBOUND_111111.txt b/internal/help/UBOUND_111111.txt index aae81cdbc..002da65a7 100644 --- a/internal/help/UBOUND_111111.txt +++ b/internal/help/UBOUND_111111.txt @@ -1,5 +1,5 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:17:09}} +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:45:27}} The {{KW|UBOUND}} function returns the largest valid index (upper bound) of an array dimension. @@ -35,4 +35,3 @@ The {{KW|UBOUND}} function returns the largest valid index (upper bound) of an a {{PageNavigation}} - diff --git a/internal/help/UCASE$_11111$.txt b/internal/help/UCASE$_11111$.txt index 257963182..b3d548be0 100644 --- a/internal/help/UCASE$_11111$.txt +++ b/internal/help/UCASE$_11111$.txt @@ -1,5 +1,5 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:17:10}} +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:45:28}} The [[UCASE$]] function outputs an all-uppercase version of a [[STRING]]. @@ -29,4 +29,3 @@ The [[UCASE$]] function outputs an all-uppercase version of a [[STRING]]. {{PageNavigation}} - diff --git a/internal/help/UEVENT_111111.txt b/internal/help/UEVENT_111111.txt index a52a1cd37..da6ac70ca 100644 --- a/internal/help/UEVENT_111111.txt +++ b/internal/help/UEVENT_111111.txt @@ -1,5 +1,5 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:17:11}} +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:45:29}} The '''UEVENT''' Statement uses ON, OFF or STOP to enable, turn off or suspend user event trapping. @@ -20,4 +20,3 @@ The '''UEVENT''' Statement uses ON, OFF or STOP to enable, turn off or suspend u {{PageNavigation}} - diff --git a/internal/help/UNLOCK_111111.txt b/internal/help/UNLOCK_111111.txt index 138fbf250..c79f29631 100644 --- a/internal/help/UNLOCK_111111.txt +++ b/internal/help/UNLOCK_111111.txt @@ -1,5 +1,5 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:17:13}} +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:45:30}} This statement opens access to parts or all of a file to other programs and network users. @@ -27,4 +27,3 @@ This statement opens access to parts or all of a file to other programs and netw {{PageNavigation}} - diff --git a/internal/help/UNTIL_11111.txt b/internal/help/UNTIL_11111.txt index 76d391cf8..fa55fafa8 100644 --- a/internal/help/UNTIL_11111.txt +++ b/internal/help/UNTIL_11111.txt @@ -1,5 +1,5 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:17:14}} +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:45:31}} The '''UNTIL''' condition is used in [[DO...LOOP]] exit verifications. @@ -18,7 +18,7 @@ The '''UNTIL''' condition is used in [[DO...LOOP]] exit verifications. * Skips the loop or loops until an evaluation becomes True. -{{Template:RelationalTable}} +{{RelationalTable}} ''See also:'' @@ -27,4 +27,3 @@ The '''UNTIL''' condition is used in [[DO...LOOP]] exit verifications. *[[WHILE...WEND]] {{PageNavigation}} - diff --git a/internal/help/Underscore_1000000000.txt b/internal/help/Underscore_1000000000.txt index 7b6446094..810823abb 100644 --- a/internal/help/Underscore_1000000000.txt +++ b/internal/help/Underscore_1000000000.txt @@ -1,5 +1,5 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:24:47}} +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:54:01}} An '''underscore''' can be used at the end of a line of code to continue a code line to the next line. @@ -23,4 +23,3 @@ An '''underscore''' can be used at the end of a line of code to continue a code {{PageNavigation}} - diff --git a/internal/help/VAL_111.txt b/internal/help/VAL_111.txt index b0cbe980f..793dffcc5 100644 --- a/internal/help/VAL_111.txt +++ b/internal/help/VAL_111.txt @@ -1,5 +1,5 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:17:15}} +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:45:32}} The '''VAL''' Function returns the decimal numerical equivalent value of a [[STRING]] numerical value. @@ -74,4 +74,3 @@ The '''VAL''' Function returns the decimal numerical equivalent value of a [[STR {{PageNavigation}} - diff --git a/internal/help/VARPTR$_111111$.txt b/internal/help/VARPTR$_111111$.txt index a4c010b6a..2edbe7617 100644 --- a/internal/help/VARPTR$_111111$.txt +++ b/internal/help/VARPTR$_111111$.txt @@ -1,5 +1,5 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:17:18}} +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:45:34}} '''VARPTR$''' is a memory function that returns a [[STRING]] representation of a variable's memory address value for use in a [[DRAW]] or [[PLAY]] statement. @@ -78,4 +78,3 @@ C = 100: D = -100 {{PageNavigation}} - diff --git a/internal/help/VARPTR_111111.txt b/internal/help/VARPTR_111111.txt index 1bd457b1b..34d4ed633 100644 --- a/internal/help/VARPTR_111111.txt +++ b/internal/help/VARPTR_111111.txt @@ -1,5 +1,5 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:17:16}} +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:45:33}} The '''VARPTR''' function returns an [[INTEGER]] value that is the offset part of the variable or array memory address within it's segment. @@ -24,4 +24,3 @@ The '''VARPTR''' function returns an [[INTEGER]] value that is the offset part o {{PageNavigation}} - diff --git a/internal/help/VARSEG_111111.txt b/internal/help/VARSEG_111111.txt index 2a621b27b..ee2afcd3b 100644 --- a/internal/help/VARSEG_111111.txt +++ b/internal/help/VARSEG_111111.txt @@ -1,5 +1,5 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:17:19}} +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:45:36}} The '''VARSEG''' function returns an [[INTEGER]] value that is the segment part of a variable or array memory address. @@ -25,4 +25,3 @@ The '''VARSEG''' function returns an [[INTEGER]] value that is the segment part {{PageNavigation}} - diff --git a/internal/help/VIEW_1111.txt b/internal/help/VIEW_1111.txt index 3bc792ab8..94e61d74a 100644 --- a/internal/help/VIEW_1111.txt +++ b/internal/help/VIEW_1111.txt @@ -1,5 +1,5 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:17:20}} +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:45:37}} The '''VIEW''' statement creates a graphics view port area by defining the coordinate limits to be viewed. @@ -42,4 +42,3 @@ The '''VIEW''' statement creates a graphics view port area by defining the coord {{PageNavigation}} - diff --git a/internal/help/VIEW_PRINT_1111_11111.txt b/internal/help/VIEW_PRINT_1111_11111.txt index 2b6bb23b7..b4cf4e719 100644 --- a/internal/help/VIEW_PRINT_1111_11111.txt +++ b/internal/help/VIEW_PRINT_1111_11111.txt @@ -1,5 +1,5 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:17:21}} +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:45:38}} The [[VIEW PRINT]] statement defines the boundaries of a text viewport {{KW|PRINT}} area. @@ -60,4 +60,3 @@ The [[VIEW PRINT]] statement defines the boundaries of a text viewport {{KW|PRIN {{PageNavigation}} - diff --git a/internal/help/WAIT_1111.txt b/internal/help/WAIT_1111.txt index d9eca1a6f..a189cbee8 100644 --- a/internal/help/WAIT_1111.txt +++ b/internal/help/WAIT_1111.txt @@ -1,5 +1,5 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:17:23}} +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:45:39}} The {{KW|WAIT}} statement waits until the value read from an I/O port has certain bits set. @@ -31,4 +31,3 @@ WAIT &H3DA, 8, 8 ' finishes whenever the screen is being written to {{PageNavigation}} - diff --git a/internal/help/WEND_1111.txt b/internal/help/WEND_1111.txt index 4a66b5ecf..66178b42f 100644 --- a/internal/help/WEND_1111.txt +++ b/internal/help/WEND_1111.txt @@ -1,4 +1,3 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:17:24}} +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:45:40}} See page [[WHILE...WEND]] - diff --git a/internal/help/WHILE...WEND_11111...1111.txt b/internal/help/WHILE...WEND_11111...1111.txt index 1598e212a..ccf98a0d7 100644 --- a/internal/help/WHILE...WEND_11111...1111.txt +++ b/internal/help/WHILE...WEND_11111...1111.txt @@ -1,5 +1,5 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:17:27}} +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:45:42}} The {{KW|WHILE...WEND}} statement is used to repeat a block of statements while the condition is met. @@ -19,7 +19,7 @@ The {{KW|WHILE...WEND}} statement is used to repeat a block of statements while * WHILE loops only run if the WHILE condition is True. -{{Template:RelationalTable}} +{{RelationalTable}} {{PageExamples}} @@ -49,4 +49,3 @@ The {{KW|WHILE...WEND}} statement is used to repeat a block of statements while {{PageNavigation}} - diff --git a/internal/help/WHILE_11111.txt b/internal/help/WHILE_11111.txt index 3f5ccd672..c5488845c 100644 --- a/internal/help/WHILE_11111.txt +++ b/internal/help/WHILE_11111.txt @@ -1,4 +1,3 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:17:25}} +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:45:41}} See page [[WHILE...WEND]] - diff --git a/internal/help/WIDTH_11111.txt b/internal/help/WIDTH_11111.txt index df83d418b..7bcda7a4f 100644 --- a/internal/help/WIDTH_11111.txt +++ b/internal/help/WIDTH_11111.txt @@ -1,5 +1,5 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:17:28}} +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:45:43}} The {{KW|WIDTH}} statement changes the text dimensions of certain {{KW|SCREEN (statement)|SCREEN}} modes. @@ -35,4 +35,3 @@ The {{KW|WIDTH}} statement changes the text dimensions of certain {{KW|SCREEN (s {{PageNavigation}} - diff --git a/internal/help/WINDOW_111111.txt b/internal/help/WINDOW_111111.txt index 6fc7438c4..ef61ae601 100644 --- a/internal/help/WINDOW_111111.txt +++ b/internal/help/WINDOW_111111.txt @@ -1,5 +1,5 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:17:29}} +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:45:45}} The '''WINDOW''' command scales the graphics coordinate system of the current [[_DEST]] image, optionally inverting the direction of the vertical axis. Any coordinates used in drawing commands made to the image are scaled such that the image seems have have the dimensions requested. {{PageSyntax}} @@ -41,4 +41,3 @@ Demonstrate a circle's radius only matching the scaling in the horizontal direct * [[VIEW PRINT]] {{PageNavigation}} - diff --git a/internal/help/WRITE_(file_statement)_11111_(0000_000000000).txt b/internal/help/WRITE_(file_statement)_11111_(0000_000000000).txt index 7d118c82b..871a4fb31 100644 --- a/internal/help/WRITE_(file_statement)_11111_(0000_000000000).txt +++ b/internal/help/WRITE_(file_statement)_11111_(0000_000000000).txt @@ -1,5 +1,5 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:17:32}} +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:45:47}} The [[WRITE (file statement)|WRITE #]] file statement writes a list of comma separated variable values to a sequential file or port. @@ -63,4 +63,3 @@ K$ = {{Cl|INPUT$}}(1) 'press a key {{PageNavigation}} - diff --git a/internal/help/WRITE_11111.txt b/internal/help/WRITE_11111.txt index 5b988cb52..b2fae9481 100644 --- a/internal/help/WRITE_11111.txt +++ b/internal/help/WRITE_11111.txt @@ -1,5 +1,5 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:17:30}} +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:45:46}} The {{KW|WRITE}} statement writes a [[comma]]-separated list of values to the screen without spacing. @@ -37,4 +37,3 @@ c! = 3.1415 {{PageNavigation}} - diff --git a/internal/help/XOR_111.txt b/internal/help/XOR_111.txt index 1b36a2732..f095b7c38 100644 --- a/internal/help/XOR_111.txt +++ b/internal/help/XOR_111.txt @@ -1,5 +1,5 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:17:33}} +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:45:48}} Bitwise operators are much like the regular mathematics operators (+, * etc.) but are defined in terms of the individual bits of their operands. The full list of bitwise operators, with a brief summary of its operation: * '''AND''': True if both inputs are true * '''OR''': True if one or both inputs are true @@ -17,20 +17,7 @@ If ''value1'' or ''value2'' are non-integer numeric types, they are rounded to t {{PageDescription}} Bitwise operators work by comparing the corresponding bits in each of the input values to generate a single bit in the output value. The operators differ in how they do the comparison. The table below shows the output bit for each pair of input bits: -{| class="wikitable" -! colspan="2"|Operands -! colspan="6"|Operations -|- -! A !! B !! A AND B !! A OR B !! NOT A !! A XOR B !! A IMP B !! A EQV B -|- -| align="center"|0 || align="center"|0 || align="center"|0 || align="center"|0 || align="center"|1 || align="center"|0 || align="center"|1 || align="center"|1 -|- -| align="center"|0 || align="center"|1 || align="center"|0 || align="center"|1 || align="center"|1 || align="center"|1 || align="center"|1 || align="center"|0 -|- -| align="center"|1 || align="center"|0 || align="center"|0 || align="center"|1 || align="center"|0 || align="center"|1 || align="center"|0 || align="center"|0 -|- -| align="center"|1 || align="center"|1 || align="center"|1 || align="center"|1 || align="center"|0 || align="center"|0 || align="center"|1 || align="center"|1 -|} +{{LogicalTruthTable}} Again, note that the NOT operator only has one operand. It is shown in the same table for convenience. If one input has more bits than the other (say, an INTEGER vs a LONG) the shorter will be considered to have 0's in the missing bit positions if it is positive, or 1's if it is negative. This scheme comes about because of the [[wikipedia:Two's_complement|Two's Complement]] system for representing negative numbers. As a general rule, there should not be any surprises. @@ -105,4 +92,3 @@ Flag C is set {{OutputEnd}} {{PageNavigation}} - diff --git a/internal/help/^_^.txt b/internal/help/^_^.txt index 7e8d88004..a774fddf5 100644 --- a/internal/help/^_^.txt +++ b/internal/help/^_^.txt @@ -1,5 +1,5 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:24:57}} +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:54:10}} The '''^''' operation raises a numerical value to an exponential value expressing how many times the value is multiplied by itself. @@ -49,4 +49,3 @@ Enter a number to calculate it's cube root: 144 {{PageNavigation}} - diff --git a/internal/help/_ACCEPTFILEDROP__11111111111111.txt b/internal/help/_ACCEPTFILEDROP__11111111111111.txt index c080a5221..4ad416ca1 100644 --- a/internal/help/_ACCEPTFILEDROP__11111111111111.txt +++ b/internal/help/_ACCEPTFILEDROP__11111111111111.txt @@ -1,5 +1,5 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:06:17}} +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:35:58}} {{DISPLAYTITLE:_ACCEPTFILEDROP}} The [[_ACCEPTFILEDROP]] statement prepares a program window to receive files dropped from Windows Explorer in a drag/drop operation. @@ -59,4 +59,3 @@ The [[_ACCEPTFILEDROP]] statement prepares a program window to receive files dro {{PageNavigation}} - diff --git a/internal/help/_ACOSH__11111.txt b/internal/help/_ACOSH__11111.txt index 5dcf608e4..9d4defd23 100644 --- a/internal/help/_ACOSH__11111.txt +++ b/internal/help/_ACOSH__11111.txt @@ -1,5 +1,5 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:06:19}} +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:36:00}} {{DISPLAYTITLE:_ACOSH}} The [[_ACOSH]] returns the nonnegative arc hyperbolic cosine of {{Parameter|x!}}, expressed in radians. @@ -22,3 +22,4 @@ The [[_ACOSH]] returns the nonnegative arc hyperbolic cosine of {{Parameter|x!}} {{PageNavigation}} +[[Category:Latest]] diff --git a/internal/help/_ACOS__1111.txt b/internal/help/_ACOS__1111.txt index 34b16fa43..d51067ed1 100644 --- a/internal/help/_ACOS__1111.txt +++ b/internal/help/_ACOS__1111.txt @@ -1,5 +1,5 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:06:18}} +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:35:59}} {{DISPLAYTITLE:_ACOS}} The [[_ACOS]] function returns the angle measured in radians based on an input [[COS]]ine value ranging from -1 to 1. @@ -85,4 +85,3 @@ Related changes Special pages Page information Privacy policyAbout QB64 WikiDisclaimersPowered by MediaWiki - diff --git a/internal/help/_ALLOWFULLSCREEN__111111111111111.txt b/internal/help/_ALLOWFULLSCREEN__111111111111111.txt index d81dfb77f..3a5ccab93 100644 --- a/internal/help/_ALLOWFULLSCREEN__111111111111111.txt +++ b/internal/help/_ALLOWFULLSCREEN__111111111111111.txt @@ -1,5 +1,5 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:06:20}} +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:36:01}} {{DISPLAYTITLE:_ALLOWFULLSCREEN}} The [[_ALLOWFULLSCREEN]] statement allows setting the behavior of the ALT+ENTER combo. @@ -76,4 +76,3 @@ The [[_ALLOWFULLSCREEN]] statement allows setting the behavior of the ALT+ENTER {{PageNavigation}} - diff --git a/internal/help/_ALPHA32__1111132.txt b/internal/help/_ALPHA32__1111132.txt index d0906846e..bb213ec3c 100644 --- a/internal/help/_ALPHA32__1111132.txt +++ b/internal/help/_ALPHA32__1111132.txt @@ -1,5 +1,5 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:06:23}} +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:36:04}} {{DISPLAYTITLE:_ALPHA32}} The [[_ALPHA32]] function returns the alpha transparency level of a 32 bit color value. @@ -49,4 +49,3 @@ clr~& = {{Cl|_RGBA}}(255, 0, 255, 192) {{PageNavigation}} - diff --git a/internal/help/_ALPHA__11111.txt b/internal/help/_ALPHA__11111.txt index 7e9fd1ff9..55e34f0d3 100644 --- a/internal/help/_ALPHA__11111.txt +++ b/internal/help/_ALPHA__11111.txt @@ -1,5 +1,5 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:06:21}} +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:36:03}} {{DISPLAYTITLE:_ALPHA}} The [[_ALPHA]] function returns the alpha channel transparency level of a color value used on a screen page or image. @@ -63,3 +63,4 @@ BG& = {{Cl|POINT}}(1, 1) {{PageNavigation}} +[[Category:Latest]] diff --git a/internal/help/_ASINH__11111.txt b/internal/help/_ASINH__11111.txt index 506b042c2..4d6305436 100644 --- a/internal/help/_ASINH__11111.txt +++ b/internal/help/_ASINH__11111.txt @@ -1,5 +1,5 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:06:25}} +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:36:07}} {{DISPLAYTITLE:_ASINH}} The [[_ASINH]] returns the arc hyperbolic sine of x, expressed in radians. @@ -22,4 +22,3 @@ The [[_ASINH]] returns the arc hyperbolic sine of x, expressed in radians. {{PageNavigation}} - diff --git a/internal/help/_ASIN__1111.txt b/internal/help/_ASIN__1111.txt index 4c2291c41..2f02f8957 100644 --- a/internal/help/_ASIN__1111.txt +++ b/internal/help/_ASIN__1111.txt @@ -1,5 +1,5 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:06:24}} +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:36:06}} {{DISPLAYTITLE:_ASIN}} The [[_ASIN]] function returns the angle measured in radians based on an input [[SIN]]e value ranging from -1 to 1. @@ -55,4 +55,3 @@ Notice, A is the Angle in Radians. If we convert it to degrees, we discover the {{PageNavigation}} - diff --git a/internal/help/_ASSERT__111111.txt b/internal/help/_ASSERT__111111.txt index 3eb9e4505..f489aaac0 100644 --- a/internal/help/_ASSERT__111111.txt +++ b/internal/help/_ASSERT__111111.txt @@ -1,5 +1,5 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:06:26}} +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:36:09}} {{DISPLAYTITLE:_ASSERT}} The [[_ASSERT]] statement can be used to perform tests in code that's in development, for debugging purposes. @@ -47,4 +47,3 @@ The [[_ASSERT]] statement can be used to perform tests in code that's in develop {{PageNavigation}} - diff --git a/internal/help/_ATAN2__11112.txt b/internal/help/_ATAN2__11112.txt index db064cb66..adf034daa 100644 --- a/internal/help/_ATAN2__11112.txt +++ b/internal/help/_ATAN2__11112.txt @@ -1,5 +1,5 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:06:30}} +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:36:11}} {{DISPLAYTITLE:_ATAN2}} The [[_ATAN2]] function returns the radian angle between the positive x-axis of a plane and the point given by the coordinates (x, y). @@ -38,4 +38,3 @@ The [[_ATAN2]] function returns the radian angle between the positive x-axis of {{PageNavigation}} - diff --git a/internal/help/_ATANH__11111.txt b/internal/help/_ATANH__11111.txt index c1663d44e..aed70eccd 100644 --- a/internal/help/_ATANH__11111.txt +++ b/internal/help/_ATANH__11111.txt @@ -1,5 +1,5 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:06:31}} +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:36:12}} {{DISPLAYTITLE:_ATANH}} The [[_ATANH]] returns the arc hyperbolic tangent of {{Parameter|x!}}, expressed in radians. @@ -23,3 +23,4 @@ The [[_ATANH]] returns the arc hyperbolic tangent of {{Parameter|x!}}, expressed {{PageNavigation}} +[[Category:Latest]] diff --git a/internal/help/_AUTODISPLAY_(function)__11111111111_(00000000).txt b/internal/help/_AUTODISPLAY_(function)__11111111111_(00000000).txt index 0d3735acc..08ea0a7de 100644 --- a/internal/help/_AUTODISPLAY_(function)__11111111111_(00000000).txt +++ b/internal/help/_AUTODISPLAY_(function)__11111111111_(00000000).txt @@ -1,5 +1,5 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:06:34}} +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:36:15}} {{DISPLAYTITLE:_AUTODISPLAY (function)}} The [[_AUTODISPLAY (function)|_AUTODISPLAY]] function returns the current display mode as true (-1) if automatic or false (0) if disabled using [[_DISPLAY]]. @@ -24,4 +24,3 @@ The [[_AUTODISPLAY (function)|_AUTODISPLAY]] function returns the current displa {{PageNavigation}} - diff --git a/internal/help/_AUTODISPLAY__11111111111.txt b/internal/help/_AUTODISPLAY__11111111111.txt index b534338b4..79ecba879 100644 --- a/internal/help/_AUTODISPLAY__11111111111.txt +++ b/internal/help/_AUTODISPLAY__11111111111.txt @@ -1,5 +1,5 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:06:33}} +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:36:14}} {{DISPLAYTITLE:_AUTODISPLAY}} The [[_AUTODISPLAY]] statement enables the automatic display of the screen image changes previously disabled by [[_DISPLAY]]. @@ -21,3 +21,4 @@ The [[_AUTODISPLAY]] statement enables the automatic display of the screen image {{PageNavigation}} +[[Category:Latest]] diff --git a/internal/help/_AXIS__1111.txt b/internal/help/_AXIS__1111.txt index 81a5bb9e5..e43a73ee5 100644 --- a/internal/help/_AXIS__1111.txt +++ b/internal/help/_AXIS__1111.txt @@ -1,5 +1,5 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:06:35}} +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:36:16}} {{DISPLAYTITLE:_AXIS}} The [[_AXIS]] function returns the relative position of a specified axis number on a controller device. @@ -53,3 +53,4 @@ The [[_AXIS]] function returns the relative position of a specified axis number {{PageNavigation}} +[[Category:Latest]] diff --git a/internal/help/_BACKGROUNDCOLOR__111111111111111.txt b/internal/help/_BACKGROUNDCOLOR__111111111111111.txt index 63c4c0bb9..9adc1c212 100644 --- a/internal/help/_BACKGROUNDCOLOR__111111111111111.txt +++ b/internal/help/_BACKGROUNDCOLOR__111111111111111.txt @@ -1,5 +1,5 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:06:37}} +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:36:17}} {{DISPLAYTITLE:_BACKGROUNDCOLOR}} The [[_BACKGROUNDCOLOR]] function returns the current background color. @@ -48,4 +48,3 @@ BG% = {{Cl|_BACKGROUNDCOLOR}} {{PageNavigation}} - diff --git a/internal/help/_BIN$__111$.txt b/internal/help/_BIN$__111$.txt index b0ba770c1..dd0770d18 100644 --- a/internal/help/_BIN$__111$.txt +++ b/internal/help/_BIN$__111$.txt @@ -1,5 +1,5 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:06:39}} +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:36:20}} {{DISPLAYTITLE:_BIN$}} This function returns the binary (base 2) representation of any numeric value. @@ -17,7 +17,7 @@ This function returns the binary (base 2) representation of any numeric value. * The function returns the base 2 (binary) representation of the given {{Parameter|number}} as [[STRING]]. * Different from [[STR$]], this function does not return a leading sign placeholder space, so no [[LTRIM$]] to strip that space from positive numbers is necessary. * [[VAL]] can convert the returned bin string value back to a decimal value by prefixing the string with "[[&B]]". -** Eg. {{InlineCode}}decimal = VAL("&B" + binvalue$){{InlineCodeEnd}}. +** Eg. {{InlineCode}}decimal = {{Cl|VAL}}("&B" + binvalue$){{InlineCodeEnd}}. {{PageAvailability}} @@ -74,10 +74,11 @@ Converting Bin value to Decimal: 255 {{PageSeeAlso}} -* [[HEX$]], [[OCT$]], [[STR$]], [[VAL]] -* [[&B]] {{text|(binary)}}, [[&H]] {{text|(hexadecimal)}}, [[&O]] {{text|(octal)}} +* [[HEX$]], [[OCT$]], [[STR$]] +* [[&B]] (binary), [[&H]] (hexadecimal), [[&O]] (octal), [[VAL]] * [[Base Comparisons]] {{PageNavigation}} +[[Category:Final]] diff --git a/internal/help/_BIT__111.txt b/internal/help/_BIT__111.txt index 689f424b4..d102d048b 100644 --- a/internal/help/_BIT__111.txt +++ b/internal/help/_BIT__111.txt @@ -1,5 +1,5 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:06:38}} +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:36:18}} {{DISPLAYTITLE:_BIT}} The [[_BIT]] datatype can return only values of 0 (bit off) and -1 (bit on). @@ -91,4 +91,3 @@ RShift = {{Cl|INT}}(n / (2 ^ RS)) {{PageNavigation}} - diff --git a/internal/help/_BLEND_(function)__11111_(00000000).txt b/internal/help/_BLEND_(function)__11111_(00000000).txt index ed3cb410c..af1e0760d 100644 --- a/internal/help/_BLEND_(function)__11111_(00000000).txt +++ b/internal/help/_BLEND_(function)__11111_(00000000).txt @@ -1,5 +1,5 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:06:41}} +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:36:22}} {{DISPLAYTITLE:_BLEND (function)}} The [[_BLEND (function)|_BLEND]] function returns enabled or disabled for the current window or a specified image handle when 32 bit. @@ -20,3 +20,4 @@ The [[_BLEND (function)|_BLEND]] function returns enabled or disabled for the cu {{PageNavigation}} +[[Category:Latest]] diff --git a/internal/help/_BLEND__11111.txt b/internal/help/_BLEND__11111.txt index 14f0dcadf..baca34eb0 100644 --- a/internal/help/_BLEND__11111.txt +++ b/internal/help/_BLEND__11111.txt @@ -1,5 +1,5 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:06:40}} +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:36:21}} {{DISPLAYTITLE:_BLEND}} The [[_BLEND]] statement turns on 32 bit alpha blending for an image or screen mode and is on by default. @@ -56,4 +56,3 @@ m& = {{Cl|POINT}}(303, 302) {{PageNavigation}} - diff --git a/internal/help/_BLINK_(function)__11111_(00000000).txt b/internal/help/_BLINK_(function)__11111_(00000000).txt index a72f5ea1d..9e237b7c1 100644 --- a/internal/help/_BLINK_(function)__11111_(00000000).txt +++ b/internal/help/_BLINK_(function)__11111_(00000000).txt @@ -1,5 +1,5 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:06:44}} +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:36:25}} {{DISPLAYTITLE:_BLINK (function)}} The [[_BLINK]] function returns the current blink setting for SCREEN 0 colors. If enabled, returns -1 (default), otherwise returns 0. @@ -32,4 +32,3 @@ The [[_BLINK]] function returns the current blink setting for SCREEN 0 colors. I * [[OUT]] {{PageNavigation}} - diff --git a/internal/help/_BLINK__11111.txt b/internal/help/_BLINK__11111.txt index 174ccb1b9..2b138f359 100644 --- a/internal/help/_BLINK__11111.txt +++ b/internal/help/_BLINK__11111.txt @@ -1,5 +1,5 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:06:43}} +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:36:24}} {{DISPLAYTITLE:_BLINK}} The [[_BLINK]] statement toggles blinking colors in text mode (SCREEN 0). Default state is ON. @@ -35,4 +35,3 @@ The [[_BLINK]] statement toggles blinking colors in text mode (SCREEN 0). Defaul * [[_DISPLAY]] {{PageNavigation}} - diff --git a/internal/help/_BLUE32__111132.txt b/internal/help/_BLUE32__111132.txt index 99853a921..906b546b1 100644 --- a/internal/help/_BLUE32__111132.txt +++ b/internal/help/_BLUE32__111132.txt @@ -1,5 +1,5 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:06:46}} +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:36:27}} {{DISPLAYTITLE:_BLUE32}} The [[_BLUE32]] function returns the blue component intensity of a 32-bit image or surface color. @@ -25,3 +25,4 @@ The [[_BLUE32]] function returns the blue component intensity of a 32-bit image {{PageNavigation}} +[[Category:Latest]] diff --git a/internal/help/_BLUE__1111.txt b/internal/help/_BLUE__1111.txt index f159b192e..ea2bbf487 100644 --- a/internal/help/_BLUE__1111.txt +++ b/internal/help/_BLUE__1111.txt @@ -1,5 +1,5 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:06:45}} +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:36:26}} {{DISPLAYTITLE:_BLUE}} The [[_BLUE]] function returns the palette intensity or the blue component intensity of a 32-bit image color. @@ -32,3 +32,4 @@ The [[_BLUE]] function returns the palette intensity or the blue component inten {{PageNavigation}} +[[Category:Latest]] diff --git a/internal/help/_BUTTONCHANGE__111111111111.txt b/internal/help/_BUTTONCHANGE__111111111111.txt index b94c3f4b2..e2b1f1a93 100644 --- a/internal/help/_BUTTONCHANGE__111111111111.txt +++ b/internal/help/_BUTTONCHANGE__111111111111.txt @@ -1,5 +1,5 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:06:49}} +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:36:29}} {{DISPLAYTITLE:_BUTTONCHANGE}} The [[_BUTTONCHANGE]] function returns -1 or 1 when a specified button number on a controller device has been pressed or released. @@ -53,4 +53,3 @@ The [[_BUTTONCHANGE]] function returns -1 or 1 when a specified button number on {{PageNavigation}} - diff --git a/internal/help/_BUTTON__111111.txt b/internal/help/_BUTTON__111111.txt index 19bb70716..388a7fd49 100644 --- a/internal/help/_BUTTON__111111.txt +++ b/internal/help/_BUTTON__111111.txt @@ -1,5 +1,5 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:06:47}} +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:36:28}} {{DISPLAYTITLE:_BUTTON}} The [[_BUTTON]] function returns -1 when specified button number on a controller device is pressed. @@ -53,4 +53,3 @@ The [[_BUTTON]] function returns -1 when specified button number on a controller {{PageNavigation}} - diff --git a/internal/help/_BYTE__1111.txt b/internal/help/_BYTE__1111.txt index 3f15e0e7e..01cde9943 100644 --- a/internal/help/_BYTE__1111.txt +++ b/internal/help/_BYTE__1111.txt @@ -1,5 +1,5 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:06:50}} +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:36:30}} {{DISPLAYTITLE:_BYTE}} A [[_BYTE]] variable can hold signed variable values from -128 to 127 (one byte or 8 [[_BIT]]s). [[_UNSIGNED|Unsigned]] from 0 to 255. @@ -102,4 +102,3 @@ The most significant bit is furthest to the left. {{PageNavigation}} - diff --git a/internal/help/_CAPSLOCK_(function)__11111111_(00000000).txt b/internal/help/_CAPSLOCK_(function)__11111111_(00000000).txt index 2167a76e0..a36a57a72 100644 --- a/internal/help/_CAPSLOCK_(function)__11111111_(00000000).txt +++ b/internal/help/_CAPSLOCK_(function)__11111111_(00000000).txt @@ -1,5 +1,5 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:06:51}} +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:36:31}} {{DISPLAYTITLE:_CAPSLOCK (function)}} The [[_CAPSLOCK (function)| _CAPSLOCK]] function returns the current state of the Caps Lock key as on (-1) or off (0). @@ -20,4 +20,3 @@ The [[_CAPSLOCK (function)| _CAPSLOCK]] function returns the current state of th {{PageNavigation}} - diff --git a/internal/help/_CAPSLOCK__11111111.txt b/internal/help/_CAPSLOCK__11111111.txt index aa2f297b5..67eb28f7d 100644 --- a/internal/help/_CAPSLOCK__11111111.txt +++ b/internal/help/_CAPSLOCK__11111111.txt @@ -1,5 +1,5 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:06:52}} +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:36:33}} {{DISPLAYTITLE:_CAPSLOCK}} The [[_CAPSLOCK]] statement sets the state of the Caps Lock key. @@ -20,4 +20,3 @@ The [[_CAPSLOCK]] statement sets the state of the Caps Lock key. {{PageNavigation}} - diff --git a/internal/help/_CEIL__1111.txt b/internal/help/_CEIL__1111.txt index 76d4ce376..1245c16e3 100644 --- a/internal/help/_CEIL__1111.txt +++ b/internal/help/_CEIL__1111.txt @@ -1,5 +1,5 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:06:55}} +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:36:35}} {{DISPLAYTITLE:_CEIL}} The [[_CEIL]] function rounds a numeric value up to the next whole number or [[INTEGER]] value. @@ -36,4 +36,3 @@ PRINT INT(-2.5), CINT(-2.5), FIX(-2.5), _CEIL(-2.5) {{PageNavigation}} - diff --git a/internal/help/_CINP__1111.txt b/internal/help/_CINP__1111.txt index 2c844fd09..845321e03 100644 --- a/internal/help/_CINP__1111.txt +++ b/internal/help/_CINP__1111.txt @@ -1,5 +1,5 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:06:56}} +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:36:36}} {{DISPLAYTITLE:_CINP}} The [[_CINP]] function returns keyboard key press codes from a [[$CONSOLE]] window. Windows-only. @@ -60,3 +60,4 @@ The [[_CINP]] function returns keyboard key press codes from a [[$CONSOLE]] wind {{PageNavigation}} +[[Category:Latest]] diff --git a/internal/help/_CLEARCOLOR_(function)__1111111111_(00000000).txt b/internal/help/_CLEARCOLOR_(function)__1111111111_(00000000).txt index 641ff0f53..5037e1890 100644 --- a/internal/help/_CLEARCOLOR_(function)__1111111111_(00000000).txt +++ b/internal/help/_CLEARCOLOR_(function)__1111111111_(00000000).txt @@ -1,5 +1,5 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:06:57}} +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:36:37}} {{DISPLAYTITLE:_CLEARCOLOR (function)}} The [[_CLEARCOLOR (function)|_CLEARCOLOR]] function returns the current transparent color of an image or page. @@ -26,3 +26,4 @@ The [[_CLEARCOLOR (function)|_CLEARCOLOR]] function returns the current transpar {{PageNavigation}} +[[Category:Latest]] diff --git a/internal/help/_CLEARCOLOR__1111111111.txt b/internal/help/_CLEARCOLOR__1111111111.txt index 55cf9ba2d..e228ce525 100644 --- a/internal/help/_CLEARCOLOR__1111111111.txt +++ b/internal/help/_CLEARCOLOR__1111111111.txt @@ -1,5 +1,5 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:06:58}} +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:36:38}} {{DISPLAYTITLE:_CLEARCOLOR}} The [[_CLEARCOLOR]] statement sets a specific color to be treated as transparent when an image is later put (via [[_PUTIMAGE]]) onto another image. @@ -97,4 +97,3 @@ DO {{PageNavigation}} - diff --git a/internal/help/_CLIPBOARD$_(statement)__111111111$_(000000000).txt b/internal/help/_CLIPBOARD$_(statement)__111111111$_(000000000).txt index 747bcb81b..53a74ecc1 100644 --- a/internal/help/_CLIPBOARD$_(statement)__111111111$_(000000000).txt +++ b/internal/help/_CLIPBOARD$_(statement)__111111111$_(000000000).txt @@ -1,5 +1,5 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:07:02}} +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:36:42}} {{DISPLAYTITLE:_CLIPBOARD$ (statement)}} The [[_CLIPBOARD$ (statement)|_CLIPBOARD$]] statement copies the [[STRING]] value into the system clipboard. @@ -43,4 +43,3 @@ This is line 2 {{PageNavigation}} - diff --git a/internal/help/_CLIPBOARD$__111111111$.txt b/internal/help/_CLIPBOARD$__111111111$.txt index 805ccba35..dc32acbb4 100644 --- a/internal/help/_CLIPBOARD$__111111111$.txt +++ b/internal/help/_CLIPBOARD$__111111111$.txt @@ -1,5 +1,5 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:07:01}} +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:36:41}} {{DISPLAYTITLE:_CLIPBOARD$}} The [[_CLIPBOARD$]] function returns the current Operating System's clipboard contents as a [[STRING]]. @@ -143,4 +143,3 @@ K$ = {{Cl|UCASE$}}({{Cl|INPUT$}}(1)) {{PageNavigation}} - diff --git a/internal/help/_CLIPBOARDIMAGE_(function)__11111111111111_(00000000).txt b/internal/help/_CLIPBOARDIMAGE_(function)__11111111111111_(00000000).txt index 194cdb8fc..09081991f 100644 --- a/internal/help/_CLIPBOARDIMAGE_(function)__11111111111111_(00000000).txt +++ b/internal/help/_CLIPBOARDIMAGE_(function)__11111111111111_(00000000).txt @@ -1,5 +1,5 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:07:03}} +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:36:43}} {{DISPLAYTITLE:_CLIPBOARDIMAGE (function)}} The [[_CLIPBOARDIMAGE (function)|_CLIPBOARDIMAGE]] function pastes an image from the clipboard into a new 32-bit image in memory. @@ -51,4 +51,3 @@ The [[_CLIPBOARDIMAGE (function)|_CLIPBOARDIMAGE]] function pastes an image from {{PageNavigation}} - diff --git a/internal/help/_CLIPBOARDIMAGE__11111111111111.txt b/internal/help/_CLIPBOARDIMAGE__11111111111111.txt index c2a3eef17..4d0b813b7 100644 --- a/internal/help/_CLIPBOARDIMAGE__11111111111111.txt +++ b/internal/help/_CLIPBOARDIMAGE__11111111111111.txt @@ -1,5 +1,5 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:07:05}} +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:36:44}} {{DISPLAYTITLE:_CLIPBOARDIMAGE}} The [[_CLIPBOARDIMAGE]] statement copies a valid QB64 image to the clipboard. @@ -56,4 +56,3 @@ PRINT "Image copied to clipboard." {{PageNavigation}} - diff --git a/internal/help/_CLIP__1111.txt b/internal/help/_CLIP__1111.txt index f1c8dd5ac..686c00668 100644 --- a/internal/help/_CLIP__1111.txt +++ b/internal/help/_CLIP__1111.txt @@ -1,5 +1,5 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:07:00}} +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:36:39}} {{DISPLAYTITLE:_CLIP}} The [[_CLIP]] option is used in a QB64 graphics [[PUT (graphics statement)|PUT]] to allow placement of an image partially off of the screen. @@ -50,3 +50,4 @@ The [[_CLIP]] option is used in a QB64 graphics [[PUT (graphics statement)|PUT]] {{PageNavigation}} +[[Category:Latest]] diff --git a/internal/help/_COMMANDCOUNT__111111111111.txt b/internal/help/_COMMANDCOUNT__111111111111.txt index 2157a3bab..c801a9c1a 100644 --- a/internal/help/_COMMANDCOUNT__111111111111.txt +++ b/internal/help/_COMMANDCOUNT__111111111111.txt @@ -1,5 +1,5 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:07:07}} +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:36:47}} {{DISPLAYTITLE:_COMMANDCOUNT}} The [[_COMMANDCOUNT]] function returns the number or arguments passed from the command line to the [[COMMAND$]] function. @@ -31,3 +31,4 @@ The [[_COMMANDCOUNT]] function returns the number or arguments passed from the c {{PageNavigation}} +[[Category:Latest]] diff --git a/internal/help/_CONNECTED__111111111.txt b/internal/help/_CONNECTED__111111111.txt index 03d125e07..88b00af9f 100644 --- a/internal/help/_CONNECTED__111111111.txt +++ b/internal/help/_CONNECTED__111111111.txt @@ -1,5 +1,5 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:07:08}} +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:36:48}} {{DISPLAYTITLE:_CONNECTED}} The [[_CONNECTED]] function returns the status of a TCP/IP connection handle. @@ -26,3 +26,4 @@ The [[_CONNECTED]] function returns the status of a TCP/IP connection handle. {{PageNavigation}} +[[Category:Latest]] diff --git a/internal/help/_CONNECTIONADDRESS$__11111111111111111$.txt b/internal/help/_CONNECTIONADDRESS$__11111111111111111$.txt index 3f2c25b17..5b38c726b 100644 --- a/internal/help/_CONNECTIONADDRESS$__11111111111111111$.txt +++ b/internal/help/_CONNECTIONADDRESS$__11111111111111111$.txt @@ -1,11 +1,11 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:07:09}} -{{DISPLAYTITLE:_CONNECTIONADDRESS}} -The [[_CONNECTIONADDRESS]] function returns a connected user's [[STRING]] IP address value. +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:36:49}} +{{DISPLAYTITLE:_CONNECTIONADDRESS$}} +The [[_CONNECTIONADDRESS$]] function returns a connected user's [[STRING]] IP address value. {{PageSyntax}} -:{{Parameter|result$}} = [[_CONNECTIONADDRESS|_CONNECTIONADDRESS[$]]]({{Parameter|connectionHandle&}}) +:{{Parameter|result$}} = [[_CONNECTIONADDRESS$]]({{Parameter|connectionHandle&}}) {{PageDescription}} @@ -13,7 +13,6 @@ The [[_CONNECTIONADDRESS]] function returns a connected user's [[STRING]] IP add * For '''[[_OPENHOST|HOST]]s''': It may return "TCP/IP:8080:213.23.32.5" where 8080 is the port it is listening on and 213.23.32.5 is the global IP address which any computer connected to the internet could use to locate your computer. If a connection to the internet is unavailable or your firewall blocks it, it returns your 'local IP' address (127.0.0.1). You might like to store this address somewhere where other computers can find it and connect to your host. Dynamic IPs which can change will need to be updated. * For '''[[_OPENCLIENT|CLIENT]]s''': It may return "TCP/IP:8080:213.23.32.5" where 8080 is the port it used to connect to the listening host and 213.23.32.5 is the IP address of the host name it resolved. * For '''[[_OPENCONNECTION|CONNECTION]]s''' (from clients): It may return "TCP/IP:8080:34.232.321.25" where 8080 was the host listening port it connected to and 34.232.321.25 is the IP address of the client that connected. This is very useful because the host can log the IP address of clients for future reference (or banning, for example). -* The $ sygil is optional for compatibility with older versions. {{PageExamples}} @@ -27,7 +26,7 @@ newclient = {{Cl|_OPENCONNECTION}}(host) ' receive any new client connection han {{Cl|IF...THEN|IF}} newclient {{Cl|THEN}} numclients = numclients + 1 ' increment index Users(numclients) = newclient ' place handle into array - IP$ = {{Cl|_CONNECTIONADDRESS}}(newclient) + IP$ = {{Cl|_CONNECTIONADDRESS$}}(newclient) {{Cl|PRINT}} IP$ + " has joined." ' displayed to Host only {{Cl|PRINT (file statement)|PRINT #f}}, IP$, numclients ' print info to a log file {{Cl|PRINT (file statement)|PRINT #}}Users(numclients),"Welcome!" ' from Host to new clients only @@ -45,4 +44,3 @@ newclient = {{Cl|_OPENCONNECTION}}(host) ' receive any new client connection han {{PageNavigation}} - diff --git a/internal/help/_CONSOLEINPUT__111111111111.txt b/internal/help/_CONSOLEINPUT__111111111111.txt index d5478bbfd..e879478d7 100644 --- a/internal/help/_CONSOLEINPUT__111111111111.txt +++ b/internal/help/_CONSOLEINPUT__111111111111.txt @@ -1,5 +1,5 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:07:13}} +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:36:53}} {{DISPLAYTITLE:_CONSOLEINPUT}} The [[_CONSOLEINPUT]] function is used to monitor any new mouse or keyboard input coming from a $CONSOLE window. It must be called in order for [[_CINP]] to return valid values. Windows-only. @@ -43,4 +43,3 @@ The [[_CONSOLEINPUT]] function is used to monitor any new mouse or keyboard inpu {{PageNavigation}} - diff --git a/internal/help/_CONSOLETITLE__111111111111.txt b/internal/help/_CONSOLETITLE__111111111111.txt index 2877d7ccc..8fcfe8fbd 100644 --- a/internal/help/_CONSOLETITLE__111111111111.txt +++ b/internal/help/_CONSOLETITLE__111111111111.txt @@ -1,5 +1,5 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:07:14}} +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:36:54}} {{DISPLAYTITLE:_CONSOLETITLE}} The [[_CONSOLETITLE]] statement creates the title of the console window using a literal or variable [[STRING|string]]. @@ -35,4 +35,3 @@ The [[_CONSOLETITLE]] statement creates the title of the console window using a {{PageNavigation}} - diff --git a/internal/help/_CONSOLE__1111111.txt b/internal/help/_CONSOLE__1111111.txt index ed04daee9..5eb451053 100644 --- a/internal/help/_CONSOLE__1111111.txt +++ b/internal/help/_CONSOLE__1111111.txt @@ -1,5 +1,5 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:07:12}} +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:36:51}} {{DISPLAYTITLE:_CONSOLE}} The [[_CONSOLE]] statement can be used to turn a console window ON/OFF. @@ -63,3 +63,4 @@ The [[_CONSOLE]] statement can be used to turn a console window ON/OFF. {{PageNavigation}} +[[Category:Latest]] diff --git a/internal/help/_CONTINUE__11111111.txt b/internal/help/_CONTINUE__11111111.txt index cb796c2ff..4c522c628 100644 --- a/internal/help/_CONTINUE__11111111.txt +++ b/internal/help/_CONTINUE__11111111.txt @@ -1,5 +1,5 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:07:16}} +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:36:55}} {{DISPLAYTITLE:_CONTINUE}} The [[_CONTINUE]] statement is used in a [[DO...LOOP]], [[WHILE...WEND]] or [[FOR...NEXT]] block to skip the remaining lines of code in a block (without exiting it) and start the next iteration. It works as a shortcut to a [[GOTO]], but without the need for a [[line numbers|line label]]. @@ -34,4 +34,3 @@ The [[_CONTINUE]] statement is used in a [[DO...LOOP]], [[WHILE...WEND]] or [[FO * [[GOTO]] {{PageNavigation}} - diff --git a/internal/help/_CONTROLCHR_(function)__1111111111_(00000000).txt b/internal/help/_CONTROLCHR_(function)__1111111111_(00000000).txt index d876da508..a7d10a6cf 100644 --- a/internal/help/_CONTROLCHR_(function)__1111111111_(00000000).txt +++ b/internal/help/_CONTROLCHR_(function)__1111111111_(00000000).txt @@ -1,5 +1,5 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:07:18}} +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:36:57}} {{DISPLAYTITLE:_CONTROLCHR (function)}} The [[_CONTROLCHR (function)|_CONTROLCHR]] function returns the current state of the [[_CONTROLCHR]] statement as -1 when OFF and 0 when ON. @@ -25,3 +25,4 @@ The [[_CONTROLCHR (function)|_CONTROLCHR]] function returns the current state of {{PageNavigation}} +[[Category:Latest]] diff --git a/internal/help/_CONTROLCHR__1111111111.txt b/internal/help/_CONTROLCHR__1111111111.txt index fec4fe36f..74b6442d5 100644 --- a/internal/help/_CONTROLCHR__1111111111.txt +++ b/internal/help/_CONTROLCHR__1111111111.txt @@ -1,5 +1,5 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:07:17}} +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:36:56}} {{DISPLAYTITLE:_CONTROLCHR}} The [[_CONTROLCHR]] statement can be used to turn OFF control character attributes and allow them to be printed. @@ -50,3 +50,4 @@ DO {{PageNavigation}} +[[Category:Latest]] diff --git a/internal/help/_COPYIMAGE__111111111.txt b/internal/help/_COPYIMAGE__111111111.txt index e767b7f95..60ae58bbc 100644 --- a/internal/help/_COPYIMAGE__111111111.txt +++ b/internal/help/_COPYIMAGE__111111111.txt @@ -1,16 +1,16 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:07:19}} +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:36:58}} {{DISPLAYTITLE:_COPYIMAGE}} -The [[_COPYIMAGE]] function creates an identical designated image in memory with a different negative [[LONG]] handle value. +This function creates an identical designated image in memory with a different negative [[LONG]] handle value. {{PageSyntax}} -: newhandle& = [[_COPYIMAGE]][({{Parameter|imageHandle&}}[, {{Parameter|mode%}})]] +: newhandle& = [[_COPYIMAGE]]({{Parameter|imageHandle&}}[, {{Parameter|mode%}}]) {{Parameters}} * The [[LONG]] ''newhandle&'' value returned will be different than the source handle value supplied. -* If ''imageHandle&'' parameter is omitted or zero is designated, the current software [[_DEST|destination]] screen or image is copied. +* If ''imageHandle&'' is designated being zero, the current software [[_DEST|destination]] screen or image is copied. * If 1 is designated instead of an ''imageHandle&'', it designates the last OpenGL hardware surface to copy. * ''Mode'' 32 can be used to convert 256 color images to 32 bit colors. * ''Mode'' 33 images are hardware accelerated in '''version 1.000 and up''', and are created using [[_LOADIMAGE]] or [[_COPYIMAGE]]. @@ -22,15 +22,14 @@ The [[_COPYIMAGE]] function creates an identical designated image in memory with * Every attribute of the passed image or program screen is copied to a new handle value in memory. * '''32 bit screen surface backgrounds (black) have zero [[_ALPHA]] so that they are transparent when placed over other surfaces.''' : Use [[CLS]] or [[_DONTBLEND]] to make a new surface background [[_ALPHA]] 255 or opaque. -* '''Images are not deallocated when the [[SUB]] or [[FUNCTION]] they are created in ends. Free them with [[_FREEIMAGE]].''' +* '''Images are not deallocated when the [[SUB]] or [[FUNCTION]] they are created in ends. Free them with [[_FREEIMAGE]].''' * '''It is important to free discarded images with [[_FREEIMAGE]] to prevent PC memory allocation errors!''' * '''Do not try to free image handles currently being used as the active [[SCREEN]]. Change screen modes first.''' {{PageExamples}} -''Example:'' Restoring a Legacy SCREEN using the _COPYIMAGE return value. +;Example 1:Restoring a Legacy SCREEN using the _COPYIMAGE return value. {{CodeStart}} - {{Cl|SCREEN}} 13 {{Cl|CIRCLE}} (160, 100), 100, 40 DO: {{Cl|SLEEP}}: {{Cl|LOOP}} {{Cl|UNTIL}} {{Cl|INKEY$}} <> "" @@ -45,20 +44,21 @@ DO: {{Cl|SLEEP}}: {{Cl|LOOP}} {{Cl|UNTIL}} {{Cl|INKEY$}} <> "" {{Cl|SCREEN}} oldmode& 'restore original screen {{Cl|IF...THEN|IF}} s& < -1 THEN {{Cl|_FREEIMAGE}} s& -{{Cl|END}} +{{Cl|END}} {{CodeEnd}} -: ''Note:'' Only free valid handle values with [[_FREEIMAGE]] AFTER a new [[SCREEN]] mode is being used by the program. - - -''Example 2:'' Program that copies desktop to a hardware image to form a 3D triangle ('''version 1.000 and up'''): +{{small|Code courtesy of Galleon}} +;Note:Only free valid handle values with [[_FREEIMAGE]] AFTER a new [[SCREEN]] mode is being used by the program. +---- +;Example 2:Program that copies desktop to a hardware image to form a 3D triangle ('''version 1.000 and up'''): {{CodeStart}} {{Cl|SCREEN}} {{Cl|_NEWIMAGE}}(640, 480, 32) my_hardware_handle = {{Cl|_COPYIMAGE}}({{Cl|_SCREENIMAGE}}, 33) 'take a screenshot and use it as our texture {{Cl|_MAPTRIANGLE}} (0, 0)-(500, 0)-(250, 500), my_hardware_handle TO_ (-1, 0, -1)-(1, 0, -1)-(0, 5, -10), , _SMOOTH {{Cl|_DISPLAY}} -{{Cl|DO...LOOP|DO}}: {{Cl|_LIMIT}} 30: {{Cl|LOOP}} {{Cl|UNTIL}} {{Cl|INKEY$}} <> "" -{{CodeEnd}}{{small|Code courtesy of Galleon}} +{{Cl|DO...LOOP|DO}}: {{Cl|_LIMIT}} 30: {{Cl|LOOP}} {{Cl|UNTIL}} {{Cl|INKEY$}} <> "" +{{CodeEnd}} +{{small|Code courtesy of Galleon}} {{PageSeeAlso}} @@ -72,4 +72,3 @@ my_hardware_handle = {{Cl|_COPYIMAGE}}({{Cl|_SCREENIMAGE}}, 33) 'take a screensh {{PageNavigation}} - diff --git a/internal/help/_COPYPALETTE__11111111111.txt b/internal/help/_COPYPALETTE__11111111111.txt index e7e48ca7e..e69ea6736 100644 --- a/internal/help/_COPYPALETTE__11111111111.txt +++ b/internal/help/_COPYPALETTE__11111111111.txt @@ -1,5 +1,5 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:07:21}} +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:36:59}} {{DISPLAYTITLE:_COPYPALETTE}} The [[_COPYPALETTE]] statement copies the color palette intensities from one 4 or 8 BPP image to another image or a [[_NEWIMAGE]] screen page using 256 or less colors. @@ -31,3 +31,4 @@ The [[_COPYPALETTE]] statement copies the color palette intensities from one 4 o {{PageNavigation}} +[[Category:Latest]] diff --git a/internal/help/_CV__11.txt b/internal/help/_CV__11.txt index 744f11f34..7619b33f7 100644 --- a/internal/help/_CV__11.txt +++ b/internal/help/_CV__11.txt @@ -1,5 +1,5 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:07:23}} +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:37:01}} {{DISPLAYTITLE:_CV}} The [[_CV]] function is used to convert [[_MK$]], [[ASCII]], [[STRING]] values to numerical values. @@ -55,4 +55,3 @@ _CV: 2305843009213693952 {{PageNavigation}} - diff --git a/internal/help/_CWD$__111$.txt b/internal/help/_CWD$__111$.txt index 97e3efeb3..1770af689 100644 --- a/internal/help/_CWD$__111$.txt +++ b/internal/help/_CWD$__111$.txt @@ -1,5 +1,5 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:07:25}} +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:37:02}} {{DISPLAYTITLE:_CWD$}} The [[_CWD$]] function returns the current working directory path as a string value without a trailing path separator. @@ -51,3 +51,4 @@ And now we're back in C:\QB64 {{PageNavigation}} +[[Category:Latest]] diff --git a/internal/help/_D2G__121.txt b/internal/help/_D2G__121.txt index 02c5c681f..5a703a21d 100644 --- a/internal/help/_D2G__121.txt +++ b/internal/help/_D2G__121.txt @@ -1,5 +1,5 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:07:26}} +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:37:03}} {{DISPLAYTITLE:_D2G}} The [[_D2G]] function converts a '''degree''' value into a '''gradient''' value. @@ -34,4 +34,3 @@ That angle in Gradient is 66.66666 {{PageNavigation}} - diff --git a/internal/help/_D2R__121.txt b/internal/help/_D2R__121.txt index 460d0e81f..f16ed38b9 100644 --- a/internal/help/_D2R__121.txt +++ b/internal/help/_D2R__121.txt @@ -1,5 +1,5 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:07:27}} +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:37:04}} {{DISPLAYTITLE:_D2R}} The [[_D2R]] function converts a '''degree''' value into a '''radian''' value. @@ -34,4 +34,3 @@ That angle in Radians is 1.047198 {{PageNavigation}} - diff --git a/internal/help/_DEFAULTCOLOR__111111111111.txt b/internal/help/_DEFAULTCOLOR__111111111111.txt index 4a5c366cb..d4c453724 100644 --- a/internal/help/_DEFAULTCOLOR__111111111111.txt +++ b/internal/help/_DEFAULTCOLOR__111111111111.txt @@ -1,5 +1,5 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:07:33}} +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:37:09}} {{DISPLAYTITLE:_DEFAULTCOLOR}} The [[_DEFAULTCOLOR]] function returns the current default text color for an image handle or page. @@ -34,4 +34,3 @@ The [[_DEFAULTCOLOR]] function returns the current default text color for an ima {{PageNavigation}} - diff --git a/internal/help/_DEFINE__111111.txt b/internal/help/_DEFINE__111111.txt index 1f770083c..2dcffafae 100644 --- a/internal/help/_DEFINE__111111.txt +++ b/internal/help/_DEFINE__111111.txt @@ -1,5 +1,5 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:07:34}} +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:37:10}} {{DISPLAYTITLE:_DEFINE}} [[_DEFINE]] defines a set of variable names according to their first character as a specified data type. @@ -48,4 +48,3 @@ Add2 = one + two {{PageNavigation}} - diff --git a/internal/help/_DEFLATE$__1111111$.txt b/internal/help/_DEFLATE$__1111111$.txt index a33558b70..2b87e0982 100644 --- a/internal/help/_DEFLATE$__1111111$.txt +++ b/internal/help/_DEFLATE$__1111111$.txt @@ -1,5 +1,5 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:07:36}} +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:37:11}} {{DISPLAYTITLE:_DEFLATE$}} The [[_DEFLATE$]] function compresses a [[STRING|string]]. @@ -48,4 +48,3 @@ After using _INFLATE$ to decompress it, LEN = 1474560 {{PageNavigation}} - diff --git a/internal/help/_DELAY__11111.txt b/internal/help/_DELAY__11111.txt index 60bf38825..54f4beb4d 100644 --- a/internal/help/_DELAY__11111.txt +++ b/internal/help/_DELAY__11111.txt @@ -1,5 +1,5 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:07:37}} +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:37:12}} {{DISPLAYTITLE:_DELAY}} The [[_DELAY]] statement suspends program execution for a [[SINGLE]] value of seconds. @@ -21,4 +21,3 @@ The [[_DELAY]] statement suspends program execution for a [[SINGLE]] value of se {{PageNavigation}} - diff --git a/internal/help/_DEPTHBUFFER__11111111111.txt b/internal/help/_DEPTHBUFFER__11111111111.txt index ebd9bcabb..f4a77b89f 100644 --- a/internal/help/_DEPTHBUFFER__11111111111.txt +++ b/internal/help/_DEPTHBUFFER__11111111111.txt @@ -1,5 +1,5 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:07:39}} +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:37:13}} {{DISPLAYTITLE:_DEPTHBUFFER}} The [[_DEPTHBUFFER]] statement turns depth buffering ON or OFF, LOCKs or _CLEARS the buffer. @@ -28,3 +28,4 @@ The [[_DEPTHBUFFER]] statement turns depth buffering ON or OFF, LOCKs or _CLEARS {{PageNavigation}} +[[Category:Latest]] diff --git a/internal/help/_DESKTOPHEIGHT__1111111111111.txt b/internal/help/_DESKTOPHEIGHT__1111111111111.txt index b9de9b502..5639d42d6 100644 --- a/internal/help/_DESKTOPHEIGHT__1111111111111.txt +++ b/internal/help/_DESKTOPHEIGHT__1111111111111.txt @@ -1,5 +1,5 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:07:42}} +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:37:14}} {{DISPLAYTITLE:_DESKTOPHEIGHT}} The [[_DESKTOPHEIGHT]] function returns the height of the users current desktop. @@ -38,4 +38,3 @@ The [[_DESKTOPHEIGHT]] function returns the height of the users current desktop. {{PageNavigation}} - diff --git a/internal/help/_DESKTOPWIDTH__111111111111.txt b/internal/help/_DESKTOPWIDTH__111111111111.txt index e66de1b1f..3a4a3df3c 100644 --- a/internal/help/_DESKTOPWIDTH__111111111111.txt +++ b/internal/help/_DESKTOPWIDTH__111111111111.txt @@ -1,5 +1,5 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:07:43}} +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:37:15}} {{DISPLAYTITLE:_DESKTOPWIDTH}} The [[_DESKTOPWIDTH]] function returns the width of the users current desktop. @@ -38,4 +38,3 @@ The [[_DESKTOPWIDTH]] function returns the width of the users current desktop. {{PageNavigation}} - diff --git a/internal/help/_DEST_(function)__1111_(00000000).txt b/internal/help/_DEST_(function)__1111_(00000000).txt index 1c57378b4..266667a35 100644 --- a/internal/help/_DEST_(function)__1111_(00000000).txt +++ b/internal/help/_DEST_(function)__1111_(00000000).txt @@ -1,5 +1,5 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:07:45}} +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:37:18}} {{DISPLAYTITLE:_DEST (function)}} The [[_DEST]] function returns the handle value of the current write page (the image used for drawing). @@ -23,3 +23,4 @@ The [[_DEST]] function returns the handle value of the current write page (the i {{PageNavigation}} +[[Category:Latest]] diff --git a/internal/help/_DEST__1111.txt b/internal/help/_DEST__1111.txt index 7e6a08c8e..dc0e5917a 100644 --- a/internal/help/_DEST__1111.txt +++ b/internal/help/_DEST__1111.txt @@ -1,5 +1,5 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:07:44}} +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:37:17}} {{DISPLAYTITLE:_DEST}} The [[_DEST]] statement sets the current write image or page. All graphic and print changes will be done to this image. @@ -114,3 +114,4 @@ ya = ya + ym {{PageNavigation}} +[[Category:Latest]] diff --git a/internal/help/_DEVICE$__111111$.txt b/internal/help/_DEVICE$__111111$.txt index 9603ec61a..bb2be6466 100644 --- a/internal/help/_DEVICE$__111111$.txt +++ b/internal/help/_DEVICE$__111111$.txt @@ -1,5 +1,5 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:07:47}} +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:37:19}} {{DISPLAYTITLE:_DEVICE$}} The '''_DEVICE$''' function returns a [[STRING]] value holding the controller type, name and input types of the input devices on a computer. @@ -69,3 +69,4 @@ Buttons: 9 Axis: 6 Wheels: 0 {{PageNavigation}} +[[Category:Latest]] diff --git a/internal/help/_DEVICEINPUT__11111111111.txt b/internal/help/_DEVICEINPUT__11111111111.txt index 2e63203d8..de4012c57 100644 --- a/internal/help/_DEVICEINPUT__11111111111.txt +++ b/internal/help/_DEVICEINPUT__11111111111.txt @@ -1,5 +1,5 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:07:48}} +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:37:20}} {{DISPLAYTITLE:_DEVICEINPUT}} The '''_DEVICEINPUT''' function returns the device number when a controller device button, wheel or axis event occurs. @@ -108,4 +108,3 @@ controller: {{PageNavigation}} - diff --git a/internal/help/_DEVICES__1111111.txt b/internal/help/_DEVICES__1111111.txt index 8228816c6..0f965e4f0 100644 --- a/internal/help/_DEVICES__1111111.txt +++ b/internal/help/_DEVICES__1111111.txt @@ -1,5 +1,5 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:07:49}} +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:37:22}} {{DISPLAYTITLE:_DEVICES}} The [[_DEVICES]] function returns the number of INPUT devices on your computer including keyboard, mouse and game devices. @@ -46,3 +46,4 @@ Buttons: 3 {{PageNavigation}} +[[Category:Latest]] diff --git a/internal/help/_DIR$__111$.txt b/internal/help/_DIR$__111$.txt index 37aaaba59..3230ca666 100644 --- a/internal/help/_DIR$__111$.txt +++ b/internal/help/_DIR$__111$.txt @@ -1,5 +1,5 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:07:51}} +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:37:23}} {{DISPLAYTITLE:_DIR$}} The [[_DIR$]] function returns common paths in '''Windows''' only such as My Documents, My Pictures, My Music, Desktop. @@ -52,4 +52,3 @@ LOCAL APPLICATION DATA=C:\Documents and Settings\Administrator\Local Settings\Ap {{PageNavigation}} - diff --git a/internal/help/_DIREXISTS__111111111.txt b/internal/help/_DIREXISTS__111111111.txt index ac9168138..7220d9e00 100644 --- a/internal/help/_DIREXISTS__111111111.txt +++ b/internal/help/_DIREXISTS__111111111.txt @@ -1,5 +1,5 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:07:52}} +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:37:24}} {{DISPLAYTITLE:_DIREXISTS}} The [[_DIREXISTS]] function determines if a designated file path or folder exists and returns true (-1) or false (0). @@ -33,4 +33,3 @@ The [[_DIREXISTS]] function determines if a designated file path or folder exist {{PageNavigation}} - diff --git a/internal/help/_DISPLAYORDER__111111111111.txt b/internal/help/_DISPLAYORDER__111111111111.txt index 92be52f0b..6b503b36c 100644 --- a/internal/help/_DISPLAYORDER__111111111111.txt +++ b/internal/help/_DISPLAYORDER__111111111111.txt @@ -1,5 +1,5 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:07:56}} +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:37:28}} {{DISPLAYTITLE:_DISPLAYORDER}} The [[_DISPLAYORDER]] statement defines the order to render software, hardware and custom-OpenGL-code. @@ -40,4 +40,3 @@ The [[_DISPLAYORDER]] statement defines the order to render software, hardware a {{PageNavigation}} - diff --git a/internal/help/_DISPLAY_(function)__1111111_(00000000).txt b/internal/help/_DISPLAY_(function)__1111111_(00000000).txt index d54075c45..9439c3bb1 100644 --- a/internal/help/_DISPLAY_(function)__1111111_(00000000).txt +++ b/internal/help/_DISPLAY_(function)__1111111_(00000000).txt @@ -1,5 +1,5 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:07:55}} +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:37:27}} {{DISPLAYTITLE:_DISPLAY (function)}} The [[_DISPLAY]] function returns the handle of the current image that is displayed on the screen. @@ -51,3 +51,4 @@ SetupCursor {{PageNavigation}} +[[Category:Latest]] diff --git a/internal/help/_DISPLAY__1111111.txt b/internal/help/_DISPLAY__1111111.txt index 8b6986f84..2f1f58c03 100644 --- a/internal/help/_DISPLAY__1111111.txt +++ b/internal/help/_DISPLAY__1111111.txt @@ -1,5 +1,5 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:07:53}} +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:37:25}} {{DISPLAYTITLE:_DISPLAY}} The [[_DISPLAY]] statement turns off the automatic display while only displaying the screen changes when called. @@ -83,3 +83,4 @@ DO {{PageNavigation}} +[[Category:Latest]] diff --git a/internal/help/_DONTBLEND__111111111.txt b/internal/help/_DONTBLEND__111111111.txt index 0d42631f2..901b80093 100644 --- a/internal/help/_DONTBLEND__111111111.txt +++ b/internal/help/_DONTBLEND__111111111.txt @@ -1,5 +1,5 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:07:57}} +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:37:29}} {{DISPLAYTITLE:_DONTBLEND}} The [[_DONTBLEND]] statement turns off 32 bit alpha blending for the current image or screen mode where [[_BLEND]] is default. @@ -102,4 +102,3 @@ ph = 0 {{PageNavigation}} - diff --git a/internal/help/_DONTWAIT__11111111.txt b/internal/help/_DONTWAIT__11111111.txt index bad1a4ab7..67be74c93 100644 --- a/internal/help/_DONTWAIT__11111111.txt +++ b/internal/help/_DONTWAIT__11111111.txt @@ -1,5 +1,5 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:07:58}} +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:37:30}} {{DISPLAYTITLE:_DONTWAIT}} [[_DONTWAIT]] is used with the [[SHELL]] statement in '''QB64''' to specify that the program shouldn't wait until the external command/program is finished (which it otherwise does by default). @@ -41,4 +41,3 @@ {{PageNavigation}} - diff --git a/internal/help/_DROPPEDFILE__11111111111.txt b/internal/help/_DROPPEDFILE__11111111111.txt index b46accc74..291179d4d 100644 --- a/internal/help/_DROPPEDFILE__11111111111.txt +++ b/internal/help/_DROPPEDFILE__11111111111.txt @@ -1,5 +1,5 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:08:00}} +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:37:31}} {{DISPLAYTITLE:_DROPPEDFILE}} The [[_DROPPEDFILE]] function returns the list of items (files or folders) dropped in a program's window after [[_ACCEPTFILEDROP]] is enabled. @@ -63,4 +63,3 @@ The [[_DROPPEDFILE]] function returns the list of items (files or folders) dropp {{PageNavigation}} - diff --git a/internal/help/_ECHO__1111.txt b/internal/help/_ECHO__1111.txt index 1c9ff861f..88cb022a5 100644 --- a/internal/help/_ECHO__1111.txt +++ b/internal/help/_ECHO__1111.txt @@ -1,5 +1,5 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:08:01}} +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:37:32}} {{DISPLAYTITLE:_ECHO}} The [[_ECHO]] statement allows outputting text to a [[$CONSOLE]] window without having to alternate between [[_DEST]] pages. @@ -33,4 +33,3 @@ The [[_ECHO]] statement allows outputting text to a [[$CONSOLE]] window without {{PageNavigation}} - diff --git a/internal/help/_ENVIRONCOUNT__111111111111.txt b/internal/help/_ENVIRONCOUNT__111111111111.txt new file mode 100644 index 000000000..6f3084b80 --- /dev/null +++ b/internal/help/_ENVIRONCOUNT__111111111111.txt @@ -0,0 +1,26 @@ +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:37:37}} +{{DISPLAYTITLE:_ENVIRONCOUNT}} +The [[_ENVIRONCOUNT]] function returns the number of items (key/value pairs) currently stored in the system environment variables table. + + +{{PageSyntax}} +: {{Parameter|totalKeys&}} = [[_ENVIRONCOUNT]] + + +{{PageDescription}} +* Any changes made at runtime to the environment table are discarded when your program ends + + +{{PageAvailability}} +* '''QB64 2.0 and up''' (QB64 Team) +* '''QBPE 0.5 and up''' (QB64 Phoenix Edition) + + +{{PageSeeAlso}} +* [[ENVIRON$]], [[ENVIRON]] + + +{{PageNavigation}} + +[[Category:Latest]] diff --git a/internal/help/_ERRORLINE__111111111.txt b/internal/help/_ERRORLINE__111111111.txt index f20967c84..a0ee98ca5 100644 --- a/internal/help/_ERRORLINE__111111111.txt +++ b/internal/help/_ERRORLINE__111111111.txt @@ -1,5 +1,5 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:08:07}} +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:37:39}} {{DISPLAYTITLE:_ERRORLINE}} The [[_ERRORLINE]] function returns the source code line number that caused the most recent runtime error. @@ -37,4 +37,3 @@ DebugLine: {{PageNavigation}} - diff --git a/internal/help/_ERRORMESSAGE$__111111111111$.txt b/internal/help/_ERRORMESSAGE$__111111111111$.txt index 85b3f4272..c4f908823 100644 --- a/internal/help/_ERRORMESSAGE$__111111111111$.txt +++ b/internal/help/_ERRORMESSAGE$__111111111111$.txt @@ -1,5 +1,5 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:08:08}} +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:37:40}} {{DISPLAYTITLE:_ERRORMESSAGE$}} The [[_ERRORMESSAGE$]] function returns a human-readable description of the most recent runtime error, or the description of an arbitrary error code passed to it. @@ -43,3 +43,4 @@ The [[_ERRORMESSAGE$]] function returns a human-readable description of the most {{PageNavigation}} +[[Category:Latest]] diff --git a/internal/help/_EXIT_(function)__1111_(00000000).txt b/internal/help/_EXIT_(function)__1111_(00000000).txt index b8b80f495..2454cf97a 100644 --- a/internal/help/_EXIT_(function)__1111_(00000000).txt +++ b/internal/help/_EXIT_(function)__1111_(00000000).txt @@ -1,5 +1,5 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:08:11}} +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:37:42}} {{DISPLAYTITLE:_EXIT (function)}} The [[_EXIT]] function prevents the user from closing a program and indicates if a user has clicked the close button in the window title ('''X''' button) or used CTRL + BREAK. @@ -66,4 +66,3 @@ LOOP {{PageNavigation}} - diff --git a/internal/help/_FILEEXISTS__1111111111.txt b/internal/help/_FILEEXISTS__1111111111.txt index 4e0d484fa..7e2ca76b9 100644 --- a/internal/help/_FILEEXISTS__1111111111.txt +++ b/internal/help/_FILEEXISTS__1111111111.txt @@ -1,5 +1,5 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:08:12}} +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:37:43}} {{DISPLAYTITLE:_FILEEXISTS}} The '''_FILEEXISTS''' function determines if a designated file name exists and returns true (-1) or false (0). @@ -33,3 +33,4 @@ The '''_FILEEXISTS''' function determines if a designated file name exists and r {{PageNavigation}} +[[Category:Latest]] diff --git a/internal/help/_FINISHDROP__1111111111.txt b/internal/help/_FINISHDROP__1111111111.txt index 35f96092d..ef1260059 100644 --- a/internal/help/_FINISHDROP__1111111111.txt +++ b/internal/help/_FINISHDROP__1111111111.txt @@ -1,5 +1,5 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:08:14}} +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:37:44}} {{DISPLAYTITLE:_FINISHDROP}} The [[_FINISHDROP]] statement resets [[_TOTALDROPPEDFILES]] and clears the [[_DROPPEDFILE]] list of items (files/folders). @@ -56,4 +56,3 @@ The [[_FINISHDROP]] statement resets [[_TOTALDROPPEDFILES]] and clears the [[_DR {{PageNavigation}} - diff --git a/internal/help/_FLOAT__11111.txt b/internal/help/_FLOAT__11111.txt index b1445151e..a5ae80be3 100644 --- a/internal/help/_FLOAT__11111.txt +++ b/internal/help/_FLOAT__11111.txt @@ -1,5 +1,5 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:08:15}} +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:37:46}} {{DISPLAYTITLE:_FLOAT}} '''_FLOAT''' numerical values offer the maximum floating-point decimal precision available using '''QB64'''. @@ -18,7 +18,6 @@ * Floating decimal point numerical values cannot be [[_UNSIGNED]]. * Values can be converted to 32 byte [[ASCII]] strings using [[_MK$]] and back with [[_CV]]. * '''When a variable has not been assigned or has no type suffix, the value defaults to [[SINGLE]].''' -* Note: OpenGL's [[_GL_FLOAT]] constant is a [[SINGLE]] (4 byte) floating point number, while a native QB64 _FLOAT is a 10-byte floating point number. {{PageSeeAlso}} @@ -31,3 +30,4 @@ {{PageNavigation}} +[[Category:Latest]] diff --git a/internal/help/_FONTHEIGHT__1111111111.txt b/internal/help/_FONTHEIGHT__1111111111.txt index d49ce2e1f..5fe4fe9cf 100644 --- a/internal/help/_FONTHEIGHT__1111111111.txt +++ b/internal/help/_FONTHEIGHT__1111111111.txt @@ -1,5 +1,5 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:08:19}} +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:37:49}} {{DISPLAYTITLE:_FONTHEIGHT}} The [[_FONTHEIGHT]] function returns the font height of a font handle created by [[_LOADFONT]]. @@ -58,3 +58,4 @@ TextHeight& = {{Cl|_FONTHEIGHT}} 'can measure normal text block heights also {{PageNavigation}} +[[Category:Latest]] diff --git a/internal/help/_FONTWIDTH__111111111.txt b/internal/help/_FONTWIDTH__111111111.txt index 788baf8e0..8f135726f 100644 --- a/internal/help/_FONTWIDTH__111111111.txt +++ b/internal/help/_FONTWIDTH__111111111.txt @@ -1,5 +1,5 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:08:20}} +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:37:50}} {{DISPLAYTITLE:_FONTWIDTH}} The [[_FONTWIDTH]] function returns the font width of a MONOSPACE font handle created by [[_LOADFONT]]. @@ -24,3 +24,4 @@ The [[_FONTWIDTH]] function returns the font width of a MONOSPACE font handle cr {{PageNavigation}} +[[Category:Latest]] diff --git a/internal/help/_FONT_(function)__1111_(00000000).txt b/internal/help/_FONT_(function)__1111_(00000000).txt index f978687b6..47731121d 100644 --- a/internal/help/_FONT_(function)__1111_(00000000).txt +++ b/internal/help/_FONT_(function)__1111_(00000000).txt @@ -1,5 +1,5 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:08:18}} +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:37:48}} {{DISPLAYTITLE:_FONT (function)}} The [[_FONT]] function retrieves the font handle from the specified image handle or the current [[_DEST]]ination page's font. @@ -18,4 +18,3 @@ The [[_FONT]] function retrieves the font handle from the specified image handle {{PageNavigation}} - diff --git a/internal/help/_FONT__1111.txt b/internal/help/_FONT__1111.txt index 8c8821687..e2f75fc13 100644 --- a/internal/help/_FONT__1111.txt +++ b/internal/help/_FONT__1111.txt @@ -1,5 +1,5 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:08:16}} +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:37:47}} {{DISPLAYTITLE:_FONT}} The [[_FONT]] statement sets the current [[_LOADFONT]] function font handle to be used by [[PRINT]]. @@ -81,4 +81,3 @@ ClearFont: {{PageNavigation}} - diff --git a/internal/help/_FREEFONT__11111111.txt b/internal/help/_FREEFONT__11111111.txt index 805133dd3..ed2e021ea 100644 --- a/internal/help/_FREEFONT__11111111.txt +++ b/internal/help/_FREEFONT__11111111.txt @@ -1,5 +1,5 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:08:22}} +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:37:51}} {{DISPLAYTITLE:_FREEFONT}} The [[_FREEFONT]] statement frees a font handle that was created by [[_LOADFONT]]. @@ -100,3 +100,4 @@ ClearFont: {{PageNavigation}} +[[Category:Latest]] diff --git a/internal/help/_FREEIMAGE__111111111.txt b/internal/help/_FREEIMAGE__111111111.txt index fb830f687..195e4252a 100644 --- a/internal/help/_FREEIMAGE__111111111.txt +++ b/internal/help/_FREEIMAGE__111111111.txt @@ -1,5 +1,5 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:08:23}} +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:37:52}} {{DISPLAYTITLE:_FREEIMAGE}} The '''_FREEIMAGE''' statement releases the designated file image created by the [[_LOADIMAGE]], [[_NEWIMAGE]] or [[_COPYIMAGE]] functions from memory when they are no longer needed. @@ -41,3 +41,4 @@ s& = {{Cl|_LOADIMAGE}}("SPLASH.BMP",32) 'load 32 bit(24 BPP) image {{PageNavigation}} +[[Category:Latest]] diff --git a/internal/help/_FREETIMER__111111111.txt b/internal/help/_FREETIMER__111111111.txt index 2ec888be2..2f0490ac7 100644 --- a/internal/help/_FREETIMER__111111111.txt +++ b/internal/help/_FREETIMER__111111111.txt @@ -1,5 +1,5 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:08:24}} +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:37:54}} {{DISPLAYTITLE:_FREETIMER}} The [[_FREETIMER]] function returns a free [[TIMER]] number for multiple [[ON TIMER(n)]] events. @@ -20,3 +20,4 @@ The [[_FREETIMER]] function returns a free [[TIMER]] number for multiple [[ON TI {{PageNavigation}} +[[Category:Latest]] diff --git a/internal/help/_FULLSCREEN_(function)__1111111111_(00000000).txt b/internal/help/_FULLSCREEN_(function)__1111111111_(00000000).txt index a4c5f15a9..42a30fedc 100644 --- a/internal/help/_FULLSCREEN_(function)__1111111111_(00000000).txt +++ b/internal/help/_FULLSCREEN_(function)__1111111111_(00000000).txt @@ -1,5 +1,5 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:08:27}} +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:37:56}} {{DISPLAYTITLE:_FULLSCREEN (function)}} The [[_FULLSCREEN]] function returns the present full screen mode setting of the screen window. @@ -107,3 +107,4 @@ f& = currentf& {{PageNavigation}} +[[Category:Latest]] diff --git a/internal/help/_FULLSCREEN__1111111111.txt b/internal/help/_FULLSCREEN__1111111111.txt index 97f1f7d0d..44b9e94c5 100644 --- a/internal/help/_FULLSCREEN__1111111111.txt +++ b/internal/help/_FULLSCREEN__1111111111.txt @@ -1,5 +1,5 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:08:25}} +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:37:55}} {{DISPLAYTITLE:_FULLSCREEN}} The [[_FULLSCREEN]] statement attempts to make the program window fullscreen. @@ -135,4 +135,3 @@ ClearFont: {{PageNavigation}} - diff --git a/internal/help/_G2D__121.txt b/internal/help/_G2D__121.txt index ac90047fe..3e4a483ce 100644 --- a/internal/help/_G2D__121.txt +++ b/internal/help/_G2D__121.txt @@ -1,5 +1,5 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:08:28}} +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:37:57}} {{DISPLAYTITLE:_G2D}} The [[_G2D]] function converts a '''gradient''' value into a '''degree''' value. @@ -33,4 +33,3 @@ That angle in Degrees is 54 {{PageNavigation}} - diff --git a/internal/help/_G2R__121.txt b/internal/help/_G2R__121.txt index 8b767d562..ed67a0ac2 100644 --- a/internal/help/_G2R__121.txt +++ b/internal/help/_G2R__121.txt @@ -1,5 +1,5 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:08:29}} +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:37:58}} {{DISPLAYTITLE:_G2R}} The [[_G2R]] function converts a '''gradient''' value into a '''radian''' value. @@ -33,4 +33,3 @@ That angle in Radians is .9424778 {{PageNavigation}} - diff --git a/internal/help/_GLRENDER__11111111.txt b/internal/help/_GLRENDER__11111111.txt index b847d0277..8fe3181da 100644 --- a/internal/help/_GLRENDER__11111111.txt +++ b/internal/help/_GLRENDER__11111111.txt @@ -1,5 +1,5 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:08:31}} +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:37:59}} {{DISPLAYTITLE:_GLRENDER}} {{PageSyntax}} @@ -19,4 +19,3 @@ Mode can be: {{PageNavigation}} - diff --git a/internal/help/_GREEN32__1111132.txt b/internal/help/_GREEN32__1111132.txt index 8f657c7da..0e6e9b132 100644 --- a/internal/help/_GREEN32__1111132.txt +++ b/internal/help/_GREEN32__1111132.txt @@ -1,5 +1,5 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:08:33}} +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:38:01}} {{DISPLAYTITLE:_GREEN32}} The [[_GREEN32]] function returns the green component intensity of a 32-bit image or surface color. @@ -25,3 +25,4 @@ The [[_GREEN32]] function returns the green component intensity of a 32-bit imag {{PageNavigation}} +[[Category:Latest]] diff --git a/internal/help/_GREEN__11111.txt b/internal/help/_GREEN__11111.txt index 746161aae..9c25ff04c 100644 --- a/internal/help/_GREEN__11111.txt +++ b/internal/help/_GREEN__11111.txt @@ -1,5 +1,5 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:08:32}} +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:38:00}} {{DISPLAYTITLE:_GREEN}} The [[_GREEN]] function returns the palette index or the green component intensity of a 32-bit image color. @@ -32,3 +32,4 @@ The [[_GREEN]] function returns the palette index or the green component intensi {{PageNavigation}} +[[Category:Latest]] diff --git a/internal/help/_HEIGHT__111111.txt b/internal/help/_HEIGHT__111111.txt index 9a0e613e3..840893ea6 100644 --- a/internal/help/_HEIGHT__111111.txt +++ b/internal/help/_HEIGHT__111111.txt @@ -1,5 +1,5 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:08:34}} +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:38:03}} {{DISPLAYTITLE:_HEIGHT}} The [[_HEIGHT]] function returns the height of an image handle or of the current write page. @@ -25,3 +25,4 @@ The [[_HEIGHT]] function returns the height of an image handle or of the current {{PageNavigation}} +[[Category:Latest]] diff --git a/internal/help/_HIDE__1111.txt b/internal/help/_HIDE__1111.txt index 74b08b270..267e7c996 100644 --- a/internal/help/_HIDE__1111.txt +++ b/internal/help/_HIDE__1111.txt @@ -1,5 +1,5 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:08:36}} +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:38:04}} {{DISPLAYTITLE:_HIDE}} The [[_HIDE]] action is used to hide the console window opened by a [[SHELL]] statement. @@ -61,3 +61,4 @@ END SUB {{PageNavigation}} +[[Category:Latest]] diff --git a/internal/help/_HYPOT__11111.txt b/internal/help/_HYPOT__11111.txt index c976fecaa..45ff4f058 100644 --- a/internal/help/_HYPOT__11111.txt +++ b/internal/help/_HYPOT__11111.txt @@ -1,5 +1,5 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:08:37}} +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:38:05}} {{DISPLAYTITLE:_HYPOT}} The [[_HYPOT]] function returns the hypotenuse of a right-angled triangle whose legs are x and y. @@ -40,4 +40,3 @@ result = {{Cl|_HYPOT}}(leg_x, leg_y) {{PageNavigation}} - diff --git a/internal/help/_ICON__1111.txt b/internal/help/_ICON__1111.txt index 4cc7baaf9..e407b4450 100644 --- a/internal/help/_ICON__1111.txt +++ b/internal/help/_ICON__1111.txt @@ -1,5 +1,5 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:08:39}} +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:38:07}} {{DISPLAYTITLE:_ICON}} The [[_ICON]] statement uses an image handle from [[_LOADIMAGE]] for the program header and icon image in the OS. @@ -132,4 +132,3 @@ Icon2BMP = count ' return the number of icons available in the icon {{PageNavigation}} - diff --git a/internal/help/_INCLERRORFILE$__1111111111111$.txt b/internal/help/_INCLERRORFILE$__1111111111111$.txt index 1a950444d..5bb97d062 100644 --- a/internal/help/_INCLERRORFILE$__1111111111111$.txt +++ b/internal/help/_INCLERRORFILE$__1111111111111$.txt @@ -1,5 +1,5 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:08:41}} +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:38:08}} {{DISPLAYTITLE:_INCLERRORFILE$}} The [[_INCLERRORFILE$]] function returns the name of the original source code [[$INCLUDE]] module that caused the most recent error. @@ -54,4 +54,3 @@ ERROR 250 ON LINE: 9 {{PageNavigation}} - diff --git a/internal/help/_INCLERRORLINE__1111111111111.txt b/internal/help/_INCLERRORLINE__1111111111111.txt index b7403ef31..ab08bc7ca 100644 --- a/internal/help/_INCLERRORLINE__1111111111111.txt +++ b/internal/help/_INCLERRORLINE__1111111111111.txt @@ -1,5 +1,5 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:08:42}} +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:38:09}} {{DISPLAYTITLE:_INCLERRORLINE}} The [[_INCLERRORFILE$]] function returns the line number in an [[$INCLUDE]] file that caused the most recent error. @@ -56,4 +56,3 @@ ERROR 250 ON LINE: 9 {{PageNavigation}} - diff --git a/internal/help/_INFLATE$__1111111$.txt b/internal/help/_INFLATE$__1111111$.txt index 995e17218..abd4ece8b 100644 --- a/internal/help/_INFLATE$__1111111$.txt +++ b/internal/help/_INFLATE$__1111111$.txt @@ -1,5 +1,5 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:08:43}} +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:38:10}} {{DISPLAYTITLE:_INFLATE$}} The [[_INFLATE$]] function decompresses a [[STRING|string]] compressed by the [[_DEFLATE$]] function. @@ -48,4 +48,3 @@ After using _INFLATE$ to decompress it, LEN = 1474560 {{PageNavigation}} - diff --git a/internal/help/_INSTRREV__11111111.txt b/internal/help/_INSTRREV__11111111.txt index 8a1bd46dd..c0fa30b45 100644 --- a/internal/help/_INSTRREV__11111111.txt +++ b/internal/help/_INSTRREV__11111111.txt @@ -1,5 +1,5 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:08:45}} +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:38:12}} {{DISPLAYTITLE:_INSTRREV}} The [[_INSTRREV]] function searches for a substring inside another string, but unlike [[INSTR]] it searches from right to left. @@ -73,4 +73,3 @@ Total spaces found: 13 {{PageNavigation}} - diff --git a/internal/help/_INTEGER64__111111164.txt b/internal/help/_INTEGER64__111111164.txt index 05ec4f60f..e5bad405a 100644 --- a/internal/help/_INTEGER64__111111164.txt +++ b/internal/help/_INTEGER64__111111164.txt @@ -1,5 +1,5 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:08:46}} +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:38:13}} {{DISPLAYTITLE:_INTEGER64}} [[_INTEGER64]] is an 8 byte number type definition that can hold whole numerical values. @@ -29,3 +29,4 @@ {{PageNavigation}} +[[Category:Latest]] diff --git a/internal/help/_KEYCLEAR__11111111.txt b/internal/help/_KEYCLEAR__11111111.txt index 47df043bc..ab5d9015e 100644 --- a/internal/help/_KEYCLEAR__11111111.txt +++ b/internal/help/_KEYCLEAR__11111111.txt @@ -1,5 +1,5 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:08:47}} +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:38:14}} {{DISPLAYTITLE:_KEYCLEAR}} [[_KEYCLEAR]] clears all keyboard input buffers. @@ -57,4 +57,3 @@ PRINT "In _KEYHIT buffer, there is "; _KEYHIT 'read the _KEYHIT buffer {{PageNavigation}} - diff --git a/internal/help/_KEYDOWN__1111111.txt b/internal/help/_KEYDOWN__1111111.txt index 406a2b5ee..3e4ec73da 100644 --- a/internal/help/_KEYDOWN__1111111.txt +++ b/internal/help/_KEYDOWN__1111111.txt @@ -1,5 +1,5 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:08:50}} +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:38:17}} {{DISPLAYTITLE:_KEYDOWN}} The '''_KEYDOWN''' function returns whether modifying keys like CTRL, ALT, SHIFT, and any other keys are pressed. @@ -173,4 +173,3 @@ DO {{PageNavigation}} - diff --git a/internal/help/_KEYHIT__111111.txt b/internal/help/_KEYHIT__111111.txt index 0cbad9990..4970df010 100644 --- a/internal/help/_KEYHIT__111111.txt +++ b/internal/help/_KEYHIT__111111.txt @@ -1,5 +1,5 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:08:49}} +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:38:15}} {{DISPLAYTITLE:_KEYHIT}} The [[_KEYHIT]] function returns [[ASCII]] one and two byte, OpenGL Virtual Key and Unicode keyboard key press codes. @@ -116,4 +116,3 @@ unifont = {{Cl|_LOADFONT}}("cyberbit.ttf", 24, "UNICODE") {{PageNavigation}} - diff --git a/internal/help/_LASTAXIS__11111111.txt b/internal/help/_LASTAXIS__11111111.txt index db503b13a..d58b3e927 100644 --- a/internal/help/_LASTAXIS__11111111.txt +++ b/internal/help/_LASTAXIS__11111111.txt @@ -1,5 +1,5 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:08:52}} +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:38:19}} {{DISPLAYTITLE:_LASTAXIS}} The [[_LASTAXIS]] function returns the number of axis a specified number INPUT device on your computer has. @@ -45,3 +45,4 @@ Axis: 2 {{PageNavigation}} +[[Category:Latest]] diff --git a/internal/help/_LASTBUTTON__1111111111.txt b/internal/help/_LASTBUTTON__1111111111.txt index 04f0924f4..41ce0a397 100644 --- a/internal/help/_LASTBUTTON__1111111111.txt +++ b/internal/help/_LASTBUTTON__1111111111.txt @@ -1,5 +1,5 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:08:54}} +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:38:20}} {{DISPLAYTITLE:_LASTBUTTON}} The [[_LASTBUTTON]] function returns the number of buttons a specified INPUT device on your computer has. @@ -47,3 +47,4 @@ Buttons: 3 {{PageNavigation}} +[[Category:Latest]] diff --git a/internal/help/_LASTWHEEL__111111111.txt b/internal/help/_LASTWHEEL__111111111.txt index 1b8832f1e..3aa12a76f 100644 --- a/internal/help/_LASTWHEEL__111111111.txt +++ b/internal/help/_LASTWHEEL__111111111.txt @@ -1,5 +1,5 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:08:55}} +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:38:21}} {{DISPLAYTITLE:_LASTWHEEL}} The [[_LASTWHEEL]] function returns the number of wheels a specified number INPUT device on your computer has. @@ -44,3 +44,4 @@ Wheels: 3 {{PageNavigation}} +[[Category:Latest]] diff --git a/internal/help/_LIMIT__11111.txt b/internal/help/_LIMIT__11111.txt index c24258a1e..49c406c2f 100644 --- a/internal/help/_LIMIT__11111.txt +++ b/internal/help/_LIMIT__11111.txt @@ -1,5 +1,5 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:08:56}} +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:38:22}} {{DISPLAYTITLE:_LIMIT}} The [[_LIMIT]] statement sets the loop repeat rate of a program to so many per second, relinquishing spare CPU cycles to other applications. @@ -42,3 +42,4 @@ To Quit press ESC key! {{PageNavigation}} +[[Category:Latest]] diff --git a/internal/help/_LOADFONT__11111111.txt b/internal/help/_LOADFONT__11111111.txt index 552b03976..5b4f02b64 100644 --- a/internal/help/_LOADFONT__11111111.txt +++ b/internal/help/_LOADFONT__11111111.txt @@ -1,5 +1,5 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:08:58}} +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:38:24}} {{DISPLAYTITLE:_LOADFONT}} The [[_LOADFONT]] function loads a TrueType font (.TTF) or an OpenType font (.OTF) file in a specific size and style and returns a [[LONG]] font handle. @@ -28,7 +28,7 @@ The [[_LOADFONT]] function loads a TrueType font (.TTF) or an OpenType font (.OT * [[_PRINTWIDTH]] can measure the width of a string of text in '''graphics modes only'''. Use one character to get the font's width. -
'''Font Handles'''
+
'''Font Handles'''
* Multiple fonts will require multiple font variable handles unless used and freed consecutively. * Font handles with values greater than 0 that are '''no longer used''' should be freed using [[_FREEFONT]]. * '''Predefined QB64''' font handle numbers can be substituted before freeing a font handle: @@ -40,7 +40,7 @@ The [[_LOADFONT]] function loads a TrueType font (.TTF) or an OpenType font (.OT * Font handle values of -1 (load failure) '''do not''' need to be freed. '''An [[ERROR Codes|error]] will occur if you try to free invalid handles.''' -
'''Font File Specs'''
+
'''Font File Specs'''
* Windows users should find '''TTF''' font files in the C:\WINDOWS\FONTS folder, but don't depend on unusual ones being there. * '''Check the font file name. The name in the "viewer" is not necessarily the file's name. Use the name in properties (right click a font listed and choose Properties in the contextual menu)''' * If a program is on a different drive than Windows, [[ENVIRON$]]("SYSTEMROOT") will return the path to the "WINDOWS" folder. Normally "C:\WINDOWS". Then add the "\FONTS\" folder and the font '''.TTF''' filename to the path [[STRING]]. @@ -137,3 +137,4 @@ QuickUTF16toUTF32$ = b$ {{PageNavigation}} +[[Category:Latest]] diff --git a/internal/help/_LOADIMAGE__111111111.txt b/internal/help/_LOADIMAGE__111111111.txt index b36a40b14..60319f366 100644 --- a/internal/help/_LOADIMAGE__111111111.txt +++ b/internal/help/_LOADIMAGE__111111111.txt @@ -1,5 +1,5 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:08:59}} +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:38:25}} {{DISPLAYTITLE:_LOADIMAGE}} The [[_LOADIMAGE]] function loads an image into memory and returns valid [[LONG]] image handle values that are less than -1. @@ -92,4 +92,3 @@ DO {{PageNavigation}} - diff --git a/internal/help/_MAPTRIANGLE__11111111111.txt b/internal/help/_MAPTRIANGLE__11111111111.txt index 7b440ef89..2b90b4510 100644 --- a/internal/help/_MAPTRIANGLE__11111111111.txt +++ b/internal/help/_MAPTRIANGLE__11111111111.txt @@ -1,5 +1,5 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:09:00}} +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:38:26}} {{DISPLAYTITLE:_MAPTRIANGLE}} The [[_MAPTRIANGLE]] statement maps a triangular portion of an image onto a destination image or screen page. @@ -707,4 +707,3 @@ DO {{PageNavigation}} - diff --git a/internal/help/_MAPUNICODE_(function)__1111111111_(00000000).txt b/internal/help/_MAPUNICODE_(function)__1111111111_(00000000).txt index b32ac253a..11aa2b585 100644 --- a/internal/help/_MAPUNICODE_(function)__1111111111_(00000000).txt +++ b/internal/help/_MAPUNICODE_(function)__1111111111_(00000000).txt @@ -1,5 +1,5 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:09:03}} +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:38:29}} {{DISPLAYTITLE:_MAPUNICODE (function)}} The [[_MAPUNICODE]] function returns the [[Unicode]] (UTF-32) code point value of a mapped [[ASCII]] character code. @@ -40,3 +40,4 @@ Unicode&(ascii) = {{Cl|_MAPUNICODE (function)|_MAPUNICODE}}(ascii) 'read Uni {{PageNavigation}} +[[Category:Latest]] diff --git a/internal/help/_MAPUNICODE__1111111111.txt b/internal/help/_MAPUNICODE__1111111111.txt index 08ff08ffd..ab237f6be 100644 --- a/internal/help/_MAPUNICODE__1111111111.txt +++ b/internal/help/_MAPUNICODE__1111111111.txt @@ -1,5 +1,5 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:09:02}} +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:38:28}} {{DISPLAYTITLE:_MAPUNICODE}} The [[_MAPUNICODE]] statement maps a [[Unicode]] value to an [[ASCII]] character code value. @@ -62,3 +62,4 @@ Microsoft_pc_cpMIK: {{PageNavigation}} +[[Category:Latest]] diff --git a/internal/help/_MEMCOPY__1111111.txt b/internal/help/_MEMCOPY__1111111.txt index a3af87a25..37783478a 100644 --- a/internal/help/_MEMCOPY__1111111.txt +++ b/internal/help/_MEMCOPY__1111111.txt @@ -1,5 +1,5 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:09:07}} +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:38:32}} {{DISPLAYTITLE:_MEMCOPY}} The [[_MEMCOPY]] statement copies a block of bytes from one memory offset to another offset in memory. @@ -73,4 +73,3 @@ b$ = {{Cl|SPACE$}}(10) {{PageNavigation}} - diff --git a/internal/help/_MEMELEMENT__1111111111.txt b/internal/help/_MEMELEMENT__1111111111.txt index 682319f87..27e59c560 100644 --- a/internal/help/_MEMELEMENT__1111111111.txt +++ b/internal/help/_MEMELEMENT__1111111111.txt @@ -1,5 +1,5 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:09:08}} +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:38:33}} {{DISPLAYTITLE:_MEMELEMENT}} The [[_MEMELEMENT]] function returns a [[_MEM]] block referring to a variable's memory, but not past it. @@ -86,3 +86,4 @@ m2 = {{Cl|_MEMELEMENT}}(a(50)) 'function returns information about the specific {{PageNavigation}} +[[Category:Latest]] diff --git a/internal/help/_MEMEXISTS__111111111.txt b/internal/help/_MEMEXISTS__111111111.txt index 623394725..da796b0fb 100644 --- a/internal/help/_MEMEXISTS__111111111.txt +++ b/internal/help/_MEMEXISTS__111111111.txt @@ -1,5 +1,5 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:09:09}} +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:38:35}} {{DISPLAYTITLE:_MEMEXISTS}} The [[_MEMEXISTS]] function returns true (-1) if the memory block variable name specified exists in memory and false (0) if it does not. @@ -24,3 +24,4 @@ The [[_MEMEXISTS]] function returns true (-1) if the memory block variable name {{PageNavigation}} +[[Category:Latest]] diff --git a/internal/help/_MEMFILL__1111111.txt b/internal/help/_MEMFILL__1111111.txt index ae4d99beb..085603d74 100644 --- a/internal/help/_MEMFILL__1111111.txt +++ b/internal/help/_MEMFILL__1111111.txt @@ -1,5 +1,5 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:09:11}} +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:38:36}} {{DISPLAYTITLE:_MEMFILL}} The [[_MEMFILL]] statement converts a value to a specified type, then fills memory with that type including any non-whole remainder. @@ -48,4 +48,3 @@ mema = {{Cl|_MEM (function)|_MEM}}(b()) {{PageNavigation}} - diff --git a/internal/help/_MEMFREE__1111111.txt b/internal/help/_MEMFREE__1111111.txt index 5b27952e6..5c3803d99 100644 --- a/internal/help/_MEMFREE__1111111.txt +++ b/internal/help/_MEMFREE__1111111.txt @@ -1,5 +1,5 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:09:12}} +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:38:37}} {{DISPLAYTITLE:_MEMFREE}} The [[_MEMFREE]] statement frees the designated memory block [[_MEM]] value and must be used with all memory functions. @@ -27,4 +27,3 @@ The [[_MEMFREE]] statement frees the designated memory block [[_MEM]] value and {{PageNavigation}} - diff --git a/internal/help/_MEMGET_(function)__111111_(00000000).txt b/internal/help/_MEMGET_(function)__111111_(00000000).txt index f7e1daf09..ecd929c31 100644 --- a/internal/help/_MEMGET_(function)__111111_(00000000).txt +++ b/internal/help/_MEMGET_(function)__111111_(00000000).txt @@ -1,5 +1,5 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:09:14}} +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:38:39}} {{DISPLAYTITLE:_MEMGET (function)}} The [[_MEMGET]] function returns a value from a specific memory block name at the specified OFFSET using a certain variable type. @@ -45,4 +45,3 @@ v = {{Cl|_MEMGET (function)|_MEMGET}}(o, o.OFFSET + 1, {{Cl|_UNSIGNED}} {{Cl|_BY {{PageNavigation}} - diff --git a/internal/help/_MEMGET__111111.txt b/internal/help/_MEMGET__111111.txt index 1636ed5e2..13c15597c 100644 --- a/internal/help/_MEMGET__111111.txt +++ b/internal/help/_MEMGET__111111.txt @@ -1,5 +1,5 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:09:13}} +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:38:38}} {{DISPLAYTITLE:_MEMGET}} The [[_MEMGET]] statement reads a portion of a memory block at an OFFSET position into a variable, array or user defined type. @@ -52,4 +52,3 @@ m = {{Cl|_MEMIMAGE}} '0 or no handle necessary when accessing the current progr {{PageNavigation}} - diff --git a/internal/help/_MEMIMAGE__11111111.txt b/internal/help/_MEMIMAGE__11111111.txt index f59982753..fe0b11709 100644 --- a/internal/help/_MEMIMAGE__11111111.txt +++ b/internal/help/_MEMIMAGE__11111111.txt @@ -1,5 +1,5 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:09:16}} +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:38:41}} {{DISPLAYTITLE:_MEMIMAGE}} The [[_MEMIMAGE]] function returns a [[_MEM]] value referring to an image's memory using a designated image handle. @@ -91,4 +91,3 @@ x1$ = {{Cl|_MEMGET (function)|_MEMGET}}(m, m.OFFSET, {{Cl|STRING}} * 11) 'conver {{PageNavigation}} - diff --git a/internal/help/_MEMNEW__111111.txt b/internal/help/_MEMNEW__111111.txt index d81cca6f2..8b3e7afd5 100644 --- a/internal/help/_MEMNEW__111111.txt +++ b/internal/help/_MEMNEW__111111.txt @@ -1,5 +1,5 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:09:17}} +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:38:42}} {{DISPLAYTITLE:_MEMNEW}} The [[_MEMNEW]] function allocates new memory and returns a [[_MEM]] memory block referring to it. @@ -54,4 +54,3 @@ f = Doggy 5 {{OutputEnd}} {{PageNavigation}} - diff --git a/internal/help/_MEMPUT__111111.txt b/internal/help/_MEMPUT__111111.txt index 4723affe2..7553c5c9c 100644 --- a/internal/help/_MEMPUT__111111.txt +++ b/internal/help/_MEMPUT__111111.txt @@ -1,5 +1,5 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:09:18}} +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:38:43}} {{DISPLAYTITLE:_MEMPUT}} The [[_MEMPUT]] statement writes data to a portion of a designated memory block at an [[OFFSET]] position. @@ -43,4 +43,3 @@ v = {{Cl|_MEMGET (function)|_MEMGET}}(o, o.OFFSET + 1, {{Cl|_UNSIGNED}} {{Cl|_BY {{PageNavigation}} - diff --git a/internal/help/_MEMSOUND__11111111.txt b/internal/help/_MEMSOUND__11111111.txt new file mode 100644 index 000000000..c105d614a --- /dev/null +++ b/internal/help/_MEMSOUND__11111111.txt @@ -0,0 +1,93 @@ +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:38:44}} +{{DISPLAYTITLE:_MEMSOUND}} +The [[_MEMSOUND]] function returns a [[_MEM]] value referring to a sound's raw data in memory using a designated sound handle created by the [[_SNDOPEN]] function. + + +{{PageSyntax}} +: {{Parameter|soundBlock}} = [[_MEMSOUND]][({{Parameter|soundHandle&}}, {{Parameter|channel%}})] + + +{{PageParameters}} +* The {{Parameter|soundBlock}} [[_MEM]] type variable holds the read-only elements .OFFSET, .SIZE, .ELEMENTSIZE, and .SOUND. +** .ELEMENTSIZE will contain the number of bytes-per-sample the audio contains. Usually returns 2 (16-bit audio). +** .SOUND will contain the same handle value as returned by the [[_SNDOPEN]] function. +* The second parameter {{Parameter| channel%}} must be 1 (left channel/mono) or 2 (right channel, for stereo files). + + +{{PageDescription}} +* Use the function to access raw sound data in memory for direct access. +* Sound handle values and the memory used must still be freed using [[_SNDCLOSE]] when no longer required. +* If .SIZE returns 0, that means the data could not be accessed. It may happen if you try to access the right channel in a mono file, for example. + + +{{PageAvailability}} +* '''QB64 1.5 and up''' (QB64 Team) +* '''QBPE 0.5 and up''' (QB64 Phoenix Edition) + + +{{PageExamples}} +''Example 1:'' Checking that a sound file is stereo. +{{CodeStart}} +song& = {{Cl|_SNDOPEN}}("song.wav") 'replace song.wav with a sound file you have +{{Cl|IF}} song& = 0 {{Cl|THEN}} {{Cl|PRINT}} "Load failed.": {{Cl|END}} + +{{Cl|DIM}} leftchannel {{Cl|AS}} {{Cl|_MEM}}, rightchannel {{Cl|AS}} {{Cl|_MEM}} +leftchannel = {{Cl|_MEMSOUND}}(song&, 1) +rightchannel = {{Cl|_MEMSOUND}}(song&, 2) + +{{Cl|IF}} rightchannel.SIZE > 0 {{Cl|THEN}} {{Cl|PRINT}} "This file is STEREO" +{{Cl|IF}} rightchannel.SIZE = 0 {{Cl|AND}} leftchannel.SIZE > 0 {{Cl|THEN}} + {{Cl|PRINT}} "This file is MONO" +{{Cl|ELSEIF}} rightchannel.SIZE = 0 {{Cl|AND}} leftchannel.SIZE = 0 {{Cl|THEN}} + {{Cl|PRINT}} "An error occurred." +{{Cl|END IF}} + +{{Cl|_SNDCLOSE}} song& 'closing the sound releases the mem blocks +{{CodeEnd}} + + +''Example 2:'' Plotting a sound's waves. +{{CodeStart}} +{{Cl|SCREEN}} {{Cl|_NEWIMAGE}}(800, 327, 32) +song& = {{Cl|_SNDOPEN}}("drums.ogg") 'replace drums.ogg with a sound file you have +{{Cl|IF}} song& = 0 {{Cl|THEN}} {{Cl|PRINT}} "Load failed.": {{Cl|END}} + +{{Cl|DIM}} leftchannel {{Cl|AS}} {{Cl|_MEM}} +leftchannel = {{Cl|_MEMSOUND}}(song&, 1) + +{{Cl|IF}} leftchannel.SIZE = 0 {{Cl|THEN}} + {{Cl|PRINT}} "An error occurred." + {{Cl|END}} +{{Cl|END IF}} + +{{Cl|DIM}} i {{Cl|AS}} {{Cl|_OFFSET}} +i = 0 +{{Cl|DO}} + {{Cl|_MEMGET}} leftchannel, leftchannel.OFFSET + i, a% 'get sound data + {{Cl|LOCATE}} 1, 1: {{Cl|PRINT}} i; "/"; leftchannel.SIZE + {{Cl|LINE}} (x, {{Cl|_HEIGHT}} / 2)-{{Cl|STEP}}(0, a% / 100), {{Cl|_RGB32}}(0, 111, 0) 'plot wave + x = x + 1 + {{Cl|IF}} x > {{Cl|_WIDTH}} {{Cl|THEN}} + x = 0 + {{Cl|LINE}} (0, 0)-({{Cl|_WIDTH}}, {{Cl|_HEIGHT}}), {{Cl|_RGB32}}(0, 120), BF 'fade out screen + {{Cl|END}} {{Cl|IF}} + i = i + 2 + {{Cl|IF}} i + 2 > leftchannel.SIZE {{Cl|THEN}} {{Cl|EXIT}} {{Cl|DO}} + {{Cl|_LIMIT}} 500 +{{Cl|LOOP}} + +{{Cl|_SNDCLOSE}} song& 'closing the sound releases the mem blocks +{{CodeEnd}} + + +{{PageSeeAlso}} +* [[_MEM]], [[_MEMIMAGE]] +* [[_MEMNEW]] +* [[_MEMGET]], [[_MEMPUT]] +* [[_MEMFREE]] +* [[$CHECKING]] + +{{PageNavigation}} + +[[Category:Latest]] diff --git a/internal/help/_MEM_(function)__111_(00000000).txt b/internal/help/_MEM_(function)__111_(00000000).txt index de1edafb2..124e3ca63 100644 --- a/internal/help/_MEM_(function)__111_(00000000).txt +++ b/internal/help/_MEM_(function)__111_(00000000).txt @@ -1,5 +1,5 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:09:04}} +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:38:30}} {{DISPLAYTITLE:_MEM (function)}} The [[_MEM]] function returns a _MEM block referring to the largest possible continuous memory region beginning at a variable's offset. @@ -11,7 +11,7 @@ The [[_MEM]] function returns a _MEM block referring to the largest possible con : {{Parameter|memoryBlock}} = [[_MEM]]({{Parameter|offset}}, {{Parameter|byteSize}}) -{{Parameters}} +{{PageParameters}} * The {{Parameter|memoryBlock}} created will hold the {{Parameter|referenceVariable}} or [[arrays|array]] value(s), type and byte size in a separate memory area. * The secure syntax {{Parameter|referenceVariable}} is an existing variable's referenced memory block. * The unsecure syntax's designated {{Parameter|offset}} and {{Parameter|byteSize}} cannot be guaranteed. '''Avoid if possible.''' @@ -63,11 +63,11 @@ Saved(3) = n3 {{PageSeeAlso}} * [[_MEM]] {{text|(variable type)}} -* [[_MEMNEW]], [[_MEMCOPY]] -* [[_MEMGET]], [[_MEMPUT]] -* [[_MEMFILL]], [[_MEMIMAGE]] -* [[_MEMFREE]] +* [[_MEMNEW]], [[_MEMCOPY]], [[_MEMFREE]] +* [[_MEMGET]], [[_MEMPUT]], [[_MEMFILL]] +* [[_MEMIMAGE]], [[_MEMSOUND]] {{PageNavigation}} +[[Category:Latest]] diff --git a/internal/help/_MEM__111.txt b/internal/help/_MEM__111.txt index fd4a654b4..ef32d5c27 100644 --- a/internal/help/_MEM__111.txt +++ b/internal/help/_MEM__111.txt @@ -1,7 +1,7 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:09:05}} +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:38:31}} {{DISPLAYTITLE:_MEM}} -The [[_MEM]] variable type can be used when working with memory blocks. It has no variable [[type]] suffix. +The [[_MEM]] variable type can be used when working with memory blocks. It has no variable [[Variable Types|type]] suffix. {{PageSyntax}} @@ -10,43 +10,46 @@ The [[_MEM]] variable type can be used when working with memory blocks. It has n {{PageDescription}} ''Variable TYPE:'' -* Memory DOT values are actually part of the built in memory variable [[type]] in QB64. The following [[TYPE]] is built in: -{{WhiteStart}}TYPE memory_type +* Memory DOT values are actually part of the built in memory variable [[Variable Types|type]] in QB64. The following [[TYPE]] is built in: +{{WhiteStart}} +TYPE memory_type OFFSET AS _OFFSET 'start location of block(changes with byte position) SIZE AS _OFFSET 'size of block remaining at offset(changes with position) - TYPE AS LONG 'type description of variable used(never changes) + TYPE AS _OFFSET 'type description of variable used(never changes) ELEMENTSIZE AS _OFFSET 'byte size of values inside the block(never changes) IMAGE AS LONG 'the image handle used when _MEMIMAGE(handle) is used + SOUND AS LONG 'the sound handle used when _MEMSOUND(handle) is used END TYPE -{{text|The above [[TYPE]] is for clarification purposes only. It '''doesn't need''' to be pasted in a program to use _MEM.|red}} +{{text|The above [[TYPE]] is for clarification purposes only. It '''doesn't need''' to be pasted in
a program to use _MEM.|red}} -{{text|''IMPORTANT NOTE: As of Build 20170802/57 onward, mem.TYPE has been changed to be an _OFFSET, just as mem.SIZE and mem.ELEMENTSIZE.''|red}} +{{text|'''IMPORTANT NOTE:''' ''As of Build 20170802/57 onward (early v1.2 development), mem.TYPE has
been changed to be an _OFFSET, just as mem.SIZE and mem.ELEMENTSIZE.''|red}} {{WhiteEnd}} ===Usage=== * The _MEM type contains the following '''read-only''' elements where ''name'' is the _MEM variable name: :: ''name'''''.OFFSET''' is the current start position in the memory block AS [[_OFFSET]]. Add bytes to change position. :: ''name'''''.SIZE''' is the remaining size of the block at current position in bytes AS [[_OFFSET]] -:: ''name'''''.TYPE''' is the type (represented as bits combined to form a value) AS [[LONG]]: +:: ''name'''''.TYPE''' is the type (represented as bits combined to form a value) AS [[_OFFSET]]: ==.TYPE values (version 1.000 and up)== -:::* 0 = UDT ([[TYPE|user defined type]]) or memory created by [[_MEMNEW]] -:::* 1 = 1 bit ELEMENT.SIZE=1 *Only used along with specific types (currently integers or floats) -:::* 2 = 2 bit. ELEMENT.SIZE=2 * -:::* 4 = 4 bit. ELEMENT.SIZE=4 * -:::* 8 = 8 bit. ELEMENT.SIZE=8 * -:::* 16 = 16 bit. ELEMENT.SIZE=16 * -:::* 32 = 32 bit. ELEMENT.SIZE=32 * -:::* 64 = 64 bit. ELEMENT.SIZE=64 * -:::* 128 = 128 bit. ELEMENT.SIZE=128 * -:::* 256 = 256 bit. ELEMENT.SIZE=256 * -:::* 512(+ bit*) = integer types only(ie. whole numbers) -:::* 1024(+ bit*) = floating point types only(ie. numbers that can have a decimal point) -:::* 2048 = [[STRING]] type only -:::* 4096(+ 512 + bit*) = [[_UNSIGNED]] integer type only -:::* 8192 = [[_MEM]] type only -:::* 16384(+ 512 + bit*)= [[_OFFSET]] type only +:::* [bit 0] 1* byte types (_BYTE) +:::* [bit 1] 2* byte types (INTEGER) +:::* [bit 2] 4* byte types (LONG or SINGLE) +:::* [bit 3] 8* byte types (DOUBLE or _INTEGER64) +:::* [bit 4] 16* byte types (reserved for future use) +:::* [bit 5] 32* byte types (_FLOAT) +:::* [bit 6] 64* byte types (reserved for future use) +:::* [bit 7] 128 = integer types (_BYTE, INTEGER, LONG, _INTEGER64) (added to *) +:::* [bit 8] 256 = floating point types (SINGLE, DOUBLE, _FLOAT) (added to *) +:::* [bit 9] 512 = STRING types (fixed length or variable length) +:::* [bit 10] 1024 = _UNSIGNED types (added to *+128) +:::* [bit 11] 2048 = pixel data usually from _MEMIMAGE (added to 1+128+1024 for 256 color screens, or 2+128+1024 for text screens, or 4+128+1024 for 32-bit color screens) +:::* [bit 12] 4096 = _MEM TYPE structure (NOT added to 32768) +:::* [bit 13] 8192 = _OFFSET type (added to 4+128+[1024] or 8+128+[1024] or future_size+128+[1024]) +:::* [bit 14] 16384 = data created/defined by _MEMNEW(size) or _MEMNEW(offset,size) +:::* [bit 15] 32768 = a custom, user defined type (ie. created with TYPE name ... END TYPE) +:::* [bit 16] 65536 = an array of data (added to other type values defining the array's data type) ''Note: If a future integer, float or other type doesn't have a size that is 1,2,4,8,16,32,64,128 or 256 it won't have a size-bit set.'' ===Versions prior to 1.000=== @@ -57,7 +60,7 @@ END TYPE :::* 8 = [[STRING]] :::* 0 = unknown(eg. created with [[_MEMNEW]]) or [[TYPE|user-defined-types]] -* '''Note: [[_OFFSET]] values cannot be cast to other variable [[type]]s reliably. _MEM is a reserved custom variable [[type]].''' +* '''Note: [[_OFFSET]] values cannot be cast to other variable [[Variable Types|type]]s reliably. _MEM is a reserved custom variable [[Variable Types|type]].''' * '''[[_MEM (function)|_MEM]] cannot reference variable length [[STRING]] variable values. String values must be designated as a fixed-[[LEN|length]] string.''' @@ -139,17 +142,17 @@ END FUNCTION {{CodeEnd}} -''Explanation:'' The above will print two numbers for us which should match. These numbers will vary, as they're representations of where X is stored in memory, and that position is going to vary every time the program is run. What it should illustrate, however, is a way to convert _OFFSET to _INTEGER64 values, which can sometimes be useful when trying to run calculations involving mem.SIZE, mem.TYPE, or mem.ELEMENTSIZE. +''Explanation:'' The above will print two numbers which should match. These numbers will vary, as they're representations of where X is stored in memory, and that position is going to vary every time the program is run. What it should illustrate, however, is a way to convert _OFFSET to _INTEGER64 values, which can sometimes be useful when trying to run calculations involving mem.SIZE, mem.TYPE, or mem.ELEMENTSIZE. {{PageSeeAlso}} -* [[_MEM (function)]] -* [[_MEMELEMENT]], [[_MEMCOPY]] -* [[_MEMIMAGE]], [[_MEMNEW]] -* [[_MEMGET]], [[_MEMPUT]] -* [[_MEMFILL]], [[_MEMFREE]] +* [[_MEM (function)]], [[_MEMELEMENT]] +* [[_MEMNEW]], [[_MEMCOPY]], [[_MEMFREE]] +* [[_MEMGET]], [[_MEMPUT]], [[_MEMFILL]] +* [[_MEMIMAGE]], [[_MEMSOUND]] {{PageNavigation}} +[[Category:Latest]] diff --git a/internal/help/_MK$__11$.txt b/internal/help/_MK$__11$.txt index 31946f30b..1a33c0495 100644 --- a/internal/help/_MK$__11$.txt +++ b/internal/help/_MK$__11$.txt @@ -1,6 +1,6 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:09:21}} -{{DISPLAYTITLE:_MK$}}{{DISPLAYTITLE:}} +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:38:47}} +{{DISPLAYTITLE:_MK$}} The [[_MK$]] function can convert any numerical type into an [[ASCII]] [[STRING]] value that can be converted back using [[_CV]]. @@ -30,5 +30,4 @@ The [[_MK$]] function can convert any numerical type into an [[ASCII]] [[STRING] * [[PDS(7.1) Procedures#CURRENCY|CURRENCY]] -{{PageNavigation}}{{DISPLAYTITLE:}} - +{{PageNavigation}} diff --git a/internal/help/_MOUSEBUTTON__11111111111.txt b/internal/help/_MOUSEBUTTON__11111111111.txt index 90418d4d2..ff556c7ee 100644 --- a/internal/help/_MOUSEBUTTON__11111111111.txt +++ b/internal/help/_MOUSEBUTTON__11111111111.txt @@ -1,5 +1,5 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:09:22}} +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:38:48}} {{DISPLAYTITLE:_MOUSEBUTTON}} The [[_MOUSEBUTTON]] function returns the button status of a specified mouse button when read after [[_MOUSEINPUT]]. @@ -173,4 +173,3 @@ y = {{Cl|_MOUSEY}} {{PageNavigation}} - diff --git a/internal/help/_MOUSEHIDE__111111111.txt b/internal/help/_MOUSEHIDE__111111111.txt index 3f3d5eff5..9d6dce0c4 100644 --- a/internal/help/_MOUSEHIDE__111111111.txt +++ b/internal/help/_MOUSEHIDE__111111111.txt @@ -1,5 +1,5 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:09:23}} +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:38:49}} {{DISPLAYTITLE:_MOUSEHIDE}} The [[_MOUSEHIDE]] statement hides the mouse cursor. @@ -16,3 +16,4 @@ The [[_MOUSEHIDE]] statement hides the mouse cursor. {{PageNavigation}} +[[Category:Latest]] diff --git a/internal/help/_MOUSEINPUT__1111111111.txt b/internal/help/_MOUSEINPUT__1111111111.txt index 9abf42c53..1ece5a33c 100644 --- a/internal/help/_MOUSEINPUT__1111111111.txt +++ b/internal/help/_MOUSEINPUT__1111111111.txt @@ -1,5 +1,5 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:09:25}} +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:38:50}} {{DISPLAYTITLE:_MOUSEINPUT}} The [[_MOUSEINPUT]] function is used to monitor any new mouse positions, button presses or movements of the scroll wheel. Must be called before other mouse information becomes available. @@ -88,3 +88,4 @@ count = 0 {{PageNavigation}} +[[Category:Latest]] diff --git a/internal/help/_MOUSEMOVEMENTX__11111111111111.txt b/internal/help/_MOUSEMOVEMENTX__11111111111111.txt index a53ff9ad7..95a39868d 100644 --- a/internal/help/_MOUSEMOVEMENTX__11111111111111.txt +++ b/internal/help/_MOUSEMOVEMENTX__11111111111111.txt @@ -1,5 +1,5 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:09:27}} +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:38:52}} {{DISPLAYTITLE:_MOUSEMOVEMENTX}} The [[_MOUSEMOVEMENTX]] function returns the relative horizontal position of the mouse cursor as positive or negative values. @@ -60,4 +60,3 @@ PX = 320: PY = 240 'center position {{PageNavigation}} - diff --git a/internal/help/_MOUSEMOVEMENTY__11111111111111.txt b/internal/help/_MOUSEMOVEMENTY__11111111111111.txt index 4ad04dbf5..7260d5f42 100644 --- a/internal/help/_MOUSEMOVEMENTY__11111111111111.txt +++ b/internal/help/_MOUSEMOVEMENTY__11111111111111.txt @@ -1,5 +1,5 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:09:28}} +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:38:54}} {{DISPLAYTITLE:_MOUSEMOVEMENTY}} The [[_MOUSEMOVEMENTY]] function returns the relative vertical position of the mouse cursor as positive or negative values. @@ -43,4 +43,3 @@ The [[_MOUSEMOVEMENTY]] function returns the relative vertical position of the m {{PageNavigation}} - diff --git a/internal/help/_MOUSEMOVE__111111111.txt b/internal/help/_MOUSEMOVE__111111111.txt index eb0c89aeb..f0287e57c 100644 --- a/internal/help/_MOUSEMOVE__111111111.txt +++ b/internal/help/_MOUSEMOVE__111111111.txt @@ -1,5 +1,5 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:09:26}} +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:38:51}} {{DISPLAYTITLE:_MOUSEMOVE}} The [[_MOUSEMOVE]] statement moves the mouse pointer to a new position on the screen as determined by the column and row coordinates. @@ -55,4 +55,3 @@ DO: {{Cl|_LIMIT}} 30 {{PageNavigation}} - diff --git a/internal/help/_MOUSEPIPEOPEN__1111111111111.txt b/internal/help/_MOUSEPIPEOPEN__1111111111111.txt deleted file mode 100644 index 099e83dd3..000000000 --- a/internal/help/_MOUSEPIPEOPEN__1111111111111.txt +++ /dev/null @@ -1,105 +0,0 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:09:30}} -{{DISPLAYTITLE: _MOUSEPIPEOPEN}} - -The [[_MOUSEPIPEOPEN]] function creates a pipe handle value for a mouse when using a virtual keyboard. - - -{{PageSyntax}} -: vkMousePipe = [[_MOUSEPIPEOPEN]] - - -{{PageDescription}} -* The pipe handle value can be used optionally with [[_MOUSEINPUT]], [[_MOUSEX]], [[_MOUSEY]], and [[_MOUSEBUTTON]] when required. - - -{{PageExamples}} -''Snippet:'' The following snippet isn't runnable/compilable, but it showcases the use of the [[_MOUSEPIPEOPEN]] function. -{{CodeStart}} - mDown = 0 - mUp = 0 - mEvent = 0 - -{{Cl|IF...THEN|IF}} VkMousePipe = 0 {{Cl|THEN}} - VkMousePipe = {{Cl|_MOUSEPIPEOPEN}} 'create new pipe -{{Cl|END IF}} - - {{Cl|DO...LOOP|DO}} {{Cl|WHILE}} {{Cl|_MOUSEINPUT}}(VkMousePipe) - mb = {{Cl|_MOUSEBUTTON}}(1, VkMousePipe) - - mx = {{Cl|_MOUSEX}}(VkMousePipe) - my = {{Cl|_MOUSEY}}(VkMousePipe) - - {{Cl|IF...THEN|IF}} {{Cl|_PIXELSIZE}} = 0 {{Cl|THEN}} 'screen 0 adjustment - mx = mx * 8 - 4 - my = my * 16 - 8 - {{Cl|END IF}} - {{Cl|IF...THEN|IF}} mb = -1 {{Cl|AND (boolean)|AND}} omb = 0 {{Cl|THEN}} mDown = -1: mEvent = 1: {{Cl|EXIT DO}} - - if VkMousePipeCapture=0 then - {{Cl|_MOUSEINPUTPIPE}} VkMousePipe - end if - - {{Cl|IF...THEN|IF}} mb = 0 {{Cl|AND (boolean)|AND}} omb = -1 {{Cl|THEN}} - VkMousePipeCapture=0 - mUp = -1 - mEvent = 1 - {{Cl|EXIT DO}} - end if - - {{Cl|LOOP}} - omb = mb - - - rootId = VkByRole("ROOT") - editMode = VK(rootId).locked - - {{Cl|IF...THEN|IF}} mDown {{Cl|THEN}} - mDownX = mx - mDownY = my - i2 = 0 - - {{Cl|FOR...NEXT|FOR}} internal = 1 {{Cl|TO}} 0 {{Cl|STEP}} -1 - {{Cl|FOR...NEXT|FOR}} i = VkLast {{Cl|TO}} 1 {{Cl|STEP}} -1 - {{Cl|IF...THEN|IF}} VK(i).active {{Cl|THEN}} - {{Cl|IF...THEN|IF}} VK(i).internal = internal {{Cl|THEN}} - x = VK(i).x * VkUnitSize - y = VK(i).y * VkUnitSize - w = VK(i).w - h = VK(i).h - x1 = {{Cl|INT}}(x) - x2 = {{Cl|INT}}(x + VkUnitSize * w) - 1 - y1 = sy - 1 - {{Cl|INT}}(y) - y2 = sy - 1 - {{Cl|INT}}(y + VkUnitSize * h) + 1 - {{Cl|IF...THEN|IF}} mx >= x1 {{Cl|AND (boolean)|AND}} mx <= x2 {{Cl|AND (boolean)|AND}} my >= y2 {{Cl|AND (boolean)|AND}} my <= y1 {{Cl|THEN}} - i2 = i - {{Cl|EXIT}} {{Cl|FOR...NEXT|FOR}} - {{Cl|END IF}} - {{Cl|END IF}} - {{Cl|END IF}} - {{Cl|NEXT}} - {{Cl|IF...THEN|IF}} i2 {{Cl|THEN}} {{Cl|EXIT}} {{Cl|FOR...NEXT|FOR}} - {{Cl|NEXT}} - {{Cl|IF...THEN|IF}} i2 {{Cl|THEN}} - VkI = i2 - VKoldX = VK(i2).x - VKoldY = VK(i2).y - VKdragging = 0 - VKstart = {{Cl|TIMER (statement)|TIMER}}(0.001) - 'VK(i2).held = -1 - VkKeyDown i2 - VkMousePipeCapture=1 - {{Cl|END IF}} - IF VkMousePipeCapture = 0 THEN {{Cl|_MOUSEINPUTPIPE}} VkMousePipe - {{Cl|END}} I - -{{TextEnd}} -: When using the [[$VIRTUALKEYBOARD|virtual keyboard]], the keyboard captures mouse input appropriately whilst selectively letting presses originating on non-key areas of the screen filter through to the default mouse queue. - - -{{PageSeeAlso}} -* [[$VIRTUALKEYBOARD]] - - -{{PageNavigation}} - diff --git a/internal/help/_MOUSESHOW__111111111.txt b/internal/help/_MOUSESHOW__111111111.txt index 8a2599255..6f74a580d 100644 --- a/internal/help/_MOUSESHOW__111111111.txt +++ b/internal/help/_MOUSESHOW__111111111.txt @@ -1,5 +1,5 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:09:31}} +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:38:55}} {{DISPLAYTITLE:_MOUSESHOW}} The [[_MOUSESHOW]] statement displays the mouse cursor and can change its shape. @@ -53,4 +53,3 @@ The [[_MOUSESHOW]] statement displays the mouse cursor and can change its shape. {{PageNavigation}} - diff --git a/internal/help/_MOUSEWHEEL__1111111111.txt b/internal/help/_MOUSEWHEEL__1111111111.txt index 3c2f1e69c..b5e0fd497 100644 --- a/internal/help/_MOUSEWHEEL__1111111111.txt +++ b/internal/help/_MOUSEWHEEL__1111111111.txt @@ -1,5 +1,5 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:09:32}} +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:38:56}} {{DISPLAYTITLE:_MOUSEWHEEL}} The [[_MOUSEWHEEL]] function returns a positive or negative [[INTEGER]] value indicating mouse scroll events since the last read of [[_MOUSEINPUT]]. @@ -67,3 +67,4 @@ DO {{PageNavigation}} +[[Category:Latest]] diff --git a/internal/help/_MOUSEX__111111.txt b/internal/help/_MOUSEX__111111.txt index af6aebf56..3ce22c652 100644 --- a/internal/help/_MOUSEX__111111.txt +++ b/internal/help/_MOUSEX__111111.txt @@ -1,5 +1,5 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:09:33}} +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:38:57}} {{DISPLAYTITLE:_MOUSEX}} The [[_MOUSEX]] function returns the current horizontal (column) mouse cursor position when read after [[_MOUSEINPUT]]. @@ -54,4 +54,3 @@ tm$ = " Column = ### Row = ### Button1 = ## Button2 = ## Button3 = ##" {{PageNavigation}} - diff --git a/internal/help/_MOUSEY__111111.txt b/internal/help/_MOUSEY__111111.txt index d61087944..4fef98368 100644 --- a/internal/help/_MOUSEY__111111.txt +++ b/internal/help/_MOUSEY__111111.txt @@ -1,5 +1,5 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:09:35}} +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:38:58}} {{DISPLAYTITLE:_MOUSEY}} The [[_MOUSEY]] function returns the current vertical (row) mouse cursor position when read after [[_MOUSEINPUT]]. @@ -63,4 +63,3 @@ addr& = (x1 - 1 + (y - 1) * {{Cl|_WIDTH (function)|_WIDTH}}) * 2 + 1 {{PageNavigation}} - diff --git a/internal/help/_NEWIMAGE__11111111.txt b/internal/help/_NEWIMAGE__11111111.txt index a6c199463..9722af919 100644 --- a/internal/help/_NEWIMAGE__11111111.txt +++ b/internal/help/_NEWIMAGE__11111111.txt @@ -1,5 +1,5 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:09:36}} +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:39:00}} {{DISPLAYTITLE:_NEWIMAGE}} The [[_NEWIMAGE]] function prepares a window image surface and returns the [[LONG]] [[handle]] value. @@ -101,4 +101,3 @@ mode2& = {{Cl|_NEWIMAGE}} (300, 200, 13) {{PageNavigation}} - diff --git a/internal/help/_NUMLOCK_(function)__1111111_(00000000).txt b/internal/help/_NUMLOCK_(function)__1111111_(00000000).txt index 61c37cb4b..5a9cc15f0 100644 --- a/internal/help/_NUMLOCK_(function)__1111111_(00000000).txt +++ b/internal/help/_NUMLOCK_(function)__1111111_(00000000).txt @@ -1,5 +1,5 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:09:38}} +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:39:02}} {{DISPLAYTITLE: _NUMLOCK (function)}} The [[_NUMLOCK (function)| _NUMLOCK]] function returns the current state of the Num Lock key as on (-1) or off (0). @@ -20,4 +20,3 @@ The [[_NUMLOCK (function)| _NUMLOCK]] function returns the current state of the {{PageNavigation}} - diff --git a/internal/help/_NUMLOCK__1111111.txt b/internal/help/_NUMLOCK__1111111.txt index 5eb843050..5fbe6f505 100644 --- a/internal/help/_NUMLOCK__1111111.txt +++ b/internal/help/_NUMLOCK__1111111.txt @@ -1,5 +1,5 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:09:40}} +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:39:03}} {{DISPLAYTITLE: _NUMLOCK}} The [[_NUMLOCK]] statement sets the state of the Num Lock key. @@ -20,4 +20,3 @@ The [[_NUMLOCK]] statement sets the state of the Num Lock key. {{PageNavigation}} - diff --git a/internal/help/_OFFSET_(function)__111111_(00000000).txt b/internal/help/_OFFSET_(function)__111111_(00000000).txt index 3dd1188d5..7c9d1af17 100644 --- a/internal/help/_OFFSET_(function)__111111_(00000000).txt +++ b/internal/help/_OFFSET_(function)__111111_(00000000).txt @@ -1,5 +1,5 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:09:41}} +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:39:04}} {{DISPLAYTITLE:_OFFSET (function)}} The [[_OFFSET]] function returns the memory offset of/within a given variable. @@ -43,4 +43,3 @@ memcpy {{Cl|_OFFSET (function)|_OFFSET}}(a$) + 5, {{Cl|_OFFSET (function)|_OFFSE {{PageNavigation}} - diff --git a/internal/help/_OFFSET__111111.txt b/internal/help/_OFFSET__111111.txt index b1685b874..593b42430 100644 --- a/internal/help/_OFFSET__111111.txt +++ b/internal/help/_OFFSET__111111.txt @@ -1,5 +1,5 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:09:42}} +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:39:05}} {{DISPLAYTITLE:_OFFSET}} The [[_OFFSET]] variable type stores the location of a value in memory. The byte size varies as required by the system. @@ -74,4 +74,3 @@ o = SHBrowseForFolder(b) {{PageNavigation}} - diff --git a/internal/help/_OPENCLIENT__1111111111.txt b/internal/help/_OPENCLIENT__1111111111.txt index edc37b406..121b6818e 100644 --- a/internal/help/_OPENCLIENT__1111111111.txt +++ b/internal/help/_OPENCLIENT__1111111111.txt @@ -1,5 +1,5 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:09:43}} +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:39:07}} The [[_OPENCLIENT]] function connects to a Host on the Internet as a Client and returns the Client status handle.{{PageSyntax}} :{{Parameter|clientHandle&}} = [[_OPENCLIENT]]('''"TCP/IP:8080:12:30:1:10"''') {{PageDescription}} @@ -74,4 +74,3 @@ t! = {{Cl|TIMER}} ' start time *[[Email Demo]], [[Inter-Program Data Sharing Demo]] *[[Downloading Files]] {{PageNavigation}} - diff --git a/internal/help/_OPENCONNECTION__11111111111111.txt b/internal/help/_OPENCONNECTION__11111111111111.txt index 035665720..0f7ea5fa3 100644 --- a/internal/help/_OPENCONNECTION__11111111111111.txt +++ b/internal/help/_OPENCONNECTION__11111111111111.txt @@ -1,5 +1,5 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:09:45}} +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:39:08}} {{DISPLAYTITLE:_OPENCONNECTION}} The [[_OPENCONNECTION]] function opens a connection from a client that the host has detected and returns a status handle. @@ -25,3 +25,4 @@ The [[_OPENCONNECTION]] function opens a connection from a client that the host {{PageNavigation}} +[[Category:Latest]] diff --git a/internal/help/_OPENHOST__11111111.txt b/internal/help/_OPENHOST__11111111.txt index 39b84a2e6..2fcaa4a94 100644 --- a/internal/help/_OPENHOST__11111111.txt +++ b/internal/help/_OPENHOST__11111111.txt @@ -1,5 +1,5 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:09:46}} +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:39:09}} {{DISPLAYTITLE:_OPENHOST}} The [[_OPENHOST]] function opens a Host which listens for new connections and returns a Host status handle. @@ -27,3 +27,4 @@ The [[_OPENHOST]] function opens a Host which listens for new connections and re {{PageNavigation}} +[[Category:Latest]] diff --git a/internal/help/_OS$__11$.txt b/internal/help/_OS$__11$.txt index 22d47d59f..c227de5fd 100644 --- a/internal/help/_OS$__11$.txt +++ b/internal/help/_OS$__11$.txt @@ -1,5 +1,5 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:09:50}} +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:39:12}} The [[_OS$]] function returns the operating system and QB64 compiler bit version used to compile a QB64 program. @@ -20,4 +20,3 @@ The [[_OS$]] function returns the operating system and QB64 compiler bit version {{PageNavigation}} - diff --git a/internal/help/_PALETTECOLOR_(function)__111111111111_(00000000).txt b/internal/help/_PALETTECOLOR_(function)__111111111111_(00000000).txt index 7231c1c65..fb1d6c374 100644 --- a/internal/help/_PALETTECOLOR_(function)__111111111111_(00000000).txt +++ b/internal/help/_PALETTECOLOR_(function)__111111111111_(00000000).txt @@ -1,5 +1,5 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:09:52}} +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:39:15}} {{DISPLAYTITLE:_PALETTECOLOR (function)}} The [[_PALETTECOLOR (function)|_PALETTECOLOR]] function is used to return the 32 bit attribute color setting of an image or screen page handle's palette. @@ -51,3 +51,4 @@ END {{PageNavigation}} +[[Category:Latest]] diff --git a/internal/help/_PALETTECOLOR__111111111111.txt b/internal/help/_PALETTECOLOR__111111111111.txt index dfc663ec4..f493747c6 100644 --- a/internal/help/_PALETTECOLOR__111111111111.txt +++ b/internal/help/_PALETTECOLOR__111111111111.txt @@ -1,5 +1,5 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:09:51}} +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:39:13}} {{DISPLAYTITLE:_PALETTECOLOR}} The [[_PALETTECOLOR]] statement sets the color value of a palette entry of an image using 256 color modes or less (4 or 8 BPP). @@ -76,3 +76,4 @@ The [[_PALETTECOLOR]] statement sets the color value of a palette entry of an im {{PageNavigation}} +[[Category:Latest]] diff --git a/internal/help/_PIXELSIZE__111111111.txt b/internal/help/_PIXELSIZE__111111111.txt index 49d771f34..a6cd8b55b 100644 --- a/internal/help/_PIXELSIZE__111111111.txt +++ b/internal/help/_PIXELSIZE__111111111.txt @@ -1,5 +1,5 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:09:55}} +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:39:17}} {{DISPLAYTITLE:_PIXELSIZE}} The [[_PIXELSIZE]] function returns the color depth (Bits Per Pixel) of an image as 0 for text, 1 for 1 to 8 BPP or 4 for 32 bit. @@ -51,3 +51,4 @@ GetImage& = h& {{PageNavigation}} +[[Category:Latest]] diff --git a/internal/help/_PI__11.txt b/internal/help/_PI__11.txt index d1ad05c6b..6d3928bb1 100644 --- a/internal/help/_PI__11.txt +++ b/internal/help/_PI__11.txt @@ -1,5 +1,5 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:09:54}} +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:39:16}} {{DISPLAYTITLE: _PI}} The [[_PI]] function returns '''ã''' as a [[_FLOAT]] value with an optional multiplier parameter. @@ -35,4 +35,3 @@ PRINT circlearea {{PageNavigation}} - diff --git a/internal/help/_PRESERVE__11111111.txt b/internal/help/_PRESERVE__11111111.txt index fdc546d5a..8bdede437 100644 --- a/internal/help/_PRESERVE__11111111.txt +++ b/internal/help/_PRESERVE__11111111.txt @@ -1,5 +1,5 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:09:56}} +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:39:18}} {{DISPLAYTITLE:_PRESERVE}} The [[_PRESERVE]] [[REDIM]] action preserves the current contents of [[$DYNAMIC|dynamic]] [[arrays]], when resizing or changing indices. @@ -40,7 +40,7 @@ a(5) = 123 {{CodeStart}} {{Cl|REDIM}} Array$(1) 'create a dynamic string array -filename$ = "Readme.txt" 'Qb64 information text file +filename$ = "Readme.txt" 'QB64 information text file {{Cl|OPEN}} filename$ {{Cl|FOR (file statement)|FOR}} {{Cl|INPUT (file mode)|INPUT}} {{Cl|AS}} #1 {{Cl|DO}} {{Cl|UNTIL}} {{Cl|EOF}}(1) count = count + 1 @@ -69,3 +69,4 @@ filename$ = "Readme.txt" 'Qb64 information text file {{PageNavigation}} +[[Category:Latest]] diff --git a/internal/help/_PRINTIMAGE__1111111111.txt b/internal/help/_PRINTIMAGE__1111111111.txt index d5fd2d771..4729383fa 100644 --- a/internal/help/_PRINTIMAGE__1111111111.txt +++ b/internal/help/_PRINTIMAGE__1111111111.txt @@ -1,5 +1,5 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:09:58}} +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:39:19}} {{DISPLAYTITLE:_PRINTIMAGE}} The [[_PRINTIMAGE]] statement prints a colored image on the printer, stretching it to full paper size first. @@ -171,3 +171,4 @@ Srow = 16 * (Trow - 1): Scol = 8 * (Tcol - 1) 'convert text to graphic coordinat {{PageNavigation}} +[[Category:Latest]] diff --git a/internal/help/_PRINTMODE_(function)__111111111_(00000000).txt b/internal/help/_PRINTMODE_(function)__111111111_(00000000).txt index 0ed2cd104..78d81be22 100644 --- a/internal/help/_PRINTMODE_(function)__111111111_(00000000).txt +++ b/internal/help/_PRINTMODE_(function)__111111111_(00000000).txt @@ -1,5 +1,5 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:10:00}} +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:39:22}} {{DISPLAYTITLE:_PRINTMODE (function)}} The [[_PRINTMODE (function)|_PRINTMODE]] function returns the current [[_PRINTMODE]] status as a numerical value from 1 to 3 in graphic screen modes. @@ -28,4 +28,3 @@ The [[_PRINTMODE (function)|_PRINTMODE]] function returns the current [[_PRINTM {{PageNavigation}} - diff --git a/internal/help/_PRINTMODE__111111111.txt b/internal/help/_PRINTMODE__111111111.txt index 8126e330c..bed49ee38 100644 --- a/internal/help/_PRINTMODE__111111111.txt +++ b/internal/help/_PRINTMODE__111111111.txt @@ -1,7 +1,7 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:09:59}} +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:39:21}} {{DISPLAYTITLE:_PRINTMODE}} -The [[_PRINTMODE]] statement sets the text or [[_FONT]] printing mode on a background image when using [[PRINT]] or [[_PRINTSTRING]]. +The [[_PRINTMODE]] statement sets the text or [[_FONT]] printing mode on an image when using [[PRINT]] or [[_PRINTSTRING]]. {{PageSyntax}} @@ -13,12 +13,12 @@ The [[_PRINTMODE]] statement sets the text or [[_FONT]] printing mode on a backg **''_KEEPBACKGROUND'' (mode 1): Text background transparent. Only the text is displayed over anything behind it. **''_ONLYBACKGROUND'' (mode 2): Text background only is displayed. Text is transparent to anything behind it. **''_FILLBACKGROUND'' (mode 3): Text and background block anything behind them like a normal [[PRINT]]. '''Default setting.''' -* If the optional {{Parameter|imageHandle&}} is omitted or = 0) it will use the current [[_DEST|destination]] image background. +* If the optional {{Parameter|imageHandle&}} is omitted or is 0 then the setting will be applied to the current [[_DEST|destination]] image. {{PageDescription}} -* Use the [[_PRINTMODE (function)]] to find the current [[_PRINTMODE]] setting mode number. -* '''The _PRINTMODE statement and function can only be used in graphic screen modes, not SCREEN 0''' +* Use the [[_PRINTMODE (function)]] to find the current [[_PRINTMODE]] setting mode number for an image. +* '''The _PRINTMODE statement and function can only be used on graphic images, not text-based ones such as SCREEN 0''' {{PageExamples}} @@ -41,4 +41,3 @@ The [[_PRINTMODE]] statement sets the text or [[_FONT]] printing mode on a backg {{PageNavigation}} - diff --git a/internal/help/_PRINTSTRING__11111111111.txt b/internal/help/_PRINTSTRING__11111111111.txt index efd972b15..716304e54 100644 --- a/internal/help/_PRINTSTRING__11111111111.txt +++ b/internal/help/_PRINTSTRING__11111111111.txt @@ -1,5 +1,5 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:10:02}} +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:39:23}} {{DISPLAYTITLE:_PRINTSTRING}} The [[_PRINTSTRING]] statement prints text [[STRING|strings]] using graphic column and row coordinate positions. @@ -119,4 +119,3 @@ row = 1 {{PageNavigation}} - diff --git a/internal/help/_PRINTWIDTH__1111111111.txt b/internal/help/_PRINTWIDTH__1111111111.txt index 65f97d735..6a9f8a809 100644 --- a/internal/help/_PRINTWIDTH__1111111111.txt +++ b/internal/help/_PRINTWIDTH__1111111111.txt @@ -1,6 +1,6 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:10:03}} -{{DISPLAYTITLE:_PRINTWIDTH}}{{DISPLAYTITLE:}} +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:39:24}} +{{DISPLAYTITLE:_PRINTWIDTH}} The [[_PRINTWIDTH]] function returns the width in pixels of the text [[STRING|string]] specified. @@ -52,4 +52,3 @@ TextHeight& = {{Cl|_FONTHEIGHT}} 'can measure normal text block heights {{PageNavigation}} - diff --git a/internal/help/_PUTIMAGE__11111111.txt b/internal/help/_PUTIMAGE__11111111.txt index 0e3117286..dbe289e95 100644 --- a/internal/help/_PUTIMAGE__11111111.txt +++ b/internal/help/_PUTIMAGE__11111111.txt @@ -1,5 +1,5 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:10:04}} +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:39:25}} {{DISPLAYTITLE:_PUTIMAGE}} [[_PUTIMAGE]] puts an area of a source image to an area of a destination image in one operation, like [[GET (graphics statement)|GET]] and [[PUT (graphics statement)|PUT]]. @@ -192,4 +192,3 @@ h& = {{Cl|_NEWIMAGE}}(640, 480, 256) {{PageNavigation}} - diff --git a/internal/help/_R2D__121.txt b/internal/help/_R2D__121.txt index 14aa9f6af..960771171 100644 --- a/internal/help/_R2D__121.txt +++ b/internal/help/_R2D__121.txt @@ -1,5 +1,5 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:10:05}} +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:39:27}} {{DISPLAYTITLE:_R2D}} The [[_R2D]] function converts a '''radian''' value into a '''degree''' value. @@ -34,4 +34,3 @@ That angle in Degrees is 28.64789 {{PageNavigation}} - diff --git a/internal/help/_R2G__121.txt b/internal/help/_R2G__121.txt index 742d0c576..d7086711c 100644 --- a/internal/help/_R2G__121.txt +++ b/internal/help/_R2G__121.txt @@ -1,5 +1,5 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:10:07}} +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:39:30}} {{DISPLAYTITLE:_R2G}} The [[_R2G]] function converts a '''radian''' value into a '''gradient''' value. @@ -34,4 +34,3 @@ That angle in Gradient is 31.83099 {{PageNavigation}} - diff --git a/internal/help/_READBIT__1111111.txt b/internal/help/_READBIT__1111111.txt index 29c608463..200055e1c 100644 --- a/internal/help/_READBIT__1111111.txt +++ b/internal/help/_READBIT__1111111.txt @@ -1,5 +1,5 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:10:10}} +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:39:33}} {{DISPLAYTITLE:_READBIT}} The [[_READBIT]] function is used to check the state of a specified bit of a integer value. @@ -57,4 +57,3 @@ B& in binary is: 00000000110000000001101000000111 * [[_RESETBIT]], [[_TOGGLEBIT]] {{PageNavigation}} - diff --git a/internal/help/_RED32__11132.txt b/internal/help/_RED32__11132.txt index 0c148a9d8..87bdd05a7 100644 --- a/internal/help/_RED32__11132.txt +++ b/internal/help/_RED32__11132.txt @@ -1,5 +1,5 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:10:09}} +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:39:32}} {{DISPLAYTITLE:_RED32}} The [[_RED32]] function returns the red component intensity of a 32-bit image or surface color. @@ -25,3 +25,4 @@ The [[_RED32]] function returns the red component intensity of a 32-bit image or {{PageNavigation}} +[[Category:Latest]] diff --git a/internal/help/_RED__111.txt b/internal/help/_RED__111.txt index 56e6a268b..cd93d253e 100644 --- a/internal/help/_RED__111.txt +++ b/internal/help/_RED__111.txt @@ -1,5 +1,5 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:10:08}} +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:39:31}} {{DISPLAYTITLE:_RED}} The [[_RED]] function returns the palette index or the red component intensity of a 32-bit image color. @@ -31,4 +31,3 @@ The [[_RED]] function returns the palette index or the red component intensity o {{PageNavigation}} - diff --git a/internal/help/_RESETBIT__11111111.txt b/internal/help/_RESETBIT__11111111.txt index a08eed403..c5906120c 100644 --- a/internal/help/_RESETBIT__11111111.txt +++ b/internal/help/_RESETBIT__11111111.txt @@ -1,5 +1,5 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:10:12}} +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:39:34}} {{DISPLAYTITLE:_RESETBIT}} The [[_RESETBIT]] function is used to set a specified bit of a numerical value to 0 (OFF state). @@ -46,4 +46,3 @@ A~%% = {{Cl|_RESETBIT}}(A~%%,6) 'Reset the seventh bit of A~%% * [[_READBIT]], [[_TOGGLEBIT]] {{PageNavigation}} - diff --git a/internal/help/_RESIZEHEIGHT__111111111111.txt b/internal/help/_RESIZEHEIGHT__111111111111.txt index dbddf10db..bb4bfc37c 100644 --- a/internal/help/_RESIZEHEIGHT__111111111111.txt +++ b/internal/help/_RESIZEHEIGHT__111111111111.txt @@ -1,5 +1,5 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:10:17}} +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:39:39}} {{DISPLAYTITLE:_RESIZEHEIGHT}} The [[_RESIZEHEIGHT]] function returns the user resized screen pixel height if [[$RESIZE]]:ON allows it and [[_RESIZE (function)|_RESIZE]] returns -1 @@ -54,4 +54,3 @@ bee& = {{Cl|_LOADIMAGE}}("qb64_trans.png") 'any image {{PageNavigation}} - diff --git a/internal/help/_RESIZEWIDTH__11111111111.txt b/internal/help/_RESIZEWIDTH__11111111111.txt index 07ac13922..2135ff954 100644 --- a/internal/help/_RESIZEWIDTH__11111111111.txt +++ b/internal/help/_RESIZEWIDTH__11111111111.txt @@ -1,5 +1,5 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:10:18}} +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:39:40}} {{DISPLAYTITLE:_RESIZEWIDTH}} The [[_RESIZEWIDTH]] function returns the user resized screen pixel width if [[$RESIZE]]:ON allows it and [[_RESIZE (function)|_RESIZE]] returns -1 @@ -54,4 +54,3 @@ bee& = {{Cl|_LOADIMAGE}}("qb64_trans.png") 'any image {{PageNavigation}} - diff --git a/internal/help/_RESIZE_(function)__111111_(00000000).txt b/internal/help/_RESIZE_(function)__111111_(00000000).txt index e8af67e63..f753e1888 100644 --- a/internal/help/_RESIZE_(function)__111111_(00000000).txt +++ b/internal/help/_RESIZE_(function)__111111_(00000000).txt @@ -1,5 +1,5 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:10:16}} +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:39:38}} {{DISPLAYTITLE:_RESIZE (function)}} The [[_RESIZE]] function returns true (-1) when a user has attempted to resize the program window and [[$RESIZE]]:ON has allowed it. @@ -55,4 +55,3 @@ bee& = {{Cl|_LOADIMAGE}}("qb64_trans.png") 'any image {{PageNavigation}} - diff --git a/internal/help/_RESIZE__111111.txt b/internal/help/_RESIZE__111111.txt index 8f14f7a95..53ec76237 100644 --- a/internal/help/_RESIZE__111111.txt +++ b/internal/help/_RESIZE__111111.txt @@ -1,5 +1,5 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:10:14}} +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:39:37}} {{DISPLAYTITLE:_RESIZE}} The [[_RESIZE]] statement sets resizing of the window ON or OFF and sets the method as _STRETCH or _SMOOTH. @@ -26,4 +26,3 @@ The [[_RESIZE]] statement sets resizing of the window ON or OFF and sets the met {{PageNavigation}} - diff --git a/internal/help/_RGB32__11132.txt b/internal/help/_RGB32__11132.txt index 88cb1fc0c..93ddb5e4e 100644 --- a/internal/help/_RGB32__11132.txt +++ b/internal/help/_RGB32__11132.txt @@ -1,5 +1,5 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:10:21}} +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:39:43}} {{DISPLAYTITLE:_RGB32}} The [[_RGB32]] function returns the 32-bit ''RGBA'' color value with specified red, green and blue component intensities and optional alpha. @@ -142,4 +142,3 @@ SYSTEM {{PageNavigation}} - diff --git a/internal/help/_RGBA32__111132.txt b/internal/help/_RGBA32__111132.txt index cd19fbf98..92350f010 100644 --- a/internal/help/_RGBA32__111132.txt +++ b/internal/help/_RGBA32__111132.txt @@ -1,5 +1,5 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:10:23}} +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:39:45}} {{DISPLAYTITLE:_RGBA32}} The [[_RGBA32]] function returns the 32-bit ''RGBA'' color value with the specified red, green, blue and alpha component intensities. @@ -59,4 +59,3 @@ img& = {{Cl|_LOADIMAGE}}("qb64_trans.png") 'use any 24/32 bit image {{PageNavigation}} - diff --git a/internal/help/_RGBA__1111.txt b/internal/help/_RGBA__1111.txt index 1cb9cf532..ce33b6285 100644 --- a/internal/help/_RGBA__1111.txt +++ b/internal/help/_RGBA__1111.txt @@ -1,5 +1,5 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:10:22}} +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:39:44}} {{DISPLAYTITLE:_RGBA}} The [[_RGBA]] function returns the closest palette index (legacy SCREEN modes) OR the 32-bit [[LONG]] color value (32-bit screens). @@ -53,3 +53,4 @@ Y% = 20 {{PageNavigation}} +[[Category:Latest]] diff --git a/internal/help/_RGB__111.txt b/internal/help/_RGB__111.txt index 27dd0d0dd..f111df467 100644 --- a/internal/help/_RGB__111.txt +++ b/internal/help/_RGB__111.txt @@ -1,5 +1,5 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:10:20}} +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:39:41}} {{DISPLAYTITLE:_RGB}} The [[_RGB]] function returns the closest palette attribute index (legacy SCREEN modes) OR the [[LONG]] 32-bit color value (32-bit screens). @@ -67,3 +67,4 @@ The [[_RGB]] function returns the closest palette attribute index (legacy SCREEN {{PageNavigation}} +[[Category:Latest]] diff --git a/internal/help/_ROUND__11111.txt b/internal/help/_ROUND__11111.txt index fbf1c9c01..eae5b954a 100644 --- a/internal/help/_ROUND__11111.txt +++ b/internal/help/_ROUND__11111.txt @@ -1,5 +1,5 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:10:25}} +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:39:46}} {{DISPLAYTITLE:_ROUND}} The [[_ROUND]] function rounds to the closest even [[INTEGER]], [[LONG]] or [[_INTEGER64]] numerical value. @@ -39,3 +39,4 @@ The [[_ROUND]] function rounds to the closest even [[INTEGER]], [[LONG]] or [[_I {{PageNavigation}} +[[Category:Latest]] diff --git a/internal/help/_SCREENCLICK__11111111111.txt b/internal/help/_SCREENCLICK__11111111111.txt index 21939e90a..1e0c5b94c 100644 --- a/internal/help/_SCREENCLICK__11111111111.txt +++ b/internal/help/_SCREENCLICK__11111111111.txt @@ -1,5 +1,5 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:10:26}} +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:39:47}} {{DISPLAYTITLE:_SCREENCLICK}} The [[_SCREENCLICK]] statement simulates clicking on a pixel coordinate on the desktop screen with the left mouse button. @@ -24,3 +24,4 @@ The [[_SCREENCLICK]] statement simulates clicking on a pixel coordinate on the d {{PageNavigation}} +[[Category:Latest]] diff --git a/internal/help/_SCREENEXISTS__111111111111.txt b/internal/help/_SCREENEXISTS__111111111111.txt index 56f6213bd..2b1418e49 100644 --- a/internal/help/_SCREENEXISTS__111111111111.txt +++ b/internal/help/_SCREENEXISTS__111111111111.txt @@ -1,5 +1,5 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:10:27}} +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:39:48}} {{DISPLAYTITLE:_SCREENEXISTS}} The [[_SCREENEXISTS]] function returns true (-1) once a screen has been created. @@ -15,10 +15,10 @@ The [[_SCREENEXISTS]] function returns true (-1) once a screen has been created. {{PageExamples}} -''Example:'' The loop waits until the screen exists to add the title. +;Example:Waiting in a loop until the screen exists to add the title. The [[_LIMIT]] prevents the loop from using all CPU time while waiting. {{CodeStart}} {{Cl|SCREEN}} 12 -{{Cl|DO}}: {{Cl|LOOP}} {{Cl|UNTIL}} _{{Cl|SCREENEXISTS}} +{{Cl|DO}}: {{Cl|_LIMIT}} 10: {{Cl|LOOP}} {{Cl|UNTIL}} {{Cl|_SCREENEXISTS}} {{Cl|_TITLE}} "My Title" {{CodeEnd}} @@ -32,3 +32,4 @@ The [[_SCREENEXISTS]] function returns true (-1) once a screen has been created. {{PageNavigation}} +[[Category:Final]] diff --git a/internal/help/_SCREENHIDE__1111111111.txt b/internal/help/_SCREENHIDE__1111111111.txt index 0d3d714c9..99aa330bc 100644 --- a/internal/help/_SCREENHIDE__1111111111.txt +++ b/internal/help/_SCREENHIDE__1111111111.txt @@ -1,24 +1,24 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:10:30}} +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:39:50}} {{DISPLAYTITLE:_SCREENHIDE}} -The '''_SCREENHIDE''' statement can be used to hide the main program window in a section of code. +The [[_SCREENHIDE]] statement can be used to hide the main program window in a section of code. {{PageSyntax}} -::: [[_SCREENHIDE]] +: [[_SCREENHIDE]] -* Use _SCREENHIDE to get rid of the main program window until later in the program. -* Use the [[Metacommand]] to get rid of the program window throughout a program or when using [[$CONSOLE]]. -* _SCREENHIDE or [[$SCREENHIDE]] must be used before [[_SCREENSHOW]] or [[$SCREENSHOW]] can be used! +{{PageDescription}} +* Use [[_SCREENHIDE]] to get rid of the main program window until later in the program. +* Use the respective [[Metacommand]] to get rid of the program window throughout a program or when using [[$CONSOLE]]. -''See also:'' - -* [[$SCREENHIDE]], [[$SCREENSHOW]], [[$CONSOLE]] (QB64 [[Metacommand]]s) +{{PageSeeAlso}} +* [[$SCREENHIDE]], [[$SCREENSHOW]], [[$CONSOLE]] ([[Metacommand#QB64 Metacommands|QB64 Metacommands]]) * [[_SCREENSHOW]], [[_CONSOLE]] * [[_SCREENICON]] {{PageNavigation}} +[[Category:Final]] diff --git a/internal/help/_SCREENICON_(function)__1111111111_(00000000).txt b/internal/help/_SCREENICON_(function)__1111111111_(00000000).txt index 91c0139d7..0d24e46d0 100644 --- a/internal/help/_SCREENICON_(function)__1111111111_(00000000).txt +++ b/internal/help/_SCREENICON_(function)__1111111111_(00000000).txt @@ -1,12 +1,11 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:10:31}} +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:39:52}} {{DISPLAYTITLE:_SCREENICON (function)}} - -The [[_SCREENICON (function)|_SCREENICON]] function returns true (-1) or false (0) to indicate if the window has been minimized to an icon on the taskbar. +The [[_SCREENICON (function)|_SCREENICON]] function returns true (-1) or false (0) to indicate whether the window has been minimized to an icon on the taskbar. {{PageSyntax}} -: {{Parameter|isMinimized%%}} = [[_SCREENICON]] +: {{Parameter|isMinimized%%}} = [[_SCREENICON (function)|_SCREENICON]] {{PageDescription}} @@ -21,3 +20,4 @@ The [[_SCREENICON (function)|_SCREENICON]] function returns true (-1) or false ( {{PageNavigation}} +[[Category:Final]] diff --git a/internal/help/_SCREENICON__1111111111.txt b/internal/help/_SCREENICON__1111111111.txt index f2f108453..de5a0cc7f 100644 --- a/internal/help/_SCREENICON__1111111111.txt +++ b/internal/help/_SCREENICON__1111111111.txt @@ -1,5 +1,5 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:10:32}} +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:39:53}} {{DISPLAYTITLE:_SCREENICON}} The [[_SCREENICON]] statement can be used to minimize the main program window to the taskbar. @@ -24,4 +24,3 @@ The [[_SCREENICON]] statement can be used to minimize the main program window to {{PageNavigation}} - diff --git a/internal/help/_SCREENIMAGE__11111111111.txt b/internal/help/_SCREENIMAGE__11111111111.txt index d1b59f895..6a15e0050 100644 --- a/internal/help/_SCREENIMAGE__11111111111.txt +++ b/internal/help/_SCREENIMAGE__11111111111.txt @@ -1,5 +1,5 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:10:33}} +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:39:54}} {{DISPLAYTITLE:_SCREENIMAGE}} The [[_SCREENIMAGE]] function stores the current desktop image or a portion of it and returns an image handle. @@ -51,3 +51,4 @@ The [[_SCREENIMAGE]] function stores the current desktop image or a portion of i {{PageNavigation}} +[[Category:Latest]] diff --git a/internal/help/_SCREENMOVE__1111111111.txt b/internal/help/_SCREENMOVE__1111111111.txt index e3d52b62a..5e088f6b4 100644 --- a/internal/help/_SCREENMOVE__1111111111.txt +++ b/internal/help/_SCREENMOVE__1111111111.txt @@ -1,5 +1,5 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:09:20}} +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:38:45}} {{DISPLAYTITLE:_SCREENMOVE}} The [[_SCREENMOVE]] statement positions the program window on the desktop using designated coordinates. @@ -69,4 +69,3 @@ high2& = {{Cl|_HEIGHT}}(img2&) {{PageNavigation}} - diff --git a/internal/help/_SCREENPRINT__11111111111.txt b/internal/help/_SCREENPRINT__11111111111.txt index 928153c9e..60ae38191 100644 --- a/internal/help/_SCREENPRINT__11111111111.txt +++ b/internal/help/_SCREENPRINT__11111111111.txt @@ -1,5 +1,5 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:10:35}} +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:39:55}} {{DISPLAYTITLE:_SCREENPRINT}} The [[_SCREENPRINT]] statement simulates typing text into a Windows focused program. @@ -11,7 +11,7 @@ The [[_SCREENPRINT]] statement simulates typing text into a Windows focused prog {{PageDescription}} * [[Keywords_currently_not_supported_by_QB64#Keywords_Not_Supported_in_Linux_or_MAC_OSX_versions|Keyword not supported in Linux or MAC versions]] * {{Parameter|text$}} is the text to be typed into a focused program's text entry area, one character at a time. -* Set the focus to a desktop program by using the [[_SCREENIMAGE]] handle as the [[_SOURCE]]. Use the image to map the desired area. +* Set the focus to a desktop program by using the [[_SCREENIMAGE]] handle as the [[_SOURCE]]. Use the image to map the desired area. * [[_SCREENCLICK]] can also be used to set the focus to a program's text entry area on the desktop. *'''Note: If the focus is not set correctly, the text may be printed to the QB64 IDE, if open, or not printed at all.''' * Ctrl + letter key shortcuts can be simulated using the appropriate [[ASCII]] Control character codes 1 to 26 shown below: @@ -27,7 +27,7 @@ The [[_SCREENPRINT]] statement simulates typing text into a Windows focused prog CTRL + S = CHR$(19) ‼ DevControl3 (DC3) CTRL + T = CHR$(20) ¶ DeviceControl4 (DC4) CTRL + U = CHR$(21) § NegativeACK (NAK) CTRL + V = CHR$(22) â–¬ Synchronous Idle (SYN) CTRL + W = CHR$(23) ↨ EndTXBlock (ETB) CTRL + X = CHR$(24) ↑ Cancel (CAN) - CTRL + Y = CHR$(25) ↓ EndMedium (EM) CTRL + Z = CHR$(26) → End Of File(SUB) (EOF) + CTRL + Y = CHR$(25) ↓ EndMedium (EM) CTRL + Z = CHR$(26) → End Of File(SUB) (EOF) {{WhiteEnd}} @@ -73,7 +73,7 @@ The [[_SCREENPRINT]] statement simulates typing text into a Windows focused prog {{Cl|_CLIPBOARD$ (statement)|_CLIPBOARD$}} = "QB64 ROCKS!" {{Cl|SLEEP}} 2 {{Cl|_SCREENPRINT}} {{Cl|CHR$}}(22) 'CTRL + V paste from clipboard -{{Cl|END}} +{{Cl|END}} {{CodeEnd}} {{small|Code by Galleon}} :''Explanation:'' If the Windows shortcuts are set up properly, printing ASCII Control characters acts like the user selected the control + letter combinations to ''Select all'' (CHR$(1)), ''Copy'' (CHR$(3)) and ''Paste'' (CHR$(22)) the text with the Windows Clipboard. If the editor program's CTRL key combinations are different, use the matching letter [[ASCII]] code from A = 1 to Z = 26 in the text editor. @@ -87,3 +87,4 @@ The [[_SCREENPRINT]] statement simulates typing text into a Windows focused prog {{PageNavigation}} +[[Category:Latest]] diff --git a/internal/help/_SCREENSHOW__1111111111.txt b/internal/help/_SCREENSHOW__1111111111.txt index f8aef816f..6fd3b1b65 100644 --- a/internal/help/_SCREENSHOW__1111111111.txt +++ b/internal/help/_SCREENSHOW__1111111111.txt @@ -1,24 +1,22 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:10:37}} -The [[$SCREENSHOW]] [[Metacommand|metacommand]] can be used to display the main program window throughout the program. +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:39:57}} +{{DISPLAYTITLE:_SCREENSHOW}} +The [[_SCREENSHOW]] statement can be used to display the main program window in a section of code. {{PageSyntax}} -: $SCREENSHOW +: [[_SCREENSHOW]] {{PageDescription}} -* The metacommand is intended to be used in a modular program when a screen surface is necessary in one or more modules. -* $SCREENSHOW can only be used after [[$SCREENHIDE]] or [[_SCREENHIDE]] have been used in another program module. -* If [[$SCREENHIDE]] and then [[$SCREENSHOW]] are used in the same program module the window will not be hidden. -* '''QB64 [[Metacommand|metacommand]]s cannot be commented out with [[apostrophe]] or [[REM]].''' +* Use [[_SCREENSHOW]] to display the main program window after it was hidden by [[_SCREENHIDE]]. {{PageSeeAlso}} -* [[$CONSOLE]], [[$SCREENHIDE]] (QB64 [[Metacommand]]s) -* [[_SCREENHIDE]], [[_SCREENSHOW]] -* [[_CONSOLE]] +* [[$SCREENHIDE]], [[$SCREENSHOW]], [[$CONSOLE]] ([[Metacommand#QB64 Metacommands|QB64 Metacommands]]) +* [[_SCREENHIDE]], [[_CONSOLE]] {{PageNavigation}} +[[Category:Final]] diff --git a/internal/help/_SCREENX__1111111.txt b/internal/help/_SCREENX__1111111.txt index a2f4b5174..b836b25e0 100644 --- a/internal/help/_SCREENX__1111111.txt +++ b/internal/help/_SCREENX__1111111.txt @@ -1,5 +1,5 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:10:39}} +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:39:58}} {{DISPLAYTITLE:_SCREENX}} The [[_SCREENX]] function returns the current column pixel coordinate of the program window on the desktop. @@ -32,3 +32,4 @@ The [[_SCREENX]] function returns the current column pixel coordinate of the pro {{PageNavigation}} +[[Category:Latest]] diff --git a/internal/help/_SCREENY__1111111.txt b/internal/help/_SCREENY__1111111.txt index 797d09158..6d93f2279 100644 --- a/internal/help/_SCREENY__1111111.txt +++ b/internal/help/_SCREENY__1111111.txt @@ -1,5 +1,5 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:10:40}} +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:39:59}} {{DISPLAYTITLE:_SCREENY}} The [[_SCREENY]] function returns the current row pixel coordinate of the program window on the desktop. @@ -32,3 +32,4 @@ The [[_SCREENY]] function returns the current row pixel coordinate of the progra {{PageNavigation}} +[[Category:Latest]] diff --git a/internal/help/_SCROLLLOCK_(function)__1111111111_(00000000).txt b/internal/help/_SCROLLLOCK_(function)__1111111111_(00000000).txt index b90323bf8..e95fed17f 100644 --- a/internal/help/_SCROLLLOCK_(function)__1111111111_(00000000).txt +++ b/internal/help/_SCROLLLOCK_(function)__1111111111_(00000000).txt @@ -1,5 +1,5 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:10:41}} +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:40:01}} {{DISPLAYTITLE: _SCROLLLOCK (function)}} The [[_SCROLLLOCK (function)| _SCROLLLOCK]] function returns the current state of the Scroll Lock key as on (-1) or off (0). @@ -20,4 +20,3 @@ The [[_SCROLLLOCK (function)| _SCROLLLOCK]] function returns the current state o {{PageNavigation}} - diff --git a/internal/help/_SCROLLLOCK__1111111111.txt b/internal/help/_SCROLLLOCK__1111111111.txt index d9e103b52..19adededc 100644 --- a/internal/help/_SCROLLLOCK__1111111111.txt +++ b/internal/help/_SCROLLLOCK__1111111111.txt @@ -1,5 +1,5 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:10:42}} +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:40:02}} {{DISPLAYTITLE: _SCROLLLOCK}} The [[_SCROLLLOCK]] statement sets the state of the Scroll Lock key. @@ -20,4 +20,3 @@ The [[_SCROLLLOCK]] statement sets the state of the Scroll Lock key. {{PageNavigation}} - diff --git a/internal/help/_SETALPHA__11111111.txt b/internal/help/_SETALPHA__11111111.txt index ed481d246..60498b7f1 100644 --- a/internal/help/_SETALPHA__11111111.txt +++ b/internal/help/_SETALPHA__11111111.txt @@ -1,6 +1,6 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:10:43}} -{{DISPLAYTITLE:_SETALPHA}}{{DISPLAYTITLE:}} +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:40:03}} +{{DISPLAYTITLE:_SETALPHA}} The [[_SETALPHA]] statement sets the alpha channel transparency level of some or all of the pixels of an image. @@ -67,4 +67,3 @@ DO {{PageNavigation}} - diff --git a/internal/help/_SETBIT__111111.txt b/internal/help/_SETBIT__111111.txt index 34ec84f07..9dad7817a 100644 --- a/internal/help/_SETBIT__111111.txt +++ b/internal/help/_SETBIT__111111.txt @@ -1,5 +1,5 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:10:45}} +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:40:04}} {{DISPLAYTITLE:_SETBIT}} The [[_SETBIT]] function is used to set a specified bit of a numerical value to 1 (on state). @@ -43,4 +43,3 @@ A~%% = {{Cl|_SETBIT}}(A~%%,6) 'set the seventh bit of A~%% * [[_RESETBIT]], [[_TOGGLEBIT]] {{PageNavigation}} - diff --git a/internal/help/_SHELLHIDE__111111111.txt b/internal/help/_SHELLHIDE__111111111.txt index 404f7ea6a..e2905a7dc 100644 --- a/internal/help/_SHELLHIDE__111111111.txt +++ b/internal/help/_SHELLHIDE__111111111.txt @@ -1,5 +1,5 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:10:46}} +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:40:05}} {{DISPLAYTITLE:_SHELLHIDE}} The [[_SHELLHIDE]] function hides the console window and returns any [[INTEGER]] code sent when a program exits. @@ -37,4 +37,3 @@ returncode% = {{Cl|_SHELLHIDE}}("DesktopSize") 'replace call with your program E {{PageNavigation}} - diff --git a/internal/help/_SHL__111.txt b/internal/help/_SHL__111.txt index 98c207e24..e77b0fe0d 100644 --- a/internal/help/_SHL__111.txt +++ b/internal/help/_SHL__111.txt @@ -1,5 +1,5 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:10:47}} +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:40:06}} {{DISPLAYTITLE:_SHL}} The [[_SHL]] function is used to shift the bits of a numerical value to the left. @@ -67,4 +67,3 @@ A~%% = 1 {{PageNavigation}} - diff --git a/internal/help/_SHR__111.txt b/internal/help/_SHR__111.txt index 6979d91e9..af1fb9422 100644 --- a/internal/help/_SHR__111.txt +++ b/internal/help/_SHR__111.txt @@ -1,5 +1,5 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:10:49}} +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:40:08}} {{DISPLAYTITLE:_SHR}} The [[_SHR]] function is used to shift the bits of a numerical value to the right. @@ -64,4 +64,3 @@ A~%% = 128 {{PageNavigation}} - diff --git a/internal/help/_SNDBAL__111111.txt b/internal/help/_SNDBAL__111111.txt index 819a04497..25e399e8b 100644 --- a/internal/help/_SNDBAL__111111.txt +++ b/internal/help/_SNDBAL__111111.txt @@ -1,5 +1,5 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:10:50}} +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:40:09}} {{DISPLAYTITLE:_SNDBAL}} The [[_SNDBAL]] statement attempts to set the balance or 3D position of a sound. @@ -101,4 +101,3 @@ LOOP {{PageNavigation}} - diff --git a/internal/help/_SNDCLOSE__11111111.txt b/internal/help/_SNDCLOSE__11111111.txt index 47d0c2f0f..37578c321 100644 --- a/internal/help/_SNDCLOSE__11111111.txt +++ b/internal/help/_SNDCLOSE__11111111.txt @@ -1,5 +1,5 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:10:51}} +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:40:10}} {{DISPLAYTITLE:_SNDCLOSE}} The [[_SNDCLOSE]] statement frees and unloads an open sound using a [[_SNDOPEN]] or [[_SNDCOPY]] handle. @@ -20,3 +20,4 @@ The [[_SNDCLOSE]] statement frees and unloads an open sound using a [[_SNDOPEN]] {{PageNavigation}} +[[Category:Latest]] diff --git a/internal/help/_SNDCOPY__1111111.txt b/internal/help/_SNDCOPY__1111111.txt index d08f7cc55..7433c2724 100644 --- a/internal/help/_SNDCOPY__1111111.txt +++ b/internal/help/_SNDCOPY__1111111.txt @@ -1,5 +1,5 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:10:52}} +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:40:11}} {{DISPLAYTITLE:_SNDCOPY}} The [[_SNDCOPY]] function copies a sound to a new handle so that two or more of the same sound can be played at once. The passed handle parameter is from the [[_SNDOPEN]] function. @@ -21,4 +21,3 @@ The [[_SNDCOPY]] function copies a sound to a new handle so that two or more of {{PageNavigation}} - diff --git a/internal/help/_SNDGETPOS__111111111.txt b/internal/help/_SNDGETPOS__111111111.txt index 071a7a9b5..0f576ed3d 100644 --- a/internal/help/_SNDGETPOS__111111111.txt +++ b/internal/help/_SNDGETPOS__111111111.txt @@ -1,5 +1,5 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:10:54}} +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:40:12}} {{DISPLAYTITLE:_SNDGETPOS}} The [[_SNDGETPOS]] function returns the current playing position in seconds using a handle from [[_SNDOPEN]]. @@ -35,3 +35,4 @@ LOOP UNTIL {{Cl|_KEYDOWN}}(27) OR {{Cl|NOT}} {{Cl|_SNDPLAYING}}(SoundFile&) 'ESC {{PageNavigation}} +[[Category:Latest]] diff --git a/internal/help/_SNDLEN__111111.txt b/internal/help/_SNDLEN__111111.txt index 8b7b09125..5259198d4 100644 --- a/internal/help/_SNDLEN__111111.txt +++ b/internal/help/_SNDLEN__111111.txt @@ -1,5 +1,5 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:10:55}} +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:40:13}} {{DISPLAYTITLE:_SNDLEN}} The [[_SNDLEN]] function returns the length in seconds of a loaded sound using a handle from the [[_SNDOPEN]] function. @@ -19,3 +19,4 @@ The [[_SNDLEN]] function returns the length in seconds of a loaded sound using a {{PageNavigation}} +[[Category:Latest]] diff --git a/internal/help/_SNDLIMIT__11111111.txt b/internal/help/_SNDLIMIT__11111111.txt index 00e30c3da..5bee1d150 100644 --- a/internal/help/_SNDLIMIT__11111111.txt +++ b/internal/help/_SNDLIMIT__11111111.txt @@ -1,5 +1,5 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:10:56}} +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:40:14}} {{DISPLAYTITLE:_SNDLIMIT}} The [[_SNDLIMIT]] statement stops playing a sound after it has been playing for a set number of seconds. @@ -30,4 +30,3 @@ The [[_SNDLIMIT]] statement stops playing a sound after it has been playing for {{PageNavigation}} - diff --git a/internal/help/_SNDLOOP__1111111.txt b/internal/help/_SNDLOOP__1111111.txt index 11c98e393..c476637d4 100644 --- a/internal/help/_SNDLOOP__1111111.txt +++ b/internal/help/_SNDLOOP__1111111.txt @@ -1,5 +1,5 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:10:58}} +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:40:15}} {{DISPLAYTITLE:_SNDLOOP}} The [[_SNDLOOP]] statement is like [[_SNDPLAY]] but the sound is looped. Uses a handle from the [[_SNDOPEN]] function. @@ -32,3 +32,4 @@ DO {{PageNavigation}} +[[Category:Latest]] diff --git a/internal/help/_SNDOPENRAW__1111111111.txt b/internal/help/_SNDOPENRAW__1111111111.txt index bdbce8307..df659188c 100644 --- a/internal/help/_SNDOPENRAW__1111111111.txt +++ b/internal/help/_SNDOPENRAW__1111111111.txt @@ -1,5 +1,5 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:11:00}} +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:40:18}} {{DISPLAYTITLE:_SNDOPENRAW}} The [[_SNDOPENRAW]] function opens a new channel to fill with _SNDRAW content to manage multiple dynamically generated sounds. @@ -37,3 +37,4 @@ b = {{Cl|_SNDOPENRAW}} {{PageNavigation}} +[[Category:Latest]] diff --git a/internal/help/_SNDOPEN__1111111.txt b/internal/help/_SNDOPEN__1111111.txt index fb0cff989..4e9a2bcda 100644 --- a/internal/help/_SNDOPEN__1111111.txt +++ b/internal/help/_SNDOPEN__1111111.txt @@ -1,5 +1,5 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:10:59}} +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:40:17}} {{DISPLAYTITLE:_SNDOPEN}} The [[_SNDOPEN]] function loads a sound file into memory and returns a [[LONG]] handle value above 0. @@ -110,4 +110,3 @@ LOOP {{PageNavigation}} - diff --git a/internal/help/_SNDPAUSED__111111111.txt b/internal/help/_SNDPAUSED__111111111.txt index c3ee3fd88..627fccbc0 100644 --- a/internal/help/_SNDPAUSED__111111111.txt +++ b/internal/help/_SNDPAUSED__111111111.txt @@ -1,5 +1,5 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:11:03}} +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:40:20}} {{DISPLAYTITLE:_SNDPAUSED}} The [[_SNDPAUSED]] function checks if a sound is paused. Uses a handle parameter passed from [[_SNDOPEN]]. @@ -25,3 +25,4 @@ The [[_SNDPAUSED]] function checks if a sound is paused. Uses a handle parameter {{PageNavigation}} +[[Category:Latest]] diff --git a/internal/help/_SNDPAUSE__11111111.txt b/internal/help/_SNDPAUSE__11111111.txt index afaba29bf..a9f5c1c27 100644 --- a/internal/help/_SNDPAUSE__11111111.txt +++ b/internal/help/_SNDPAUSE__11111111.txt @@ -1,5 +1,5 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:11:01}} +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:40:19}} {{DISPLAYTITLE:_SNDPAUSE}} The [[_SNDPAUSE]] statement pauses a sound using a handle from the [[_SNDOPEN]] function. @@ -20,3 +20,4 @@ The [[_SNDPAUSE]] statement pauses a sound using a handle from the [[_SNDOPEN]] {{PageNavigation}} +[[Category:Latest]] diff --git a/internal/help/_SNDPLAYCOPY__11111111111.txt b/internal/help/_SNDPLAYCOPY__11111111111.txt index 47d2d30d3..8da662f25 100644 --- a/internal/help/_SNDPLAYCOPY__11111111111.txt +++ b/internal/help/_SNDPLAYCOPY__11111111111.txt @@ -1,5 +1,5 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:11:05}} +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:40:22}} {{DISPLAYTITLE:_SNDPLAYCOPY}} The [[_SNDPLAYCOPY]] statement copies a sound, plays it, and automatically closes the copy using a handle parameter passed from [[_SNDOPEN]] or [[_SNDCOPY]] @@ -44,4 +44,3 @@ _SNDPLAYCOPY chomp&, 0.5 + RND * 0.49 {{PageNavigation}} - diff --git a/internal/help/_SNDPLAYFILE__11111111111.txt b/internal/help/_SNDPLAYFILE__11111111111.txt index 7edffc527..919382879 100644 --- a/internal/help/_SNDPLAYFILE__11111111111.txt +++ b/internal/help/_SNDPLAYFILE__11111111111.txt @@ -1,5 +1,5 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:11:06}} +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:40:23}} {{DISPLAYTITLE:_SNDPLAYFILE}} The [[_SNDPLAYFILE]] statement is used to play a sound file without generating a handle, automatically closing it after playback finishes. @@ -32,3 +32,4 @@ The [[_SNDPLAYFILE]] statement is used to play a sound file without generating a {{PageNavigation}} +[[Category:Latest]] diff --git a/internal/help/_SNDPLAYING__1111111111.txt b/internal/help/_SNDPLAYING__1111111111.txt index 669e0437a..3872bd5e7 100644 --- a/internal/help/_SNDPLAYING__1111111111.txt +++ b/internal/help/_SNDPLAYING__1111111111.txt @@ -1,5 +1,5 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:11:08}} +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:40:25}} {{DISPLAYTITLE:_SNDPLAYING}} The [[_SNDPLAYING]] function returns whether a sound is being played. Uses a handle from the [[_SNDOPEN]] or [[_SNDCOPY]] functions. @@ -26,3 +26,4 @@ The [[_SNDPLAYING]] function returns whether a sound is being played. Uses a han {{PageNavigation}} +[[Category:Latest]] diff --git a/internal/help/_SNDPLAY__1111111.txt b/internal/help/_SNDPLAY__1111111.txt index 599e5b0b8..4cfcd6835 100644 --- a/internal/help/_SNDPLAY__1111111.txt +++ b/internal/help/_SNDPLAY__1111111.txt @@ -1,5 +1,5 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:11:04}} +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:40:21}} {{DISPLAYTITLE:_SNDPLAY}} The [[_SNDPLAY]] statement plays a sound designated by a file handle created by [[_SNDOPEN]]. @@ -25,3 +25,4 @@ The [[_SNDPLAY]] statement plays a sound designated by a file handle created by {{PageNavigation}} +[[Category:Latest]] diff --git a/internal/help/_SNDRATE__1111111.txt b/internal/help/_SNDRATE__1111111.txt index 0daf05484..5fa70152a 100644 --- a/internal/help/_SNDRATE__1111111.txt +++ b/internal/help/_SNDRATE__1111111.txt @@ -1,5 +1,5 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:11:09}} +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:40:26}} {{DISPLAYTITLE:_SNDRATE}} The [[_SNDRATE]] function returns the sample rate frequency per second of the current computer's sound card. @@ -24,3 +24,4 @@ The [[_SNDRATE]] function returns the sample rate frequency per second of the cu {{PageNavigation}} +[[Category:Latest]] diff --git a/internal/help/_SNDRAWDONE__1111111111.txt b/internal/help/_SNDRAWDONE__1111111111.txt index dd59690bb..912924848 100644 --- a/internal/help/_SNDRAWDONE__1111111111.txt +++ b/internal/help/_SNDRAWDONE__1111111111.txt @@ -1,11 +1,15 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:11:12}} +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:40:28}} {{DISPLAYTITLE:_SNDRAWDONE}} [[_SNDRAWDONE]] ensures that the final buffer portion is played in short sound effects even if it is incomplete. {{PageSyntax}} -: [[_SNDRAWDONE]] +: [[_SNDRAWDONE]] [{{Parameter|pipeHandle&}}] + + +{{PageParameters}} +* The optional {{Parameter|pipeHandle&}} parameter refers to the sound pipe opened using [[_SNDOPENRAW]]. {{PageDescription}} @@ -25,4 +29,3 @@ {{PageNavigation}} - diff --git a/internal/help/_SNDRAWLEN__111111111.txt b/internal/help/_SNDRAWLEN__111111111.txt index afcf05081..917ba8593 100644 --- a/internal/help/_SNDRAWLEN__111111111.txt +++ b/internal/help/_SNDRAWLEN__111111111.txt @@ -1,11 +1,15 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:11:13}} +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:40:29}} {{DISPLAYTITLE:_SNDRAWLEN}} The [[_SNDRAWLEN]] function returns the length, in seconds, of a [[_SNDRAW]] sound currently queued. {{PageSyntax}} -: {{Parameter|length#}} = [[_SNDRAWLEN]] +: {{Parameter|length#}} = [[_SNDRAWLEN]] [{{Parameter|pipeHandle&}}] + + +{{PageParameters}} +* The optional {{Parameter|pipeHandle&}} parameter refers to the sound pipe opened using [[_SNDOPENRAW]]. {{PageDescription}} @@ -26,4 +30,3 @@ The [[_SNDRAWLEN]] function returns the length, in seconds, of a [[_SNDRAW]] sou {{PageNavigation}} - diff --git a/internal/help/_SNDRAW__111111.txt b/internal/help/_SNDRAW__111111.txt index 1614260b2..290709388 100644 --- a/internal/help/_SNDRAW__111111.txt +++ b/internal/help/_SNDRAW__111111.txt @@ -1,5 +1,5 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:11:10}} +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:40:27}} {{DISPLAYTITLE:_SNDRAW}} The [[_SNDRAW]] statement plays sound wave sample frequencies created by a program. @@ -114,4 +114,3 @@ SndLoop! = 0 {{PageNavigation}} - diff --git a/internal/help/_SNDSETPOS__111111111.txt b/internal/help/_SNDSETPOS__111111111.txt index d1688d8f0..beba38cfa 100644 --- a/internal/help/_SNDSETPOS__111111111.txt +++ b/internal/help/_SNDSETPOS__111111111.txt @@ -1,5 +1,5 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:11:14}} +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:40:30}} {{DISPLAYTITLE:_SNDSETPOS}} The [[_SNDSETPOS]] statement changes the current/starting playing position in seconds of a sound. @@ -34,3 +34,4 @@ LOOP UNTIL {{Cl|_KEYDOWN}}(27) OR {{Cl|NOT}} {{Cl|_SNDPLAYING}}(SoundFile&) 'ESC {{PageNavigation}} +[[Category:Latest]] diff --git a/internal/help/_SNDSTOP__1111111.txt b/internal/help/_SNDSTOP__1111111.txt index c7d8e68b7..478f9de34 100644 --- a/internal/help/_SNDSTOP__1111111.txt +++ b/internal/help/_SNDSTOP__1111111.txt @@ -1,5 +1,5 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:11:15}} +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:40:31}} {{DISPLAYTITLE:_SNDSTOP}} The [[_SNDSTOP]] statement stops a playing or paused sound using a handle from the [[_SNDOPEN]] or [[_SNDCOPY]] functions. @@ -25,3 +25,4 @@ The [[_SNDSTOP]] statement stops a playing or paused sound using a handle from t {{PageNavigation}} +[[Category:Latest]] diff --git a/internal/help/_SNDVOL__111111.txt b/internal/help/_SNDVOL__111111.txt index 890cb0ff4..b5a37f908 100644 --- a/internal/help/_SNDVOL__111111.txt +++ b/internal/help/_SNDVOL__111111.txt @@ -1,5 +1,5 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:11:17}} +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:40:33}} {{DISPLAYTITLE:_SNDVOL}} The [[_SNDVOL]] statement sets the volume of a sound loaded in memory using a handle from the [[_SNDOPEN]] function. @@ -27,3 +27,4 @@ h& = {{Cl|_SNDOPEN}}("bell.wav") {{PageNavigation}} +[[Category:Latest]] diff --git a/internal/help/_SOURCE_(function)__111111_(00000000).txt b/internal/help/_SOURCE_(function)__111111_(00000000).txt index 10581bb75..ea8b9d051 100644 --- a/internal/help/_SOURCE_(function)__111111_(00000000).txt +++ b/internal/help/_SOURCE_(function)__111111_(00000000).txt @@ -1,5 +1,5 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:11:19}} +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:40:35}} {{DISPLAYTITLE:_SOURCE (function)}} The [[_SOURCE (function)|_SOURCE]] function returns the present image source handle value. @@ -27,3 +27,4 @@ See the examples in: {{PageNavigation}} +[[Category:Latest]] diff --git a/internal/help/_SOURCE__111111.txt b/internal/help/_SOURCE__111111.txt index 90c7e1b4e..36e9e5cba 100644 --- a/internal/help/_SOURCE__111111.txt +++ b/internal/help/_SOURCE__111111.txt @@ -1,5 +1,5 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:11:18}} +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:40:34}} {{DISPLAYTITLE:_SOURCE}} The [[_SOURCE]] statement establishes the image SOURCE using a handle created by [[_LOADIMAGE]], [[_NEWIMAGE]] or [[_COPYIMAGE]]. @@ -45,3 +45,4 @@ See the examples in: {{PageNavigation}} +[[Category:Latest]] diff --git a/internal/help/_STARTDIR$__11111111$.txt b/internal/help/_STARTDIR$__11111111$.txt index 87961e289..2627c2a6b 100644 --- a/internal/help/_STARTDIR$__11111111$.txt +++ b/internal/help/_STARTDIR$__11111111$.txt @@ -1,5 +1,5 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:11:21}} +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:40:36}} {{DISPLAYTITLE:_STARTDIR$}} The [[_STARTDIR$]] function returns the path a user called a QB64 program from. @@ -34,4 +34,3 @@ The [[_STARTDIR$]] function returns the path a user called a QB64 program from. {{PageNavigation}} - diff --git a/internal/help/_STRCMP__111111.txt b/internal/help/_STRCMP__111111.txt index 9e64fb55f..e2964ef81 100644 --- a/internal/help/_STRCMP__111111.txt +++ b/internal/help/_STRCMP__111111.txt @@ -1,5 +1,5 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:11:22}} +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:40:37}} {{DISPLAYTITLE:_STRCMP}} The [[_STRCMP]] function compares the relationship between two strings, comparing upper or lower case. @@ -23,3 +23,4 @@ The [[_STRCMP]] function compares the relationship between two strings, comparin {{PageNavigation}} +[[Category:Latest]] diff --git a/internal/help/_STRICMP__1111111.txt b/internal/help/_STRICMP__1111111.txt index f4d6865f2..d6ef7c585 100644 --- a/internal/help/_STRICMP__1111111.txt +++ b/internal/help/_STRICMP__1111111.txt @@ -1,5 +1,5 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:11:23}} +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:40:38}} {{DISPLAYTITLE:_STRICMP}} The [[_STRICMP]] function compares the relationship between two strings, ignoring upper or lower case letters. @@ -23,3 +23,4 @@ The [[_STRICMP]] function compares the relationship between two strings, ignorin {{PageNavigation}} +[[Category:Latest]] diff --git a/internal/help/_TITLE$__11111$.txt b/internal/help/_TITLE$__11111$.txt index 8a5327728..b61e7f585 100644 --- a/internal/help/_TITLE$__11111$.txt +++ b/internal/help/_TITLE$__11111$.txt @@ -1,5 +1,5 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:11:26}} +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:40:40}} {{DISPLAYTITLE:_TITLE$}} The [[_TITLE$]] function returns the program title last set by the [[_TITLE]] statement. @@ -23,4 +23,3 @@ The [[_TITLE$]] function returns the program title last set by the [[_TITLE]] st {{PageNavigation}} - diff --git a/internal/help/_TITLE__11111.txt b/internal/help/_TITLE__11111.txt index 41141b8f9..283eb7dd8 100644 --- a/internal/help/_TITLE__11111.txt +++ b/internal/help/_TITLE__11111.txt @@ -1,5 +1,5 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:11:25}} +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:40:39}} {{DISPLAYTITLE:_TITLE}} The [[_TITLE]] statement provides the program name in the title bar of the program window. @@ -71,4 +71,3 @@ Result = GetModuleFileNameA(0, FileName$, {{Cl|LEN}}(FileName$)) {{PageNavigation}} - diff --git a/internal/help/_TOGGLEBIT__111111111.txt b/internal/help/_TOGGLEBIT__111111111.txt index 8dc69b379..60e329c80 100644 --- a/internal/help/_TOGGLEBIT__111111111.txt +++ b/internal/help/_TOGGLEBIT__111111111.txt @@ -1,6 +1,6 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:11:27}} -{{DISPLAYTITLE:_TOGLEBIT}} +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:40:42}} +{{DISPLAYTITLE:_TOGGLEBIT}} The [[_TOGGLEBIT]] function is used to toggle a specified bit of a numerical value. @@ -46,4 +46,3 @@ A~%% = {{Cl|_TOGGLEBIT}}(A~%%,4) 'toggle the fourth bit of A~%% * [[_RESETBIT]], [[_READBIT]] {{PageNavigation}} - diff --git a/internal/help/_TOTALDROPPEDFILES__11111111111111111.txt b/internal/help/_TOTALDROPPEDFILES__11111111111111111.txt index d98c6c0bd..eb4271281 100644 --- a/internal/help/_TOTALDROPPEDFILES__11111111111111111.txt +++ b/internal/help/_TOTALDROPPEDFILES__11111111111111111.txt @@ -1,5 +1,5 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:11:28}} +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:40:43}} {{DISPLAYTITLE:_TOTALDROPPEDFILES}} The [[_TOTALDROPPEDFILES]] function returns the number of items (files or folders) dropped in a program's window after [[_ACCEPTFILEDROP]] is enabled. @@ -30,4 +30,3 @@ The [[_TOTALDROPPEDFILES]] function returns the number of items (files or folder {{PageNavigation}} - diff --git a/internal/help/_TRIM$__1111$.txt b/internal/help/_TRIM$__1111$.txt index 2933aff5f..e314b737f 100644 --- a/internal/help/_TRIM$__1111$.txt +++ b/internal/help/_TRIM$__1111$.txt @@ -1,5 +1,5 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:11:30}} +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:40:44}} {{DISPLAYTITLE:_TRIM$}} The [[_TRIM$]] function removes both leading and trailing space characters from a [[STRING]] value. @@ -39,3 +39,4 @@ text$ = {{Cl|SPACE$}}(10) + "some text" + {{Cl|SPACE$}}(10) {{PageNavigation}} +[[Category:Latest]] diff --git a/internal/help/_UNSIGNED__11111111.txt b/internal/help/_UNSIGNED__11111111.txt index cc73e438d..bb41dab5b 100644 --- a/internal/help/_UNSIGNED__11111111.txt +++ b/internal/help/_UNSIGNED__11111111.txt @@ -1,5 +1,5 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:11:31}} +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:40:45}} {{DISPLAYTITLE:_UNSIGNED}} [[_UNSIGNED]] defines a numerical value as being only positive. @@ -19,7 +19,7 @@ * The unsigned variable type suffix used is the '''tilde (~)''', right before the number's own type suffix: {{Parameter|variableName~&}} -
How negative values affect the [[_UNSIGNED]] value returned by a [[_BYTE]] (8 bits).
+
How negative values affect the [[_UNSIGNED]] value returned by a [[_BYTE]] (8 bits).
{{WhiteStart}} 00000001 - unsigned & signed are both 1 01111111 - unsigned & signed are both 127 @@ -89,4 +89,3 @@ i~% = 70000 {{PageNavigation}} - diff --git a/internal/help/_WHEEL__11111.txt b/internal/help/_WHEEL__11111.txt index 22e56d6c5..8fb5a81e8 100644 --- a/internal/help/_WHEEL__11111.txt +++ b/internal/help/_WHEEL__11111.txt @@ -1,5 +1,5 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:11:35}} +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:40:49}} {{DISPLAYTITLE:_WHEEL}} The [[_WHEEL]] function returns the relative position of a specified wheel number on a controller device. @@ -71,3 +71,4 @@ DO: {{Cl|_LIMIT}} 30 'main loop {{PageNavigation}} +[[Category:Latest]] diff --git a/internal/help/_WIDTH_(function)__11111_(00000000).txt b/internal/help/_WIDTH_(function)__11111_(00000000).txt index d387f0017..8f276d77e 100644 --- a/internal/help/_WIDTH_(function)__11111_(00000000).txt +++ b/internal/help/_WIDTH_(function)__11111_(00000000).txt @@ -1,5 +1,5 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:11:36}} +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:40:50}} {{DISPLAYTITLE:_WIDTH (function)}} The [[_WIDTH (function)|_WIDTH]] function returns the width of an image handle or of the current write page. @@ -50,3 +50,4 @@ The [[_WIDTH (function)|_WIDTH]] function returns the width of an image handle o {{PageNavigation}} +[[Category:Latest]] diff --git a/internal/help/_WINDOWHANDLE__111111111111.txt b/internal/help/_WINDOWHANDLE__111111111111.txt index 3b3bb4e1a..82f917454 100644 --- a/internal/help/_WINDOWHANDLE__111111111111.txt +++ b/internal/help/_WINDOWHANDLE__111111111111.txt @@ -1,5 +1,5 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:11:38}} +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:40:51}} {{DISPLAYTITLE:_WINDOWHANDLE}} The [[_WINDOWHANDLE]] function returns the window handle assigned to the current program by the OS. Windows-only. @@ -96,4 +96,3 @@ MsgBox& = MessageBoxA&({{Cl|_WINDOWHANDLE}}, Message$, Title$, BoxType& + Icon& {{PageNavigation}} - diff --git a/internal/help/_WINDOWHASFOCUS__11111111111111.txt b/internal/help/_WINDOWHASFOCUS__11111111111111.txt index 0fbcae287..ce04e0632 100644 --- a/internal/help/_WINDOWHASFOCUS__11111111111111.txt +++ b/internal/help/_WINDOWHASFOCUS__11111111111111.txt @@ -1,5 +1,5 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:11:39}} +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:40:52}} {{DISPLAYTITLE:_WINDOWHASFOCUS}} The [[_WINDOWHASFOCUS]] function returns true (-1) if the current program's window has focus. Windows-only. @@ -42,4 +42,3 @@ DO {{PageNavigation}} - diff --git a/internal/help/_glAccum__0010000.txt b/internal/help/_glAccum__0010000.txt new file mode 100644 index 000000000..dacdd2192 --- /dev/null +++ b/internal/help/_glAccum__0010000.txt @@ -0,0 +1,32 @@ +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:45:49}} +{{DISPLAYTITLE:_glAccum}} +The '''_glAccum''' statement operates on the accumulation buffer. + + +{{PageSyntax}} +: '''_glAccum''' GLenum {{Parameter|op}}, GLfloat {{Parameter|value}} + + +{{PageParameters}} +* OpenGL is using its own set of variable types to describe its command parameters. +* Use the following table to find the respective QB64 [[Variable Types]]. +{{OpenGLTypesPlugin}} + + +{{PageDescription}} +* OpenGL's documentation is available in several places, so we won't reproduce it here for another time. +* The full description for this command can be found at [https://docs.microsoft.com/en-us/windows/win32/opengl/glaccum Microsoft Docs] and is also valid for QB64 usage. + + +{{PageSeeAlso}} +* [[_GL|SUB _GL]] +* [[_glBegin]], [[_glBlendFunc]], [[_glClear]], [[_glClearAccum]] +* [[_glCopyPixels]], [[_glEnd]], [https://docs.microsoft.com/en-us/windows/win32/opengl/glgetbooleanv--glgetdoublev--glgetfloatv--glgetintegerv _glGet], [[_glLogicOp]] +* [https://docs.microsoft.com/en-us/windows/win32/opengl/glpixelstore-functions _glPixelStore], [https://docs.microsoft.com/en-us/windows/win32/opengl/glpixeltransfer _glPixelTransfer], [[_glReadBuffer]], [[_glReadPixels]] +* [[_glScissor]], [[_glStencilOp]] + + +{{PageNavigation}} + +[[Category:Final]] diff --git a/internal/help/_glAlphaFunc__00100001000.txt b/internal/help/_glAlphaFunc__00100001000.txt new file mode 100644 index 000000000..b9ccc58b6 --- /dev/null +++ b/internal/help/_glAlphaFunc__00100001000.txt @@ -0,0 +1,31 @@ +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:45:51}} +{{DISPLAYTITLE:_glAlphaFunc}} +The '''_glAlphaFunc''' statement enables your application to set the alpha test function. + + +{{PageSyntax}} +: '''_glAlphaFunc''' GLenum {{Parameter|func}}, GLclampf {{Parameter|ref}} + + +{{PageParameters}} +* OpenGL is using its own set of variable types to describe its command parameters. +* Use the following table to find the respective QB64 [[Variable Types]]. +{{OpenGLTypesPlugin}} + + +{{PageDescription}} +* OpenGL's documentation is available in several places, so we won't reproduce it here for another time. +* The full description for this command can be found at [https://docs.microsoft.com/en-us/windows/win32/opengl/glalphafunc Microsoft Docs] and is also valid for QB64 usage. + + +{{PageSeeAlso}} +* [[_GL|SUB _GL]] +* [[_glBegin]], [[_glBlendFunc]], [[_glClear]], [[_glDepthFunc]] +* [[_glEnable]], [[_glEnd]], [https://docs.microsoft.com/en-us/windows/win32/opengl/glgetbooleanv--glgetdoublev--glgetfloatv--glgetintegerv _glGet], [[_glIsEnabled]] +* [[_glStencilFunc]] + + +{{PageNavigation}} + +[[Category:Final]] diff --git a/internal/help/_glAreTexturesResident__001001000000010000000.txt b/internal/help/_glAreTexturesResident__001001000000010000000.txt new file mode 100644 index 000000000..4fc8f1c75 --- /dev/null +++ b/internal/help/_glAreTexturesResident__001001000000010000000.txt @@ -0,0 +1,30 @@ +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:45:54}} +{{DISPLAYTITLE:_glAreTexturesResident}} +The '''_glAreTexturesResident''' function determines whether specified texture objects are resident in texture memory. + + +{{PageSyntax}} +: GLboolean {{Parameter|result}} = '''_glAreTexturesResident''' (GLsizei {{Parameter|n}}, const GLuint {{Parameter|*textures}}, GLboolean {{Parameter|*residences}}) + + +{{PageParameters}} +* OpenGL is using its own set of variable types to describe its command parameters. +* Use the following table to find the respective QB64 [[Variable Types]]. +{{OpenGLTypesPlugin}} + + +{{PageDescription}} +* OpenGL's documentation is available in several places, so we won't reproduce it here for another time. +* The full description for this command can be found at [https://docs.microsoft.com/en-us/windows/win32/opengl/glaretexturesresident Microsoft Docs] and is also valid for QB64 usage. + + +{{PageSeeAlso}} +* [[_GL|SUB _GL]] +* [[_glBegin]], [[_glBindTexture]], [[_glEnd]], [https://docs.microsoft.com/en-us/windows/win32/opengl/glgettexparameter _glGetTexParameter] +* [[_glPrioritizeTextures]], [[_glTexImage1D]], [[_glTexImage2D]] + + +{{PageNavigation}} + +[[Category:Final]] diff --git a/internal/help/_glArrayElement__00100001000000.txt b/internal/help/_glArrayElement__00100001000000.txt new file mode 100644 index 000000000..56e0bffe7 --- /dev/null +++ b/internal/help/_glArrayElement__00100001000000.txt @@ -0,0 +1,31 @@ +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:45:56}} +{{DISPLAYTITLE:_glArrayElement}} +The '''_glArrayElement''' statement specifies the array elements used to render a vertex. + + +{{PageSyntax}} +: '''_glArrayElement''' GLint {{Parameter|index}} + + +{{PageParameters}} +* OpenGL is using its own set of variable types to describe its command parameters. +* Use the following table to find the respective QB64 [[Variable Types]]. +{{OpenGLTypesPlugin}} + + +{{PageDescription}} +* OpenGL's documentation is available in several places, so we won't reproduce it here for another time. +* The full description for this command can be found at [https://docs.microsoft.com/en-us/windows/win32/opengl/glarrayelement Microsoft Docs] and is also valid for QB64 usage. + + +{{PageSeeAlso}} +* [[_GL|SUB _GL]] +* [[_glBegin]], [[_glColorPointer]], [[_glDrawArrays]], [[_glEdgeFlagPointer]] +* [[_glEnableClientState]], [[_glEnd]], [[_glGetPointerv]], [[_glGetString]] +* [[_glIndexPointer]], [[_glNormalPointer]], [[_glTexCoordPointer]], [[_glVertexPointer]] + + +{{PageNavigation}} + +[[Category:Final]] diff --git a/internal/help/_glBegin__0010000.txt b/internal/help/_glBegin__0010000.txt new file mode 100644 index 000000000..daac04017 --- /dev/null +++ b/internal/help/_glBegin__0010000.txt @@ -0,0 +1,31 @@ +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:45:58}} +{{DISPLAYTITLE:_glBegin}} +The '''_glBegin''' and '''_glEnd''' statements delimit the vertices of a primitive or a group of like primitives. + + +{{PageSyntax}} +: '''_glBegin''' GLenum {{Parameter|mode}} + + +{{PageParameters}} +* OpenGL is using its own set of variable types to describe its command parameters. +* Use the following table to find the respective QB64 [[Variable Types]]. +{{OpenGLTypesPlugin}} + + +{{PageDescription}} +* OpenGL's documentation is available in several places, so we won't reproduce it here for another time. +* The full description for this command can be found at [https://docs.microsoft.com/en-us/windows/win32/opengl/glbegin Microsoft Docs] and is also valid for QB64 usage. + + +{{PageSeeAlso}} +* [[_GL|SUB _GL]] +* [[_glCallList]], [[_glCallLists]], [https://docs.microsoft.com/en-us/windows/win32/opengl/glcolor-functions _glColor], [https://docs.microsoft.com/en-us/windows/win32/opengl/gledgeflag-functions _glEdgeFlag] +* [[_glEnd]], [https://docs.microsoft.com/en-us/windows/win32/opengl/glevalcoord-functions _glEvalCoord], [https://docs.microsoft.com/en-us/windows/win32/opengl/glevalpoint _glEvalPoint], [https://docs.microsoft.com/en-us/windows/win32/opengl/glindex-functions _glIndex] +* [https://docs.microsoft.com/en-us/windows/win32/opengl/glmaterial-functions _glMaterial], [https://docs.microsoft.com/en-us/windows/win32/opengl/glnormal-functions _glNormal], [https://docs.microsoft.com/en-us/windows/win32/opengl/gltexcoord-functions _glTexCoord], [https://docs.microsoft.com/en-us/windows/win32/opengl/glvertex-functions _glVertex] + + +{{PageNavigation}} + +[[Category:Final]] diff --git a/internal/help/_glBindTexture__0010001000000.txt b/internal/help/_glBindTexture__0010001000000.txt index d8e8f3d31..8449197d4 100644 --- a/internal/help/_glBindTexture__0010001000000.txt +++ b/internal/help/_glBindTexture__0010001000000.txt @@ -1,60 +1,31 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:17:42}} -'''_glBindTexture:''' bind a named texture to a texturing target +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:46:00}} +{{DISPLAYTITLE:_glBindTexture}} +The '''_glBindTexture''' statement enables the creation of a named texture that is bound to a texture target. {{PageSyntax}} - -:: SUB '''_glBindTexture''' (BYVAL target AS _UNSIGNED LONG, BYVAL texture AS _UNSIGNED LONG) -:: void '''_glBindTexture'''(GLenum {{Parameter|target}}, GLuint {{Parameter|texture}}); +: '''_glBindTexture''' GLenum {{Parameter|target}}, GLuint {{Parameter|texture}} -; target -: Specifies the target to which the texture is bound. Must be either {{KW|_GL_TEXTURE_1D}}, {{KW|_GL_TEXTURE_2D}}, {{KW|_GL_TEXTURE_3D}}, or {{KW|_GL_TEXTURE_1D_ARRAY}}, {{KW|_GL_TEXTURE_2D_ARRAY}}, {{KW|_GL_TEXTURE_RECTANGLE}}, {{KW|_GL_TEXTURE_CUBE_MAP}}, {{KW|_GL_TEXTURE_2D_MULTISAMPLE}}, {{KW|_GL_TEXTURE_2D_MULTISAMPLE_ARRAY}}, {{KW|_GL_TEXTURE_BUFFER}}, or {{KW|_GL_TEXTURE_CUBE_MAP_ARRAY}}. -; texture -: Specifies the name of a texture. +{{PageParameters}} +* OpenGL is using its own set of variable types to describe its command parameters. +* Use the following table to find the respective QB64 [[Variable Types]]. +{{OpenGLTypesPlugin}} {{PageDescription}} +* OpenGL's documentation is available in several places, so we won't reproduce it here for another time. +* The full description for this command can be found at [https://docs.microsoft.com/en-us/windows/win32/opengl/glbindtexture Microsoft Docs] and is also valid for QB64 usage. -'''_glBindTexture''' lets you create or use a named texture. Calling '''_glBindTexture''' with {{Parameter|target}} set to {{KW|_GL_TEXTURE_1D}}, {{KW|_GL_TEXTURE_2D}}, {{KW|_GL_TEXTURE_3D}}, or {{KW|_GL_TEXTURE_1D_ARRAY}}, {{KW|_GL_TEXTURE_2D_ARRAY}}, {{KW|_GL_TEXTURE_RECTANGLE}}, {{KW|_GL_TEXTURE_CUBE_MAP}}, {{KW|_GL_TEXTURE_2D_MULTISAMPLE}} or {{KW|_GL_TEXTURE_2D_MULTISAMPLE_ARRAY}} and {{Parameter|texture}} set to the name of the new texture binds the texture name to the target. When a texture is bound to a target, the previous binding for that target is automatically broken. - -Texture names are unsigned integers. The value zero is reserved to represent the default texture for each texture target. Texture names and the corresponding texture contents are local to the shared object space of the current GL rendering context; two rendering contexts share texture names only if they explicitly enable sharing between contexts through the appropriate GL windows interfaces functions. - -You must use {{KW|_glGenTextures}} to generate a set of new texture names. - -When a texture is first bound, it assumes the specified target: A texture first bound to {{KW|_GL_TEXTURE_1D}} becomes one-dimensional texture, a texture first bound to {{KW|_GL_TEXTURE_2D}} becomes two-dimensional texture, a texture first bound to {{KW|_GL_TEXTURE_3D}} becomes three-dimensional texture, a texture first bound to {{KW|_GL_TEXTURE_1D_ARRAY}} becomes one-dimensional array texture, a texture first bound to {{KW|_GL_TEXTURE_2D_ARRAY}} becomes two-dimensional arary texture, a texture first bound to {{KW|_GL_TEXTURE_RECTANGLE}} becomes rectangle texture, a, texture first bound to {{KW|_GL_TEXTURE_CUBE_MAP}} becomes a cube-mapped texture, a texture first bound to {{KW|_GL_TEXTURE_2D_MULTISAMPLE}} becomes a two-dimensional multisampled texture, and a texture first bound to {{KW|_GL_TEXTURE_2D_MULTISAMPLE_ARRAY}} becomes a two-dimensional multisampled array texture. The state of a one-dimensional texture immediately after it is first bound is equivalent to the state of the default {{KW|_GL_TEXTURE_1D}} at GL initialization, and similarly for the other texture types. - -While a texture is bound, GL operations on the target to which it is bound affect the bound texture, and queries of the target to which it is bound return state from the bound texture. In effect, the texture targets become aliases for the textures currently bound to them, and the texture name zero refers to the default textures that were bound to them at initialization. - -A texture binding created with '''_glBindTexture''' remains active until a different texture is bound to the same target, or until the bound texture is deleted with {{KW|_glDeleteTextures}}. - -Once created, a named texture may be re-bound to its same original target as often as needed. It is usually much faster to use '''_glBindTexture''' to bind an existing named texture to one of the texture targets than it is to reload the texture image using {{KW|_glTexImage1D}}, {{KW|_glTexImage2D}}, {{KW|_glTexImage3D}} or another similar function. - - -{{PageNotes}} - -The {{KW|_GL_TEXTURE_2D_MULTISAMPLE}} and {{KW|_GL_TEXTURE_2D_MULTISAMPLE_ARRAY}} targets are available only if the GL version is 3.2 or higher. - - -{{PageErrors}} - -{{KW|_GL_INVALID_ENUM}} is generated if {{Parameter|target}} is not one of the allowable values. - -{{KW|_GL_INVALID_VALUE}} is generated if {{Parameter|target}} is not a name returned from a previous call to {{KW|_glGenTextures}}. - -{{KW|_GL_INVALID_OPERATION}} is generated if {{Parameter|texture}} was previously created with a target that doesn't match that of {{Parameter|target}}. - - -{{PageUseWith}} - -{{KW|_glGet}} with argument {{KW|_GL_TEXTURE_BINDING_1D}}, {{KW|_GL_TEXTURE_BINDING_2D}}, {{KW|_GL_TEXTURE_BINDING_3D}}, {{KW|_GL_TEXTURE_BINDING_1D_ARRAY}}, {{KW|_GL_TEXTURE_BINDING_2D_ARRAY}}, {{KW|_GL_TEXTURE_BINDING_RECTANGLE}}, {{KW|_GL_TEXTURE_BINDING_2D_MULTISAMPLE}}, or {{KW|_GL_TEXTURE_BINDING_2D_MULTISAMPLE_ARRAY}}. {{PageSeeAlso}} - -[[_GL|SUB _GL]] -{{KW|_glActiveTexture}}, {{KW|_glDeleteTextures}}, {{KW|_glGenTextures}}, {{KW|_glGetTexParameter}}, {{KW|_glIsTexture}}, {{KW|_glTexParameter}} +* [[_GL|SUB _GL]] +* [[_glAreTexturesResident]], [[_glDeleteTextures]], [[_glGenTextures]], [https://docs.microsoft.com/en-us/windows/win32/opengl/glgetbooleanv--glgetdoublev--glgetfloatv--glgetintegerv _glGet] +* [https://docs.microsoft.com/en-us/windows/win32/opengl/glgettexparameter _glGetTexParameter], [[_glIsTexture]], [[_glPrioritizeTextures]], [[_glTexImage1D]] +* [[_glTexImage2D]], [https://docs.microsoft.com/en-us/windows/win32/opengl/gltexparameter-functions _glTexParameter] -{{PageCopyright}} +{{PageNavigation}} +[[Category:Final]] diff --git a/internal/help/_glBitmap__00100000.txt b/internal/help/_glBitmap__00100000.txt new file mode 100644 index 000000000..38ace6922 --- /dev/null +++ b/internal/help/_glBitmap__00100000.txt @@ -0,0 +1,30 @@ +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:46:02}} +{{DISPLAYTITLE:_glBitmap}} +The '''_glBitmap''' statement draws a bitmap. + + +{{PageSyntax}} +: '''_glBitmap''' GLSizei {{Parameter|width}}, GLSizei {{Parameter|height}}, GLfloat {{Parameter|xorig}}, GLfloat {{Parameter|yorig}}, GLfloat {{Parameter|xmove}}, GLfloat {{Parameter|ymove}}, const GLubyte {{Parameter|*bitmap}} + + +{{PageParameters}} +* OpenGL is using its own set of variable types to describe its command parameters. +* Use the following table to find the respective QB64 [[Variable Types]]. +{{OpenGLTypesPlugin}} + + +{{PageDescription}} +* OpenGL's documentation is available in several places, so we won't reproduce it here for another time. +* The full description for this command can be found at [https://docs.microsoft.com/en-us/windows/win32/opengl/glbitmap Microsoft Docs] and is also valid for QB64 usage. + + +{{PageSeeAlso}} +* [[_GL|SUB _GL]] +* [[_glBegin]], [[_glDrawPixels]], [[_glEnd]], [https://docs.microsoft.com/en-us/windows/win32/opengl/glpixelstore-functions _glPixelStore] +* [https://docs.microsoft.com/en-us/windows/win32/opengl/glpixeltransfer _glPixelTransfer], [https://docs.microsoft.com/en-us/windows/win32/opengl/glrasterpos-functions _glRasterPos] + + +{{PageNavigation}} + +[[Category:Final]] diff --git a/internal/help/_glBlendFunc__00100001000.txt b/internal/help/_glBlendFunc__00100001000.txt new file mode 100644 index 000000000..f771abe34 --- /dev/null +++ b/internal/help/_glBlendFunc__00100001000.txt @@ -0,0 +1,31 @@ +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:46:05}} +{{DISPLAYTITLE:_glBlendFunc}} +The '''_glBlendFunc''' statement specifies pixel arithmetic. + + +{{PageSyntax}} +: '''_glBlendFunc''' GLenum {{Parameter|sfactor}}, GLenum {{Parameter|dfactor}} + + +{{PageParameters}} +* OpenGL is using its own set of variable types to describe its command parameters. +* Use the following table to find the respective QB64 [[Variable Types]]. +{{OpenGLTypesPlugin}} + + +{{PageDescription}} +* OpenGL's documentation is available in several places, so we won't reproduce it here for another time. +* The full description for this command can be found at [https://docs.microsoft.com/en-us/windows/win32/opengl/glblendfunc Microsoft Docs] and is also valid for QB64 usage. + + +{{PageSeeAlso}} +* [[_GL|SUB _GL]] +* [[_glAlphaFunc]], [[_glBegin]], [[_glClear]], [[_glDisable]] +* [[_glDrawBuffer]], [[_glEnable]], [https://docs.microsoft.com/en-us/windows/win32/opengl/glgetbooleanv--glgetdoublev--glgetfloatv--glgetintegerv _glGet], [[_glIsEnabled]] +* [[_glLogicOp]], [[_glStencilFunc]] + + +{{PageNavigation}} + +[[Category:Final]] diff --git a/internal/help/_glCallList__0010001000.txt b/internal/help/_glCallList__0010001000.txt new file mode 100644 index 000000000..07ac6d872 --- /dev/null +++ b/internal/help/_glCallList__0010001000.txt @@ -0,0 +1,31 @@ +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:46:07}} +{{DISPLAYTITLE:_glCallList}} +The '''_glCallList''' statement executes a display list. + + +{{PageSyntax}} +: '''_glCallList''' GLuint {{Parameter|list}} + + +{{PageParameters}} +* OpenGL is using its own set of variable types to describe its command parameters. +* Use the following table to find the respective QB64 [[Variable Types]]. +{{OpenGLTypesPlugin}} + + +{{PageDescription}} +* OpenGL's documentation is available in several places, so we won't reproduce it here for another time. +* The full description for this command can be found at [https://docs.microsoft.com/en-us/windows/win32/opengl/glcalllist Microsoft Docs] and is also valid for QB64 usage. + + +{{PageSeeAlso}} +* [[_GL|SUB _GL]] +* [[_glBegin]], [[_glCallLists]], [[_glDeleteLists]], [[_glEnd]] +* [[_glGenLists]], [https://docs.microsoft.com/en-us/windows/win32/opengl/glgetbooleanv--glgetdoublev--glgetfloatv--glgetintegerv _glGet], [[_glIsList]], [[_glNewList]] +* [[_glPopAttrib]], [[_glPopMatrix]], [[_glPushAttrib]], [[_glPushMatrix]] + + +{{PageNavigation}} + +[[Category:Final]] diff --git a/internal/help/_glCallLists__00100010000.txt b/internal/help/_glCallLists__00100010000.txt new file mode 100644 index 000000000..361ed0f0f --- /dev/null +++ b/internal/help/_glCallLists__00100010000.txt @@ -0,0 +1,32 @@ +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:46:09}} +{{DISPLAYTITLE:_glCallLists}} +The '''_glCallLists''' statement executes a list of display lists. + + +{{PageSyntax}} +: '''_glCallLists''' GLsizei {{Parameter|n}}, GLenum {{Parameter|type}}, const GLvoid {{Parameter|*lists}} + + +{{PageParameters}} +* OpenGL is using its own set of variable types to describe its command parameters. +* Use the following table to find the respective QB64 [[Variable Types]]. +{{OpenGLTypesPlugin}} + + +{{PageDescription}} +* OpenGL's documentation is available in several places, so we won't reproduce it here for another time. +* The full description for this command can be found at [https://docs.microsoft.com/en-us/windows/win32/opengl/glcalllists Microsoft Docs] and is also valid for QB64 usage. + + +{{PageSeeAlso}} +* [[_GL|SUB _GL]] +* [[_glBegin]], [[_glCallList]], [[_glDeleteLists]], [[_glEnd]] +* [[_glGenLists]], [https://docs.microsoft.com/en-us/windows/win32/opengl/glgetbooleanv--glgetdoublev--glgetfloatv--glgetintegerv _glGet], [[_glIsList]], [[_glListBase]] +* [[_glNewList]], [[_glPopAttrib]], [[_glPopMatrix]], [[_glPushAttrib]] +* [[_glPushMatrix]] + + +{{PageNavigation}} + +[[Category:Final]] diff --git a/internal/help/_glClearAccum__001000010000.txt b/internal/help/_glClearAccum__001000010000.txt new file mode 100644 index 000000000..28a3b6be6 --- /dev/null +++ b/internal/help/_glClearAccum__001000010000.txt @@ -0,0 +1,29 @@ +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:46:14}} +{{DISPLAYTITLE:_glClearAccum}} +The '''_glClearAccum''' statement specifies the clear values for the accumulation buffer. + + +{{PageSyntax}} +: '''_glClearAccum''' GLfloat {{Parameter|red}}, GLfloat {{Parameter|green}}, GLfloat {{Parameter|blue}}, GLfloat {{Parameter|alpha}} + + +{{PageParameters}} +* OpenGL is using its own set of variable types to describe its command parameters. +* Use the following table to find the respective QB64 [[Variable Types]]. +{{OpenGLTypesPlugin}} + + +{{PageDescription}} +* OpenGL's documentation is available in several places, so we won't reproduce it here for another time. +* The full description for this command can be found at [https://docs.microsoft.com/en-us/windows/win32/opengl/glclearaccum Microsoft Docs] and is also valid for QB64 usage. + + +{{PageSeeAlso}} +* [[_GL|SUB _GL]] +* [[_glBegin]], [[_glClear]], [[_glEnd]], [https://docs.microsoft.com/en-us/windows/win32/opengl/glgetbooleanv--glgetdoublev--glgetfloatv--glgetintegerv _glGet] + + +{{PageNavigation}} + +[[Category:Final]] diff --git a/internal/help/_glClearColor__001000010000.txt b/internal/help/_glClearColor__001000010000.txt index 655bc179b..404a7957d 100644 --- a/internal/help/_glClearColor__001000010000.txt +++ b/internal/help/_glClearColor__001000010000.txt @@ -1,37 +1,29 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:17:50}} -'''_glClearColor:''' specify clear values for the color buffers +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:46:16}} +{{DISPLAYTITLE:_glClearColor}} +The '''_glClearColor''' statement specifies clear values for the color buffers. {{PageSyntax}} - -:: SUB '''_glClearColor''' (BYVAL red AS SINGLE, BYVAL green AS SINGLE, BYVAL blue AS SINGLE, BYVAL alpha AS SINGLE) -:: void '''_glClearColor'''(GLfloat {{Parameter|red}}, GLfloat {{Parameter|green}}, GLfloat {{Parameter|blue}}, GLfloat {{Parameter|alpha}}); +: '''_glClearColor''' GLclampf {{Parameter|red}}, GLclampf {{Parameter|green}}, GLclampf {{Parameter|blue}}, GLclampf {{Parameter|alpha}} -; red, green, blue, alpha -: Specify the red, green, blue, and alpha values used when the color buffers are cleared. The initial values are all 0. +{{PageParameters}} +* OpenGL is using its own set of variable types to describe its command parameters. +* Use the following table to find the respective QB64 [[Variable Types]]. +{{OpenGLTypesPlugin}} {{PageDescription}} +* OpenGL's documentation is available in several places, so we won't reproduce it here for another time. +* The full description for this command can be found at [https://docs.microsoft.com/en-us/windows/win32/opengl/glclearcolor Microsoft Docs] and is also valid for QB64 usage. -'''_glClearColor''' specifies the red, green, blue, and alpha values used by {{KW|_glClear}} to clear the color buffers. - - -{{PageNotes}} - -The type of the {{Parameter|red}}, {{Parameter|green}}, {{Parameter|blue}}, and {{Parameter|alpha}} parameters was changed from GLclampf to GLfloat. This change is transparent to user code. - - -{{PageUseWith}} - -{{KW|_glGet}} with argument {{KW|_GL_COLOR_CLEAR_VALUE}} {{PageSeeAlso}} - -[[_GL|SUB _GL]] -{{KW|_glClear}} +* [[_GL|SUB _GL]] +* [[_glBegin]], [[_glClear]], [[_glEnd]], [https://docs.microsoft.com/en-us/windows/win32/opengl/glgetbooleanv--glgetdoublev--glgetfloatv--glgetintegerv _glGet] -{{PageCopyright}} +{{PageNavigation}} +[[Category:Final]] diff --git a/internal/help/_glClearDepth__001000010000.txt b/internal/help/_glClearDepth__001000010000.txt index 1ba5aba68..7a0907116 100644 --- a/internal/help/_glClearDepth__001000010000.txt +++ b/internal/help/_glClearDepth__001000010000.txt @@ -1,37 +1,29 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:17:52}} -'''_glClearDepth:''' specify the clear value for the depth buffer +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:46:18}} +{{DISPLAYTITLE:_glClearDepth}} +The '''_glClearDepth''' statement specifies the clear value for the depth buffer. {{PageSyntax}} +: '''_glClearDepth''' GLclampd {{Parameter|depth}} -:: SUB _glClearDepth (BYVAL depth AS DOUBLE) -:: void '''_glClearDepth'''(GLdouble {{Parameter|depth}}); -:: void '''_glClearDepthf'''(GLfloat {{Parameter|depth}}); -; depth -: Specifies the depth value used when the depth buffer is cleared. The initial value is 1. +{{PageParameters}} +* OpenGL is using its own set of variable types to describe its command parameters. +* Use the following table to find the respective QB64 [[Variable Types]]. +{{OpenGLTypesPlugin}} {{PageDescription}} +* OpenGL's documentation is available in several places, so we won't reproduce it here for another time. +* The full description for this command can be found at [https://docs.microsoft.com/en-us/windows/win32/opengl/glcleardepth Microsoft Docs] and is also valid for QB64 usage. -'''_glClearDepth''' specifies the depth value used by {{KW|_glClear}} to clear the depth buffer. Values specified by '''_glClearDepth''' are clamped to the range [0, 1]. - - -{{PageNotes}} - -The type of the {{Parameter|depth}} parameter was changed from GLclampf to GLfloat for '''_glClearDepthf''' and from GLclampd to GLdouble for '''_glClearDepth'''. This change is transparent to user code. - - -{{PageUseWith}} - -{{KW|_glGet}} with argument {{KW|_GL_DEPTH_CLEAR_VALUE}} {{PageSeeAlso}} - -[[_GL|SUB _GL]] -{{KW|_glClear}} +* [[_GL|SUB _GL]] +* [[_glBegin]], [[_glClear]], [[_glEnd]], [https://docs.microsoft.com/en-us/windows/win32/opengl/glgetbooleanv--glgetdoublev--glgetfloatv--glgetintegerv _glGet] -{{PageCopyright}} +{{PageNavigation}} +[[Category:Final]] diff --git a/internal/help/_glClearIndex__001000010000.txt b/internal/help/_glClearIndex__001000010000.txt new file mode 100644 index 000000000..0ba9ee37e --- /dev/null +++ b/internal/help/_glClearIndex__001000010000.txt @@ -0,0 +1,29 @@ +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:46:20}} +{{DISPLAYTITLE:_glClearIndex}} +The '''_glClearIndex''' statement specifies the clear value for the color-index buffers. + + +{{PageSyntax}} +: '''_glClearIndex''' GLfloat {{Parameter|c}} + + +{{PageParameters}} +* OpenGL is using its own set of variable types to describe its command parameters. +* Use the following table to find the respective QB64 [[Variable Types]]. +{{OpenGLTypesPlugin}} + + +{{PageDescription}} +* OpenGL's documentation is available in several places, so we won't reproduce it here for another time. +* The full description for this command can be found at [https://docs.microsoft.com/en-us/windows/win32/opengl/glclearindex Microsoft Docs] and is also valid for QB64 usage. + + +{{PageSeeAlso}} +* [[_GL|SUB _GL]] +* [[_glBegin]], [[_glClear]], [[_glEnd]], [https://docs.microsoft.com/en-us/windows/win32/opengl/glgetbooleanv--glgetdoublev--glgetfloatv--glgetintegerv _glGet] + + +{{PageNavigation}} + +[[Category:Final]] diff --git a/internal/help/_glClearStencil__00100001000000.txt b/internal/help/_glClearStencil__00100001000000.txt index 9cce6cfee..c8b8be694 100644 --- a/internal/help/_glClearStencil__00100001000000.txt +++ b/internal/help/_glClearStencil__00100001000000.txt @@ -1,35 +1,29 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:17:54}} -'''_glClearStencil:''' specify the clear value for the stencil buffer +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:46:22}} +{{DISPLAYTITLE:_glClearStencil}} +The '''_glClearStencil''' statement specifies the clear value for the stencil buffer. {{PageSyntax}} - -:: SUB _glClearStencil (BYVAL s AS LONG) -:: void '''_glClearStencil'''(GLint {{Parameter|s}}); +: '''_glClearStencil''' GLint {{Parameter|s}} -; s -: Specifies the index used when the stencil buffer is cleared. The initial value is 0. +{{PageParameters}} +* OpenGL is using its own set of variable types to describe its command parameters. +* Use the following table to find the respective QB64 [[Variable Types]]. +{{OpenGLTypesPlugin}} {{PageDescription}} - -'''_glClearStencil''' specifies the index used by {{KW|_glClear}} to clear the stencil buffer. {{Parameter|s}} is masked with 2m - 1, where m is the number of bits in the stencil buffer. - - -{{PageUseWith}} - -{{KW|_glGet}} with argument {{KW|_GL_STENCIL_CLEAR_VALUE}} - -{{KW|_glGet}} with argument {{KW|_GL_STENCIL_BITS}} +* OpenGL's documentation is available in several places, so we won't reproduce it here for another time. +* The full description for this command can be found at [https://docs.microsoft.com/en-us/windows/win32/opengl/glclearstencil Microsoft Docs] and is also valid for QB64 usage. {{PageSeeAlso}} - -[[_GL|SUB _GL]] -{{KW|_glClear}} +* [[_GL|SUB _GL]] +* [[_glBegin]], [[_glClear]], [[_glEnd]], [https://docs.microsoft.com/en-us/windows/win32/opengl/glgetbooleanv--glgetdoublev--glgetfloatv--glgetintegerv _glGet] -{{PageCopyright}} +{{PageNavigation}} +[[Category:Final]] diff --git a/internal/help/_glClear__0010000.txt b/internal/help/_glClear__0010000.txt index c8bef2c84..c2af71799 100644 --- a/internal/help/_glClear__0010000.txt +++ b/internal/help/_glClear__0010000.txt @@ -1,59 +1,30 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:17:48}} -'''_glClear:''' clear buffers to preset values +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:46:11}} +{{DISPLAYTITLE:_glClear}} +The '''_glClear''' statement clears buffers to preset values. {{PageSyntax}} - -:: [[SUB]] _glClear ([[BYVAL]] mask AS [[_UNSIGNED]] [[LONG]]) -:: void '''_glClear'''(GLbitfield {{Parameter|mask}}); +: '''_glClear''' GLbitfield {{Parameter|mask}} {{PageParameters}} -* ''mask'' that indicate the buffer [[OR]] buffers to be cleared. The three masks are [[_GL_COLOR_BUFFER_BIT]], [[_GL_DEPTH_BUFFER_BIT]], and [[_GL_STENCIL_BUFFER_BIT]]. +* OpenGL is using its own set of variable types to describe its command parameters. +* Use the following table to find the respective QB64 [[Variable Types]]. +{{OpenGLTypesPlugin}} {{PageDescription}} - -* [[_glClear]] sets the bitplane area of the window to values previously selected by [[_glClearColor]], [[glClearDepth]], and [[_glClearStencil]]. -* Multiple color buffers can be cleared simultaneously by selecting more than one buffer at a time using [[_glDrawBuffer]]. -* The pixel ownership test, the scissor test, dithering, and the buffer writemasks affect the operation of [[_glClear]]. The scissor box bounds the cleared region. Alpha function, blend function, logical operation, stenciling, texture mapping, and depth-buffering are ignored by [[_glClear]]. - -* [[_glClear]] takes a single argument that is the bitwise OR of several values indicating which buffer is to be cleared. The values are as follows: - -::: [[_GL_COLOR_BUFFER_BIT]]: Indicates the buffers currently enabled for color writing. -::: [[_GL_DEPTH_BUFFER_BIT]]: Indicates the depth buffer. -::: [[_GL_STENCIL_BUFFER_BIT]]: Indicates the stencil buffer. - -* The value to which each buffer is cleared depends on the setting of the clear value for that buffer. - - -{{PageNotes}} - -If a buffer is not present, then a '''_glClear''' directed at that buffer has no effect. - - -{{PageErrors}} - -{{KW|_GL_INVALID_VALUE}} is generated if any bit other than the three defined bits is set in {{Parameter|mask}}. - - -{{PageUseWith}} - -{{KW|_glGet}} with argument {{KW|_GL_DEPTH_CLEAR_VALUE}} - -{{KW|_glGet}} with argument {{KW|_GL_COLOR_CLEAR_VALUE}} - -{{KW|_glGet}} with argument {{KW|_GL_STENCIL_CLEAR_VALUE}} +* OpenGL's documentation is available in several places, so we won't reproduce it here for another time. +* The full description for this command can be found at [https://docs.microsoft.com/en-us/windows/win32/opengl/glclear Microsoft Docs] and is also valid for QB64 usage. {{PageSeeAlso}} -* [[_GL]] -* [[_glClearBuffer]], [[_glClearColor]], [[_glClearDepth]], [[_glClearStencil]] -* [[_glColorMask]], [[_glDepthMask]], [[_glStencilMask]] -* [[_glDrawBuffer]], [[_glDrawBuffers]] -* [[_glScissor]] +* [[_GL|SUB _GL]] +* [[_glClearAccum]], [[_glClearColor]], [[_glClearDepth]], [[_glClearIndex]] +* [[_glClearStencil]], [[_glDrawBuffer]], [https://docs.microsoft.com/en-us/windows/win32/opengl/glgetbooleanv--glgetdoublev--glgetfloatv--glgetintegerv _glGet], [[_glScissor]] -{{PageCopyright}} +{{PageNavigation}} +[[Category:Final]] diff --git a/internal/help/_glClipPlane__00100010000.txt b/internal/help/_glClipPlane__00100010000.txt new file mode 100644 index 000000000..7b9c58b58 --- /dev/null +++ b/internal/help/_glClipPlane__00100010000.txt @@ -0,0 +1,30 @@ +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:46:24}} +{{DISPLAYTITLE:_glClipPlane}} +The '''_glClipPlane''' statement specifies a plane against which all geometry is clipped. + + +{{PageSyntax}} +: '''_glClipPlane''' GLenum {{Parameter|plane}}, const GLdouble {{Parameter|*equation}} + + +{{PageParameters}} +* OpenGL is using its own set of variable types to describe its command parameters. +* Use the following table to find the respective QB64 [[Variable Types]]. +{{OpenGLTypesPlugin}} + + +{{PageDescription}} +* OpenGL's documentation is available in several places, so we won't reproduce it here for another time. +* The full description for this command can be found at [https://docs.microsoft.com/en-us/windows/win32/opengl/glclipplane Microsoft Docs] and is also valid for QB64 usage. + + +{{PageSeeAlso}} +* [[_GL|SUB _GL]] +* [[_glBegin]], [[_glDisable]], [[_glEnable]], [[_glEnd]] +* [[_glGetClipPlane]], [[_glIsEnabled]] + + +{{PageNavigation}} + +[[Category:Final]] diff --git a/internal/help/_glColor3b__001000030.txt b/internal/help/_glColor3b__001000030.txt new file mode 100644 index 000000000..7fb335c59 --- /dev/null +++ b/internal/help/_glColor3b__001000030.txt @@ -0,0 +1,29 @@ +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:46:27}} +{{DISPLAYTITLE:_glColor3b}} +The '''_glColor3b''' statement sets the current color. + + +{{PageSyntax}} +: '''_glColor3b''' GLbyte {{Parameter|red}}, GLbyte {{Parameter|green}}, GLbyte {{Parameter|blue}} + + +{{PageParameters}} +* OpenGL is using its own set of variable types to describe its command parameters. +* Use the following table to find the respective QB64 [[Variable Types]]. +{{OpenGLTypesPlugin}} + + +{{PageDescription}} +* OpenGL's documentation is available in several places, so we won't reproduce it here for another time. +* The full description for this command can be found at [https://docs.microsoft.com/en-us/windows/win32/opengl/glcolor3b Microsoft Docs] and is also valid for QB64 usage. + + +{{PageSeeAlso}} +* [[_GL|SUB _GL]] +* [[_glBegin]], [[_glEnd]], [https://docs.microsoft.com/en-us/windows/win32/opengl/glgetbooleanv--glgetdoublev--glgetfloatv--glgetintegerv _glGet], [https://docs.microsoft.com/en-us/windows/win32/opengl/glindex-functions _glIndex] + + +{{PageNavigation}} + +[[Category:Final]] diff --git a/internal/help/_glColor3bv__0010000300.txt b/internal/help/_glColor3bv__0010000300.txt new file mode 100644 index 000000000..8e7b283cf --- /dev/null +++ b/internal/help/_glColor3bv__0010000300.txt @@ -0,0 +1,29 @@ +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:46:29}} +{{DISPLAYTITLE:_glColor3bv}} +The '''_glColor3bv''' statement sets the current color from an already existing array of color values. + + +{{PageSyntax}} +: '''_glColor3bv''' const GLbyte {{Parameter|*v}} + + +{{PageParameters}} +* OpenGL is using its own set of variable types to describe its command parameters. +* Use the following table to find the respective QB64 [[Variable Types]]. +{{OpenGLTypesPlugin}} + + +{{PageDescription}} +* OpenGL's documentation is available in several places, so we won't reproduce it here for another time. +* The full description for this command can be found at [https://docs.microsoft.com/en-us/windows/win32/opengl/glcolor3bv Microsoft Docs] and is also valid for QB64 usage. + + +{{PageSeeAlso}} +* [[_GL|SUB _GL]] +* [[_glBegin]], [[_glEnd]], [https://docs.microsoft.com/en-us/windows/win32/opengl/glgetbooleanv--glgetdoublev--glgetfloatv--glgetintegerv _glGet], [https://docs.microsoft.com/en-us/windows/win32/opengl/glindex-functions _glIndex] + + +{{PageNavigation}} + +[[Category:Final]] diff --git a/internal/help/_glColor3d__001000030.txt b/internal/help/_glColor3d__001000030.txt new file mode 100644 index 000000000..e4117e1c6 --- /dev/null +++ b/internal/help/_glColor3d__001000030.txt @@ -0,0 +1,29 @@ +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:46:31}} +{{DISPLAYTITLE:_glColor3d}} +The '''_glColor3d''' statement sets the current color. + + +{{PageSyntax}} +: '''_glColor3d''' GLdouble {{Parameter|red}}, GLdouble {{Parameter|green}}, GLdouble {{Parameter|blue}} + + +{{PageParameters}} +* OpenGL is using its own set of variable types to describe its command parameters. +* Use the following table to find the respective QB64 [[Variable Types]]. +{{OpenGLTypesPlugin}} + + +{{PageDescription}} +* OpenGL's documentation is available in several places, so we won't reproduce it here for another time. +* The full description for this command can be found at [https://docs.microsoft.com/en-us/windows/win32/opengl/glcolor3d Microsoft Docs] and is also valid for QB64 usage. + + +{{PageSeeAlso}} +* [[_GL|SUB _GL]] +* [[_glBegin]], [[_glEnd]], [https://docs.microsoft.com/en-us/windows/win32/opengl/glgetbooleanv--glgetdoublev--glgetfloatv--glgetintegerv _glGet], [https://docs.microsoft.com/en-us/windows/win32/opengl/glindex-functions _glIndex] + + +{{PageNavigation}} + +[[Category:Final]] diff --git a/internal/help/_glColor3dv__0010000300.txt b/internal/help/_glColor3dv__0010000300.txt new file mode 100644 index 000000000..07a141e07 --- /dev/null +++ b/internal/help/_glColor3dv__0010000300.txt @@ -0,0 +1,29 @@ +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:46:33}} +{{DISPLAYTITLE:_glColor3dv}} +The '''_glColor3dv''' statement sets the current color from an already existing array of color values. + + +{{PageSyntax}} +: '''_glColor3dv''' const GLdouble {{Parameter|*v}} + + +{{PageParameters}} +* OpenGL is using its own set of variable types to describe its command parameters. +* Use the following table to find the respective QB64 [[Variable Types]]. +{{OpenGLTypesPlugin}} + + +{{PageDescription}} +* OpenGL's documentation is available in several places, so we won't reproduce it here for another time. +* The full description for this command can be found at [https://docs.microsoft.com/en-us/windows/win32/opengl/glcolor3dv Microsoft Docs] and is also valid for QB64 usage. + + +{{PageSeeAlso}} +* [[_GL|SUB _GL]] +* [[_glBegin]], [[_glEnd]], [https://docs.microsoft.com/en-us/windows/win32/opengl/glgetbooleanv--glgetdoublev--glgetfloatv--glgetintegerv _glGet], [https://docs.microsoft.com/en-us/windows/win32/opengl/glindex-functions _glIndex] + + +{{PageNavigation}} + +[[Category:Final]] diff --git a/internal/help/_glColor3f__001000030.txt b/internal/help/_glColor3f__001000030.txt new file mode 100644 index 000000000..27813ca64 --- /dev/null +++ b/internal/help/_glColor3f__001000030.txt @@ -0,0 +1,29 @@ +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:46:35}} +{{DISPLAYTITLE:_glColor3f}} +The '''_glColor3f''' statement sets the current color. + + +{{PageSyntax}} +: '''_glColor3f''' GLfloat {{Parameter|red}}, GLfloat {{Parameter|green}}, GLfloat {{Parameter|blue}} + + +{{PageParameters}} +* OpenGL is using its own set of variable types to describe its command parameters. +* Use the following table to find the respective QB64 [[Variable Types]]. +{{OpenGLTypesPlugin}} + + +{{PageDescription}} +* OpenGL's documentation is available in several places, so we won't reproduce it here for another time. +* The full description for this command can be found at [https://docs.microsoft.com/en-us/windows/win32/opengl/glcolor3f Microsoft Docs] and is also valid for QB64 usage. + + +{{PageSeeAlso}} +* [[_GL|SUB _GL]] +* [[_glBegin]], [[_glEnd]], [https://docs.microsoft.com/en-us/windows/win32/opengl/glgetbooleanv--glgetdoublev--glgetfloatv--glgetintegerv _glGet], [https://docs.microsoft.com/en-us/windows/win32/opengl/glindex-functions _glIndex] + + +{{PageNavigation}} + +[[Category:Final]] diff --git a/internal/help/_glColor3fv__0010000300.txt b/internal/help/_glColor3fv__0010000300.txt new file mode 100644 index 000000000..a3ed0a3f1 --- /dev/null +++ b/internal/help/_glColor3fv__0010000300.txt @@ -0,0 +1,29 @@ +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:46:37}} +{{DISPLAYTITLE:_glColor3fv}} +The '''_glColor3fv''' statement sets the current color from an already existing array of color values. + + +{{PageSyntax}} +: '''_glColor3fv''' const GLfloat {{Parameter|*v}} + + +{{PageParameters}} +* OpenGL is using its own set of variable types to describe its command parameters. +* Use the following table to find the respective QB64 [[Variable Types]]. +{{OpenGLTypesPlugin}} + + +{{PageDescription}} +* OpenGL's documentation is available in several places, so we won't reproduce it here for another time. +* The full description for this command can be found at [https://docs.microsoft.com/en-us/windows/win32/opengl/glcolor3fv Microsoft Docs] and is also valid for QB64 usage. + + +{{PageSeeAlso}} +* [[_GL|SUB _GL]] +* [[_glBegin]], [[_glEnd]], [https://docs.microsoft.com/en-us/windows/win32/opengl/glgetbooleanv--glgetdoublev--glgetfloatv--glgetintegerv _glGet], [https://docs.microsoft.com/en-us/windows/win32/opengl/glindex-functions _glIndex] + + +{{PageNavigation}} + +[[Category:Final]] diff --git a/internal/help/_glColor3i__001000030.txt b/internal/help/_glColor3i__001000030.txt new file mode 100644 index 000000000..020619b1c --- /dev/null +++ b/internal/help/_glColor3i__001000030.txt @@ -0,0 +1,29 @@ +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:46:40}} +{{DISPLAYTITLE:_glColor3i}} +The '''_glColor3i''' statement sets the current color. + + +{{PageSyntax}} +: '''_glColor3i''' GLint {{Parameter|red}}, GLint {{Parameter|green}}, GLint {{Parameter|blue}} + + +{{PageParameters}} +* OpenGL is using its own set of variable types to describe its command parameters. +* Use the following table to find the respective QB64 [[Variable Types]]. +{{OpenGLTypesPlugin}} + + +{{PageDescription}} +* OpenGL's documentation is available in several places, so we won't reproduce it here for another time. +* The full description for this command can be found at [https://docs.microsoft.com/en-us/windows/win32/opengl/glcolor3i Microsoft Docs] and is also valid for QB64 usage. + + +{{PageSeeAlso}} +* [[_GL|SUB _GL]] +* [[_glBegin]], [[_glEnd]], [https://docs.microsoft.com/en-us/windows/win32/opengl/glgetbooleanv--glgetdoublev--glgetfloatv--glgetintegerv _glGet], [https://docs.microsoft.com/en-us/windows/win32/opengl/glindex-functions _glIndex] + + +{{PageNavigation}} + +[[Category:Final]] diff --git a/internal/help/_glColor3iv__0010000300.txt b/internal/help/_glColor3iv__0010000300.txt new file mode 100644 index 000000000..96670f942 --- /dev/null +++ b/internal/help/_glColor3iv__0010000300.txt @@ -0,0 +1,29 @@ +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:46:42}} +{{DISPLAYTITLE:_glColor3iv}} +The '''_glColor3iv''' statement sets the current color from an already existing array of color values. + + +{{PageSyntax}} +: '''_glColor3iv''' const GLint {{Parameter|*v}} + + +{{PageParameters}} +* OpenGL is using its own set of variable types to describe its command parameters. +* Use the following table to find the respective QB64 [[Variable Types]]. +{{OpenGLTypesPlugin}} + + +{{PageDescription}} +* OpenGL's documentation is available in several places, so we won't reproduce it here for another time. +* The full description for this command can be found at [https://docs.microsoft.com/en-us/windows/win32/opengl/glcolor3iv Microsoft Docs] and is also valid for QB64 usage. + + +{{PageSeeAlso}} +* [[_GL|SUB _GL]] +* [[_glBegin]], [[_glEnd]], [https://docs.microsoft.com/en-us/windows/win32/opengl/glgetbooleanv--glgetdoublev--glgetfloatv--glgetintegerv _glGet], [https://docs.microsoft.com/en-us/windows/win32/opengl/glindex-functions _glIndex] + + +{{PageNavigation}} + +[[Category:Final]] diff --git a/internal/help/_glColor3s__001000030.txt b/internal/help/_glColor3s__001000030.txt new file mode 100644 index 000000000..91f1d67fa --- /dev/null +++ b/internal/help/_glColor3s__001000030.txt @@ -0,0 +1,29 @@ +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:46:44}} +{{DISPLAYTITLE:_glColor3s}} +The '''_glColor3s''' statement sets the current color. + + +{{PageSyntax}} +: '''_glColor3s''' GLshort {{Parameter|red}}, GLshort {{Parameter|green}}, GLshort {{Parameter|blue}} + + +{{PageParameters}} +* OpenGL is using its own set of variable types to describe its command parameters. +* Use the following table to find the respective QB64 [[Variable Types]]. +{{OpenGLTypesPlugin}} + + +{{PageDescription}} +* OpenGL's documentation is available in several places, so we won't reproduce it here for another time. +* The full description for this command can be found at [https://docs.microsoft.com/en-us/windows/win32/opengl/glcolor3s Microsoft Docs] and is also valid for QB64 usage. + + +{{PageSeeAlso}} +* [[_GL|SUB _GL]] +* [[_glBegin]], [[_glEnd]], [https://docs.microsoft.com/en-us/windows/win32/opengl/glgetbooleanv--glgetdoublev--glgetfloatv--glgetintegerv _glGet], [https://docs.microsoft.com/en-us/windows/win32/opengl/glindex-functions _glIndex] + + +{{PageNavigation}} + +[[Category:Final]] diff --git a/internal/help/_glColor3sv__0010000300.txt b/internal/help/_glColor3sv__0010000300.txt new file mode 100644 index 000000000..eee71e67b --- /dev/null +++ b/internal/help/_glColor3sv__0010000300.txt @@ -0,0 +1,29 @@ +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:46:46}} +{{DISPLAYTITLE:_glColor3sv}} +The '''_glColor3sv''' statement sets the current color from an already existing array of color values. + + +{{PageSyntax}} +: '''_glColor3sv''' const GLshort {{Parameter|*v}} + + +{{PageParameters}} +* OpenGL is using its own set of variable types to describe its command parameters. +* Use the following table to find the respective QB64 [[Variable Types]]. +{{OpenGLTypesPlugin}} + + +{{PageDescription}} +* OpenGL's documentation is available in several places, so we won't reproduce it here for another time. +* The full description for this command can be found at [https://docs.microsoft.com/en-us/windows/win32/opengl/glcolor3sv Microsoft Docs] and is also valid for QB64 usage. + + +{{PageSeeAlso}} +* [[_GL|SUB _GL]] +* [[_glBegin]], [[_glEnd]], [https://docs.microsoft.com/en-us/windows/win32/opengl/glgetbooleanv--glgetdoublev--glgetfloatv--glgetintegerv _glGet], [https://docs.microsoft.com/en-us/windows/win32/opengl/glindex-functions _glIndex] + + +{{PageNavigation}} + +[[Category:Final]] diff --git a/internal/help/_glColor3ub__0010000300.txt b/internal/help/_glColor3ub__0010000300.txt new file mode 100644 index 000000000..62516a4fa --- /dev/null +++ b/internal/help/_glColor3ub__0010000300.txt @@ -0,0 +1,29 @@ +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:46:48}} +{{DISPLAYTITLE:_glColor3ub}} +The '''_glColor3ub''' statement sets the current color. + + +{{PageSyntax}} +: '''_glColor3ub''' GLubyte {{Parameter|red}}, GLubyte {{Parameter|green}}, GLubyte {{Parameter|blue}} + + +{{PageParameters}} +* OpenGL is using its own set of variable types to describe its command parameters. +* Use the following table to find the respective QB64 [[Variable Types]]. +{{OpenGLTypesPlugin}} + + +{{PageDescription}} +* OpenGL's documentation is available in several places, so we won't reproduce it here for another time. +* The full description for this command can be found at [https://docs.microsoft.com/en-us/windows/win32/opengl/glcolor3ub Microsoft Docs] and is also valid for QB64 usage. + + +{{PageSeeAlso}} +* [[_GL|SUB _GL]] +* [[_glBegin]], [[_glEnd]], [https://docs.microsoft.com/en-us/windows/win32/opengl/glgetbooleanv--glgetdoublev--glgetfloatv--glgetintegerv _glGet], [https://docs.microsoft.com/en-us/windows/win32/opengl/glindex-functions _glIndex] + + +{{PageNavigation}} + +[[Category:Final]] diff --git a/internal/help/_glColor3ubv__00100003000.txt b/internal/help/_glColor3ubv__00100003000.txt new file mode 100644 index 000000000..bff55c124 --- /dev/null +++ b/internal/help/_glColor3ubv__00100003000.txt @@ -0,0 +1,29 @@ +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:46:51}} +{{DISPLAYTITLE:_glColor3ubv}} +The '''_glColor3ubv''' statement sets the current color from an already existing array of color values. + + +{{PageSyntax}} +: '''_glColor3ubv''' const GLubyte {{Parameter|*v}} + + +{{PageParameters}} +* OpenGL is using its own set of variable types to describe its command parameters. +* Use the following table to find the respective QB64 [[Variable Types]]. +{{OpenGLTypesPlugin}} + + +{{PageDescription}} +* OpenGL's documentation is available in several places, so we won't reproduce it here for another time. +* The full description for this command can be found at [https://docs.microsoft.com/en-us/windows/win32/opengl/glcolor3ubv Microsoft Docs] and is also valid for QB64 usage. + + +{{PageSeeAlso}} +* [[_GL|SUB _GL]] +* [[_glBegin]], [[_glEnd]], [https://docs.microsoft.com/en-us/windows/win32/opengl/glgetbooleanv--glgetdoublev--glgetfloatv--glgetintegerv _glGet], [https://docs.microsoft.com/en-us/windows/win32/opengl/glindex-functions _glIndex] + + +{{PageNavigation}} + +[[Category:Final]] diff --git a/internal/help/_glColor3ui__0010000300.txt b/internal/help/_glColor3ui__0010000300.txt new file mode 100644 index 000000000..8070c6dbe --- /dev/null +++ b/internal/help/_glColor3ui__0010000300.txt @@ -0,0 +1,29 @@ +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:46:53}} +{{DISPLAYTITLE:_glColor3ui}} +The '''_glColor3ui''' statement sets the current color. + + +{{PageSyntax}} +: '''_glColor3ui''' GLuint {{Parameter|red}}, GLuint {{Parameter|green}}, GLuint {{Parameter|blue}} + + +{{PageParameters}} +* OpenGL is using its own set of variable types to describe its command parameters. +* Use the following table to find the respective QB64 [[Variable Types]]. +{{OpenGLTypesPlugin}} + + +{{PageDescription}} +* OpenGL's documentation is available in several places, so we won't reproduce it here for another time. +* The full description for this command can be found at [https://docs.microsoft.com/en-us/windows/win32/opengl/glcolor3ui Microsoft Docs] and is also valid for QB64 usage. + + +{{PageSeeAlso}} +* [[_GL|SUB _GL]] +* [[_glBegin]], [[_glEnd]], [https://docs.microsoft.com/en-us/windows/win32/opengl/glgetbooleanv--glgetdoublev--glgetfloatv--glgetintegerv _glGet], [https://docs.microsoft.com/en-us/windows/win32/opengl/glindex-functions _glIndex] + + +{{PageNavigation}} + +[[Category:Final]] diff --git a/internal/help/_glColor3uiv__00100003000.txt b/internal/help/_glColor3uiv__00100003000.txt new file mode 100644 index 000000000..a6a94b308 --- /dev/null +++ b/internal/help/_glColor3uiv__00100003000.txt @@ -0,0 +1,29 @@ +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:46:56}} +{{DISPLAYTITLE:_glColor3uiv}} +The '''_glColor3uiv''' statement sets the current color from an already existing array of color values. + + +{{PageSyntax}} +: '''_glColor3uiv''' const GLuint {{Parameter|*v}} + + +{{PageParameters}} +* OpenGL is using its own set of variable types to describe its command parameters. +* Use the following table to find the respective QB64 [[Variable Types]]. +{{OpenGLTypesPlugin}} + + +{{PageDescription}} +* OpenGL's documentation is available in several places, so we won't reproduce it here for another time. +* The full description for this command can be found at [https://docs.microsoft.com/en-us/windows/win32/opengl/glcolor3uiv Microsoft Docs] and is also valid for QB64 usage. + + +{{PageSeeAlso}} +* [[_GL|SUB _GL]] +* [[_glBegin]], [[_glEnd]], [https://docs.microsoft.com/en-us/windows/win32/opengl/glgetbooleanv--glgetdoublev--glgetfloatv--glgetintegerv _glGet], [https://docs.microsoft.com/en-us/windows/win32/opengl/glindex-functions _glIndex] + + +{{PageNavigation}} + +[[Category:Final]] diff --git a/internal/help/_glColor3us__0010000300.txt b/internal/help/_glColor3us__0010000300.txt new file mode 100644 index 000000000..918ac6b8d --- /dev/null +++ b/internal/help/_glColor3us__0010000300.txt @@ -0,0 +1,29 @@ +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:46:58}} +{{DISPLAYTITLE:_glColor3us}} +The '''_glColor3us''' statement sets the current color. + + +{{PageSyntax}} +: '''_glColor3us''' GLushort {{Parameter|red}}, GLushort {{Parameter|green}}, GLushort {{Parameter|blue}} + + +{{PageParameters}} +* OpenGL is using its own set of variable types to describe its command parameters. +* Use the following table to find the respective QB64 [[Variable Types]]. +{{OpenGLTypesPlugin}} + + +{{PageDescription}} +* OpenGL's documentation is available in several places, so we won't reproduce it here for another time. +* The full description for this command can be found at [https://docs.microsoft.com/en-us/windows/win32/opengl/glcolor3us Microsoft Docs] and is also valid for QB64 usage. + + +{{PageSeeAlso}} +* [[_GL|SUB _GL]] +* [[_glBegin]], [[_glEnd]], [https://docs.microsoft.com/en-us/windows/win32/opengl/glgetbooleanv--glgetdoublev--glgetfloatv--glgetintegerv _glGet], [https://docs.microsoft.com/en-us/windows/win32/opengl/glindex-functions _glIndex] + + +{{PageNavigation}} + +[[Category:Final]] diff --git a/internal/help/_glColor3usv__00100003000.txt b/internal/help/_glColor3usv__00100003000.txt new file mode 100644 index 000000000..eec4e5572 --- /dev/null +++ b/internal/help/_glColor3usv__00100003000.txt @@ -0,0 +1,29 @@ +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:47:00}} +{{DISPLAYTITLE:_glColor3usv}} +The '''_glColor3usv''' statement sets the current color from an already existing array of color values. + + +{{PageSyntax}} +: '''_glColor3usv''' const GLushort {{Parameter|*v}} + + +{{PageParameters}} +* OpenGL is using its own set of variable types to describe its command parameters. +* Use the following table to find the respective QB64 [[Variable Types]]. +{{OpenGLTypesPlugin}} + + +{{PageDescription}} +* OpenGL's documentation is available in several places, so we won't reproduce it here for another time. +* The full description for this command can be found at [https://docs.microsoft.com/en-us/windows/win32/opengl/glcolor3usv Microsoft Docs] and is also valid for QB64 usage. + + +{{PageSeeAlso}} +* [[_GL|SUB _GL]] +* [[_glBegin]], [[_glEnd]], [https://docs.microsoft.com/en-us/windows/win32/opengl/glgetbooleanv--glgetdoublev--glgetfloatv--glgetintegerv _glGet], [https://docs.microsoft.com/en-us/windows/win32/opengl/glindex-functions _glIndex] + + +{{PageNavigation}} + +[[Category:Final]] diff --git a/internal/help/_glColor4b__001000040.txt b/internal/help/_glColor4b__001000040.txt new file mode 100644 index 000000000..cd1893bbc --- /dev/null +++ b/internal/help/_glColor4b__001000040.txt @@ -0,0 +1,29 @@ +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:47:02}} +{{DISPLAYTITLE:_glColor4b}} +The '''_glColor4b''' statement sets the current color. + + +{{PageSyntax}} +: '''_glColor4b''' GLbyte {{Parameter|red}}, GLbyte {{Parameter|green}}, GLbyte {{Parameter|blue}}, GLbyte {{Parameter|alpha}} + + +{{PageParameters}} +* OpenGL is using its own set of variable types to describe its command parameters. +* Use the following table to find the respective QB64 [[Variable Types]]. +{{OpenGLTypesPlugin}} + + +{{PageDescription}} +* OpenGL's documentation is available in several places, so we won't reproduce it here for another time. +* The full description for this command can be found at [https://docs.microsoft.com/en-us/windows/win32/opengl/glcolor4b Microsoft Docs] and is also valid for QB64 usage. + + +{{PageSeeAlso}} +* [[_GL|SUB _GL]] +* [[_glBegin]], [[_glEnd]], [https://docs.microsoft.com/en-us/windows/win32/opengl/glgetbooleanv--glgetdoublev--glgetfloatv--glgetintegerv _glGet], [https://docs.microsoft.com/en-us/windows/win32/opengl/glindex-functions _glIndex] + + +{{PageNavigation}} + +[[Category:Final]] diff --git a/internal/help/_glColor4bv__0010000400.txt b/internal/help/_glColor4bv__0010000400.txt new file mode 100644 index 000000000..359feb240 --- /dev/null +++ b/internal/help/_glColor4bv__0010000400.txt @@ -0,0 +1,29 @@ +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:47:05}} +{{DISPLAYTITLE:_glColor4bv}} +The '''_glColor4bv''' statement sets the current color from an already existing array of color values. + + +{{PageSyntax}} +: '''_glColor4bv''' const GLbyte {{Parameter|*v}} + + +{{PageParameters}} +* OpenGL is using its own set of variable types to describe its command parameters. +* Use the following table to find the respective QB64 [[Variable Types]]. +{{OpenGLTypesPlugin}} + + +{{PageDescription}} +* OpenGL's documentation is available in several places, so we won't reproduce it here for another time. +* The full description for this command can be found at [https://docs.microsoft.com/en-us/windows/win32/opengl/glcolor4bv Microsoft Docs] and is also valid for QB64 usage. + + +{{PageSeeAlso}} +* [[_GL|SUB _GL]] +* [[_glBegin]], [[_glEnd]], [https://docs.microsoft.com/en-us/windows/win32/opengl/glgetbooleanv--glgetdoublev--glgetfloatv--glgetintegerv _glGet], [https://docs.microsoft.com/en-us/windows/win32/opengl/glindex-functions _glIndex] + + +{{PageNavigation}} + +[[Category:Final]] diff --git a/internal/help/_glColor4d__001000040.txt b/internal/help/_glColor4d__001000040.txt new file mode 100644 index 000000000..276aa7c4f --- /dev/null +++ b/internal/help/_glColor4d__001000040.txt @@ -0,0 +1,29 @@ +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:47:07}} +{{DISPLAYTITLE:_glColor4d}} +The '''_glColor4d''' statement sets the current color. + + +{{PageSyntax}} +: '''_glColor4d''' GLdouble {{Parameter|red}}, GLdouble {{Parameter|green}}, GLdouble {{Parameter|blue}}, GLdouble {{Parameter|alpha}} + + +{{PageParameters}} +* OpenGL is using its own set of variable types to describe its command parameters. +* Use the following table to find the respective QB64 [[Variable Types]]. +{{OpenGLTypesPlugin}} + + +{{PageDescription}} +* OpenGL's documentation is available in several places, so we won't reproduce it here for another time. +* The full description for this command can be found at [https://docs.microsoft.com/en-us/windows/win32/opengl/glcolor4d Microsoft Docs] and is also valid for QB64 usage. + + +{{PageSeeAlso}} +* [[_GL|SUB _GL]] +* [[_glBegin]], [[_glEnd]], [https://docs.microsoft.com/en-us/windows/win32/opengl/glgetbooleanv--glgetdoublev--glgetfloatv--glgetintegerv _glGet], [https://docs.microsoft.com/en-us/windows/win32/opengl/glindex-functions _glIndex] + + +{{PageNavigation}} + +[[Category:Final]] diff --git a/internal/help/_glColor4dv__0010000400.txt b/internal/help/_glColor4dv__0010000400.txt new file mode 100644 index 000000000..44eb701f5 --- /dev/null +++ b/internal/help/_glColor4dv__0010000400.txt @@ -0,0 +1,29 @@ +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:47:09}} +{{DISPLAYTITLE:_glColor4dv}} +The '''_glColor4dv''' statement sets the current color from an already existing array of color values. + + +{{PageSyntax}} +: '''_glColor4dv''' const GLdouble {{Parameter|*v}} + + +{{PageParameters}} +* OpenGL is using its own set of variable types to describe its command parameters. +* Use the following table to find the respective QB64 [[Variable Types]]. +{{OpenGLTypesPlugin}} + + +{{PageDescription}} +* OpenGL's documentation is available in several places, so we won't reproduce it here for another time. +* The full description for this command can be found at [https://docs.microsoft.com/en-us/windows/win32/opengl/glcolor4dv Microsoft Docs] and is also valid for QB64 usage. + + +{{PageSeeAlso}} +* [[_GL|SUB _GL]] +* [[_glBegin]], [[_glEnd]], [https://docs.microsoft.com/en-us/windows/win32/opengl/glgetbooleanv--glgetdoublev--glgetfloatv--glgetintegerv _glGet], [https://docs.microsoft.com/en-us/windows/win32/opengl/glindex-functions _glIndex] + + +{{PageNavigation}} + +[[Category:Final]] diff --git a/internal/help/_glColor4f__001000040.txt b/internal/help/_glColor4f__001000040.txt new file mode 100644 index 000000000..99d686ef5 --- /dev/null +++ b/internal/help/_glColor4f__001000040.txt @@ -0,0 +1,29 @@ +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:47:11}} +{{DISPLAYTITLE:_glColor4f}} +The '''_glColor4f''' statement sets the current color. + + +{{PageSyntax}} +: '''_glColor4f''' GLfloat {{Parameter|red}}, GLfloat {{Parameter|green}}, GLfloat {{Parameter|blue}}, GLfloat {{Parameter|alpha}} + + +{{PageParameters}} +* OpenGL is using its own set of variable types to describe its command parameters. +* Use the following table to find the respective QB64 [[Variable Types]]. +{{OpenGLTypesPlugin}} + + +{{PageDescription}} +* OpenGL's documentation is available in several places, so we won't reproduce it here for another time. +* The full description for this command can be found at [https://docs.microsoft.com/en-us/windows/win32/opengl/glcolor4f Microsoft Docs] and is also valid for QB64 usage. + + +{{PageSeeAlso}} +* [[_GL|SUB _GL]] +* [[_glBegin]], [[_glEnd]], [https://docs.microsoft.com/en-us/windows/win32/opengl/glgetbooleanv--glgetdoublev--glgetfloatv--glgetintegerv _glGet], [https://docs.microsoft.com/en-us/windows/win32/opengl/glindex-functions _glIndex] + + +{{PageNavigation}} + +[[Category:Final]] diff --git a/internal/help/_glColor4fv__0010000400.txt b/internal/help/_glColor4fv__0010000400.txt new file mode 100644 index 000000000..e823eaf94 --- /dev/null +++ b/internal/help/_glColor4fv__0010000400.txt @@ -0,0 +1,29 @@ +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:47:13}} +{{DISPLAYTITLE:_glColor4fv}} +The '''_glColor4fv''' statement sets the current color from an already existing array of color values. + + +{{PageSyntax}} +: '''_glColor4fv''' const GLfloat {{Parameter|*v}} + + +{{PageParameters}} +* OpenGL is using its own set of variable types to describe its command parameters. +* Use the following table to find the respective QB64 [[Variable Types]]. +{{OpenGLTypesPlugin}} + + +{{PageDescription}} +* OpenGL's documentation is available in several places, so we won't reproduce it here for another time. +* The full description for this command can be found at [https://docs.microsoft.com/en-us/windows/win32/opengl/glcolor4fv Microsoft Docs] and is also valid for QB64 usage. + + +{{PageSeeAlso}} +* [[_GL|SUB _GL]] +* [[_glBegin]], [[_glEnd]], [https://docs.microsoft.com/en-us/windows/win32/opengl/glgetbooleanv--glgetdoublev--glgetfloatv--glgetintegerv _glGet], [https://docs.microsoft.com/en-us/windows/win32/opengl/glindex-functions _glIndex] + + +{{PageNavigation}} + +[[Category:Final]] diff --git a/internal/help/_glColor4i__001000040.txt b/internal/help/_glColor4i__001000040.txt new file mode 100644 index 000000000..d64cc4328 --- /dev/null +++ b/internal/help/_glColor4i__001000040.txt @@ -0,0 +1,29 @@ +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:47:15}} +{{DISPLAYTITLE:_glColor4i}} +The '''_glColor4i''' statement sets the current color. + + +{{PageSyntax}} +: '''_glColor4i''' GLint {{Parameter|red}}, GLint {{Parameter|green}}, GLint {{Parameter|blue}}, GLint {{Parameter|alpha}} + + +{{PageParameters}} +* OpenGL is using its own set of variable types to describe its command parameters. +* Use the following table to find the respective QB64 [[Variable Types]]. +{{OpenGLTypesPlugin}} + + +{{PageDescription}} +* OpenGL's documentation is available in several places, so we won't reproduce it here for another time. +* The full description for this command can be found at [https://docs.microsoft.com/en-us/windows/win32/opengl/glcolor4i Microsoft Docs] and is also valid for QB64 usage. + + +{{PageSeeAlso}} +* [[_GL|SUB _GL]] +* [[_glBegin]], [[_glEnd]], [https://docs.microsoft.com/en-us/windows/win32/opengl/glgetbooleanv--glgetdoublev--glgetfloatv--glgetintegerv _glGet], [https://docs.microsoft.com/en-us/windows/win32/opengl/glindex-functions _glIndex] + + +{{PageNavigation}} + +[[Category:Final]] diff --git a/internal/help/_glColor4iv__0010000400.txt b/internal/help/_glColor4iv__0010000400.txt new file mode 100644 index 000000000..c8804866c --- /dev/null +++ b/internal/help/_glColor4iv__0010000400.txt @@ -0,0 +1,29 @@ +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:47:18}} +{{DISPLAYTITLE:_glColor4iv}} +The '''_glColor4iv''' statement sets the current color from an already existing array of color values. + + +{{PageSyntax}} +: '''_glColor4iv''' const GLint {{Parameter|*v}} + + +{{PageParameters}} +* OpenGL is using its own set of variable types to describe its command parameters. +* Use the following table to find the respective QB64 [[Variable Types]]. +{{OpenGLTypesPlugin}} + + +{{PageDescription}} +* OpenGL's documentation is available in several places, so we won't reproduce it here for another time. +* The full description for this command can be found at [https://docs.microsoft.com/en-us/windows/win32/opengl/glcolor4iv Microsoft Docs] and is also valid for QB64 usage. + + +{{PageSeeAlso}} +* [[_GL|SUB _GL]] +* [[_glBegin]], [[_glEnd]], [https://docs.microsoft.com/en-us/windows/win32/opengl/glgetbooleanv--glgetdoublev--glgetfloatv--glgetintegerv _glGet], [https://docs.microsoft.com/en-us/windows/win32/opengl/glindex-functions _glIndex] + + +{{PageNavigation}} + +[[Category:Final]] diff --git a/internal/help/_glColor4s__001000040.txt b/internal/help/_glColor4s__001000040.txt new file mode 100644 index 000000000..d7bc6cea1 --- /dev/null +++ b/internal/help/_glColor4s__001000040.txt @@ -0,0 +1,29 @@ +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:47:20}} +{{DISPLAYTITLE:_glColor4s}} +The '''_glColor4s''' statement sets the current color. + + +{{PageSyntax}} +: '''_glColor4s''' GLshort {{Parameter|red}}, GLshort {{Parameter|green}}, GLshort {{Parameter|blue}}, GLshort {{Parameter|alpha}} + + +{{PageParameters}} +* OpenGL is using its own set of variable types to describe its command parameters. +* Use the following table to find the respective QB64 [[Variable Types]]. +{{OpenGLTypesPlugin}} + + +{{PageDescription}} +* OpenGL's documentation is available in several places, so we won't reproduce it here for another time. +* The full description for this command can be found at [https://docs.microsoft.com/en-us/windows/win32/opengl/glcolor4s Microsoft Docs] and is also valid for QB64 usage. + + +{{PageSeeAlso}} +* [[_GL|SUB _GL]] +* [[_glBegin]], [[_glEnd]], [https://docs.microsoft.com/en-us/windows/win32/opengl/glgetbooleanv--glgetdoublev--glgetfloatv--glgetintegerv _glGet], [https://docs.microsoft.com/en-us/windows/win32/opengl/glindex-functions _glIndex] + + +{{PageNavigation}} + +[[Category:Final]] diff --git a/internal/help/_glColor4sv__0010000400.txt b/internal/help/_glColor4sv__0010000400.txt new file mode 100644 index 000000000..cddacc61a --- /dev/null +++ b/internal/help/_glColor4sv__0010000400.txt @@ -0,0 +1,29 @@ +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:47:22}} +{{DISPLAYTITLE:_glColor4sv}} +The '''_glColor4sv''' statement sets the current color from an already existing array of color values. + + +{{PageSyntax}} +: '''_glColor4sv''' const GLshort {{Parameter|*v}} + + +{{PageParameters}} +* OpenGL is using its own set of variable types to describe its command parameters. +* Use the following table to find the respective QB64 [[Variable Types]]. +{{OpenGLTypesPlugin}} + + +{{PageDescription}} +* OpenGL's documentation is available in several places, so we won't reproduce it here for another time. +* The full description for this command can be found at [https://docs.microsoft.com/en-us/windows/win32/opengl/glcolor4sv Microsoft Docs] and is also valid for QB64 usage. + + +{{PageSeeAlso}} +* [[_GL|SUB _GL]] +* [[_glBegin]], [[_glEnd]], [https://docs.microsoft.com/en-us/windows/win32/opengl/glgetbooleanv--glgetdoublev--glgetfloatv--glgetintegerv _glGet], [https://docs.microsoft.com/en-us/windows/win32/opengl/glindex-functions _glIndex] + + +{{PageNavigation}} + +[[Category:Final]] diff --git a/internal/help/_glColor4ub__0010000400.txt b/internal/help/_glColor4ub__0010000400.txt new file mode 100644 index 000000000..fb95ee5f4 --- /dev/null +++ b/internal/help/_glColor4ub__0010000400.txt @@ -0,0 +1,29 @@ +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:47:24}} +{{DISPLAYTITLE:_glColor4ub}} +The '''_glColor4ub''' statement sets the current color. + + +{{PageSyntax}} +: '''_glColor4ub''' GLubyte {{Parameter|red}}, GLubyte {{Parameter|green}}, GLubyte {{Parameter|blue}}, GLubyte {{Parameter|alpha}} + + +{{PageParameters}} +* OpenGL is using its own set of variable types to describe its command parameters. +* Use the following table to find the respective QB64 [[Variable Types]]. +{{OpenGLTypesPlugin}} + + +{{PageDescription}} +* OpenGL's documentation is available in several places, so we won't reproduce it here for another time. +* The full description for this command can be found at [https://docs.microsoft.com/en-us/windows/win32/opengl/glcolor4ub Microsoft Docs] and is also valid for QB64 usage. + + +{{PageSeeAlso}} +* [[_GL|SUB _GL]] +* [[_glBegin]], [[_glEnd]], [https://docs.microsoft.com/en-us/windows/win32/opengl/glgetbooleanv--glgetdoublev--glgetfloatv--glgetintegerv _glGet], [https://docs.microsoft.com/en-us/windows/win32/opengl/glindex-functions _glIndex] + + +{{PageNavigation}} + +[[Category:Final]] diff --git a/internal/help/_glColor4ubv__00100004000.txt b/internal/help/_glColor4ubv__00100004000.txt new file mode 100644 index 000000000..999ae9f22 --- /dev/null +++ b/internal/help/_glColor4ubv__00100004000.txt @@ -0,0 +1,29 @@ +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:47:26}} +{{DISPLAYTITLE:_glColor4ubv}} +The '''_glColor4ubv''' statement sets the current color from an already existing array of color values. + + +{{PageSyntax}} +: '''_glColor4ubv''' const GLubyte {{Parameter|*v}} + + +{{PageParameters}} +* OpenGL is using its own set of variable types to describe its command parameters. +* Use the following table to find the respective QB64 [[Variable Types]]. +{{OpenGLTypesPlugin}} + + +{{PageDescription}} +* OpenGL's documentation is available in several places, so we won't reproduce it here for another time. +* The full description for this command can be found at [https://docs.microsoft.com/en-us/windows/win32/opengl/glcolor4ubv Microsoft Docs] and is also valid for QB64 usage. + + +{{PageSeeAlso}} +* [[_GL|SUB _GL]] +* [[_glBegin]], [[_glEnd]], [https://docs.microsoft.com/en-us/windows/win32/opengl/glgetbooleanv--glgetdoublev--glgetfloatv--glgetintegerv _glGet], [https://docs.microsoft.com/en-us/windows/win32/opengl/glindex-functions _glIndex] + + +{{PageNavigation}} + +[[Category:Final]] diff --git a/internal/help/_glColor4ui__0010000400.txt b/internal/help/_glColor4ui__0010000400.txt new file mode 100644 index 000000000..eaf571bd2 --- /dev/null +++ b/internal/help/_glColor4ui__0010000400.txt @@ -0,0 +1,29 @@ +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:47:29}} +{{DISPLAYTITLE:_glColor4ui}} +The '''_glColor4ui''' statement sets the current color. + + +{{PageSyntax}} +: '''_glColor4ui''' GLuint {{Parameter|red}}, GLuint {{Parameter|green}}, GLuint {{Parameter|blue}}, GLuint {{Parameter|alpha}} + + +{{PageParameters}} +* OpenGL is using its own set of variable types to describe its command parameters. +* Use the following table to find the respective QB64 [[Variable Types]]. +{{OpenGLTypesPlugin}} + + +{{PageDescription}} +* OpenGL's documentation is available in several places, so we won't reproduce it here for another time. +* The full description for this command can be found at [https://docs.microsoft.com/en-us/windows/win32/opengl/glcolor4ui Microsoft Docs] and is also valid for QB64 usage. + + +{{PageSeeAlso}} +* [[_GL|SUB _GL]] +* [[_glBegin]], [[_glEnd]], [https://docs.microsoft.com/en-us/windows/win32/opengl/glgetbooleanv--glgetdoublev--glgetfloatv--glgetintegerv _glGet], [https://docs.microsoft.com/en-us/windows/win32/opengl/glindex-functions _glIndex] + + +{{PageNavigation}} + +[[Category:Final]] diff --git a/internal/help/_glColor4uiv__00100004000.txt b/internal/help/_glColor4uiv__00100004000.txt new file mode 100644 index 000000000..57c50ee51 --- /dev/null +++ b/internal/help/_glColor4uiv__00100004000.txt @@ -0,0 +1,29 @@ +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:47:31}} +{{DISPLAYTITLE:_glColor4uiv}} +The '''_glColor4uiv''' statement sets the current color from an already existing array of color values. + + +{{PageSyntax}} +: '''_glColor4uiv''' const GLuint {{Parameter|*v}} + + +{{PageParameters}} +* OpenGL is using its own set of variable types to describe its command parameters. +* Use the following table to find the respective QB64 [[Variable Types]]. +{{OpenGLTypesPlugin}} + + +{{PageDescription}} +* OpenGL's documentation is available in several places, so we won't reproduce it here for another time. +* The full description for this command can be found at [https://docs.microsoft.com/en-us/windows/win32/opengl/glcolor4uiv Microsoft Docs] and is also valid for QB64 usage. + + +{{PageSeeAlso}} +* [[_GL|SUB _GL]] +* [[_glBegin]], [[_glEnd]], [https://docs.microsoft.com/en-us/windows/win32/opengl/glgetbooleanv--glgetdoublev--glgetfloatv--glgetintegerv _glGet], [https://docs.microsoft.com/en-us/windows/win32/opengl/glindex-functions _glIndex] + + +{{PageNavigation}} + +[[Category:Final]] diff --git a/internal/help/_glColor4us__0010000400.txt b/internal/help/_glColor4us__0010000400.txt new file mode 100644 index 000000000..2f6445559 --- /dev/null +++ b/internal/help/_glColor4us__0010000400.txt @@ -0,0 +1,29 @@ +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:47:33}} +{{DISPLAYTITLE:_glColor4us}} +The '''_glColor4us''' statement sets the current color. + + +{{PageSyntax}} +: '''_glColor4us''' GLushort {{Parameter|red}}, GLushort {{Parameter|green}}, GLushort {{Parameter|blue}}, GLushort {{Parameter|alpha}} + + +{{PageParameters}} +* OpenGL is using its own set of variable types to describe its command parameters. +* Use the following table to find the respective QB64 [[Variable Types]]. +{{OpenGLTypesPlugin}} + + +{{PageDescription}} +* OpenGL's documentation is available in several places, so we won't reproduce it here for another time. +* The full description for this command can be found at [https://docs.microsoft.com/en-us/windows/win32/opengl/glcolor4us Microsoft Docs] and is also valid for QB64 usage. + + +{{PageSeeAlso}} +* [[_GL|SUB _GL]] +* [[_glBegin]], [[_glEnd]], [https://docs.microsoft.com/en-us/windows/win32/opengl/glgetbooleanv--glgetdoublev--glgetfloatv--glgetintegerv _glGet], [https://docs.microsoft.com/en-us/windows/win32/opengl/glindex-functions _glIndex] + + +{{PageNavigation}} + +[[Category:Final]] diff --git a/internal/help/_glColor4usv__00100004000.txt b/internal/help/_glColor4usv__00100004000.txt new file mode 100644 index 000000000..857bd712c --- /dev/null +++ b/internal/help/_glColor4usv__00100004000.txt @@ -0,0 +1,29 @@ +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:47:36}} +{{DISPLAYTITLE:_glColor4usv}} +The '''_glColor4usv''' statement sets the current color from an already existing array of color values. + + +{{PageSyntax}} +: '''_glColor4usv''' const GLushort {{Parameter|*v}} + + +{{PageParameters}} +* OpenGL is using its own set of variable types to describe its command parameters. +* Use the following table to find the respective QB64 [[Variable Types]]. +{{OpenGLTypesPlugin}} + + +{{PageDescription}} +* OpenGL's documentation is available in several places, so we won't reproduce it here for another time. +* The full description for this command can be found at [https://docs.microsoft.com/en-us/windows/win32/opengl/glcolor4usv Microsoft Docs] and is also valid for QB64 usage. + + +{{PageSeeAlso}} +* [[_GL|SUB _GL]] +* [[_glBegin]], [[_glEnd]], [https://docs.microsoft.com/en-us/windows/win32/opengl/glgetbooleanv--glgetdoublev--glgetfloatv--glgetintegerv _glGet], [https://docs.microsoft.com/en-us/windows/win32/opengl/glindex-functions _glIndex] + + +{{PageNavigation}} + +[[Category:Final]] diff --git a/internal/help/_glColorMask__00100001000.txt b/internal/help/_glColorMask__00100001000.txt index dbbf394a9..5acf6f851 100644 --- a/internal/help/_glColorMask__00100001000.txt +++ b/internal/help/_glColorMask__00100001000.txt @@ -1,43 +1,30 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:18:38}} -'''_glColorMask, glColorMaski:''' enable and disable writing of frame buffer color components - +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:47:38}} +{{DISPLAYTITLE:_glColorMask}} +The '''_glColorMask''' statement enables and disables writing of frame-buffer color components. {{PageSyntax}} +: '''_glColorMask''' GLboolean {{Parameter|red}}, GLboolean {{Parameter|green}}, GLboolean {{Parameter|blue}}, GLboolean {{Parameter|alpha}} -:: SUB _glColorMask (BYVAL red AS _UNSIGNED _BYTE, BYVAL green AS _UNSIGNED _BYTE, BYVAL blue AS _UNSIGNED _BYTE, BYVAL alpha AS _UNSIGNED _BYTE) -:: void '''_glColorMask'''(GLboolean {{Parameter|red}}, GLboolean {{Parameter|green}}, GLboolean {{Parameter|blue}}, GLboolean {{Parameter|alpha}}); -:: void '''_glColorMaski'''(GLuint {{Parameter|buf}}, GLboolean {{Parameter|red}}, GLboolean {{Parameter|green}}, GLboolean {{Parameter|blue}}, GLboolean {{Parameter|alpha}}); -; buf -: For '''_glColorMaski''', specifies the index of the draw buffer whose color mask to set. -; red, green, blue, alpha -: Specify whether red, green, blue, and alpha are to be written into the frame buffer. The initial values are all {{KW|_GL_TRUE}}, indicating that the color components are written. +{{PageParameters}} +* OpenGL is using its own set of variable types to describe its command parameters. +* Use the following table to find the respective QB64 [[Variable Types]]. +{{OpenGLTypesPlugin}} {{PageDescription}} - -'''_glColorMask''' and '''_glColorMaski''' specify whether the individual color components in the frame buffer can or cannot be written. '''_glColorMaski''' sets the mask for a specific draw buffer, whereas '''_glColorMask''' sets the mask for all draw buffers. If {{Parameter|red}} is {{KW|_GL_FALSE}}, for example, no change is made to the red component of any pixel in any of the color buffers, regardless of the drawing operation attempted. - -Changes to individual bits of components cannot be controlled. Rather, changes are either enabled or disabled for entire color components. - - -{{PageErrors}} - -{{KW|_GL_INVALID_VALUE}} is generated if {{Parameter|buf}} is greater than {{KW|_GL_MAX_DRAW_BUFFERS}} minus 1. - - -{{PageUseWith}} - -{{KW|_glGet}} with argument {{KW|_GL_COLOR_WRITEMASK}} +* OpenGL's documentation is available in several places, so we won't reproduce it here for another time. +* The full description for this command can be found at [https://docs.microsoft.com/en-us/windows/win32/opengl/glcolormask Microsoft Docs] and is also valid for QB64 usage. {{PageSeeAlso}} - -[[_GL|SUB _GL]] -{{KW|_glClear}}, {{KW|_glClearBuffer}}, {{KW|_glDepthMask}}, {{KW|_glStencilMask}} +* [[_GL|SUB _GL]] +* [[_glBegin]], [https://docs.microsoft.com/en-us/windows/win32/opengl/glcolor-functions _glColor], [[_glDepthMask]], [[_glEnd]] +* [https://docs.microsoft.com/en-us/windows/win32/opengl/glgetbooleanv--glgetdoublev--glgetfloatv--glgetintegerv _glGet], [https://docs.microsoft.com/en-us/windows/win32/opengl/glindex-functions _glIndex], [[_glIndexMask]], [[_glStencilMask]] -{{PageCopyright}} +{{PageNavigation}} +[[Category:Final]] diff --git a/internal/help/_glColorMaterial__001000010000000.txt b/internal/help/_glColorMaterial__001000010000000.txt new file mode 100644 index 000000000..68f6dba47 --- /dev/null +++ b/internal/help/_glColorMaterial__001000010000000.txt @@ -0,0 +1,31 @@ +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:47:40}} +{{DISPLAYTITLE:_glColorMaterial}} +The '''_glColorMaterial''' statement causes a material color to track the current color. + + +{{PageSyntax}} +: '''_glColorMaterial''' GLenum {{Parameter|face}}, GLenum {{Parameter|mode}} + + +{{PageParameters}} +* OpenGL is using its own set of variable types to describe its command parameters. +* Use the following table to find the respective QB64 [[Variable Types]]. +{{OpenGLTypesPlugin}} + + +{{PageDescription}} +* OpenGL's documentation is available in several places, so we won't reproduce it here for another time. +* The full description for this command can be found at [https://docs.microsoft.com/en-us/windows/win32/opengl/glcolormaterial Microsoft Docs] and is also valid for QB64 usage. + + +{{PageSeeAlso}} +* [[_GL|SUB _GL]] +* [[_glBegin]], [https://docs.microsoft.com/en-us/windows/win32/opengl/glcolor-functions _glColor], [[_glDisable]], [[_glEnable]] +* [[_glEnd]], [https://docs.microsoft.com/en-us/windows/win32/opengl/glgetbooleanv--glgetdoublev--glgetfloatv--glgetintegerv _glGet], [[_glIsEnabled]], [https://docs.microsoft.com/en-us/windows/win32/opengl/gllight-functions _glLight] +* [https://docs.microsoft.com/en-us/windows/win32/opengl/gllightmodel-functions _glLightModel], [https://docs.microsoft.com/en-us/windows/win32/opengl/glmaterial-functions _glMaterial] + + +{{PageNavigation}} + +[[Category:Final]] diff --git a/internal/help/_glColorPointer__00100001000000.txt b/internal/help/_glColorPointer__00100001000000.txt new file mode 100644 index 000000000..affad35b7 --- /dev/null +++ b/internal/help/_glColorPointer__00100001000000.txt @@ -0,0 +1,32 @@ +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:47:42}} +{{DISPLAYTITLE:_glColorPointer}} +The '''_glColorPointer''' statement defines an array of colors. + + +{{PageSyntax}} +: '''_glColorPointer''' GLint {{Parameter|size}}, GLenum {{Parameter|type}}, GLsizei {{Parameter|stride}}, const GLvoid {{Parameter|*pointer}} + + +{{PageParameters}} +* OpenGL is using its own set of variable types to describe its command parameters. +* Use the following table to find the respective QB64 [[Variable Types]]. +{{OpenGLTypesPlugin}} + + +{{PageDescription}} +* OpenGL's documentation is available in several places, so we won't reproduce it here for another time. +* The full description for this command can be found at [https://docs.microsoft.com/en-us/windows/win32/opengl/glcolorpointer Microsoft Docs] and is also valid for QB64 usage. + + +{{PageSeeAlso}} +* [[_GL|SUB _GL]] +* [[_glArrayElement]], [[_glBegin]], [[_glDrawArrays]], [[_glEdgeFlagPointer]] +* [[_glEnableClientState]], [[_glEnd]], [https://docs.microsoft.com/en-us/windows/win32/opengl/glgetbooleanv--glgetdoublev--glgetfloatv--glgetintegerv _glGet], [[_glGetString]] +* [[_glGetPointerv]], [[_glIndexPointer]], [[_glIsEnabled]], [[_glNormalPointer]] +* [[_glPopAttrib]], [[_glPushAttrib]], [[_glTexCoordPointer]], [[_glVertexPointer]] + + +{{PageNavigation}} + +[[Category:Final]] diff --git a/internal/help/_glCopyPixels__001000100000.txt b/internal/help/_glCopyPixels__001000100000.txt new file mode 100644 index 000000000..dcdd3ff39 --- /dev/null +++ b/internal/help/_glCopyPixels__001000100000.txt @@ -0,0 +1,32 @@ +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:47:44}} +{{DISPLAYTITLE:_glCopyPixels}} +The '''_glCopyPixels''' statement copies pixels in the framebuffer. + + +{{PageSyntax}} +: '''_glCopyPixels''' GLint {{Parameter|x}}, GLint {{Parameter|y}}, GLsizei {{Parameter|width}}, GLsizei {{Parameter|height}}, GLenum {{Parameter|type}} + + +{{PageParameters}} +* OpenGL is using its own set of variable types to describe its command parameters. +* Use the following table to find the respective QB64 [[Variable Types]]. +{{OpenGLTypesPlugin}} + + +{{PageDescription}} +* OpenGL's documentation is available in several places, so we won't reproduce it here for another time. +* The full description for this command can be found at [https://docs.microsoft.com/en-us/windows/win32/opengl/glcopypixels Microsoft Docs] and is also valid for QB64 usage. + + +{{PageSeeAlso}} +* [[_GL|SUB _GL]] +* [[_glBegin]], [[_glDepthFunc]], [[_glDrawBuffer]], [[_glDrawPixels]] +* [[_glEnd]], [https://docs.microsoft.com/en-us/windows/win32/opengl/glgetbooleanv--glgetdoublev--glgetfloatv--glgetintegerv _glGet], [https://docs.microsoft.com/en-us/windows/win32/opengl/glpixelmap _glPixelMap], [https://docs.microsoft.com/en-us/windows/win32/opengl/glpixelstore-functions _glPixelStore] +* [https://docs.microsoft.com/en-us/windows/win32/opengl/glpixeltransfer _glPixelTransfer], [[_glPixelZoom]], [https://docs.microsoft.com/en-us/windows/win32/opengl/glrasterpos-functions _glRasterPos], [[_glReadBuffer]] +* [[_glReadPixels]], [[_glStencilFunc]] + + +{{PageNavigation}} + +[[Category:Final]] diff --git a/internal/help/_glCopyTexImage1D__0010001001000011.txt b/internal/help/_glCopyTexImage1D__0010001001000011.txt index 2a90d140a..cdfaae23b 100644 --- a/internal/help/_glCopyTexImage1D__0010001001000011.txt +++ b/internal/help/_glCopyTexImage1D__0010001001000011.txt @@ -1,80 +1,31 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:18:43}} -'''_glCopyTexImage1D:''' copy pixels into a 1D texture image +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:47:47}} +{{DISPLAYTITLE:_glCopyTexImage1D}} +The '''_glCopyTexImage1D''' statement copies pixels from the framebuffer into a one-dimensional texture image. {{PageSyntax}} - -: SUB _glCopyTexImage1D (BYVAL target AS _UNSIGNED LONG, BYVAL level AS LONG, BYVAL internalFormat AS _UNSIGNED LONG, BYVAL x AS LONG, BYVAL y AS LONG, BYVAL width AS LONG, BYVAL border AS LONG) - -: void '''_glCopyTexImage1D'''(GLenum {{Parameter|target}}, GLint {{Parameter|level}}, GLenum {{Parameter|internalformat}}, GLint {{Parameter|x}}, GLint {{Parameter|y}}, GLsizei {{Parameter|width}}, GLint {{Parameter|border}}); +: '''_glCopyTexImage1D''' GLenum {{Parameter|target}}, GLint {{Parameter|level}}, GLenum {{Parameter|internalFormat}}, GLint {{Parameter|x}}, GLint {{Parameter|y}}, GLsizei {{Parameter|width}}, GLint {{Parameter|border}} -; target -: Specifies the target texture. Must be {{KW|_GL_TEXTURE_1D}}. -; level -: Specifies the level-of-detail number. Level 0 is the base image level. Level ''n'' is the ''n''th mipmap reduction image. -; internalformat -: Specifies the internal format of the texture. Must be one of the following symbolic constants: {{KW|_GL_COMPRESSED_RED}}, {{KW|_GL_COMPRESSED_RG}}, {{KW|_GL_COMPRESSED_RGB}}, {{KW|_GL_COMPRESSED_RGBA}}. {{KW|_GL_COMPRESSED_SRGB}}, {{KW|_GL_COMPRESSED_SRGB_ALPHA}}. {{KW|_GL_DEPTH_COMPONENT}}, {{KW|_GL_DEPTH_COMPONENT16}}, {{KW|_GL_DEPTH_COMPONENT24}}, {{KW|_GL_DEPTH_COMPONENT32}}, {{KW|_GL_RED}}, {{KW|_GL_RG}}, {{KW|_GL_RGB}}, {{KW|_GL_R3_G3_B2}}, {{KW|_GL_RGB4}}, {{KW|_GL_RGB5}}, {{KW|_GL_RGB8}}, {{KW|_GL_RGB10}}, {{KW|_GL_RGB12}}, {{KW|_GL_RGB16}}, {{KW|_GL_RGBA}}, {{KW|_GL_RGBA2}}, {{KW|_GL_RGBA4}}, {{KW|_GL_RGB5_A1}}, {{KW|_GL_RGBA8}}, {{KW|_GL_RGB10_A2}}, {{KW|_GL_RGBA12}}, {{KW|_GL_RGBA16}}, {{KW|_GL_SRGB}}, {{KW|_GL_SRGB8}}, {{KW|_GL_SRGB_ALPHA}}, or {{KW|_GL_SRGB8_ALPHA8}}. -; x, y -: Specify the window coordinates of the left corner of the row of pixels to be copied. -; width -: Specifies the width of the texture image. The height of the texture image is 1. -; border -: This value must be 0. +{{PageParameters}} +* OpenGL is using its own set of variable types to describe its command parameters. +* Use the following table to find the respective QB64 [[Variable Types]]. +{{OpenGLTypesPlugin}} {{PageDescription}} - -'''_glCopyTexImage1D''' defines a one-dimensional texture image with pixels from the current {{KW|_GL_READ_BUFFER}}. - -The screen-aligned pixel row with left corner at (''x'', ''y'') and with a length of {{Parameter|width}} defines the texture array at the mipmap level specified by {{Parameter|level}}. {{Parameter|internalformat}} specifies the internal format of the texture array. - -The pixels in the row are processed exactly as if {{KW|_glReadPixels}} had been called, but the process stops just before final conversion. At this point all pixel component values are clamped to the range [0, 1] and then converted to the texture's internal format for storage in the texel array. - -Pixel ordering is such that lower ''x'' screen coordinates correspond to lower texture coordinates. - -If any of the pixels within the specified row of the current {{KW|_GL_READ_BUFFER}} are outside the window associated with the current rendering context, then the values obtained for those pixels are undefined. - -'''_glCopyTexImage1D''' defines a one-dimensional texture image with pixels from the current {{KW|_GL_READ_BUFFER}}. - -When {{Parameter|internalformat}} is one of the sRGB types, the GL does not automatically convert the source pixels to the sRGB color space. In this case, the '''_glPixelMap''' function can be used to accomplish the conversion. - - -{{PageNotes}} - -1, 2, 3, and 4 are not accepted values for {{Parameter|internalformat}}. - -An image with 0 width indicates a NULL texture. - - -{{PageErrors}} - -{{KW|_GL_INVALID_ENUM}} is generated if {{Parameter|target}} is not one of the allowable values. - -{{KW|_GL_INVALID_VALUE}} is generated if {{Parameter|level}} is less than 0. - -{{KW|_GL_INVALID_VALUE}} may be generated if {{Parameter|level}} is greater than log2(max), where max is the returned value of {{KW|_GL_MAX_TEXTURE_SIZE}}. - -{{KW|_GL_INVALID_VALUE}} is generated if {{Parameter|internalformat}} is not an allowable value. - -{{KW|_GL_INVALID_VALUE}} is generated if {{Parameter|width}} is less than 0 or greater than {{KW|_GL_MAX_TEXTURE_SIZE}}. - -{{KW|_GL_INVALID_VALUE}} is generated if {{Parameter|border}} is not 0. - -{{KW|_GL_INVALID_OPERATION}} is generated if {{Parameter|internalformat}} is {{KW|_GL_DEPTH_COMPONENT}}, {{KW|_GL_DEPTH_COMPONENT16}}, {{KW|_GL_DEPTH_COMPONENT24}}, or {{KW|_GL_DEPTH_COMPONENT32}} and there is no depth buffer. - - -{{PageUseWith}} - -{{KW|_glGetTexImage}} +* OpenGL's documentation is available in several places, so we won't reproduce it here for another time. +* The full description for this command can be found at [https://docs.microsoft.com/en-us/windows/win32/opengl/glcopyteximage1d Microsoft Docs] and is also valid for QB64 usage. {{PageSeeAlso}} - -[[_GL|SUB _GL]] -{{KW|_glActiveTexture}}, {{KW|_glBindTexture}}, {{KW|_glBindFramebuffer}}, {{KW|_glCopyTexImage2D}}, {{KW|_glCopyImageSubData}}, {{KW|_glCopyTexSubImage1D}}, {{KW|_glCopyTexSubImage2D}}, {{KW|_glReadBuffer}} +* [[_GL|SUB _GL]] +* [[_glCopyPixels]], [[_glCopyTexImage2D]], [[_glDrawPixels]], [https://docs.microsoft.com/en-us/windows/win32/opengl/glfog _glFog] +* [https://docs.microsoft.com/en-us/windows/win32/opengl/glpixelstore-functions _glPixelStore], [https://docs.microsoft.com/en-us/windows/win32/opengl/glpixeltransfer _glPixelTransfer], [https://docs.microsoft.com/en-us/windows/win32/opengl/gltexenv-functions _glTexEnv], [https://docs.microsoft.com/en-us/windows/win32/opengl/gltexgen-functions _glTexGen] +* [[_glTexImage1D]], [[_glTexImage2D]], [https://docs.microsoft.com/en-us/windows/win32/opengl/gltexparameter-functions _glTexParameter] -{{PageCopyright}} +{{PageNavigation}} +[[Category:Final]] diff --git a/internal/help/_glCopyTexImage2D__0010001001000021.txt b/internal/help/_glCopyTexImage2D__0010001001000021.txt index 36738c6bc..54441bb3f 100644 --- a/internal/help/_glCopyTexImage2D__0010001001000021.txt +++ b/internal/help/_glCopyTexImage2D__0010001001000021.txt @@ -1,79 +1,31 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:18:45}} -'''_glCopyTexImage2D:''' copy pixels into a 2D texture image +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:47:49}} +{{DISPLAYTITLE:_glCopyTexImage2D}} +The '''_glCopyTexImage2D''' statement copies pixels from the framebuffer into a two-dimensional texture image. {{PageSyntax}} - -: SUB _glCopyTexImage2D (BYVAL target AS _UNSIGNED LONG, BYVAL level AS LONG, BYVAL internalFormat AS _UNSIGNED LONG, BYVAL x AS LONG, BYVAL y AS LONG, BYVAL width AS LONG, BYVAL height AS LONG, BYVAL border AS LONG) -: void '''_glCopyTexImage2D'''(GLenum {{Parameter|target}}, GLint {{Parameter|level}}, GLenum {{Parameter|internalformat}}, GLint {{Parameter|x}}, GLint {{Parameter|y}}, GLsizei {{Parameter|width}}, GLsizei {{Parameter|height}}, GLint {{Parameter|border}}); +: '''_glCopyTexImage2D''' GLenum {{Parameter|target}}, GLint {{Parameter|level}}, GLenum {{Parameter|internalFormat}}, GLint {{Parameter|x}}, GLint {{Parameter|y}}, GLsizei {{Parameter|width}}, GLsizei {{Parameter|height}}, GLint {{Parameter|border}} -; target -: Specifies the target texture. Must be {{KW|_GL_TEXTURE_2D}}, {{KW|_GL_TEXTURE_CUBE_MAP_POSITIVE_X}}, {{KW|_GL_TEXTURE_CUBE_MAP_NEGATIVE_X}}, {{KW|_GL_TEXTURE_CUBE_MAP_POSITIVE_Y}}, {{KW|_GL_TEXTURE_CUBE_MAP_NEGATIVE_Y}}, {{KW|_GL_TEXTURE_CUBE_MAP_POSITIVE_Z}}, or {{KW|_GL_TEXTURE_CUBE_MAP_NEGATIVE_Z}}. -; level -: Specifies the level-of-detail number. Level 0 is the base image level. Level ''n'' is the ''n''th mipmap reduction image. -; internalformat -: Specifies the internal format of the texture. Must be one of the following symbolic constants: {{KW|_GL_COMPRESSED_RED}}, {{KW|_GL_COMPRESSED_RG}}, {{KW|_GL_COMPRESSED_RGB}}, {{KW|_GL_COMPRESSED_RGBA}}. {{KW|_GL_COMPRESSED_SRGB}}, {{KW|_GL_COMPRESSED_SRGB_ALPHA}}. {{KW|_GL_DEPTH_COMPONENT}}, {{KW|_GL_DEPTH_COMPONENT16}}, {{KW|_GL_DEPTH_COMPONENT24}}, {{KW|_GL_DEPTH_COMPONENT32}}, {{KW|_GL_RED}}, {{KW|_GL_RG}}, {{KW|_GL_RGB}}, {{KW|_GL_R3_G3_B2}}, {{KW|_GL_RGB4}}, {{KW|_GL_RGB5}}, {{KW|_GL_RGB8}}, {{KW|_GL_RGB10}}, {{KW|_GL_RGB12}}, {{KW|_GL_RGB16}}, {{KW|_GL_RGBA}}, {{KW|_GL_RGBA2}}, {{KW|_GL_RGBA4}}, {{KW|_GL_RGB5_A1}}, {{KW|_GL_RGBA8}}, {{KW|_GL_RGB10_A2}}, {{KW|_GL_RGBA12}}, {{KW|_GL_RGBA16}}, {{KW|_GL_SRGB}}, {{KW|_GL_SRGB8}}, {{KW|_GL_SRGB_ALPHA}}, or {{KW|_GL_SRGB8_ALPHA8}}. -; x, y -: Specify the window coordinates of the lower left corner of the rectangular region of pixels to be copied. -; width -: Specifies the width of the texture image. -; height -: Specifies the height of the texture image. -; border -: This value must be 0. +{{PageParameters}} +* OpenGL is using its own set of variable types to describe its command parameters. +* Use the following table to find the respective QB64 [[Variable Types]]. +{{OpenGLTypesPlugin}} {{PageDescription}} - -'''_glCopyTexImage2D''' defines a two-dimensional texture image, or cube-map texture image with pixels from the current {{KW|_GL_READ_BUFFER}}. - -The screen-aligned pixel rectangle with lower left corner at ({{Parameter|x}}, {{Parameter|y}}) and with a width of {{Parameter|width}} and a height of {{Parameter|height}} defines the texture array at the mipmap level specified by {{Parameter|level}}. {{Parameter|internalformat}} specifies the internal format of the texture array. - -The pixels in the rectangle are processed exactly as if {{KW|_glReadPixels}} had been called, but the process stops just before final conversion. At this point all pixel component values are clamped to the range [0, 1] and then converted to the texture's internal format for storage in the texel array. - -Pixel ordering is such that lower x and y screen coordinates correspond to lower s and t texture coordinates. - -If any of the pixels within the specified rectangle of the current {{KW|_GL_READ_BUFFER}} are outside the window associated with the current rendering context, then the values obtained for those pixels are undefined. - -When {{Parameter|internalformat}} is one of the sRGB types, the GL does not automatically convert the source pixels to the sRGB color space. In this case, the '''_glPixelMap''' function can be used to accomplish the conversion. - - -{{PageNotes}} - -1, 2, 3, and 4 are not accepted values for {{Parameter|internalformat}}. - -An image with height or width of 0 indicates a NULL texture. - - -{{PageErrors}} - -{{KW|_GL_INVALID_ENUM}} is generated if {{Parameter|target}} is not {{KW|_GL_TEXTURE_2D}}, {{KW|_GL_TEXTURE_CUBE_MAP_POSITIVE_X}}, {{KW|_GL_TEXTURE_CUBE_MAP_NEGATIVE_X}}, {{KW|_GL_TEXTURE_CUBE_MAP_POSITIVE_Y}}, {{KW|_GL_TEXTURE_CUBE_MAP_NEGATIVE_Y}}, {{KW|_GL_TEXTURE_CUBE_MAP_POSITIVE_Z}}, or {{KW|_GL_TEXTURE_CUBE_MAP_NEGATIVE_Z}}. - -{{KW|_GL_INVALID_VALUE}} is generated if {{Parameter|level}} is less than 0. - -{{KW|_GL_INVALID_VALUE}} may be generated if {{Parameter|level}} is greater than log2(max}, where max is the returned value of {{KW|_GL_MAX_TEXTURE_SIZE}}. - -{{KW|_GL_INVALID_VALUE}} is generated if {{Parameter|width}} is less than 0 or greater than {{KW|_GL_MAX_TEXTURE_SIZE}}. - -{{KW|_GL_INVALID_VALUE}} is generated if {{Parameter|border}} is not 0. - -{{KW|_GL_INVALID_VALUE}} is generated if {{Parameter|internalformat}} is not an accepted format. - -{{KW|_GL_INVALID_OPERATION}} is generated if {{Parameter|internalformat}} is {{KW|_GL_DEPTH_COMPONENT}}, {{KW|_GL_DEPTH_COMPONENT16}}, {{KW|_GL_DEPTH_COMPONENT24}}, or {{KW|_GL_DEPTH_COMPONENT32}} and there is no depth buffer. - - -{{PageUseWith}} - -{{KW|_glGetTexImage}} +* OpenGL's documentation is available in several places, so we won't reproduce it here for another time. +* The full description for this command can be found at [https://docs.microsoft.com/en-us/windows/win32/opengl/glcopyteximage2d Microsoft Docs] and is also valid for QB64 usage. {{PageSeeAlso}} - -[[_GL|SUB _GL]] -{{KW|_glActiveTexture}}, {{KW|_glBindTexture}}, {{KW|_glBindFramebuffer}}, {{KW|_glCopyTexImage1D}}, {{KW|_glCopyImageSubData}}, {{KW|_glCopyTexSubImage1D}}, {{KW|_glCopyTexSubImage2D}}, {{KW|_glReadBuffer}} +* [[_GL|SUB _GL]] +* [[_glBegin]], [[_glCopyTexImage1D]], [[_glDrawPixels]], [[_glEnd]] +* [https://docs.microsoft.com/en-us/windows/win32/opengl/glfog _glFog], [https://docs.microsoft.com/en-us/windows/win32/opengl/glpixelstore-functions _glPixelStore], [https://docs.microsoft.com/en-us/windows/win32/opengl/glpixeltransfer _glPixelTransfer], [https://docs.microsoft.com/en-us/windows/win32/opengl/gltexenv-functions _glTexEnv] +* [https://docs.microsoft.com/en-us/windows/win32/opengl/gltexgen-functions _glTexGen], [[_glTexImage1D]], [[_glTexImage2D]], [https://docs.microsoft.com/en-us/windows/win32/opengl/gltexparameter-functions _glTexParameter] -{{PageCopyright}} +{{PageNavigation}} +[[Category:Final]] diff --git a/internal/help/_glCopyTexSubImage1D__0010001001001000011.txt b/internal/help/_glCopyTexSubImage1D__0010001001001000011.txt index 84d3e8523..11b62e94a 100644 --- a/internal/help/_glCopyTexSubImage1D__0010001001001000011.txt +++ b/internal/help/_glCopyTexSubImage1D__0010001001001000011.txt @@ -1,68 +1,32 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:18:46}} -'''_glCopyTexSubImage1D:''' copy a one-dimensional texture subimage +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:47:51}} +{{DISPLAYTITLE:_glCopyTexSubImage1D}} +The '''_glCopyTexSubImage1D''' statement copies a sub-image of a one-dimensional texture image from the framebuffer. {{PageSyntax}} - -: SUB _glCopyTexSubImage1D (BYVAL target AS _UNSIGNED LONG, BYVAL level AS LONG, BYVAL xoffset AS LONG, BYVAL x AS LONG, BYVAL y AS LONG, BYVAL width AS LONG) - -: void '''_glCopyTexSubImage1D'''(GLenum {{Parameter|target}}, GLint {{Parameter|level}}, GLint {{Parameter|xoffset}}, GLint {{Parameter|x}}, GLint {{Parameter|y}}, GLsizei {{Parameter|width}}); +: '''_glCopyTexSubImage1D''' GLenum {{Parameter|target}}, GLint {{Parameter|level}}, GLint {{Parameter|xoffset}}, GLint {{Parameter|x}}, GLint {{Parameter|y}}, GLsizei {{Parameter|width}} -; target -: Specifies the target texture. Must be {{KW|_GL_TEXTURE_1D}}. -; level -: Specifies the level-of-detail number. Level 0 is the base image level. Level ''n'' is the ''n''th mipmap reduction image. -; xoffset -: Specifies the texel offset within the texture array. -; x, y -: Specify the window coordinates of the left corner of the row of pixels to be copied. -; width -: Specifies the width of the texture subimage. +{{PageParameters}} +* OpenGL is using its own set of variable types to describe its command parameters. +* Use the following table to find the respective QB64 [[Variable Types]]. +{{OpenGLTypesPlugin}} {{PageDescription}} - -'''_glCopyTexSubImage1D''' replaces a portion of a one-dimensional texture image with pixels from the current {{KW|_GL_READ_BUFFER}} (rather than from main memory, as is the case for {{KW|_glTexSubImage1D}}). - -The screen-aligned pixel row with left corner at ({{Parameter|x}},\ {{Parameter|y}}), and with length {{Parameter|width}} replaces the portion of the texture array with x indices {{Parameter|xoffset}} through ''xoffset + width - 1'', inclusive. The destination in the texture array may not include any texels outside the texture array as it was originally specified. - -The pixels in the row are processed exactly as if {{KW|_glReadPixels}} had been called, but the process stops just before final conversion. At this point, all pixel component values are clamped to the range [0, 1] and then converted to the texture's internal format for storage in the texel array. - -It is not an error to specify a subtexture with zero width, but such a specification has no effect. If any of the pixels within the specified row of the current {{KW|_GL_READ_BUFFER}} are outside the read window associated with the current rendering context, then the values obtained for those pixels are undefined. - -No change is made to the ''internalformat'', ''width'', or ''border'' parameters of the specified texture array or to texel values outside the specified subregion. - - -{{PageNotes}} - -The {{KW|_glPixelStore}} mode affects texture images. - - -{{PageErrors}} - -{{KW|_GL_INVALID_ENUM}} is generated if /{{Parameter|target}} is not {{KW|_GL_TEXTURE_1D}}. - -{{KW|_GL_INVALID_OPERATION}} is generated if the texture array has not been defined by a previous {{KW|_glTexImage1D}} or {{KW|_glCopyTexImage1D}} operation. - -{{KW|_GL_INVALID_VALUE}} is generated if {{Parameter|level}} is less than 0. - -{{KW|_GL_INVALID_VALUE}} may be generated if ''level'' is greater than log2(max), where ''max'' is the returned value of {{KW|_GL_MAX_TEXTURE_SIZE}}. - -{{KW|_GL_INVALID_VALUE}} is generated if xoffset < 0 or xoffset + width > w, where w is the {{KW|_GL_TEXTURE_WIDTH}}. - - -{{PageUseWith}} - -{{KW|_glGetTexImage}} +* OpenGL's documentation is available in several places, so we won't reproduce it here for another time. +* The full description for this command can be found at [https://docs.microsoft.com/en-us/windows/win32/opengl/glcopytexsubimage1d Microsoft Docs] and is also valid for QB64 usage. {{PageSeeAlso}} - -[[_GL|SUB _GL]] -{{KW|_glActiveTexture}}, {{KW|_glBindTexture}}, {{KW|_glBindFramebuffer}}, {{KW|_glCopyImageSubData}}, {{KW|_glCopyTexSubImage2D}}, {{KW|_glCopyTexSubImage3D}}, {{KW|_glCopyTexImage1D}}, {{KW|_glReadBuffer}} +* [[_GL|SUB _GL]] +* [[_glBegin]], [[_glCopyTexSubImage2D]], [[_glDrawPixels]], [[_glEnd]] +* [https://docs.microsoft.com/en-us/windows/win32/opengl/glfog _glFog], [https://docs.microsoft.com/en-us/windows/win32/opengl/glpixelstore-functions _glPixelStore], [https://docs.microsoft.com/en-us/windows/win32/opengl/glpixeltransfer _glPixelTransfer], [https://docs.microsoft.com/en-us/windows/win32/opengl/gltexenv-functions _glTexEnv] +* [https://docs.microsoft.com/en-us/windows/win32/opengl/gltexgen-functions _glTexGen], [[_glTexImage1D]], [[_glTexImage2D]], [[_glTexSubImage1D]] +* [[_glTexSubImage2D]], [https://docs.microsoft.com/en-us/windows/win32/opengl/gltexparameter-functions _glTexParameter] -{{PageCopyright}} +{{PageNavigation}} +[[Category:Final]] diff --git a/internal/help/_glCopyTexSubImage2D__0010001001001000021.txt b/internal/help/_glCopyTexSubImage2D__0010001001001000021.txt index d5da5a2ef..0b56d084b 100644 --- a/internal/help/_glCopyTexSubImage2D__0010001001001000021.txt +++ b/internal/help/_glCopyTexSubImage2D__0010001001001000021.txt @@ -1,76 +1,32 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:18:47}} -'''_glCopyTexSubImage2D:''' copy a two-dimensional texture subimage +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:47:54}} +{{DISPLAYTITLE:_glCopyTexSubImage2D}} +The '''_glCopyTexSubImage2D''' statement copies a sub-image of a two-dimensional texture image from the framebuffer. {{PageSyntax}} - -: SUB _glCopyTexSubImage2D (BYVAL target AS _UNSIGNED LONG, BYVAL level AS LONG, BYVAL xoffset AS LONG, BYVAL yoffset AS LONG, BYVAL x AS LONG, BYVAL y AS LONG, BYVAL width AS LONG, BYVAL height AS LONG) - -: void '''_glCopyTexSubImage2D'''(GLenum {{Parameter|target}}, GLint {{Parameter|level}}, GLint {{Parameter|xoffset}}, GLint {{Parameter|yoffset}}, GLint {{Parameter|x}}, GLint {{Parameter|y}}, GLsizei {{Parameter|width}}, GLsizei {{Parameter|height}}); +: '''_glCopyTexSubImage2D''' GLenum {{Parameter|target}}, GLint {{Parameter|level}}, GLint {{Parameter|xoffset}}, GLint {{Parameter|yoffset}}, GLint {{Parameter|x}}, GLint {{Parameter|y}}, GLsizei {{Parameter|width}}, GLsizei {{Parameter|height}} -; target -: Specifies the target texture. Must be {{KW|_GL_TEXTURE_2D}}, {{KW|_GL_TEXTURE_CUBE_MAP_POSITIVE_X}}, {{KW|_GL_TEXTURE_CUBE_MAP_NEGATIVE_X}}, {{KW|_GL_TEXTURE_CUBE_MAP_POSITIVE_Y}}, {{KW|_GL_TEXTURE_CUBE_MAP_NEGATIVE_Y}}, {{KW|_GL_TEXTURE_CUBE_MAP_POSITIVE_Z}}, {{KW|_GL_TEXTURE_CUBE_MAP_NEGATIVE_Z}}, or {{KW|_GL_TEXTURE_1D_ARRAY}}. -; level -: Specifies the level-of-detail number. Level 0 is the base image level. Level ''n'' is the ''n''th mipmap reduction image. -; xoffset -: Specifies a texel offset in the x direction within the texture array. -; yoffset -: Specifies a texel offset in the y direction within the texture array. -; x, y -: Specify the window coordinates of the lower left corner of the rectangular region of pixels to be copied. -; width -: Specifies the width of the texture subimage. -; height -: Specifies the height of the texture subimage. +{{PageParameters}} +* OpenGL is using its own set of variable types to describe its command parameters. +* Use the following table to find the respective QB64 [[Variable Types]]. +{{OpenGLTypesPlugin}} {{PageDescription}} - -'''_glCopyTexSubImage2D''' replaces a rectangular portion of a two-dimensional texture image, cube-map texture image or a linear portion of a number of slices of a one-dimensional array texture with pixels from the current {{KW|_GL_READ_BUFFER}} (rather than from main memory, as is the case for {{KW|_glTexSubImage2D}}). - -The screen-aligned pixel rectangle with lower left corner at (''x'', ''y'') and with width {{Parameter|width}} and height {{Parameter|height}} replaces the portion of the texture array with x indices {{Parameter|xoffset}} through ''xoffset + width - 1'', inclusive, and y indices {{Parameter|yoffset}} through ''yoffset + height - 1'', inclusive, at the mipmap level specified by {{Parameter|level}}. - -The pixels in the rectangle are processed exactly as if {{KW|_glReadPixels}} had been called, but the process stops just before final conversion. At this point, all pixel component values are clamped to the range [0, 1] and then converted to the texture's internal format for storage in the texel array. - -The destination rectangle in the texture array may not include any texels outside the texture array as it was originally specified. It is not an error to specify a subtexture with zero width or height, but such a specification has no effect. - -When {{Parameter|target}} is {{KW|_GL_TEXTURE_1D_ARRAY}} then the y coordinate and height are treated as the start slice and number of slices to modify. - -If any of the pixels within the specified rectangle of the current {{KW|_GL_READ_BUFFER}} are outside the read window associated with the current rendering context, then the values obtained for those pixels are undefined. - -No change is made to the ''internalformat'', ''width'', ''height'', or ''border'' parameters of the specified texture array or to texel values outside the specified subregion. - - -{{PageNotes}} - -{{KW|_glPixelStore}} modes affect texture images. - - -{{PageErrors}} - -{{KW|_GL_INVALID_ENUM}} is generated if {{Parameter|target}} is not {{KW|_GL_TEXTURE_2D}}, {{KW|_GL_TEXTURE_CUBE_MAP_POSITIVE_X}}, {{KW|_GL_TEXTURE_CUBE_MAP_NEGATIVE_X}}, {{KW|_GL_TEXTURE_CUBE_MAP_POSITIVE_Y}}, {{KW|_GL_TEXTURE_CUBE_MAP_NEGATIVE_Y}}, {{KW|_GL_TEXTURE_CUBE_MAP_POSITIVE_Z}}, {{KW|_GL_TEXTURE_CUBE_MAP_NEGATIVE_Z}}, or {{KW|_GL_TEXTURE_1D_ARRAY}}. - -{{KW|_GL_INVALID_OPERATION}} is generated if the texture array has not been defined by a previous {{KW|_glTexImage2D}} or {{KW|_glCopyTexImage2D}} operation. - -{{KW|_GL_INVALID_VALUE}} is generated if {{Parameter|level}} is less than 0. - -{{KW|_GL_INVALID_VALUE}} may be generated if ''level'' is greater than log2(max), where ''max'' is the returned value of {{KW|_GL_MAX_TEXTURE_SIZE}}. - -{{KW|_GL_INVALID_VALUE}} is generated if xoffset < 0, xoffset + width > w, yoffset < 0, or yoffset + height > h, where w is the {{KW|_GL_TEXTURE_WIDTH}} and h is the {{KW|_GL_TEXTURE_HEIGHT}} of the texture image being modified. - - -{{PageUseWith}} - -{{KW|_glGetTexImage}} +* OpenGL's documentation is available in several places, so we won't reproduce it here for another time. +* The full description for this command can be found at [https://docs.microsoft.com/en-us/windows/win32/opengl/glcopytexsubimage2d Microsoft Docs] and is also valid for QB64 usage. {{PageSeeAlso}} - -[[_GL|SUB _GL]] -{{KW|_glActiveTexture}}, {{KW|_glBindTexture}}, {{KW|_glBindFramebuffer}}, {{KW|_glCopyImageSubData}}, {{KW|_glCopyTexSubImage1D}}, {{KW|_glCopyTexSubImage3D}}, {{KW|_glCopyTexImage2D}}, {{KW|_glReadBuffer}} +* [[_GL|SUB _GL]] +* [[_glBegin]], [[_glCopyPixels]], [[_glCopyTexSubImage1D]], [[_glDrawPixels]] +* [[_glEnd]], [https://docs.microsoft.com/en-us/windows/win32/opengl/glfog _glFog], [https://docs.microsoft.com/en-us/windows/win32/opengl/glpixelstore-functions _glPixelStore], [https://docs.microsoft.com/en-us/windows/win32/opengl/glpixeltransfer _glPixelTransfer] +* [https://docs.microsoft.com/en-us/windows/win32/opengl/gltexenv-functions _glTexEnv], [https://docs.microsoft.com/en-us/windows/win32/opengl/gltexgen-functions _glTexGen], [[_glTexImage2D]], [[_glTexSubImage2D]] +* [https://docs.microsoft.com/en-us/windows/win32/opengl/gltexparameter-functions _glTexParameter] -{{PageCopyright}} +{{PageNavigation}} +[[Category:Final]] diff --git a/internal/help/_glCullFace__0010001000.txt b/internal/help/_glCullFace__0010001000.txt index 6043ae549..dc04a126a 100644 --- a/internal/help/_glCullFace__0010001000.txt +++ b/internal/help/_glCullFace__0010001000.txt @@ -1,47 +1,30 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:18:48}} -'''_glCullFace:''' specify whether front- or back-facing facets can be culled +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:47:56}} +{{DISPLAYTITLE:_glCullFace}} +The '''_glCullFace''' statement specifies whether front-facing or back-facing facets can be culled. {{PageSyntax}} - -::SUB '''_glCullFace''' (BYVAL mode AS _UNSIGNED LONG) -:: void '''_glCullFace'''(GLenum {{Parameter|mode}}); +: '''_glCullFace''' GLenum {{Parameter|mode}} -; mode -: Specifies whether front- or back-facing facets are candidates for culling. Symbolic constants {{KW|_GL_FRONT}}, {{KW|_GL_BACK}}, and {{KW|_GL_FRONT_AND_BACK}} are accepted. The initial value is {{KW|_GL_BACK}}. +{{PageParameters}} +* OpenGL is using its own set of variable types to describe its command parameters. +* Use the following table to find the respective QB64 [[Variable Types]]. +{{OpenGLTypesPlugin}} {{PageDescription}} - -'''_glCullFace''' specifies whether front- or back-facing facets are culled (as specified by ''mode'') when facet culling is enabled. Facet culling is initially disabled. To enable and disable facet culling, call the {{KW|_glEnable}} and {{KW|_glDisable}} commands with the argument {{KW|_GL_CULL_FACE}}. Facets include triangles, quadrilaterals, polygons, and rectangles. - -{{KW|_glFrontFace}} specifies which of the clockwise and counterclockwise facets are front-facing and back-facing. See {{KW|_glFrontFace}}. - - -{{PageNotes}} - -If {{Parameter|mode}} is {{KW|_GL_FRONT_AND_BACK}}, no facets are drawn, but other primitives such as points and lines are drawn. - - -{{PageErrors}} - -{{KW|_GL_INVALID_ENUM}} is generated if {{Parameter|mode}} is not an accepted value. - - -{{PageUseWith}} - -{{KW|_glIsEnabled}} with argument {{KW|_GL_CULL_FACE}} - -{{KW|_glGet}} with argument {{KW|_GL_CULL_FACE_MODE}} +* OpenGL's documentation is available in several places, so we won't reproduce it here for another time. +* The full description for this command can be found at [https://docs.microsoft.com/en-us/windows/win32/opengl/glcullface Microsoft Docs] and is also valid for QB64 usage. {{PageSeeAlso}} - -[[_GL|SUB _GL]] -{{KW|_glEnable|(GL_CULL_FACE)}}, {{KW|_glFrontFace}} +* [[_GL|SUB _GL]] +* [[_glBegin]], [[_glDisable]], [[_glEnable]], [[_glEnd]] +* [[_glFrontFace]], [https://docs.microsoft.com/en-us/windows/win32/opengl/glgetbooleanv--glgetdoublev--glgetfloatv--glgetintegerv _glGet], [[_glIsEnabled]] -{{PageCopyright}} +{{PageNavigation}} +[[Category:Final]] diff --git a/internal/help/_glDeleteLists__0010000010000.txt b/internal/help/_glDeleteLists__0010000010000.txt new file mode 100644 index 000000000..58fe44f76 --- /dev/null +++ b/internal/help/_glDeleteLists__0010000010000.txt @@ -0,0 +1,30 @@ +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:47:58}} +{{DISPLAYTITLE:_glDeleteLists}} +The '''_glDeleteLists''' statement deletes a contiguous group of display lists. + + +{{PageSyntax}} +: '''_glDeleteLists''' GLuint {{Parameter|list}}, GLsizei {{Parameter|range}} + + +{{PageParameters}} +* OpenGL is using its own set of variable types to describe its command parameters. +* Use the following table to find the respective QB64 [[Variable Types]]. +{{OpenGLTypesPlugin}} + + +{{PageDescription}} +* OpenGL's documentation is available in several places, so we won't reproduce it here for another time. +* The full description for this command can be found at [https://docs.microsoft.com/en-us/windows/win32/opengl/gldeletelists Microsoft Docs] and is also valid for QB64 usage. + + +{{PageSeeAlso}} +* [[_GL|SUB _GL]] +* [[_glBegin]], [[_glCallList]], [[_glCallLists]], [[_glEnd]] +* [[_glGenLists]], [[_glIsList]], [[_glNewList]] + + +{{PageNavigation}} + +[[Category:Final]] diff --git a/internal/help/_glDeleteTextures__0010000010000000.txt b/internal/help/_glDeleteTextures__0010000010000000.txt index 89a92cad2..344c39411 100644 --- a/internal/help/_glDeleteTextures__0010000010000000.txt +++ b/internal/help/_glDeleteTextures__0010000010000000.txt @@ -1,43 +1,32 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:18:51}} -'''_glDeleteTextures:''' delete named textures +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:48:00}} +{{DISPLAYTITLE:_glDeleteTextures}} +The '''_glDeleteTextures''' statement deletes named textures. {{PageSyntax}} - -: SUB _glDeleteTextures (BYVAL n AS LONG, textures AS _UNSIGNED LONG) - -: void '''_glDeleteTextures'''(GLsizei {{Parameter|n}}, const GLuint * {{Parameter|textures}}); +: '''_glDeleteTextures''' GLsizei {{Parameter|n}}, const GLuint {{Parameter|*textures}} -; n -: Specifies the number of textures to be deleted. -; textures -: Specifies an array of textures to be deleted. +{{PageParameters}} +* OpenGL is using its own set of variable types to describe its command parameters. +* Use the following table to find the respective QB64 [[Variable Types]]. +{{OpenGLTypesPlugin}} {{PageDescription}} - -'''_glDeleteTextures''' deletes {{Parameter|n}} textures named by the elements of the array {{Parameter|textures}}. After a texture is deleted, it has no contents or dimensionality, and its name is free for reuse (for example by {{KW|_glGenTextures}}). If a texture that is currently bound is deleted, the binding reverts to 0 (the default texture). - -'''_glDeleteTextures''' silently ignores 0's and names that do not correspond to existing textures. - - -{{PageErrors}} - -{{KW|_GL_INVALID_VALUE}} is generated if {{Parameter|n}} is negative. - - -{{PageUseWith}} - -{{KW|_glIsTexture}} +* OpenGL's documentation is available in several places, so we won't reproduce it here for another time. +* The full description for this command can be found at [https://docs.microsoft.com/en-us/windows/win32/opengl/gldeletetextures Microsoft Docs] and is also valid for QB64 usage. {{PageSeeAlso}} - -[[_GL|SUB _GL]] -{{KW|_glBindTexture}}, {{KW|_glGenTextures}}, {{KW|_glIsTexture}} +* [[_GL|SUB _GL]] +* [[_glAreTexturesResident]], [[_glBegin]], [[_glBindTexture]], [[_glEnd]] +* [[_glGenTextures]], [https://docs.microsoft.com/en-us/windows/win32/opengl/glgetbooleanv--glgetdoublev--glgetfloatv--glgetintegerv _glGet], [https://docs.microsoft.com/en-us/windows/win32/opengl/glgettexparameter _glGetTexParameter], [[_glIsTexture]] +* [[_glPrioritizeTextures]], [https://docs.microsoft.com/en-us/windows/win32/opengl/gltexgen-functions _glTexGen], [[_glTexImage1D]], [[_glTexImage2D]] +* [https://docs.microsoft.com/en-us/windows/win32/opengl/gltexparameter-functions _glTexParameter] -{{PageCopyright}} +{{PageNavigation}} +[[Category:Final]] diff --git a/internal/help/_glDepthFunc__00100001000.txt b/internal/help/_glDepthFunc__00100001000.txt index ab9a1ea62..597912675 100644 --- a/internal/help/_glDepthFunc__00100001000.txt +++ b/internal/help/_glDepthFunc__00100001000.txt @@ -1,65 +1,30 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:18:52}} -'''_glDepthFunc:''' specify the value used for depth buffer comparisons +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:48:02}} +{{DISPLAYTITLE:_glDepthFunc}} +The '''_glDepthFunc''' statement specifies the value used for depth-buffer comparisons. {{PageSyntax}} - -:: SUB _glDepthFunc (BYVAL func AS _UNSIGNED LONG) -:: void '''_glDepthFunc'''(GLenum {{Parameter|func}}); +: '''_glDepthFunc''' GLenum {{Parameter|func}} -; func -: Specifies the depth comparison function. Symbolic constants {{KW|_GL_NEVER}}, {{KW|_GL_LESS}}, {{KW|_GL_EQUAL}}, {{KW|_GL_LEQUAL}}, {{KW|_GL_GREATER}}, {{KW|_GL_NOTEQUAL}}, {{KW|_GL_GEQUAL}}, and {{KW|_GL_ALWAYS}} are accepted. The initial value is {{KW|_GL_LESS}}. +{{PageParameters}} +* OpenGL is using its own set of variable types to describe its command parameters. +* Use the following table to find the respective QB64 [[Variable Types]]. +{{OpenGLTypesPlugin}} {{PageDescription}} - -'''_glDepthFunc''' specifies the function used to compare each incoming pixel depth value with the depth value present in the depth buffer. The comparison is performed only if depth testing is enabled. (See {{KW|_glEnable}} and {{KW|_glDisable}} of {{KW|_GL_DEPTH_TEST}}.) - -{{Parameter|func}} specifies the conditions under which the pixel will be drawn. The comparison functions are as follows: - -; {{KW|_GL_NEVER}} -: Never passes. -; {{KW|_GL_LESS}} -: Passes if the incoming depth value is less than the stored depth value. -; {{KW|_GL_EQUAL}} -: Passes if the incoming depth value is equal to the stored depth value. -; {{KW|_GL_LEQUAL}} -: Passes if the incoming depth value is less than or equal to the stored depth value. -; {{KW|_GL_GREATER}} -: Passes if the incoming depth value is greater than the stored depth value. -; {{KW|_GL_NOTEQUAL}} -: Passes if the incoming depth value is not equal to the stored depth value. -; {{KW|_GL_GEQUAL}} -: Passes if the incoming depth value is greater than or equal to the stored depth value. -; {{KW|_GL_ALWAYS}} -: Always passes. -The initial value of {{Parameter|func}} is {{KW|_GL_LESS}}. Initially, depth testing is disabled. If depth testing is disabled or if no depth buffer exists, it is as if the depth test always passes. - - -{{PageNotes}} - -Even if the depth buffer exists and the depth mask is non-zero, the depth buffer is not updated if the depth test is disabled. In order to unconditionally write to the depth buffer, the depth test should be enabled and set to {{KW|_GL_ALWAYS}}. - - -{{PageErrors}} - -{{KW|_GL_INVALID_ENUM}} is generated if {{Parameter|func}} is not an accepted value. - - -{{PageUseWith}} - -{{KW|_glGet}} with argument {{KW|_GL_DEPTH_FUNC}} - -{{KW|_glIsEnabled}} with argument {{KW|_GL_DEPTH_TEST}} +* OpenGL's documentation is available in several places, so we won't reproduce it here for another time. +* The full description for this command can be found at [https://docs.microsoft.com/en-us/windows/win32/opengl/gldepthfunc Microsoft Docs] and is also valid for QB64 usage. {{PageSeeAlso}} - -[[_GL|SUB _GL]] -{{KW|_glEnable|(GL_DEPTH_TEST)}}, {{KW|_glDepthRange}}, {{KW|_glPolygonOffset}} +* [[_GL|SUB _GL]] +* [[_glBegin]], [[_glDepthRange]], [[_glEnable]], [[_glEnd]] +* [https://docs.microsoft.com/en-us/windows/win32/opengl/glgetbooleanv--glgetdoublev--glgetfloatv--glgetintegerv _glGet], [[_glIsEnabled]] -{{PageCopyright}} +{{PageNavigation}} +[[Category:Final]] diff --git a/internal/help/_glDepthMask__00100001000.txt b/internal/help/_glDepthMask__00100001000.txt index e768c7023..6389d57ac 100644 --- a/internal/help/_glDepthMask__00100001000.txt +++ b/internal/help/_glDepthMask__00100001000.txt @@ -1,38 +1,30 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:18:54}} -'''_glDepthMask:''' enable or disable writing into the depth buffer +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:48:05}} +{{DISPLAYTITLE:_glDepthMask}} +The '''_glDepthMask''' statement enables or disables writing into the depth buffer. {{PageSyntax}} - -:: SUB _glDepthMask (BYVAL flag AS _UNSIGNED _BYTE) -:: void '''_glDepthMask'''(GLboolean {{Parameter|flag}}); +: '''_glDepthMask''' GLboolean {{Parameter|flag}} -; flag -: Specifies whether the depth buffer is enabled for writing. If {{Parameter|flag}} is {{KW|_GL_FALSE}}, depth buffer writing is disabled. Otherwise, it is enabled. Initially, depth buffer writing is enabled. +{{PageParameters}} +* OpenGL is using its own set of variable types to describe its command parameters. +* Use the following table to find the respective QB64 [[Variable Types]]. +{{OpenGLTypesPlugin}} {{PageDescription}} - -'''_glDepthMask''' specifies whether the depth buffer is enabled for writing. If {{Parameter|flag}} is {{KW|_GL_FALSE}}, depth buffer writing is disabled. Otherwise, it is enabled. Initially, depth buffer writing is enabled. - - -{{PageUseWith}} - -{{KW|_glGet}} with argument {{KW|_GL_DEPTH_WRITEMASK}} - - -{{PageNotes}} - -Even if the depth buffer exists and the depth mask is non-zero, the depth buffer is not updated if the depth test is disabled. In order to unconditionally write to the depth buffer, the depth test should be enabled and set to {{KW|_GL_ALWAYS}} (see {{KW|_glDepthFunc}}). +* OpenGL's documentation is available in several places, so we won't reproduce it here for another time. +* The full description for this command can be found at [https://docs.microsoft.com/en-us/windows/win32/opengl/gldepthmask Microsoft Docs] and is also valid for QB64 usage. {{PageSeeAlso}} - -[[_GL|SUB _GL]] -{{KW|_glColorMask}}, {{KW|_glClearBuffer}}, {{KW|_glDepthFunc}}, {{KW|_glDepthRange}}, {{KW|_glStencilMask}} +* [[_GL|SUB _GL]] +* [[_glBegin]], [[_glColorMask]], [[_glDepthFunc]], [[_glDepthRange]] +* [[_glEnd]], [https://docs.microsoft.com/en-us/windows/win32/opengl/glgetbooleanv--glgetdoublev--glgetfloatv--glgetintegerv _glGet], [[_glIndexMask]], [[_glStencilMask]] -{{PageCopyright}} +{{PageNavigation}} +[[Category:Final]] diff --git a/internal/help/_glDepthRange__001000010000.txt b/internal/help/_glDepthRange__001000010000.txt index d973cf283..0ff3e597a 100644 --- a/internal/help/_glDepthRange__001000010000.txt +++ b/internal/help/_glDepthRange__001000010000.txt @@ -1,45 +1,30 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:18:55}} -'''_glDepthRange:''' specify mapping of depth values from normalized device coordinates to window coordinates +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:48:07}} +{{DISPLAYTITLE:_glDepthRange}} +The '''_glDepthRange''' statement specifies the mapping of z values from normalized device coordinates to window coordinates. {{PageSyntax}} +: '''_glDepthRange''' GLclampd {{Parameter|zNear}}, GLclampd {{Parameter|zFar}} -:: SUB _glDepthRange (BYVAL zNear AS DOUBLE, BYVAL zFar AS DOUBLE) -:: void '''_glDepthRange'''(GLdouble {{Parameter|nearVal}}, GLdouble {{Parameter|farVal}}); -:: void '''_glDepthRangef'''(GLfloat {{Parameter|nearVal}}, GLfloat {{Parameter|farVal}}); - -; nearVal -: Specifies the mapping of the near clipping plane to window coordinates. The initial value is 0. -; farVal -: Specifies the mapping of the far clipping plane to window coordinates. The initial value is 1. +{{PageParameters}} +* OpenGL is using its own set of variable types to describe its command parameters. +* Use the following table to find the respective QB64 [[Variable Types]]. +{{OpenGLTypesPlugin}} {{PageDescription}} - -After clipping and division by ''w'', depth coordinates range from -1 to 1, corresponding to the near and far clipping planes. '''_glDepthRange''' specifies a linear mapping of the normalized depth coordinates in this range to window depth coordinates. Regardless of the actual depth buffer implementation, window coordinate depth values are treated as though they range from 0 through 1 (like color components). Thus, the values accepted by '''_glDepthRange''' are both clamped to this range before they are accepted. - -The setting of (0,1) maps the near plane to 0 and the far plane to 1. With this mapping, the depth buffer range is fully utilized. - - -{{PageNotes}} - -It is not necessary that {{Parameter|nearVal}} be less than {{Parameter|farVal}}. Reverse mappings such as ''nearVal'' = 1, and ''farVal'' = 0 are acceptable. - -The type of the {{Parameter|nearVal}} and {{Parameter|farVal}} parameters was changed from GLclampf to GLfloat for '''_glDepthRangef''' and from GLclampd to GLdouble for '''_glDepthRange'''. This change is transparent to user code. - - -{{PageUseWith}} - -{{KW|_glGet}} with argument {{KW|_GL_DEPTH_RANGE}} +* OpenGL's documentation is available in several places, so we won't reproduce it here for another time. +* The full description for this command can be found at [https://docs.microsoft.com/en-us/windows/win32/opengl/gldepthrange Microsoft Docs] and is also valid for QB64 usage. {{PageSeeAlso}} - -[[_GL|SUB _GL]] -{{KW|_glDepthFunc}}, {{KW|_glDepthRangeArray}}, {{KW|_glDepthRangeIndexed}}, {{KW|_glPolygonOffset}}, {{KW|_glViewport}} +* [[_GL|SUB _GL]] +* [[_glBegin]], [[_glDepthFunc]], [[_glEnd]], [https://docs.microsoft.com/en-us/windows/win32/opengl/glgetbooleanv--glgetdoublev--glgetfloatv--glgetintegerv _glGet] +* [[_glViewport]] -{{PageCopyright}} +{{PageNavigation}} +[[Category:Final]] diff --git a/internal/help/_glDisableClientState__00100000010000010000.txt b/internal/help/_glDisableClientState__00100000010000010000.txt new file mode 100644 index 000000000..dfdce673c --- /dev/null +++ b/internal/help/_glDisableClientState__00100000010000010000.txt @@ -0,0 +1,32 @@ +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:48:11}} +{{DISPLAYTITLE:_glDisableClientState}} +The '''_glEnableClientState''' and '''_glDisableClientState''' statements enable and disable arrays respectively. + + +{{PageSyntax}} +: '''_glDisableClientState''' GLenum {{Parameter|array}} + + +{{PageParameters}} +* OpenGL is using its own set of variable types to describe its command parameters. +* Use the following table to find the respective QB64 [[Variable Types]]. +{{OpenGLTypesPlugin}} + + +{{PageDescription}} +* OpenGL's documentation is available in several places, so we won't reproduce it here for another time. +* The full description for this command can be found at [https://docs.microsoft.com/en-us/windows/win32/opengl/gldisableclientstate Microsoft Docs] and is also valid for QB64 usage. + + +{{PageSeeAlso}} +* [[_GL|SUB _GL]] +* [[_glArrayElement]], [[_glBegin]], [[_glColorPointer]], [[_glDrawArrays]] +* [[_glDrawElements]], [[_glEdgeFlagPointer]], [[_glEnable]], [[_glEnableClientState]] +* [[_glEnd]], [[_glGetPointerv]], [[_glIndexPointer]], [[_glInterleavedArrays]] +* [[_glNormalPointer]], [[_glTexCoordPointer]], [[_glVertexPointer]] + + +{{PageNavigation}} + +[[Category:Final]] diff --git a/internal/help/_glDisable__001000000.txt b/internal/help/_glDisable__001000000.txt new file mode 100644 index 000000000..b33d690a0 --- /dev/null +++ b/internal/help/_glDisable__001000000.txt @@ -0,0 +1,39 @@ +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:48:09}} +{{DISPLAYTITLE:_glDisable}} +The '''_glEnable''' and '''_glDisable''' statements enable or disable OpenGL capabilities. + + +{{PageSyntax}} +: '''_glDisable''' GLenum {{Parameter|cap}} + + +{{PageParameters}} +* OpenGL is using its own set of variable types to describe its command parameters. +* Use the following table to find the respective QB64 [[Variable Types]]. +{{OpenGLTypesPlugin}} + + +{{PageDescription}} +* OpenGL's documentation is available in several places, so we won't reproduce it here for another time. +* The full description for this command can be found at [https://docs.microsoft.com/en-us/windows/win32/opengl/gldisable Microsoft Docs] and is also valid for QB64 usage. + + +{{PageSeeAlso}} +* [[_GL|SUB _GL]] +* [[_glAlphaFunc]], [[_glArrayElement]], [[_glBegin]], [[_glBlendFunc]] +* [[_glClipPlane]], [[_glColorMaterial]], [[_glColorPointer]], [[_glCullFace]] +* [[_glDepthFunc]], [[_glDepthRange]], [[_glDrawArrays]], [[_glEdgeFlagPointer]] +* [[_glEnable]], [[_glEnd]], [https://docs.microsoft.com/en-us/windows/win32/opengl/glevalcoord-functions _glEvalCoord], [https://docs.microsoft.com/en-us/windows/win32/opengl/glevalmesh-functions _glEvalMesh] +* [https://docs.microsoft.com/en-us/windows/win32/opengl/glevalpoint _glEvalPoint], [https://docs.microsoft.com/en-us/windows/win32/opengl/glfog _glFog], [https://docs.microsoft.com/en-us/windows/win32/opengl/glgetbooleanv--glgetdoublev--glgetfloatv--glgetintegerv _glGet], [[_glIndexPointer]] +* [[_glIsEnabled]], [https://docs.microsoft.com/en-us/windows/win32/opengl/gllight-functions _glLight], [https://docs.microsoft.com/en-us/windows/win32/opengl/gllightmodel-functions _glLightModel], [[_glLineWidth]] +* [[_glLineStipple]], [[_glLogicOp]], [https://docs.microsoft.com/en-us/windows/win32/opengl/glmap1 _glMap1], [https://docs.microsoft.com/en-us/windows/win32/opengl/glmap2 _glMap2] +* [https://docs.microsoft.com/en-us/windows/win32/opengl/glmaterial-functions _glMaterial], [https://docs.microsoft.com/en-us/windows/win32/opengl/glnormal-functions _glNormal], [[_glNormalPointer]], [[_glPointSize]] +* [[_glPolygonMode]], [[_glPolygonStipple]], [[_glScissor]], [[_glStencilFunc]] +* [[_glStencilOp]], [[_glTexCoordPointer]], [https://docs.microsoft.com/en-us/windows/win32/opengl/gltexgen-functions _glTexGen], [[_glTexImage1D]] +* [[_glTexImage2D]] + + +{{PageNavigation}} + +[[Category:Final]] diff --git a/internal/help/_glDrawArrays__001000100000.txt b/internal/help/_glDrawArrays__001000100000.txt index b1cd747de..6f9ef0553 100644 --- a/internal/help/_glDrawArrays__001000100000.txt +++ b/internal/help/_glDrawArrays__001000100000.txt @@ -1,52 +1,31 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:18:59}} -'''_glDrawArrays:''' render primitives from array data +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:48:14}} +{{DISPLAYTITLE:_glDrawArrays}} +The '''_glDrawArrays''' statement specifies multiple primitives to render. {{PageSyntax}} - -:: SUB _glDrawArrays (BYVAL mode AS _UNSIGNED LONG, BYVAL first AS LONG, BYVAL count AS LONG) -:: void '''_glDrawArrays'''(GLenum {{Parameter|mode}}, GLint {{Parameter|first}}, GLsizei {{Parameter|count}}); +: '''_glDrawArrays''' GLenum {{Parameter|mode}}, GLint {{Parameter|first}}, GLsizei {{Parameter|count}} -; mode -: Specifies what kind of primitives to render. Symbolic constants {{KW|_GL_POINTS}}, {{KW|_GL_LINE_STRIP}}, {{KW|_GL_LINE_LOOP}}, {{KW|_GL_LINES}}, {{KW|_GL_LINE_STRIP_ADJACENCY}}, {{KW|_GL_LINES_ADJACENCY}}, {{KW|_GL_TRIANGLE_STRIP}}, {{KW|_GL_TRIANGLE_FAN}}, {{KW|_GL_TRIANGLES}}, {{KW|_GL_TRIANGLE_STRIP_ADJACENCY}}, {{KW|_GL_TRIANGLES_ADJACENCY}} and {{KW|_GL_PATCHES}} are accepted. -; first -: Specifies the starting index in the enabled arrays. -; count -: Specifies the number of indices to be rendered. +{{PageParameters}} +* OpenGL is using its own set of variable types to describe its command parameters. +* Use the following table to find the respective QB64 [[Variable Types]]. +{{OpenGLTypesPlugin}} {{PageDescription}} - -'''_glDrawArrays''' specifies multiple geometric primitives with very few subroutine calls. Instead of calling a GL procedure to pass each individual vertex, normal, texture coordinate, edge flag, or color, you can prespecify separate arrays of vertices, normals, and colors and use them to construct a sequence of primitives with a single call to '''_glDrawArrays'''. - -When '''_glDrawArrays''' is called, it uses {{Parameter|count}} sequential elements from each enabled array to construct a sequence of geometric primitives, beginning with element {{Parameter|first}}. {{Parameter|mode}} specifies what kind of primitives are constructed and how the array elements construct those primitives. - -Vertex attributes that are modified by '''_glDrawArrays''' have an unspecified value after '''_glDrawArrays''' returns. Attributes that aren't modified remain well defined. - - -{{PageNotes}} - -{{KW|_GL_LINE_STRIP_ADJACENCY}}, {{KW|_GL_LINES_ADJACENCY}}, {{KW|_GL_TRIANGLE_STRIP_ADJACENCY}} and {{KW|_GL_TRIANGLES_ADJACENCY}} are available only if the GL version is 3.2 or greater. - - -{{PageErrors}} - -{{KW|_GL_INVALID_ENUM}} is generated if {{Parameter|mode}} is not an accepted value. - -{{KW|_GL_INVALID_VALUE}} is generated if {{Parameter|count}} is negative. - -{{KW|_GL_INVALID_OPERATION}} is generated if a non-zero buffer object name is bound to an enabled array and the buffer object's data store is currently mapped. - -{{KW|_GL_INVALID_OPERATION}} is generated if a geometry shader is active and {{Parameter|mode}} is incompatible with the input primitive type of the geometry shader in the currently installed program object. +* OpenGL's documentation is available in several places, so we won't reproduce it here for another time. +* The full description for this command can be found at [https://docs.microsoft.com/en-us/windows/win32/opengl/gldrawarrays Microsoft Docs] and is also valid for QB64 usage. {{PageSeeAlso}} - -[[_GL|SUB _GL]] -{{KW|_glBindVertexArray}}, {{KW|_glDrawArraysIndirect}}, {{KW|_glDrawArraysInstanced}}, {{KW|_glDrawArraysInstancedBaseInstance}}, {{KW|_glMultiDrawArrays}}, {{KW|_glMultiDrawArraysIndirect}} +* [[_GL|SUB _GL]] +* [[_glArrayElement]], [[_glBegin]], [[_glColorPointer]], [[_glEdgeFlagPointer]] +* [[_glEnd]], [[_glGetPointerv]], [[_glGetString]], [[_glIndexPointer]] +* [[_glNormalPointer]], [[_glTexCoordPointer]], [[_glVertexPointer]] -{{PageCopyright}} +{{PageNavigation}} +[[Category:Final]] diff --git a/internal/help/_glDrawBuffer__001000100000.txt b/internal/help/_glDrawBuffer__001000100000.txt index 0e271c2aa..40f50381f 100644 --- a/internal/help/_glDrawBuffer__001000100000.txt +++ b/internal/help/_glDrawBuffer__001000100000.txt @@ -1,64 +1,30 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:19:00}} -'''_glDrawBuffer:''' specify which color buffers are to be drawn into +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:48:16}} +{{DISPLAYTITLE:_glDrawBuffer}} +The '''_glDrawBuffer''' statement specifies which color buffers are to be drawn into. {{PageSyntax}} - -:: SUB _glDrawBuffer (BYVAL mode AS _UNSIGNED LONG) -:: void '''_glDrawBuffer'''(GLenum {{Parameter|mode}}); +: '''_glDrawBuffer''' GLenum {{Parameter|mode}} -; mode -: Specifies up to four color buffers to be drawn into. Symbolic constants {{KW|_GL_NONE}}, {{KW|_GL_FRONT_LEFT}}, {{KW|_GL_FRONT_RIGHT}}, {{KW|_GL_BACK_LEFT}}, {{KW|_GL_BACK_RIGHT}}, {{KW|_GL_FRONT}}, {{KW|_GL_BACK}}, {{KW|_GL_LEFT}}, {{KW|_GL_RIGHT}}, and {{KW|_GL_FRONT_AND_BACK}} are accepted. The initial value is {{KW|_GL_FRONT}} for single-buffered contexts, and {{KW|_GL_BACK}} for double-buffered contexts. +{{PageParameters}} +* OpenGL is using its own set of variable types to describe its command parameters. +* Use the following table to find the respective QB64 [[Variable Types]]. +{{OpenGLTypesPlugin}} {{PageDescription}} - -When colors are written to the frame buffer, they are written into the color buffers specified by '''_glDrawBuffer'''. The specifications are as follows: - -; {{KW|_GL_NONE}} -: No color buffers are written. -; {{KW|_GL_FRONT_LEFT}} -: Only the front left color buffer is written. -; {{KW|_GL_FRONT_RIGHT}} -: Only the front right color buffer is written. -; {{KW|_GL_BACK_LEFT}} -: Only the back left color buffer is written. -; {{KW|_GL_BACK_RIGHT}} -: Only the back right color buffer is written. -; {{KW|_GL_FRONT}} -: Only the front left and front right color buffers are written. If there is no front right color buffer, only the front left color buffer is written. -; {{KW|_GL_BACK}} -: Only the back left and back right color buffers are written. If there is no back right color buffer, only the back left color buffer is written. -; {{KW|_GL_LEFT}} -: Only the front left and back left color buffers are written. If there is no back left color buffer, only the front left color buffer is written. -; {{KW|_GL_RIGHT}} -: Only the front right and back right color buffers are written. If there is no back right color buffer, only the front right color buffer is written. -; {{KW|_GL_FRONT_AND_BACK}} -: All the front and back color buffers (front left, front right, back left, back right) are written. If there are no back color buffers, only the front left and front right color buffers are written. If there are no right color buffers, only the front left and back left color buffers are written. If there are no right or back color buffers, only the front left color buffer is written. -If more than one color buffer is selected for drawing, then blending or logical operations are computed and applied independently for each color buffer and can produce different results in each buffer. - -Monoscopic contexts include only ''left'' buffers, and stereoscopic contexts include both ''left'' and ''right'' buffers. Likewise, single-buffered contexts include only ''front'' buffers, and double-buffered contexts include both ''front'' and ''back'' buffers. The context is selected at GL initialization. - - -{{PageErrors}} - -{{KW|_GL_INVALID_ENUM}} is generated if {{Parameter|mode}} is not an accepted value. - -{{KW|_GL_INVALID_OPERATION}} is generated if none of the buffers indicated by {{Parameter|mode}} exists. - - -{{PageUseWith}} - -{{KW|_glGet}} with argument {{KW|_GL_DRAW_BUFFER}} +* OpenGL's documentation is available in several places, so we won't reproduce it here for another time. +* The full description for this command can be found at [https://docs.microsoft.com/en-us/windows/win32/opengl/gldrawbuffer Microsoft Docs] and is also valid for QB64 usage. {{PageSeeAlso}} - -[[_GL|SUB _GL]] -{{KW|_glBindFramebuffer}}, {{KW|_glBlendFunc}}, {{KW|_glColorMask}}, {{KW|_glDrawBuffers}}, {{KW|_glLogicOp}} +* [[_GL|SUB _GL]] +* [[_glBegin]], [[_glBlendFunc]], [[_glColorMask]], [[_glEnd]] +* [https://docs.microsoft.com/en-us/windows/win32/opengl/glgetbooleanv--glgetdoublev--glgetfloatv--glgetintegerv _glGet], [[_glIndexMask]], [[_glLogicOp]], [[_glReadBuffer]] -{{PageCopyright}} +{{PageNavigation}} +[[Category:Final]] diff --git a/internal/help/_glDrawElements__00100010000000.txt b/internal/help/_glDrawElements__00100010000000.txt index 935139099..18c6752c2 100644 --- a/internal/help/_glDrawElements__00100010000000.txt +++ b/internal/help/_glDrawElements__00100010000000.txt @@ -1,54 +1,31 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:19:01}} -'''_glDrawElements:''' render primitives from array data +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:48:19}} +{{DISPLAYTITLE:_glDrawElements}} +The '''_glDrawElements''' statement renders primitives from array data. {{PageSyntax}} - -: SUB _glDrawElements (BYVAL mode AS _UNSIGNED LONG, BYVAL count AS LONG, BYVAL type AS _UNSIGNED LONG, indices AS _OFFSET) -: void '''_glDrawElements'''(GLenum {{Parameter|mode}}, GLsizei {{Parameter|count}}, GLenum {{Parameter|type}}, const GLvoid * {{Parameter|indices}}); +: '''_glDrawElements''' GLenum {{Parameter|mode}}, GLsizei {{Parameter|count}}, GLenum {{Parameter|type}}, const GLvoid {{Parameter|*indices}} -; mode -: Specifies what kind of primitives to render. Symbolic constants {{KW|_GL_POINTS}}, {{KW|_GL_LINE_STRIP}}, {{KW|_GL_LINE_LOOP}}, {{KW|_GL_LINES}}, {{KW|_GL_LINE_STRIP_ADJACENCY}}, {{KW|_GL_LINES_ADJACENCY}}, {{KW|_GL_TRIANGLE_STRIP}}, {{KW|_GL_TRIANGLE_FAN}}, {{KW|_GL_TRIANGLES}}, {{KW|_GL_TRIANGLE_STRIP_ADJACENCY}}, {{KW|_GL_TRIANGLES_ADJACENCY}} and {{KW|_GL_PATCHES}} are accepted. -; count -: Specifies the number of elements to be rendered. -; type -: Specifies the type of the values in {{Parameter|indices}}. Must be one of {{KW|_GL_UNSIGNED_BYTE}}, {{KW|_GL_UNSIGNED_SHORT}}, or {{KW|_GL_UNSIGNED_INT}}. -; indices -: Specifies a pointer to the location where the indices are stored. +{{PageParameters}} +* OpenGL is using its own set of variable types to describe its command parameters. +* Use the following table to find the respective QB64 [[Variable Types]]. +{{OpenGLTypesPlugin}} {{PageDescription}} - -'''_glDrawElements''' specifies multiple geometric primitives with very few subroutine calls. Instead of calling a GL function to pass each individual vertex, normal, texture coordinate, edge flag, or color, you can prespecify separate arrays of vertices, normals, and so on, and use them to construct a sequence of primitives with a single call to '''_glDrawElements'''. - -When '''_glDrawElements''' is called, it uses {{Parameter|count}} sequential elements from an enabled array, starting at {{Parameter|indices}} (interpreted as a byte count) to construct a sequence of geometric primitives. {{Parameter|mode}} specifies what kind of primitives are constructed and how the array elements construct these primitives. If more than one array is enabled, each is used. - -Vertex attributes that are modified by '''_glDrawElements''' have an unspecified value after '''_glDrawElements''' returns. Attributes that aren't modified maintain their previous values. - - -{{PageNotes}} - -{{KW|_GL_LINE_STRIP_ADJACENCY}}, {{KW|_GL_LINES_ADJACENCY}}, {{KW|_GL_TRIANGLE_STRIP_ADJACENCY}} and {{KW|_GL_TRIANGLES_ADJACENCY}} are available only if the GL version is 3.2 or greater. - - -{{PageErrors}} - -{{KW|_GL_INVALID_ENUM}} is generated if {{Parameter|mode}} is not an accepted value. - -{{KW|_GL_INVALID_VALUE}} is generated if {{Parameter|count}} is negative. - -{{KW|_GL_INVALID_OPERATION}} is generated if a geometry shader is active and {{Parameter|mode}} is incompatible with the input primitive type of the geometry shader in the currently installed program object. - -{{KW|_GL_INVALID_OPERATION}} is generated if a non-zero buffer object name is bound to an enabled array or the element array and the buffer object's data store is currently mapped. +* OpenGL's documentation is available in several places, so we won't reproduce it here for another time. +* The full description for this command can be found at [https://docs.microsoft.com/en-us/windows/win32/opengl/gldrawelements Microsoft Docs] and is also valid for QB64 usage. {{PageSeeAlso}} - -[[_GL|SUB _GL]] -{{KW|_glBindVertexArray}}, {{KW|_glDrawArrays}}, {{KW|_glDrawElementsBaseVertex}}, {{KW|_glDrawElementsIndirect}}, {{KW|_glDrawElementsInstanced}}, {{KW|_glDrawElementsInstancedBaseInstance}}, {{KW|_glDrawElementsInstancedBaseVertex}}, {{KW|_glDrawElementsInstancedBaseVertexBaseInstance}}, {{KW|_glDrawRangeElements}}, {{KW|_glDrawRangeElementsBaseVertex}}, {{KW|_glMultiDrawElements}}, {{KW|_glMultiDrawElementsBaseVertex}}, {{KW|_glMultiDrawElementsIndirect}} +* [[_GL|SUB _GL]] +* [[_glArrayElement]], [[_glBegin]], [[_glColorPointer]], [[_glDrawArrays]] +* [[_glEdgeFlagPointer]], [[_glEnd]], [[_glGetPointerv]], [[_glIndexPointer]] +* [[_glNormalPointer]], [[_glTexCoordPointer]], [[_glVertexPointer]] -{{PageCopyright}} +{{PageNavigation}} +[[Category:Final]] diff --git a/internal/help/_glDrawPixels__001000100000.txt b/internal/help/_glDrawPixels__001000100000.txt new file mode 100644 index 000000000..489aec868 --- /dev/null +++ b/internal/help/_glDrawPixels__001000100000.txt @@ -0,0 +1,32 @@ +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:48:21}} +{{DISPLAYTITLE:_glDrawPixels}} +The '''_glDrawPixels''' statement writes a block of pixels to the framebuffer. + + +{{PageSyntax}} +: '''_glDrawPixels''' GLsizei {{Parameter|width}}, GLsizei {{Parameter|height}}, GLenum {{Parameter|format}}, GLenum {{Parameter|type}}, const GLvoid {{Parameter|*pixels}} + + +{{PageParameters}} +* OpenGL is using its own set of variable types to describe its command parameters. +* Use the following table to find the respective QB64 [[Variable Types]]. +{{OpenGLTypesPlugin}} + + +{{PageDescription}} +* OpenGL's documentation is available in several places, so we won't reproduce it here for another time. +* The full description for this command can be found at [https://docs.microsoft.com/en-us/windows/win32/opengl/gldrawpixels Microsoft Docs] and is also valid for QB64 usage. + + +{{PageSeeAlso}} +* [[_GL|SUB _GL]] +* [[_glAlphaFunc]], [[_glBegin]], [[_glBlendFunc]], [[_glCopyPixels]] +* [[_glDepthFunc]], [[_glEnd]], [https://docs.microsoft.com/en-us/windows/win32/opengl/glgetbooleanv--glgetdoublev--glgetfloatv--glgetintegerv _glGet], [[_glLogicOp]] +* [https://docs.microsoft.com/en-us/windows/win32/opengl/glpixelmap _glPixelMap], [https://docs.microsoft.com/en-us/windows/win32/opengl/glpixelstore-functions _glPixelStore], [https://docs.microsoft.com/en-us/windows/win32/opengl/glpixeltransfer _glPixelTransfer], [[_glPixelZoom]] +* [https://docs.microsoft.com/en-us/windows/win32/opengl/glrasterpos-functions _glRasterPos], [[_glReadPixels]], [[_glScissor]], [[_glStencilFunc]] + + +{{PageNavigation}} + +[[Category:Final]] diff --git a/internal/help/_glEdgeFlagPointer__00100010001000000.txt b/internal/help/_glEdgeFlagPointer__00100010001000000.txt new file mode 100644 index 000000000..cf6628889 --- /dev/null +++ b/internal/help/_glEdgeFlagPointer__00100010001000000.txt @@ -0,0 +1,32 @@ +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:48:28}} +{{DISPLAYTITLE:_glEdgeFlagPointer}} +The '''_glEdgeFlagPointer''' statement defines an array of edge flags. + + +{{PageSyntax}} +: '''_glEdgeFlagPointer''' GLsizei {{Parameter|stride}}, const GLvoid {{Parameter|*pointer}} + + +{{PageParameters}} +* OpenGL is using its own set of variable types to describe its command parameters. +* Use the following table to find the respective QB64 [[Variable Types]]. +{{OpenGLTypesPlugin}} + + +{{PageDescription}} +* OpenGL's documentation is available in several places, so we won't reproduce it here for another time. +* The full description for this command can be found at [https://docs.microsoft.com/en-us/windows/win32/opengl/gledgeflagpointer Microsoft Docs] and is also valid for QB64 usage. + + +{{PageSeeAlso}} +* [[_GL|SUB _GL]] +* [[_glArrayElement]], [[_glBegin]], [[_glColorPointer]], [[_glDrawArrays]] +* [[_glEnableClientState]], [[_glEnd]], [https://docs.microsoft.com/en-us/windows/win32/opengl/glgetbooleanv--glgetdoublev--glgetfloatv--glgetintegerv _glGet], [[_glGetPointerv]] +* [[_glGetString]], [[_glIndexPointer]], [[_glIsEnabled]], [[_glNormalPointer]] +* [[_glPopAttrib]], [[_glPushAttrib]], [[_glTexCoordPointer]], [[_glVertexPointer]] + + +{{PageNavigation}} + +[[Category:Final]] diff --git a/internal/help/_glEdgeFlag__0010001000.txt b/internal/help/_glEdgeFlag__0010001000.txt new file mode 100644 index 000000000..4a1df4768 --- /dev/null +++ b/internal/help/_glEdgeFlag__0010001000.txt @@ -0,0 +1,28 @@ +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:48:23}} +{{DISPLAYTITLE:_glEdgeFlag}} +The '''_glEdgeFlag''' statement flags edges as either boundary or nonboundary. + + +{{PageSyntax}} +: '''_glEdgeFlag''' GLboolean {{Parameter|flag}} + + +{{PageParameters}} +* OpenGL is using its own set of variable types to describe its command parameters. +* Use the following table to find the respective QB64 [[Variable Types]]. +{{OpenGLTypesPlugin}} + + +{{PageDescription}} +* OpenGL's documentation is available in several places, so we won't reproduce it here for another time. +* The full description for this command can be found at [https://docs.microsoft.com/en-us/windows/win32/opengl/gledgeflag Microsoft Docs] and is also valid for QB64 usage. + + +{{PageSeeAlso}} +* [[_GL|SUB _GL]] + + +{{PageNavigation}} + +[[Category:Final]] diff --git a/internal/help/_glEdgeFlagv__00100010000.txt b/internal/help/_glEdgeFlagv__00100010000.txt new file mode 100644 index 000000000..d7f75bd5c --- /dev/null +++ b/internal/help/_glEdgeFlagv__00100010000.txt @@ -0,0 +1,28 @@ +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:48:26}} +{{DISPLAYTITLE:_glEdgeFlagv}} +The '''_glEdgeFlagv''' statement flags edges as either boundary or nonboundary. + + +{{PageSyntax}} +: '''_glEdgeFlagv''' const GLboolean {{Parameter|*flag}} + + +{{PageParameters}} +* OpenGL is using its own set of variable types to describe its command parameters. +* Use the following table to find the respective QB64 [[Variable Types]]. +{{OpenGLTypesPlugin}} + + +{{PageDescription}} +* OpenGL's documentation is available in several places, so we won't reproduce it here for another time. +* The full description for this command can be found at [https://docs.microsoft.com/en-us/windows/win32/opengl/gledgeflagv Microsoft Docs] and is also valid for QB64 usage. + + +{{PageSeeAlso}} +* [[_GL|SUB _GL]] + + +{{PageNavigation}} + +[[Category:Final]] diff --git a/internal/help/_glEnableClientState__0010000010000010000.txt b/internal/help/_glEnableClientState__0010000010000010000.txt new file mode 100644 index 000000000..ad13a8c35 --- /dev/null +++ b/internal/help/_glEnableClientState__0010000010000010000.txt @@ -0,0 +1,32 @@ +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:48:32}} +{{DISPLAYTITLE:_glEnableClientState}} +The '''_glEnableClientState''' and '''_glDisableClientState''' statements enable and disable arrays respectively. + + +{{PageSyntax}} +: '''_glEnableClientState''' GLenum {{Parameter|array}} + + +{{PageParameters}} +* OpenGL is using its own set of variable types to describe its command parameters. +* Use the following table to find the respective QB64 [[Variable Types]]. +{{OpenGLTypesPlugin}} + + +{{PageDescription}} +* OpenGL's documentation is available in several places, so we won't reproduce it here for another time. +* The full description for this command can be found at [https://docs.microsoft.com/en-us/windows/win32/opengl/glenableclientstate Microsoft Docs] and is also valid for QB64 usage. + + +{{PageSeeAlso}} +* [[_GL|SUB _GL]] +* [[_glArrayElement]], [[_glBegin]], [[_glColorPointer]], [[_glDisableClientState]] +* [[_glDrawArrays]], [[_glDrawElements]], [[_glEdgeFlagPointer]], [[_glEnable]] +* [[_glEnd]], [[_glGetPointerv]], [[_glIndexPointer]], [[_glInterleavedArrays]] +* [[_glNormalPointer]], [[_glTexCoordPointer]], [[_glVertexPointer]] + + +{{PageNavigation}} + +[[Category:Final]] diff --git a/internal/help/_glEnable__00100000.txt b/internal/help/_glEnable__00100000.txt index b24c9f8ce..ba8aa4fd3 100644 --- a/internal/help/_glEnable__00100000.txt +++ b/internal/help/_glEnable__00100000.txt @@ -1,143 +1,39 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:19:08}} -'''_glEnable:''' enable or disable server-side GL capabilities +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:48:30}} +{{DISPLAYTITLE:_glEnable}} +The '''_glEnable''' and '''_glDisable''' statements enable or disable OpenGL capabilities. {{PageSyntax}} - - SUB _glEnable (BYVAL cap AS _UNSIGNED LONG) - void '''_glEnable'''(GLenum {{Parameter|cap}}); - - SUB _glDisable (BYVAL cap AS _UNSIGNED LONG) - void '''_glDisable'''(GLenum {{Parameter|cap}}); +: '''_glEnable''' GLenum {{Parameter|cap}} -; cap -: Specifies a symbolic constant indicating a GL capability. - - -{{PageSyntax}} - -| name = glEnablei, glDisablei -| core = 3.0 -}} - - void '''_glEnablei'''(GLenum {{Parameter|cap}}, GLuint {{Parameter|index}}); - void '''_glDisablei'''(GLenum {{Parameter|cap}}, GLuint {{Parameter|index}}); - -; cap -: Specifies a symbolic constant indicating a GL capability. -; index -: Specifies the index of the capability to enable/disable. +{{PageParameters}} +* OpenGL is using its own set of variable types to describe its command parameters. +* Use the following table to find the respective QB64 [[Variable Types]]. +{{OpenGLTypesPlugin}} {{PageDescription}} - -'''_glEnable''' and {{KW|_glDisable}} enable and disable various capabilities. Use {{KW|_glIsEnabled}} or {{KW|_glGet}} to determine the current setting of any capability. The initial value for each capability with the exception of {{KW|_GL_DITHER}} and {{KW|_GL_MULTISAMPLE}} is {{KW|_GL_FALSE}}. The initial value for {{KW|_GL_DITHER}} and {{KW|_GL_MULTISAMPLE}} is {{KW|_GL_TRUE}}. - -Both '''_glEnable''' and {{KW|_glDisable}} take a single argument, {{Parameter|cap}}, which can assume one of the following values: - -; {{KW|_GL_BLEND}} -: If enabled, blend the computed fragment color values with the values in the color buffers. See [[GLAPI/glBlendFunc|glBlendFunc]]. Sets the blend enable/disable flag for all color buffers. -; {{KW|_GL_CLIP_DISTANCE}}''i'' -: If enabled, clip geometry against user-defined half space ''i''. -; {{KW|_GL_COLOR_LOGIC_OP}} -: If enabled, apply the currently selected logical operation to the computed fragment color and color buffer values. See [[GLAPI/glLogicOp|glLogicOp]]. -; {{KW|_GL_CULL_FACE}} -: If enabled, cull polygons based on their winding in window coordinates. See [[GLAPI/glCullFace|glCullFace]]. -; {{KW|_GL_DEBUG_OUTPUT}} -: If enabled, debug messages are produced by a debug context. When disabled, the debug message log is silenced. Note that in a non-debug context, very few, if any messages might be produced, even when {{KW|_GL_DEBUG_OUTPUT}} is enabled. -; {{KW|_GL_DEBUG_OUTPUT_SYNCHRONOUS}} -: If enabled, debug messages are produced synchronously by a debug context. If disabled, debug messages may be produced asynchronously. In particular, they may be delayed relative to the execution of GL commands, and the debug callback function may be called from a thread other than that in which the commands are executed. See {{KW|_glDebugMessageCallback}}. -; {{KW|_GL_DEPTH_CLAMP}} -: If enabled, the -wc <= zc <= wc plane equation is ignored by view volume clipping (effectively, there is no near or far plane clipping). See [[GLAPI/glDepthRange|glDepthRange]]. -; {{KW|_GL_DEPTH_TEST}} -: If enabled, do depth comparisons and update the depth buffer. Note that even if the depth buffer exists and the depth mask is non-zero, the depth buffer is not updated if the depth test is disabled. See [[GLAPI/glDepthFunc|glDepthFunc]] and [[GLAPI/glDepthRange|glDepthRange]]. -; {{KW|_GL_DITHER}} -: If enabled, dither color components or indices before they are written to the color buffer. -; {{KW|_GL_FRAMEBUFFER_SRGB}} -: If enabled and the value of {{KW|_GL_FRAMEBUFFER_ATTACHMENT_COLOR_ENCODING}} for the framebuffer attachment corresponding to the destination buffer is {{KW|_GL_SRGB}}, the R, G, and B destination color values (after conversion from fixed-point to floating-point) are considered to be encoded for the sRGB color space and hence are linearized prior to their use in blending. -; {{KW|_GL_LINE_SMOOTH}} -: If enabled, draw lines with correct filtering. Otherwise, draw aliased lines. See [[GLAPI/glLineWidth|glLineWidth]]. -; {{KW|_GL_MULTISAMPLE}} -: If enabled, use multiple fragment samples in computing the final color of a pixel. See [[GLAPI/glSampleCoverage|glSampleCoverage]]. -; {{KW|_GL_POLYGON_OFFSET_FILL}} -: If enabled, and if the polygon is rendered in {{KW|_GL_FILL}} mode, an offset is added to depth values of a polygon's fragments before the depth comparison is performed. See [[GLAPI/glPolygonOffset|glPolygonOffset]]. -; {{KW|_GL_POLYGON_OFFSET_LINE}} -: If enabled, and if the polygon is rendered in {{KW|_GL_LINE}} mode, an offset is added to depth values of a polygon's fragments before the depth comparison is performed. See [[GLAPI/glPolygonOffset|glPolygonOffset]]. -; {{KW|_GL_POLYGON_OFFSET_POINT}} -: If enabled, an offset is added to depth values of a polygon's fragments before the depth comparison is performed, if the polygon is rendered in {{KW|_GL_POINT}} mode. See [[GLAPI/glPolygonOffset|glPolygonOffset]]. -; {{KW|_GL_POLYGON_SMOOTH}} -: If enabled, draw polygons with proper filtering. Otherwise, draw aliased polygons. For correct antialiased polygons, an alpha buffer is needed and the polygons must be sorted front to back. -; {{KW|_GL_PRIMITIVE_RESTART}} -: Enables primitive restarting. If enabled, any one of the draw commands which transfers a set of generic attribute array elements to the GL will restart the primitive when the index of the vertex is equal to the primitive restart index. See {{KW|_glPrimitiveRestartIndex}}. -; {{KW|_GL_PRIMITIVE_RESTART_FIXED_INDEX}} -: Enables primitive restarting with a fixed index. If enabled, any one of the draw commands which transfers a set of generic attribute array elements to the GL will restart the primitive when the index of the vertex is equal to the fixed primitive index for the specified index type. The fixed index is equal to 2^n - 1 where ''n'' is equal to 8 for {{KW|_GL_UNSIGNED_BYTE}}, 16 for {{KW|_GL_UNSIGNED_SHORT}} and 32 for {{KW|_GL_UNSIGNED_INT}}. -; {{KW|_GL_RASTERIZER_DISCARD}} -: If enabled, all primitives are discarded before rasterization, but ''after'' any optional transform feedback. Also causes {{KW|_glClear}} and {{KW|_glClearBuffer}} commands to be ignored. -; {{KW|_GL_SAMPLE_ALPHA_TO_COVERAGE}} -: If enabled, compute a temporary coverage value where each bit is determined by the alpha value at the corresponding sample location. The temporary coverage value is then ANDed with the fragment coverage value. -; {{KW|_GL_SAMPLE_ALPHA_TO_ONE}} -: If enabled, each sample alpha value is replaced by the maximum representable alpha value. -; {{KW|_GL_SAMPLE_COVERAGE}} -: If enabled, the fragment's coverage is ANDed with the temporary coverage value. If {{KW|_GL_SAMPLE_COVERAGE_INVERT}} is set to {{KW|_GL_TRUE}}, invert the coverage value. See [[GLAPI/glSampleCoverage|glSampleCoverage]]. -; {{KW|_GL_SAMPLE_SHADING}} -: If enabled, the active fragment shader is run once for each covered sample, or at fraction of this rate as determined by the current value of {{KW|_GL_MIN_SAMPLE_SHADING_VALUE}}. See [[GLAPI/glMinSampleShading|glMinSampleShading]]. -; {{KW|_GL_SAMPLE_MASK}} -: If enabled, the sample coverage mask generated for a fragment during rasterization will be ANDed with the value of {{KW|_GL_SAMPLE_MASK_VALUE}} before shading occurs. See [[GLAPI/glSampleMaski|glSampleMaski]]. -; {{KW|_GL_SCISSOR_TEST}} -: If enabled, discard fragments that are outside the scissor rectangle. See [[GLAPI/glScissor|glScissor]]. -; {{KW|_GL_STENCIL_TEST}} -: If enabled, do stencil testing and update the stencil buffer. See [[GLAPI/glStencilFunc|glStencilFunc]] and [[GLAPI/glStencilOp|glStencilOp]]. -; {{KW|_GL_TEXTURE_CUBE_MAP_SEAMLESS}} -: If enabled, cubemap textures are sampled such that when linearly sampling from the border between two adjacent faces, texels from both faces are used to generate the final sample value. When disabled, texels from only a single face are used to construct the final sample value. -; {{KW|_GL_PROGRAM_POINT_SIZE}} -: If enabled and a vertex or geometry shader is active, then the derived point size is taken from the (potentially clipped) shader builtin {{code|gl_PointSize}} and clamped to the implementation-dependent point size range. - -=== Indexed Capabilities === - -Some of the GL's capabilities are indexed. '''_glEnablei''' and '''_glDisablei''' enable and disable indexed capabilities. Only the following capabilities may be used with indices higher than zero: - -; {{KW|_GL_BLEND}} -: If enabled, blend the computed fragment color values with the values in the specified color buffer. {{Parameter|index}} must be less than {{KW|_GL_MAX_DRAW_BUFFERS}} or {{KW|_GL_INVALID_VALUE}} will result. See [[GLAPI/glBlendFunc|glBlendFunc]]. - - -{{PageErrors}} - -{{KW|_GL_INVALID_ENUM}} is generated if {{Parameter|cap}} is not one of the values listed previously. - -{{KW|_GL_INVALID_VALUE}} is generated by '''_glEnablei''' and '''_glDisablei''' if {{Parameter|index}} is greater than or equal to the number of indexed capabilities for {{Parameter|cap}}. - - -{{PageNotes}} - -{{KW|_GL_PRIMITIVE_RESTART}} is available only if the GL version is 3.1 or greater. - -{{KW|_GL_TEXTURE_CUBE_MAP_SEAMLESS}} is available only if the GL version is 3.2 or greater. - -{{KW|_GL_PRIMITIVE_RESTART_FIXED_INDEX}} is available only if the GL version is 4.3 or greater. - -{{KW|_GL_DEBUG_OUTPUT}} and {{KW|_GL_DEBUG_OUTPUT_SYNCHRONOUS}} are available only if the GL version is 4.3 or greater. - -Any token accepted by '''_glEnable''' or '''_glDisable''' is also accepted by '''_glEnablei''' and '''_glDisablei''', but if the capability is not indexed, the maximum value that {{Parameter|index}} may take is zero. - -In general, passing an indexed capability to '''_glEnable''' or '''_glDisable''' will enable or disable that capability for all indices, resepectively. - - -{{PageUseWith}} - -{{KW|_glIsEnabled}} - -{{KW|_glGet}} +* OpenGL's documentation is available in several places, so we won't reproduce it here for another time. +* The full description for this command can be found at [https://docs.microsoft.com/en-us/windows/win32/opengl/glenable Microsoft Docs] and is also valid for QB64 usage. {{PageSeeAlso}} - -[[_GL|SUB _GL]] -{{KW|_glActiveTexture}}, {{KW|_glBlendFunc}}, {{KW|_glCullFace}}, {{KW|_glDepthFunc}}, {{KW|_glDepthRange}}, {{KW|_glGet}}, {{KW|_glIsEnabled}}, {{KW|_glLineWidth}}, {{KW|_glLogicOp}}, {{KW|_glPointSize}}, {{KW|_glPolygonMode}}, {{KW|_glPolygonOffset}}, {{KW|_glSampleCoverage}}, {{KW|_glScissor}}, {{KW|_glStencilFunc}}, {{KW|_glStencilOp}}, {{KW|_glTexImage1D}}, {{KW|_glTexImage2D}}, {{KW|_glTexImage3D}} +* [[_GL|SUB _GL]] +* [[_glAlphaFunc]], [[_glArrayElement]], [[_glBegin]], [[_glBlendFunc]] +* [[_glClipPlane]], [[_glColorMaterial]], [[_glColorPointer]], [[_glCullFace]] +* [[_glDepthFunc]], [[_glDepthRange]], [[_glDisable]], [[_glDrawArrays]] +* [[_glEdgeFlagPointer]], [[_glEnd]], [https://docs.microsoft.com/en-us/windows/win32/opengl/glevalcoord-functions _glEvalCoord], [https://docs.microsoft.com/en-us/windows/win32/opengl/glevalmesh-functions _glEvalMesh] +* [https://docs.microsoft.com/en-us/windows/win32/opengl/glevalpoint _glEvalPoint], [https://docs.microsoft.com/en-us/windows/win32/opengl/glfog _glFog], [https://docs.microsoft.com/en-us/windows/win32/opengl/glgetbooleanv--glgetdoublev--glgetfloatv--glgetintegerv _glGet], [[_glIndexPointer]] +* [[_glIsEnabled]], [https://docs.microsoft.com/en-us/windows/win32/opengl/gllight-functions _glLight], [https://docs.microsoft.com/en-us/windows/win32/opengl/gllightmodel-functions _glLightModel], [[_glLineWidth]] +* [[_glLineStipple]], [[_glLogicOp]], [https://docs.microsoft.com/en-us/windows/win32/opengl/glmap1 _glMap1], [https://docs.microsoft.com/en-us/windows/win32/opengl/glmap2 _glMap2] +* [https://docs.microsoft.com/en-us/windows/win32/opengl/glmaterial-functions _glMaterial], [https://docs.microsoft.com/en-us/windows/win32/opengl/glnormal-functions _glNormal], [[_glNormalPointer]], [[_glPointSize]] +* [[_glPolygonMode]], [[_glPolygonStipple]], [[_glScissor]], [[_glStencilFunc]] +* [[_glStencilOp]], [[_glTexCoordPointer]], [https://docs.microsoft.com/en-us/windows/win32/opengl/gltexgen-functions _glTexGen], [[_glTexImage1D]] +* [[_glTexImage2D]] -{{PageCopyright}} - -Copyright 1991-2006 Silicon Graphics, Inc. Copyright 2010-2011 Khronos Group. This document is licensed under the SGI Free Software B License. For details, see [http://oss.sgi.com/projects/FreeB/ http://oss.sgi.com/projects/FreeB/]. +{{PageNavigation}} +[[Category:Final]] diff --git a/internal/help/_glEndList__001001000.txt b/internal/help/_glEndList__001001000.txt new file mode 100644 index 000000000..a13351ba7 --- /dev/null +++ b/internal/help/_glEndList__001001000.txt @@ -0,0 +1,24 @@ +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:48:36}} +{{DISPLAYTITLE:_glEndList}} +The '''_glNewList''' and '''_glEndList''' statements create or replace a display list. + + +{{PageSyntax}} +: '''_glEndList''' + + +{{PageDescription}} +* OpenGL's documentation is available in several places, so we won't reproduce it here for another time. +* The full description for this command can be found at [https://docs.microsoft.com/en-us/windows/win32/opengl/glendlist Microsoft Docs] and is also valid for QB64 usage. + + +{{PageSeeAlso}} +* [[_GL|SUB _GL]] +* [[_glBegin]], [[_glCallList]], [[_glCallLists]], [[_glDeleteLists]] +* [[_glEnd]], [[_glGenLists]], [[_glIsList]], [[_glNewList]] + + +{{PageNavigation}} + +[[Category:Final]] diff --git a/internal/help/_glEnd__00100.txt b/internal/help/_glEnd__00100.txt new file mode 100644 index 000000000..2f4493ca4 --- /dev/null +++ b/internal/help/_glEnd__00100.txt @@ -0,0 +1,25 @@ +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:48:35}} +{{DISPLAYTITLE:_glEnd}} +The '''_glBegin''' and '''_glEnd''' statements delimit the vertices of a primitive or a group of like primitives. + + +{{PageSyntax}} +: '''_glEnd''' + + +{{PageDescription}} +* OpenGL's documentation is available in several places, so we won't reproduce it here for another time. +* The full description for this command can be found at [https://docs.microsoft.com/en-us/windows/win32/opengl/glend Microsoft Docs] and is also valid for QB64 usage. + + +{{PageSeeAlso}} +* [[_GL|SUB _GL]] +* [[_glBegin]], [[_glCallLists]], [https://docs.microsoft.com/en-us/windows/win32/opengl/glcolor-functions _glColor], [https://docs.microsoft.com/en-us/windows/win32/opengl/gledgeflag-functions _glEdgeFlag] +* [https://docs.microsoft.com/en-us/windows/win32/opengl/glevalcoord-functions _glEvalCoord], [https://docs.microsoft.com/en-us/windows/win32/opengl/glevalpoint _glEvalPoint], [https://docs.microsoft.com/en-us/windows/win32/opengl/glindex-functions _glIndex], [https://docs.microsoft.com/en-us/windows/win32/opengl/glmaterial-functions _glMaterial] +* [https://docs.microsoft.com/en-us/windows/win32/opengl/glnormal-functions _glNormal], [https://docs.microsoft.com/en-us/windows/win32/opengl/gltexcoord-functions _glTexCoord], [https://docs.microsoft.com/en-us/windows/win32/opengl/glvertex-functions _glVertex] + + +{{PageNavigation}} + +[[Category:Final]] diff --git a/internal/help/_glFeedbackBuffer__0010000000100000.txt b/internal/help/_glFeedbackBuffer__0010000000100000.txt new file mode 100644 index 000000000..dc9d2502c --- /dev/null +++ b/internal/help/_glFeedbackBuffer__0010000000100000.txt @@ -0,0 +1,30 @@ +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:48:50}} +{{DISPLAYTITLE:_glFeedbackBuffer}} +The '''_glFeedbackBuffer''' statement controls feedback mode. + + +{{PageSyntax}} +: '''_glFeedbackBuffer''' GLsizei {{Parameter|size}}, GLenum {{Parameter|type}}, GLfloat {{Parameter|*buffer}} + + +{{PageParameters}} +* OpenGL is using its own set of variable types to describe its command parameters. +* Use the following table to find the respective QB64 [[Variable Types]]. +{{OpenGLTypesPlugin}} + + +{{PageDescription}} +* OpenGL's documentation is available in several places, so we won't reproduce it here for another time. +* The full description for this command can be found at [https://docs.microsoft.com/en-us/windows/win32/opengl/glfeedbackbuffer Microsoft Docs] and is also valid for QB64 usage. + + +{{PageSeeAlso}} +* [[_GL|SUB _GL]] +* [[_glBegin]], [[_glEnd]], [https://docs.microsoft.com/en-us/windows/win32/opengl/glgetbooleanv--glgetdoublev--glgetfloatv--glgetintegerv _glGet], [[_glLineStipple]] +* [[_glPassThrough]], [[_glPolygonMode]], [[_glRenderMode]], [[_glSelectBuffer]] + + +{{PageNavigation}} + +[[Category:Final]] diff --git a/internal/help/_glFinish__00100000.txt b/internal/help/_glFinish__00100000.txt index f65e0630b..ddd2879c6 100644 --- a/internal/help/_glFinish__00100000.txt +++ b/internal/help/_glFinish__00100000.txt @@ -1,32 +1,23 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:19:29}} -'''_glFinish:''' block until all GL execution is complete +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:48:52}} +{{DISPLAYTITLE:_glFinish}} +The '''_glFinish''' statement blocks until all OpenGL execution is complete. {{PageSyntax}} - - SUB _glFinish - void '''_glFinish'''({{Parameter|void}}); - +: '''_glFinish''' {{PageDescription}} - -'''_glFinish''' does not return until the effects of all previously called GL commands are complete. Such effects include all changes to GL state, all changes to connection state, and all changes to the frame buffer contents. - - -{{PageNotes}} - -'''_glFinish''' requires a round trip to the server. +* OpenGL's documentation is available in several places, so we won't reproduce it here for another time. +* The full description for this command can be found at [https://docs.microsoft.com/en-us/windows/win32/opengl/glfinish Microsoft Docs] and is also valid for QB64 usage. {{PageSeeAlso}} - -[[_GL|SUB _GL]] -{{KW|_glFlush}}, {{KW|_glFenceSync}}, {{KW|_glWaitSync}}, {{KW|_glClientWaitSync}} +* [[_GL|SUB _GL]] +* [[_glBegin]], [[_glEnd]], [[_glFlush]] -{{PageCopyright}} - -Copyright 1991-2006 Silicon Graphics, Inc. This document is licensed under the SGI Free Software B License. For details, see [http://oss.sgi.com/projects/FreeB/ http://oss.sgi.com/projects/FreeB/]. +{{PageNavigation}} +[[Category:Final]] diff --git a/internal/help/_glFlush__0010000.txt b/internal/help/_glFlush__0010000.txt index 2432c8338..35abb8033 100644 --- a/internal/help/_glFlush__0010000.txt +++ b/internal/help/_glFlush__0010000.txt @@ -1,34 +1,23 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:19:30}} -'''_glFlush:''' force execution of GL commands in finite time +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:48:53}} +{{DISPLAYTITLE:_glFlush}} +The '''_glFlush''' statement forces execution of OpenGL functions in finite time. {{PageSyntax}} - - SUB _glFlush - void '''_glFlush'''({{Parameter|void}}); - +: '''_glFlush''' {{PageDescription}} - -Different GL implementations buffer commands in several different locations, including network buffers and the graphics accelerator itself. '''_glFlush''' empties all of these buffers, causing all issued commands to be executed as quickly as they are accepted by the actual rendering engine. Though this execution may not be completed in any particular time period, it does complete in finite time. - -Because any GL program might be executed over a network, or on an accelerator that buffers commands, all programs should call '''_glFlush''' whenever they count on having all of their previously issued commands completed. For example, call '''_glFlush''' before waiting for user input that depends on the generated image. - - -{{PageNotes}} - -'''_glFlush''' can return at any time. It does not wait until the execution of all previously issued GL commands is complete. +* OpenGL's documentation is available in several places, so we won't reproduce it here for another time. +* The full description for this command can be found at [https://docs.microsoft.com/en-us/windows/win32/opengl/glflush Microsoft Docs] and is also valid for QB64 usage. {{PageSeeAlso}} - -[[_GL|SUB _GL]] -{{KW|_glFinish}} +* [[_GL|SUB _GL]] +* [[_glBegin]], [[_glEnd]], [[_glFinish]] -{{PageCopyright}} - -Copyright 1991-2006 Silicon Graphics, Inc. This document is licensed under the SGI Free Software B License. For details, see [http://oss.sgi.com/projects/FreeB/ http://oss.sgi.com/projects/FreeB/]. +{{PageNavigation}} +[[Category:Final]] diff --git a/internal/help/_glFrontFace__00100001000.txt b/internal/help/_glFrontFace__00100001000.txt index 4ce9c35d8..1c70d8dab 100644 --- a/internal/help/_glFrontFace__00100001000.txt +++ b/internal/help/_glFrontFace__00100001000.txt @@ -1,42 +1,30 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:19:37}} -'''_glFrontFace:''' define front- and back-facing polygons +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:48:59}} +{{DISPLAYTITLE:_glFrontFace}} +The '''_glFrontFace''' statement defines front-facing and back-facing polygons. {{PageSyntax}} - - SUB _glFrontFace (BYVAL mode AS _UNSIGNED LONG) - void '''_glFrontFace'''(GLenum {{Parameter|mode}}); +: '''_glFrontFace''' GLenum {{Parameter|mode}} -; mode -: Specifies the orientation of front-facing polygons. {{KW|_GL_CW}} and {{KW|_GL_CCW}} are accepted. The initial value is {{KW|_GL_CCW}}. +{{PageParameters}} +* OpenGL is using its own set of variable types to describe its command parameters. +* Use the following table to find the respective QB64 [[Variable Types]]. +{{OpenGLTypesPlugin}} {{PageDescription}} - -In a scene composed entirely of opaque closed surfaces, back-facing polygons are never visible. Eliminating these invisible polygons has the obvious benefit of speeding up the rendering of the image. To enable and disable elimination of back-facing polygons, call {{KW|_glEnable}} and {{KW|_glDisable}} with argument {{KW|_GL_CULL_FACE}}. - -The projection of a polygon to window coordinates is said to have clockwise winding if an imaginary object following the path from its first vertex, its second vertex, and so on, to its last vertex, and finally back to its first vertex, moves in a clockwise direction about the interior of the polygon. The polygon's winding is said to be counterclockwise if the imaginary object following the same path moves in a counterclockwise direction about the interior of the polygon. '''_glFrontFace''' specifies whether polygons with clockwise winding in window coordinates, or counterclockwise winding in window coordinates, are taken to be front-facing. Passing {{KW|_GL_CCW}} to {{Parameter|mode}} selects counterclockwise polygons as front-facing; {{KW|_GL_CW}} selects clockwise polygons as front-facing. By default, counterclockwise polygons are taken to be front-facing. - - -{{PageErrors}} - -{{KW|_GL_INVALID_ENUM}} is generated if {{Parameter|mode}} is not an accepted value. - - -{{PageUseWith}} - -{{KW|_glGet}} with argument {{KW|_GL_FRONT_FACE}} +* OpenGL's documentation is available in several places, so we won't reproduce it here for another time. +* The full description for this command can be found at [https://docs.microsoft.com/en-us/windows/win32/opengl/glfrontface Microsoft Docs] and is also valid for QB64 usage. {{PageSeeAlso}} - -[[_GL|SUB _GL]] -{{KW|_glCullFace}} +* [[_GL|SUB _GL]] +* [[_glBegin]], [[_glCullFace]], [[_glDisable]], [[_glEnable]] +* [[_glEnd]], [https://docs.microsoft.com/en-us/windows/win32/opengl/glgetbooleanv--glgetdoublev--glgetfloatv--glgetintegerv _glGet], [https://docs.microsoft.com/en-us/windows/win32/opengl/gllightmodel-functions _glLightModel] -{{PageCopyright}} - -Copyright 1991-2006 Silicon Graphics, Inc. This document is licensed under the SGI Free Software B License. For details, see [http://oss.sgi.com/projects/FreeB/ http://oss.sgi.com/projects/FreeB/]. +{{PageNavigation}} +[[Category:Final]] diff --git a/internal/help/_glFrustum__001000000.txt b/internal/help/_glFrustum__001000000.txt new file mode 100644 index 000000000..048a85b5e --- /dev/null +++ b/internal/help/_glFrustum__001000000.txt @@ -0,0 +1,31 @@ +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:49:01}} +{{DISPLAYTITLE:_glFrustum}} +The '''_glFrustum''' statement multiplies the current matrix by a perspective matrix. + + +{{PageSyntax}} +: '''_glFrustum''' GLdouble {{Parameter|left}}, GLdouble {{Parameter|right}}, GLdouble {{Parameter|bottom}}, GLdouble {{Parameter|top}}, GLdouble {{Parameter|zNear}}, GLdouble {{Parameter|zFar}} + + +{{PageParameters}} +* OpenGL is using its own set of variable types to describe its command parameters. +* Use the following table to find the respective QB64 [[Variable Types]]. +{{OpenGLTypesPlugin}} + + +{{PageDescription}} +* OpenGL's documentation is available in several places, so we won't reproduce it here for another time. +* The full description for this command can be found at [https://docs.microsoft.com/en-us/windows/win32/opengl/glfrustum Microsoft Docs] and is also valid for QB64 usage. + + +{{PageSeeAlso}} +* [[_GL|SUB _GL]] +* [[_glBegin]], [[_glEnd]], [https://docs.microsoft.com/en-us/windows/win32/opengl/glgetbooleanv--glgetdoublev--glgetfloatv--glgetintegerv _glGet], [[_glMatrixMode]] +* [https://docs.microsoft.com/en-us/windows/win32/opengl/glmultmatrix _glMultMatrix], [[_glOrtho]], [[_glPopMatrix]], [[_glPushMatrix]] +* [[_glViewport]] + + +{{PageNavigation}} + +[[Category:Final]] diff --git a/internal/help/_glGenTextures__0010010000000.txt b/internal/help/_glGenTextures__0010010000000.txt index 84f8b07c1..23d366a2a 100644 --- a/internal/help/_glGenTextures__0010010000000.txt +++ b/internal/help/_glGenTextures__0010010000000.txt @@ -1,46 +1,31 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:19:41}} -'''_glGenTextures:''' generate texture names +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:49:04}} +{{DISPLAYTITLE:_glGenTextures}} +The '''_glGenTextures''' statement generates texture names. {{PageSyntax}} - - SUB _glGenTextures (BYVAL n AS LONG, textures AS _UNSIGNED LONG) - void '''_glGenTextures'''(GLsizei {{Parameter|n}}, GLuint * {{Parameter|textures}}); +: '''_glGenTextures''' GLsizei {{Parameter|n}}, GLuint {{Parameter|*textures}} -; n -: Specifies the number of texture names to be generated. -; textures -: Specifies an array in which the generated texture names are stored. +{{PageParameters}} +* OpenGL is using its own set of variable types to describe its command parameters. +* Use the following table to find the respective QB64 [[Variable Types]]. +{{OpenGLTypesPlugin}} {{PageDescription}} - -'''_glGenTextures''' returns {{Parameter|n}} texture names in {{Parameter|textures}}. There is no guarantee that the names form a contiguous set of integers; however, it is guaranteed that none of the returned names was in use immediately before the call to '''_glGenTextures'''. - -The generated textures have no dimensionality; they assume the dimensionality of the texture target to which they are first bound (see {{KW|_glBindTexture}}). - -Texture names returned by a call to '''_glGenTextures''' are not returned by subsequent calls, unless they are first deleted with {{KW|_glDeleteTextures}}. - - -{{PageErrors}} - -{{KW|_GL_INVALID_VALUE}} is generated if {{Parameter|n}} is negative. - - -{{PageUseWith}} - -{{KW|_glIsTexture}} +* OpenGL's documentation is available in several places, so we won't reproduce it here for another time. +* The full description for this command can be found at [https://docs.microsoft.com/en-us/windows/win32/opengl/glgentextures Microsoft Docs] and is also valid for QB64 usage. {{PageSeeAlso}} - -[[_GL|SUB _GL]] -{{KW|_glBindTexture}}, {{KW|_glDeleteTextures}}, {{KW|_glIsTexture}} +* [[_GL|SUB _GL]] +* [[_glBegin]], [[_glBindTexture]], [[_glDeleteTextures]], [[_glEnd]] +* [https://docs.microsoft.com/en-us/windows/win32/opengl/glgetbooleanv--glgetdoublev--glgetfloatv--glgetintegerv _glGet], [https://docs.microsoft.com/en-us/windows/win32/opengl/glgettexparameter _glGetTexParameter], [[_glIsTexture]], [[_glTexImage1D]] +* [[_glTexImage2D]], [https://docs.microsoft.com/en-us/windows/win32/opengl/gltexparameter-functions _glTexParameter] -{{PageCopyright}} - -Copyright 1991-2006 Silicon Graphics, Inc. This document is licensed under the SGI Free Software B License. For details, see [http://oss.sgi.com/projects/FreeB/ http://oss.sgi.com/projects/FreeB/]. +{{PageNavigation}} +[[Category:Final]] diff --git a/internal/help/_glGetError__0010010000.txt b/internal/help/_glGetError__0010010000.txt index 28d28973a..b750cfbf4 100644 --- a/internal/help/_glGetError__0010010000.txt +++ b/internal/help/_glGetError__0010010000.txt @@ -1,45 +1,29 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:19:46}} -'''_glGetError:''' return error information +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:49:10}} +{{DISPLAYTITLE:_glGetError}} +The '''_glGetError''' function returns error information. {{PageSyntax}} +: GLenum {{Parameter|result}} = '''_glGetError''' - FUNCTION _glGetError~& - GLenum '''_glGetError'''({{Parameter|void}}); +{{PageParameters}} +* OpenGL is using its own set of variable types to describe its command parameters. +* Use the following table to find the respective QB64 [[Variable Types]]. +{{OpenGLTypesPlugin}} {{PageDescription}} - -'''_glGetError''' returns the value of the error flag. Each detectable error is assigned a numeric code and symbolic name. When an error occurs, the error flag is set to the appropriate error code value. No other errors are recorded until '''_glGetError''' is called, the error code is returned, and the flag is reset to {{KW|_GL_NO_ERROR}}. If a call to '''_glGetError''' returns {{KW|_GL_NO_ERROR}}, there has been no detectable error since the last call to '''_glGetError''', or since the GL was initialized. - -To allow for distributed implementations, there may be several error flags. If any single error flag has recorded an error, the value of that flag is returned and that flag is reset to {{KW|_GL_NO_ERROR}} when '''_glGetError''' is called. If more than one flag has recorded an error, '''_glGetError''' returns and clears an arbitrary error flag value. Thus, '''_glGetError''' should always be called in a loop, until it returns {{KW|_GL_NO_ERROR}}, if all error flags are to be reset. - -Initially, all error flags are set to {{KW|_GL_NO_ERROR}}. - -The following errors are currently defined: - -; {{KW|_GL_NO_ERROR}} -: No error has been recorded. The value of this symbolic constant is guaranteed to be 0. -; {{KW|_GL_INVALID_ENUM}} -: An unacceptable value is specified for an enumerated argument. The offending command is ignored and has no other side effect than to set the error flag. -; {{KW|_GL_INVALID_VALUE}} -: A numeric argument is out of range. The offending command is ignored and has no other side effect than to set the error flag. -; {{KW|_GL_INVALID_OPERATION}} -: The specified operation is not allowed in the current state. The offending command is ignored and has no other side effect than to set the error flag. -; {{KW|_GL_INVALID_FRAMEBUFFER_OPERATION}} -: The framebuffer object is not complete. The offending command is ignored and has no other side effect than to set the error flag. -; {{KW|_GL_OUT_OF_MEMORY}} -: There is not enough memory left to execute the command. The state of the GL is undefined, except for the state of the error flags, after this error is recorded. -; {{KW|_GL_STACK_UNDERFLOW}} -: An attempt has been made to perform an operation that would cause an internal stack to underflow. -; {{KW|_GL_STACK_OVERFLOW}} -: An attempt has been made to perform an operation that would cause an internal stack to overflow. -When an error flag is set, results of a GL operation are undefined only if {{KW|_GL_OUT_OF_MEMORY}} has occurred. In all other cases, the command generating the error is ignored and has no effect on the GL state or frame buffer contents. If the generating command returns a value, it returns 0. If '''_glGetError''' itself generates an error, it returns 0. +* OpenGL's documentation is available in several places, so we won't reproduce it here for another time. +* The full description for this command can be found at [https://docs.microsoft.com/en-us/windows/win32/opengl/glgeterror Microsoft Docs] and is also valid for QB64 usage. -{{PageCopyright}} +{{PageSeeAlso}} +* [[_GL|SUB _GL]] +* [[_glBegin]], [[_glEnd]] -Copyright 1991-2006 Silicon Graphics, Inc. Copyright 2012 Khronos Group. This document is licensed under the SGI Free Software B License. For details, see [http://oss.sgi.com/projects/FreeB/ http://oss.sgi.com/projects/FreeB/]. +{{PageNavigation}} + +[[Category:Final]] diff --git a/internal/help/_glGetString__00100100000.txt b/internal/help/_glGetString__00100100000.txt index 4398161e6..5dc3ff9f0 100644 --- a/internal/help/_glGetString__00100100000.txt +++ b/internal/help/_glGetString__00100100000.txt @@ -1,75 +1,29 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:20:05}} -'''_glGetString:''' return a string describing the current GL connection +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:49:29}} +{{DISPLAYTITLE:_glGetString}} +The '''_glGetString''' function returns a string describing the current OpenGL connection. {{PageSyntax}} +: const GLubyte {{Parameter|*result}} = '''_glGetString''' (GLenum {{Parameter|name}}) - FUNCTION _glGetString&& (BYVAL name AS _UNSIGNED LONG) - const GLubyte* '''_glGetString'''(GLenum {{Parameter|name}}); - const GLubyte* '''_glGetStringi'''(GLenum {{Parameter|name}}, GLuint {{Parameter|index}}); - -; name -: Specifies a symbolic constant, one of {{KW|_GL_VENDOR}}, {{KW|_GL_RENDERER}}, {{KW|_GL_VERSION}}, or {{KW|_GL_SHADING_LANGUAGE_VERSION}}. Additionally, '''_glGetStringi''' accepts the {{KW|_GL_EXTENSIONS}} token. -; index -: For '''_glGetStringi''', specifies the index of the string to return. +{{PageParameters}} +* OpenGL is using its own set of variable types to describe its command parameters. +* Use the following table to find the respective QB64 [[Variable Types]]. +{{OpenGLTypesPlugin}} {{PageDescription}} - -'''_glGetString''' returns a pointer to a static string describing some aspect of the current GL connection. {{Parameter|name}} can be one of the following: - -; {{KW|_GL_VENDOR}} -: -Returns the company responsible for this GL implementation. This name does not change from release to release. -; {{KW|_GL_RENDERER}} -: -Returns the name of the renderer. This name is typically specific to a particular configuration of a hardware platform. It does not change from release to release. -; {{KW|_GL_VERSION}} -: -Returns a version or release number. -; {{KW|_GL_SHADING_LANGUAGE_VERSION}} -: -Returns a version or release number for the shading language. - -Strings {{KW|_GL_VENDOR}} and {{KW|_GL_RENDERER}} together uniquely specify a platform. They do not change from release to release and should be used by platform-recognition algorithms. - -'''_glGetStringi''' returns a pointer to a static string indexed by {{Parameter|index}}. {{Parameter|name}} can be one of the following: - -; {{KW|_GL_EXTENSIONS}} -: For '''_glGetStringi''' only, returns the extension string supported by the implementation at {{Parameter|index}}. The index {{Parameter|index}} is on the range [0 to {{KW|_glGet|Integerv(GL_NUM_EXTENSIONS)}} - 1]. -; {{KW|_GL_SHADING_LANGUAGE_VERSION}} -: Returns one of the versions of [[GLSL]] supported by this implementation. {{Parameter|index}} is on the range [0 to {{KW|_glGet|Integerv(GL_NUM_SHADING_LANGUAGE_VERSIONS)}} - 1]. - -The {{KW|_GL_VERSION}} and {{KW|_GL_SHADING_LANGUAGE_VERSION}} strings begin with a version number. The version number uses one of these forms: - -''major_number.minor_number'' - -or - -''major_number.minor_number.release_number'' - -Vendor-specific information may follow the version number. Its format depends on the implementation, but a space always separates the version number and the vendor-specific information. - -All strings are null-terminated. +* OpenGL's documentation is available in several places, so we won't reproduce it here for another time. +* The full description for this command can be found at [https://docs.microsoft.com/en-us/windows/win32/opengl/glgetstring Microsoft Docs] and is also valid for QB64 usage. -{{PageNotes}} - -If an error is generated, '''_glGetString''' returns 0. - -The client and server may support different versions. '''_glGetString''' always returns a compatible version number. The release number always describes the server. +{{PageSeeAlso}} +* [[_GL|SUB _GL]] +* [[_glBegin]], [[_glEnd]] -{{PageErrors}} - -{{KW|_GL_INVALID_ENUM}} is generated if {{Parameter|name}} is not an accepted value. - -{{KW|_GL_INVALID_VALUE}} is generated by '''_glGetStringi''' if {{Parameter|index}} is outside the valid range for indexed state {{Parameter|name}}. - - -{{PageCopyright}} - -Copyright 1991-2006 Silicon Graphics, Inc. Copyright 2010 Khronos Group. This document is licensed under the SGI Free Software B License. For details, see [http://oss.sgi.com/projects/FreeB/ http://oss.sgi.com/projects/FreeB/]. +{{PageNavigation}} +[[Category:Final]] diff --git a/internal/help/_glGetTexImage__0010010010000.txt b/internal/help/_glGetTexImage__0010010010000.txt index 2b825b3b4..8313a8d67 100644 --- a/internal/help/_glGetTexImage__0010010010000.txt +++ b/internal/help/_glGetTexImage__0010010010000.txt @@ -1,85 +1,30 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:20:13}} -'''_glGetTexImage:''' return a texture image +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:49:36}} +{{DISPLAYTITLE:_glGetTexImage}} +The '''_glGetTexImage''' statement returns a texture image. {{PageSyntax}} - - SUB _glGetTexImage (BYVAL target AS _UNSIGNED LONG, BYVAL level AS LONG, BYVAL format AS _UNSIGNED LONG, BYVAL type AS _UNSIGNED LONG, pixels AS _OFFSET) - void '''_glGetTexImage'''(GLenum {{Parameter|target}}, GLint {{Parameter|level}}, GLenum {{Parameter|format}}, GLenum {{Parameter|type}}, GLvoid * {{Parameter|img}}); +: '''_glGetTexImage''' GLenum {{Parameter|target}}, GLint {{Parameter|level}}, GLenum {{Parameter|format}}, GLenum {{Parameter|type}}, GLvoid {{Parameter|*pixels}} -; target -: Specifies which texture is to be obtained. {{KW|_GL_TEXTURE_1D}}, {{KW|_GL_TEXTURE_2D}}, {{KW|_GL_TEXTURE_3D}}, {{KW|_GL_TEXTURE_1D_ARRAY}}, {{KW|_GL_TEXTURE_2D_ARRAY}}, {{KW|_GL_TEXTURE_RECTANGLE}}, {{KW|_GL_TEXTURE_CUBE_MAP_POSITIVE_X}}, {{KW|_GL_TEXTURE_CUBE_MAP_NEGATIVE_X}}, {{KW|_GL_TEXTURE_CUBE_MAP_POSITIVE_Y}}, {{KW|_GL_TEXTURE_CUBE_MAP_NEGATIVE_Y}}, {{KW|_GL_TEXTURE_CUBE_MAP_POSITIVE_Z}}, and {{KW|_GL_TEXTURE_CUBE_MAP_NEGATIVE_Z}} are accepted. -; level -: Specifies the level-of-detail number of the desired image. Level 0 is the base image level. Level ''n'' is the ''n''th mipmap reduction image. -; format -: Specifies a pixel format for the returned data. The supported formats are {{KW|_GL_STENCIL_INDEX}}, {{KW|_GL_DEPTH_COMPONENT}}, {{KW|_GL_DEPTH_STENCIL}}, {{KW|_GL_RED}}, {{KW|_GL_GREEN}}, {{KW|_GL_BLUE}}, {{KW|_GL_RG}}, {{KW|_GL_RGB}}, {{KW|_GL_RGBA}}, {{KW|_GL_BGR}}, {{KW|_GL_BGRA}}, {{KW|_GL_RED_INTEGER}}, {{KW|_GL_GREEN_INTEGER}}, {{KW|_GL_BLUE_INTEGER}}, {{KW|_GL_RG_INTEGER}}, {{KW|_GL_RGB_INTEGER}}, {{KW|_GL_RGBA_INTEGER}}, {{KW|_GL_BGR_INTEGER}}, {{KW|_GL_BGRA_INTEGER}}. -; type -: Specifies a pixel type for the returned data. The supported types are {{KW|_GL_UNSIGNED_BYTE}}, {{KW|_GL_BYTE}}, {{KW|_GL_UNSIGNED_SHORT}}, {{KW|_GL_SHORT}}, {{KW|_GL_UNSIGNED_INT}}, {{KW|_GL_INT}}, {{KW|_GL_HALF_FLOAT}}, {{KW|_GL_FLOAT}}, {{KW|_GL_UNSIGNED_BYTE_3_3_2}}, {{KW|_GL_UNSIGNED_BYTE_2_3_3_REV}}, {{KW|_GL_UNSIGNED_SHORT_5_6_5}}, {{KW|_GL_UNSIGNED_SHORT_5_6_5_REV}}, {{KW|_GL_UNSIGNED_SHORT_4_4_4_4}}, {{KW|_GL_UNSIGNED_SHORT_4_4_4_4_REV}}, {{KW|_GL_UNSIGNED_SHORT_5_5_5_1}}, {{KW|_GL_UNSIGNED_SHORT_1_5_5_5_REV}}, {{KW|_GL_UNSIGNED_INT_8_8_8_8}}, {{KW|_GL_UNSIGNED_INT_8_8_8_8_REV}}, {{KW|_GL_UNSIGNED_INT_10_10_10_2}}, {{KW|_GL_UNSIGNED_INT_2_10_10_10_REV}}, {{KW|_GL_UNSIGNED_INT_24_8}}, {{KW|_GL_UNSIGNED_INT_10F_11F_11F_REV}}, {{KW|_GL_UNSIGNED_INT_5_9_9_9_REV}}, and {{KW|_GL_FLOAT_32_UNSIGNED_INT_24_8_REV}}. -; img -: Returns the texture image. Should be a pointer to an array of the type specified by {{Parameter|type}}. +{{PageParameters}} +* OpenGL is using its own set of variable types to describe its command parameters. +* Use the following table to find the respective QB64 [[Variable Types]]. +{{OpenGLTypesPlugin}} {{PageDescription}} - -'''_glGetTexImage''' returns a texture image into {{Parameter|img}}. {{Parameter|target}} specifies whether the desired texture image is one specified by {{KW|_glTexImage1D}} ({{KW|_GL_TEXTURE_1D}}), {{KW|_glTexImage2D}} ({{KW|_GL_TEXTURE_1D_ARRAY}}, {{KW|_GL_TEXTURE_RECTANGLE}}, {{KW|_GL_TEXTURE_2D}} or any of {{KW|_GL_TEXTURE_CUBE_MAP_*}}), or {{KW|_glTexImage3D}} ({{KW|_GL_TEXTURE_2D_ARRAY}}, {{KW|_GL_TEXTURE_3D}}). {{Parameter|level}} specifies the level-of-detail number of the desired image. {{Parameter|format}} and {{Parameter|type}} specify the format and type of the desired image array. See the reference page for {{KW|_glTexImage1D}} for a description of the acceptable values for the {{Parameter|format}} and {{Parameter|type}} parameters, respectively. - -If a non-zero named buffer object is bound to the {{KW|_GL_PIXEL_PACK_BUFFER}} target (see {{KW|_glBindBuffer}}) while a texture image is requested, {{Parameter|img}} is treated as a byte offset into the buffer object's data store. - -To understand the operation of '''_glGetTexImage''', consider the selected internal four-component texture image to be an RGBA color buffer the size of the image. The semantics of '''_glGetTexImage''' are then identical to those of {{KW|_glReadPixels}}, with the exception that no pixel transfer operations are performed, when called with the same {{Parameter|format}} and {{Parameter|type}}, with ''x'' and ''y'' set to 0, ''width'' set to the width of the texture image and ''height'' set to 1 for 1D images, or to the height of the texture image for 2D images. - -If the selected texture image does not contain four components, the following mappings are applied. Single-component textures are treated as RGBA buffers with red set to the single-component value, green set to 0, blue set to 0, and alpha set to 1. Two-component textures are treated as RGBA buffers with red set to the value of component zero, alpha set to the value of component one, and green and blue set to 0. Finally, three-component textures are treated as RGBA buffers with red set to component zero, green set to component one, blue set to component two, and alpha set to 1. - -To determine the required size of {{Parameter|img}}, use {{KW|_glGetTexLevelParameter}} to determine the dimensions of the internal texture image, then scale the required number of pixels by the storage required for each pixel, based on {{Parameter|format}} and {{Parameter|type}}. Be sure to take the pixel storage parameters into account, especially {{KW|_GL_PACK_ALIGNMENT}}. - - -{{PageNotes}} - -If an error is generated, no change is made to the contents of {{Parameter|img}}. - -'''_glGetTexImage''' returns the texture image for the active texture unit. - - -{{PageErrors}} - -{{KW|_GL_INVALID_ENUM}} is generated if {{Parameter|target}}, {{Parameter|format}}, or {{Parameter|type}} is not an accepted value. - -{{KW|_GL_INVALID_VALUE}} is generated if {{Parameter|level}} is less than 0. - -{{KW|_GL_INVALID_VALUE}} may be generated if {{Parameter|level}} is greater than log2(''max''), where ''max'' is the returned value of {{KW|_GL_MAX_TEXTURE_SIZE}}. - -{{KW|_GL_INVALID_OPERATION}} is returned if {{Parameter|type}} is one of {{KW|_GL_UNSIGNED_BYTE_3_3_2}}, {{KW|_GL_UNSIGNED_BYTE_2_3_3_REV}}, {{KW|_GL_UNSIGNED_SHORT_5_6_5}}, {{KW|_GL_UNSIGNED_SHORT_5_6_5_REV}}, or {{KW|_GL_UNSIGNED_INT_10F_11F_11F_REV}} and {{Parameter|format}} is not {{KW|_GL_RGB}}. - -{{KW|_GL_INVALID_OPERATION}} is returned if {{Parameter|type}} is one of {{KW|_GL_UNSIGNED_SHORT_4_4_4_4}}, {{KW|_GL_UNSIGNED_SHORT_4_4_4_4_REV}}, {{KW|_GL_UNSIGNED_SHORT_5_5_5_1}}, {{KW|_GL_UNSIGNED_SHORT_1_5_5_5_REV}}, {{KW|_GL_UNSIGNED_INT_8_8_8_8}}, {{KW|_GL_UNSIGNED_INT_8_8_8_8_REV}}, {{KW|_GL_UNSIGNED_INT_10_10_10_2}}, {{KW|_GL_UNSIGNED_INT_2_10_10_10_REV}}, or {{KW|_GL_UNSIGNED_INT_5_9_9_9_REV}} and {{Parameter|format}} is neither {{KW|_GL_RGBA}} or {{KW|_GL_BGRA}}. - -{{KW|_GL_INVALID_OPERATION}} is generated if a non-zero buffer object name is bound to the {{KW|_GL_PIXEL_PACK_BUFFER}} target and the buffer object's data store is currently mapped. - -{{KW|_GL_INVALID_OPERATION}} is generated if a non-zero buffer object name is bound to the {{KW|_GL_PIXEL_PACK_BUFFER}} target and the data would be packed to the buffer object such that the memory writes required would exceed the data store size. - -{{KW|_GL_INVALID_OPERATION}} is generated if a non-zero buffer object name is bound to the {{KW|_GL_PIXEL_PACK_BUFFER}} target and {{Parameter|img}} is not evenly divisible into the number of bytes needed to store in memory a datum indicated by {{Parameter|type}}. - - -{{PageUseWith}} - -{{KW|_glGetTexLevelParameter}} with argument {{KW|_GL_TEXTURE_WIDTH}} - -{{KW|_glGetTexLevelParameter}} with argument {{KW|_GL_TEXTURE_HEIGHT}} - -{{KW|_glGetTexLevelParameter}} with argument {{KW|_GL_TEXTURE_INTERNAL_FORMAT}} - -{{KW|_glGet}} with arguments {{KW|_GL_PACK_ALIGNMENT}} and others - -{{KW|_glGet}} with argument {{KW|_GL_PIXEL_PACK_BUFFER_BINDING}} +* OpenGL's documentation is available in several places, so we won't reproduce it here for another time. +* The full description for this command can be found at [https://docs.microsoft.com/en-us/windows/win32/opengl/glgetteximage Microsoft Docs] and is also valid for QB64 usage. {{PageSeeAlso}} - -[[_GL|SUB _GL]] -{{KW|_glActiveTexture}}, {{KW|_glBindTexture}}, {{KW|_glPixelStore}}, {{KW|_glReadPixels}}, {{KW|_glTexSubImage1D}}, {{KW|_glTexSubImage2D}}, {{KW|_glTexSubImage3D}} +* [[_GL|SUB _GL]] +* [[_glBegin]], [[_glDrawPixels]], [[_glEnd]], [https://docs.microsoft.com/en-us/windows/win32/opengl/glgettexlevelparameter _glGetTexLevelParameter] +* [[_glReadPixels]], [[_glTexImage1D]], [[_glTexImage2D]] -{{PageCopyright}} - -Copyright 1991-2006 Silicon Graphics, Inc. Copyright 2010 Khronos Group. This document is licensed under the SGI Free Software B License. For details, see [http://oss.sgi.com/projects/FreeB/ http://oss.sgi.com/projects/FreeB/]. +{{PageNavigation}} +[[Category:Final]] diff --git a/internal/help/_glHint__001000.txt b/internal/help/_glHint__001000.txt index 54b1ee48b..2fc6317f3 100644 --- a/internal/help/_glHint__001000.txt +++ b/internal/help/_glHint__001000.txt @@ -1,59 +1,29 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:20:19}} -'''_glHint:''' specify implementation-specific hints +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:49:43}} +{{DISPLAYTITLE:_glHint}} +The '''_glHint''' statement specifies implementation-specific hints. {{PageSyntax}} - - SUB _glHint (BYVAL target AS _UNSIGNED LONG, BYVAL mode AS _UNSIGNED LONG) - void '''_glHint'''(GLenum {{Parameter|target}}, GLenum {{Parameter|mode}}); +: '''_glHint''' GLenum {{Parameter|target}}, GLenum {{Parameter|mode}} -; target -: Specifies a symbolic constant indicating the behavior to be controlled. {{KW|_GL_LINE_SMOOTH_HINT}}, {{KW|_GL_POLYGON_SMOOTH_HINT}}, {{KW|_GL_TEXTURE_COMPRESSION_HINT}}, and {{KW|_GL_FRAGMENT_SHADER_DERIVATIVE_HINT}} are accepted. -; mode -: Specifies a symbolic constant indicating the desired behavior. {{KW|_GL_FASTEST}}, {{KW|_GL_NICEST}}, and {{KW|_GL_DONT_CARE}} are accepted. +{{PageParameters}} +* OpenGL is using its own set of variable types to describe its command parameters. +* Use the following table to find the respective QB64 [[Variable Types]]. +{{OpenGLTypesPlugin}} {{PageDescription}} - -Certain aspects of GL behavior, when there is room for interpretation, can be controlled with hints. A hint is specified with two arguments. {{Parameter|target}} is a symbolic constant indicating the behavior to be controlled, and {{Parameter|mode}} is another symbolic constant indicating the desired behavior. The initial value for each {{Parameter|target}} is {{KW|_GL_DONT_CARE}}. {{Parameter|mode}} can be one of the following: - -; {{KW|_GL_FASTEST}} -: -The most efficient option should be chosen. -; {{KW|_GL_NICEST}} -: -The most correct, or highest quality, option should be chosen. -; {{KW|_GL_DONT_CARE}} -: -No preference. -Though the implementation aspects that can be hinted are well defined, the interpretation of the hints depends on the implementation. The hint aspects that can be specified with {{Parameter|target}}, along with suggested semantics, are as follows: - -; {{KW|_GL_FRAGMENT_SHADER_DERIVATIVE_HINT}} -: -Indicates the accuracy of the derivative calculation for the GL shading language fragment processing built-in functions: {{KW|_dFdx}}, {{KW|_dFdy}}, and {{KW|_fwidth}}. -; {{KW|_GL_LINE_SMOOTH_HINT}} -: -Indicates the sampling quality of antialiased lines. If a larger filter function is applied, hinting {{KW|_GL_NICEST}} can result in more pixel fragments being generated during rasterization. -; {{KW|_GL_POLYGON_SMOOTH_HINT}} -: -Indicates the sampling quality of antialiased polygons. Hinting {{KW|_GL_NICEST}} can result in more pixel fragments being generated during rasterization, if a larger filter function is applied. -; {{KW|_GL_TEXTURE_COMPRESSION_HINT}} -: -Indicates the quality and performance of the compressing texture images. Hinting {{KW|_GL_FASTEST}} indicates that texture images should be compressed as quickly as possible, while {{KW|_GL_NICEST}} indicates that texture images should be compressed with as little image quality loss as possible. {{KW|_GL_NICEST}} should be selected if the texture is to be retrieved by {{KW|_glGetCompressedTexImage}} for reuse. - -{{PageNotes}} - -The interpretation of hints depends on the implementation. Some implementations ignore '''_glHint''' settings. +* OpenGL's documentation is available in several places, so we won't reproduce it here for another time. +* The full description for this command can be found at [https://docs.microsoft.com/en-us/windows/win32/opengl/glhint Microsoft Docs] and is also valid for QB64 usage. -{{PageErrors}} - -{{KW|_GL_INVALID_ENUM}} is generated if either {{Parameter|target}} or {{Parameter|mode}} is not an accepted value. +{{PageSeeAlso}} +* [[_GL|SUB _GL]] +* [[_glBegin]], [[_glEnd]] -{{PageCopyright}} - -Copyright 1991-2006 Silicon Graphics, Inc. This document is licensed under the SGI Free Software B License. For details, see [http://oss.sgi.com/projects/FreeB/ http://oss.sgi.com/projects/FreeB/]. +{{PageNavigation}} +[[Category:Final]] diff --git a/internal/help/_glIsEnabled__00101000000.txt b/internal/help/_glIsEnabled__00101000000.txt index 5a607e71d..2de55cbb2 100644 --- a/internal/help/_glIsEnabled__00101000000.txt +++ b/internal/help/_glIsEnabled__00101000000.txt @@ -1,134 +1,29 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:20:40}} -'''_glIsEnabled, glIsEnabledi:''' test whether a capability is enabled +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:50:00}} +{{DISPLAYTITLE:_glIsEnabled}} +The '''_glIsEnabled''' function tests whether a capability is enabled. {{PageSyntax}} +: GLboolean {{Parameter|result}} = '''_glIsEnabled''' (GLenum {{Parameter|cap}}) - FUNCTION _glIsEnabled~%% (BYVAL cap AS _UNSIGNED LONG) - GLboolean '''_glIsEnabled'''(GLenum {{Parameter|cap}}); - GLboolean '''_glIsEnabledi'''(GLenum {{Parameter|cap}}, GLuint {{Parameter|index}}); - -; cap -: Specifies a symbolic constant indicating a GL capability. -; index -: Specifies the index of the capability. +{{PageParameters}} +* OpenGL is using its own set of variable types to describe its command parameters. +* Use the following table to find the respective QB64 [[Variable Types]]. +{{OpenGLTypesPlugin}} {{PageDescription}} - -'''_glIsEnabled''' returns {{KW|_GL_TRUE}} if {{Parameter|cap}} is an enabled capability and returns {{KW|_GL_FALSE}} otherwise. Boolean states that are indexed may be tested with '''_glIsEnabledi'''. For '''_glIsEnabledi''', {{Parameter|index}} specifies the index of the capability to test. {{Parameter|index}} must be between zero and the count of indexed capabilities for {{Parameter|cap}}. Initially all capabilities except {{KW|_GL_DITHER}} are disabled; {{KW|_GL_DITHER}} is initially enabled. - -The following capabilities are accepted for {{Parameter|cap}}: - - - -{| -|+ -! '''Constant''' -! '''See''' -|+ -| {{KW|_GL_BLEND}} -| {{KW|_glBlendFunc}}, {{KW|_glLogicOp}} -|+ -| {{KW|_GL_CLIP_DISTANCE}}''i'' -| {{KW|_glEnable}} -|+ -| {{KW|_GL_COLOR_LOGIC_OP}} -| {{KW|_glLogicOp}} -|+ -| {{KW|_GL_CULL_FACE}} -| {{KW|_glCullFace}} -|+ -| {{KW|_GL_DEPTH_CLAMP}} -| {{KW|_glEnable}} -|+ -| {{KW|_GL_DEBUG_OUTPUT}} -| {{KW|_glEnable}} -|+ -| {{KW|_GL_DEBUG_OUTPUT_SYNCHRONOUS}} -| {{KW|_glEnable}} -|+ -| {{KW|_GL_DEPTH_TEST}} -| {{KW|_glDepthFunc}}, {{KW|_glDepthRange}} -|+ -| {{KW|_GL_DITHER}} -| {{KW|_glEnable}} -|+ -| {{KW|_GL_FRAMEBUFFER_SRGB}} -| {{KW|_glEnable}} -|+ -| {{KW|_GL_LINE_SMOOTH}} -| {{KW|_glLineWidth}} -|+ -| {{KW|_GL_MULTISAMPLE}} -| {{KW|_glSampleCoverage}} -|+ -| {{KW|_GL_POLYGON_SMOOTH}} -| {{KW|_glPolygonMode}} -|+ -| {{KW|_GL_POLYGON_OFFSET_FILL}} -| {{KW|_glPolygonOffset}} -|+ -| {{KW|_GL_POLYGON_OFFSET_LINE}} -| {{KW|_glPolygonOffset}} -|+ -| {{KW|_GL_POLYGON_OFFSET_POINT}} -| {{KW|_glPolygonOffset}} -|+ -| {{KW|_GL_PROGRAM_POINT_SIZE}} -| {{KW|_glEnable}} -|+ -| {{KW|_GL_PRIMITIVE_RESTART}} -| {{KW|_glEnable}}, {{KW|_glPrimitiveRestartIndex}} -|+ -| {{KW|_GL_SAMPLE_ALPHA_TO_COVERAGE}} -| {{KW|_glSampleCoverage}} -|+ -| {{KW|_GL_SAMPLE_ALPHA_TO_ONE}} -| {{KW|_glSampleCoverage}} -|+ -| {{KW|_GL_SAMPLE_COVERAGE}} -| {{KW|_glSampleCoverage}} -|+ -| {{KW|_GL_SAMPLE_MASK}} -| {{KW|_glEnable}} -|+ -| {{KW|_GL_SCISSOR_TEST}} -| {{KW|_glScissor}} -|+ -| {{KW|_GL_STENCIL_TEST}} -| {{KW|_glStencilFunc}}, {{KW|_glStencilOp}} -|+ -| {{KW|_GL_TEXTURE_CUBEMAP_SEAMLESS}} -| {{KW|_glEnable}} -|} - - - - -{{PageNotes}} - -If an error is generated, '''_glIsEnabled''' and '''_glIsEnabledi''' return {{KW|_GL_FALSE}}. - -{{KW|_GL_DEBUG_OUTPUT}} and {{KW|_GL_DEBUG_OUTPUT_SYNCHRONOUS}} are available only if the GL version is 4.3 or greater. - - -{{PageErrors}} - -{{KW|_GL_INVALID_ENUM}} is generated if {{Parameter|cap}} is not an accepted value. - -{{KW|_GL_INVALID_VALUE}} is generated by '''_glIsEnabledi''' if {{Parameter|index}} is outside the valid range for the indexed state {{Parameter|cap}}. +* OpenGL's documentation is available in several places, so we won't reproduce it here for another time. +* The full description for this command can be found at [https://docs.microsoft.com/en-us/windows/win32/opengl/glisenabled Microsoft Docs] and is also valid for QB64 usage. {{PageSeeAlso}} - -[[_GL|SUB _GL]] -{{KW|_glEnable}}, {{KW|_glDisable}}, {{KW|_glGet}} +* [[_GL|SUB _GL]] +* [[_glBegin]], [[_glEnable]], [[_glEnd]] -{{PageCopyright}} - -Copyright 1991-2006 Silicon Graphics, Inc. Copyright 2010-2011 Khronos Group. This document is licensed under the SGI Free Software B License. For details, see [http://oss.sgi.com/projects/FreeB/ http://oss.sgi.com/projects/FreeB/]. +{{PageNavigation}} +[[Category:Final]] diff --git a/internal/help/_glIsTexture__00101000000.txt b/internal/help/_glIsTexture__00101000000.txt index 24258e925..9164596fe 100644 --- a/internal/help/_glIsTexture__00101000000.txt +++ b/internal/help/_glIsTexture__00101000000.txt @@ -1,32 +1,31 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:20:42}} -'''_glIsTexture:''' determine if a name corresponds to a texture +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:50:03}} +{{DISPLAYTITLE:_glIsTexture}} +The '''_glIsTexture''' function determines if a name corresponds to a texture. {{PageSyntax}} - - FUNCTION _glIsTexture~%% (BYVAL texture AS _UNSIGNED LONG) - GLboolean '''_glIsTexture'''(GLuint {{Parameter|texture}}); +: GLboolean {{Parameter|result}} = '''_glIsTexture''' (GLuint {{Parameter|texture}}) -; texture -: Specifies a value that may be the name of a texture. +{{PageParameters}} +* OpenGL is using its own set of variable types to describe its command parameters. +* Use the following table to find the respective QB64 [[Variable Types]]. +{{OpenGLTypesPlugin}} {{PageDescription}} - -'''_glIsTexture''' returns {{KW|_GL_TRUE}} if {{Parameter|texture}} is currently the name of a texture. If {{Parameter|texture}} is zero, or is a non-zero value that is not currently the name of a texture, or if an error occurs, '''_glIsTexture''' returns {{KW|_GL_FALSE}}. - -A name returned by {{KW|_glGenTextures}}, but not yet associated with a texture by calling {{KW|_glBindTexture}}, is not the name of a texture. +* OpenGL's documentation is available in several places, so we won't reproduce it here for another time. +* The full description for this command can be found at [https://docs.microsoft.com/en-us/windows/win32/opengl/glistexture Microsoft Docs] and is also valid for QB64 usage. {{PageSeeAlso}} - -[[_GL|SUB _GL]] -{{KW|_glBindTexture}}, {{KW|_glDeleteTextures}}, {{KW|_glGenTextures}} +* [[_GL|SUB _GL]] +* [[_glBegin]], [[_glBindTexture]], [[_glEnd]], [[_glGenTextures]] +* [https://docs.microsoft.com/en-us/windows/win32/opengl/glgetbooleanv--glgetdoublev--glgetfloatv--glgetintegerv _glGet], [https://docs.microsoft.com/en-us/windows/win32/opengl/glgettexparameter _glGetTexParameter], [[_glTexImage1D]], [[_glTexImage2D]] +* [https://docs.microsoft.com/en-us/windows/win32/opengl/gltexparameter-functions _glTexParameter] -{{PageCopyright}} - -Copyright 1991-2006 Silicon Graphics, Inc. This document is licensed under the SGI Free Software B License. For details, see [http://oss.sgi.com/projects/FreeB/ http://oss.sgi.com/projects/FreeB/]. +{{PageNavigation}} +[[Category:Final]] diff --git a/internal/help/_glLineWidth__00100010000.txt b/internal/help/_glLineWidth__00100010000.txt index 0ec82f3f7..929b438da 100644 --- a/internal/help/_glLineWidth__00100010000.txt +++ b/internal/help/_glLineWidth__00100010000.txt @@ -1,63 +1,29 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:20:55}} -'''_glLineWidth:''' specify the width of rasterized lines +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:50:16}} +{{DISPLAYTITLE:_glLineWidth}} +The '''_glLineWidth''' statement specifies the width of rasterized lines. {{PageSyntax}} - - SUB _glLineWidth (BYVAL width AS SINGLE) - void '''_glLineWidth'''(GLfloat {{Parameter|width}}); +: '''_glLineWidth''' GLfloat {{Parameter|width}} -; width -: Specifies the width of rasterized lines. The initial value is 1. +{{PageParameters}} +* OpenGL is using its own set of variable types to describe its command parameters. +* Use the following table to find the respective QB64 [[Variable Types]]. +{{OpenGLTypesPlugin}} {{PageDescription}} - -'''_glLineWidth''' specifies the rasterized width of both aliased and antialiased lines. Using a line width other than 1 has different effects, depending on whether line antialiasing is enabled. To enable and disable line antialiasing, call {{KW|_glEnable}} and {{KW|_glDisable}} with argument {{KW|_GL_LINE_SMOOTH}}. Line antialiasing is initially disabled. - -If line antialiasing is disabled, the actual width is determined by rounding the supplied width to the nearest integer. (If the rounding results in the value 0, it is as if the line width were 1.) If |\Delta X| \ge |\Delta Y|, ''i'' pixels are filled in each column that is rasterized, where ''i'' is the rounded value of {{Parameter|width}}. Otherwise, ''i'' pixels are filled in each row that is rasterized. - -If antialiasing is enabled, line rasterization produces a fragment for each pixel square that intersects the region lying within the rectangle having width equal to the current line width, length equal to the actual length of the line, and centered on the mathematical line segment. The coverage value for each fragment is the window coordinate area of the intersection of the rectangular region with the corresponding pixel square. This value is saved and used in the final rasterization step. - -Not all widths can be supported when line antialiasing is enabled. If an unsupported width is requested, the nearest supported width is used. Only width 1 is guaranteed to be supported; others depend on the implementation. Likewise, there is a range for aliased line widths as well. To query the range of supported widths and the size difference between supported widths within the range, call {{KW|_glGet}} with arguments {{KW|_GL_ALIASED_LINE_WIDTH_RANGE}}, {{KW|_GL_SMOOTH_LINE_WIDTH_RANGE}}, and {{KW|_GL_SMOOTH_LINE_WIDTH_GRANULARITY}}. - - -{{PageNotes}} - -The line width specified by '''_glLineWidth''' is always returned when {{KW|_GL_LINE_WIDTH}} is queried. Clamping and rounding for aliased and antialiased lines have no effect on the specified value. - -Nonantialiased line width may be clamped to an implementation-dependent maximum. Call {{KW|_glGet}} with {{KW|_GL_ALIASED_LINE_WIDTH_RANGE}} to determine the maximum width. - -In OpenGL 1.2, the tokens {{KW|_GL_LINE_WIDTH_RANGE}} and {{KW|_GL_LINE_WIDTH_GRANULARITY}} were replaced by {{KW|_GL_ALIASED_LINE_WIDTH_RANGE}}, {{KW|_GL_SMOOTH_LINE_WIDTH_RANGE}}, and {{KW|_GL_SMOOTH_LINE_WIDTH_GRANULARITY}}. The old names are retained for backward compatibility, but should not be used in new code. - - -{{PageErrors}} - -{{KW|_GL_INVALID_VALUE}} is generated if {{Parameter|width}} is less than or equal to 0. - - -{{PageUseWith}} - -{{KW|_glGet}} with argument {{KW|_GL_LINE_WIDTH}} - -{{KW|_glGet}} with argument {{KW|_GL_ALIASED_LINE_WIDTH_RANGE}} - -{{KW|_glGet}} with argument {{KW|_GL_SMOOTH_LINE_WIDTH_RANGE}} - -{{KW|_glGet}} with argument {{KW|_GL_SMOOTH_LINE_WIDTH_GRANULARITY}} - -{{KW|_glIsEnabled}} with argument {{KW|_GL_LINE_SMOOTH}} +* OpenGL's documentation is available in several places, so we won't reproduce it here for another time. +* The full description for this command can be found at [https://docs.microsoft.com/en-us/windows/win32/opengl/gllinewidth Microsoft Docs] and is also valid for QB64 usage. {{PageSeeAlso}} - -[[_GL|SUB _GL]] -{{KW|_glEnable}} +* [[_GL|SUB _GL]] +* [[_glBegin]], [[_glEnable]], [[_glEnd]], [[_glIsEnabled]] -{{PageCopyright}} - -Copyright 1991-2006 Silicon Graphics, Inc. This document is licensed under the SGI Free Software B License. For details, see [http://oss.sgi.com/projects/FreeB/ http://oss.sgi.com/projects/FreeB/]. +{{PageNavigation}} +[[Category:Final]] diff --git a/internal/help/_glLogicOp__001000010.txt b/internal/help/_glLogicOp__001000010.txt index dbeecaa71..85a0b9aff 100644 --- a/internal/help/_glLogicOp__001000010.txt +++ b/internal/help/_glLogicOp__001000010.txt @@ -1,107 +1,30 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:21:03}} -'''_glLogicOp:''' specify a logical pixel operation for rendering +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:50:23}} +{{DISPLAYTITLE:_glLogicOp}} +The '''_glLogicOp''' statement specifies a logical pixel operation for color index rendering. {{PageSyntax}} - - SUB _glLogicOp (BYVAL opcode AS _UNSIGNED LONG) - void '''_glLogicOp'''(GLenum {{Parameter|opcode}}); +: '''_glLogicOp''' GLenum {{Parameter|opcode}} -; opcode -: Specifies a symbolic constant that selects a logical operation. The following symbols are accepted: {{KW|_GL_CLEAR}}, {{KW|_GL_SET}}, {{KW|_GL_COPY}}, {{KW|_GL_COPY_INVERTED}}, {{KW|_GL_NOOP}}, {{KW|_GL_INVERT}}, {{KW|_GL_AND}}, {{KW|_GL_NAND}}, {{KW|_GL_OR}}, {{KW|_GL_NOR}}, {{KW|_GL_XOR}}, {{KW|_GL_EQUIV}}, {{KW|_GL_AND_REVERSE}}, {{KW|_GL_AND_INVERTED}}, {{KW|_GL_OR_REVERSE}}, and {{KW|_GL_OR_INVERTED}}. The initial value is {{KW|_GL_COPY}}. +{{PageParameters}} +* OpenGL is using its own set of variable types to describe its command parameters. +* Use the following table to find the respective QB64 [[Variable Types]]. +{{OpenGLTypesPlugin}} {{PageDescription}} - -'''_glLogicOp''' specifies a logical operation that, when enabled, is applied between the incoming RGBA color and the RGBA color at the corresponding location in the frame buffer. To enable or disable the logical operation, call {{KW|_glEnable}} and {{KW|_glDisable}} using the symbolic constant {{KW|_GL_COLOR_LOGIC_OP}}. The initial value is disabled. - - - -{| -|+ -! '''Opcode''' -! '''Resulting Operation''' -|+ -| {{KW|_GL_CLEAR}} -| 0 -|+ -| {{KW|_GL_SET}} -| 1 -|+ -| {{KW|_GL_COPY}} -| s -|+ -| {{KW|_GL_COPY_INVERTED}} -| ~s -|+ -| {{KW|_GL_NOOP}} -| d -|+ -| {{KW|_GL_INVERT}} -| ~d -|+ -| {{KW|_GL_AND}} -| s & d -|+ -| {{KW|_GL_NAND}} -| ~(s & d) -|+ -| {{KW|_GL_OR}} -| s | d -|+ -| {{KW|_GL_NOR}} -| ~(s | d) -|+ -| {{KW|_GL_XOR}} -| s ^ d -|+ -| {{KW|_GL_EQUIV}} -| ~(s ^ d) -|+ -| {{KW|_GL_AND_REVERSE}} -| s & ~d -|+ -| {{KW|_GL_AND_INVERTED}} -| ~s & d -|+ -| {{KW|_GL_OR_REVERSE}} -| s | ~d -|+ -| {{KW|_GL_OR_INVERTED}} -| ~s | d -|} - -{{Parameter|opcode}} is a symbolic constant chosen from the list above. In the explanation of the logical operations, ''s'' represents the incoming color and ''d'' represents the color in the frame buffer. Standard C-language operators are used. As these bitwise operators suggest, the logical operation is applied independently to each bit pair of the source and destination colors. - - -{{PageNotes}} - -When more than one RGBA color buffer is enabled for drawing, logical operations are performed separately for each enabled buffer, using for the destination value the contents of that buffer (see {{KW|_glDrawBuffer}}). - -Logic operations have no effect on floating point draw buffers. However, if {{KW|_GL_COLOR_LOGIC_OP}} is enabled, blending is still disabled in this case. - - -{{PageErrors}} - -{{KW|_GL_INVALID_ENUM}} is generated if {{Parameter|opcode}} is not an accepted value. - - -{{PageUseWith}} - -{{KW|_glGet}} with argument {{KW|_GL_LOGIC_OP_MODE}}. - -{{KW|_glIsEnabled}} with argument {{KW|_GL_COLOR_LOGIC_OP}}. +* OpenGL's documentation is available in several places, so we won't reproduce it here for another time. +* The full description for this command can be found at [https://docs.microsoft.com/en-us/windows/win32/opengl/gllogicop Microsoft Docs] and is also valid for QB64 usage. {{PageSeeAlso}} - -[[_GL|SUB _GL]] -{{KW|_glEnable|(GL_COLOR_LOGIC_OP)}}, {{KW|_glDrawBuffer}}, {{KW|_glDrawBuffers}}, {{KW|_glStencilOp}} +* [[_GL|SUB _GL]] +* [[_glAlphaFunc]], [[_glBegin]], [[_glBlendFunc]], [[_glDrawBuffer]] +* [[_glEnable]], [[_glEnd]], [[_glIsEnabled]], [[_glStencilOp]] -{{PageCopyright}} - -Copyright 1991-2006 Silicon Graphics, Inc. This document is licensed under the SGI Free Software B License. For details, see [http://oss.sgi.com/projects/FreeB/ http://oss.sgi.com/projects/FreeB/]. +{{PageNavigation}} +[[Category:Final]] diff --git a/internal/help/_glPointSize__00100001000.txt b/internal/help/_glPointSize__00100001000.txt index e8478a84a..f967cebb0 100644 --- a/internal/help/_glPointSize__00100001000.txt +++ b/internal/help/_glPointSize__00100001000.txt @@ -1,57 +1,29 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:21:51}} -'''_glPointSize:''' specify the diameter of rasterized points +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:51:05}} +{{DISPLAYTITLE:_glPointSize}} +The '''_glPointSize''' statement specifies the diameter of rasterized points. {{PageSyntax}} - - SUB _glPointSize (BYVAL size AS SINGLE) - void '''_glPointSize'''(GLfloat {{Parameter|size}}); +: '''_glPointSize''' GLfloat {{Parameter|size}} -; size -: Specifies the diameter of rasterized points. The initial value is 1. +{{PageParameters}} +* OpenGL is using its own set of variable types to describe its command parameters. +* Use the following table to find the respective QB64 [[Variable Types]]. +{{OpenGLTypesPlugin}} {{PageDescription}} - -'''_glPointSize''' specifies the rasterized diameter of points. If point size mode is disabled (see {{KW|_glEnable}} with parameter {{KW|_GL_PROGRAM_POINT_SIZE}}), this value will be used to rasterize points. Otherwise, the value written to the shading language built-in variable {{code|gl_PointSize}} will be used. - - -{{PageNotes}} - -The point size specified by '''_glPointSize''' is always returned when {{KW|_GL_POINT_SIZE}} is queried. Clamping and rounding for points have no effect on the specified value. - - -{{PageErrors}} - -{{KW|_GL_INVALID_VALUE}} is generated if {{Parameter|size}} is less than or equal to 0. - - -{{PageUseWith}} - -{{KW|_glGet}} with argument {{KW|_GL_POINT_SIZE_RANGE}} - -{{KW|_glGet}} with argument {{KW|_GL_POINT_SIZE_GRANULARITY}} - -{{KW|_glGet}} with argument {{KW|_GL_POINT_SIZE}} - -{{KW|_glGet}} with argument {{KW|_GL_POINT_SIZE_MIN}} - -{{KW|_glGet}} with argument {{KW|_GL_POINT_SIZE_MAX}} - -{{KW|_glGet}} with argument {{KW|_GL_POINT_FADE_THRESHOLD_SIZE}} - -{{KW|_glIsEnabled}} with argument {{KW|_GL_PROGRAM_POINT_SIZE}} +* OpenGL's documentation is available in several places, so we won't reproduce it here for another time. +* The full description for this command can be found at [https://docs.microsoft.com/en-us/windows/win32/opengl/glpointsize Microsoft Docs] and is also valid for QB64 usage. {{PageSeeAlso}} - -[[_GL|SUB _GL]] -{{KW|_glEnable|(GL_PROGRAM_POINT_SIZE)}}, {{KW|_glPointParameter}} +* [[_GL|SUB _GL]] +* [[_glBegin]], [[_glEnable]], [[_glEnd]], [[_glIsEnabled]] -{{PageCopyright}} - -Copyright 1991-2006 Silicon Graphics, Inc. This document is licensed under the SGI Free Software B License. For details, see [http://oss.sgi.com/projects/FreeB/ http://oss.sgi.com/projects/FreeB/]. +{{PageNavigation}} +[[Category:Final]] diff --git a/internal/help/_glPolygonMode__0010000001000.txt b/internal/help/_glPolygonMode__0010000001000.txt index bc3cc4ec0..067ec2f2b 100644 --- a/internal/help/_glPolygonMode__0010000001000.txt +++ b/internal/help/_glPolygonMode__0010000001000.txt @@ -1,59 +1,30 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:21:53}} -'''_glPolygonMode:''' select a polygon rasterization mode +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:51:07}} +{{DISPLAYTITLE:_glPolygonMode}} +The '''_glPolygonMode''' statement selects a polygon rasterization mode. {{PageSyntax}} - - SUB _glPolygonMode (BYVAL face AS _UNSIGNED LONG, BYVAL mode AS _UNSIGNED LONG) - void '''_glPolygonMode'''(GLenum {{Parameter|face}}, GLenum {{Parameter|mode}}); +: '''_glPolygonMode''' GLenum {{Parameter|face}}, GLenum {{Parameter|mode}} -; face -: Specifies the polygons that {{Parameter|mode}} applies to. Must be {{KW|_GL_FRONT_AND_BACK}} for front- and back-facing polygons. -; mode -: Specifies how polygons will be rasterized. Accepted values are {{KW|_GL_POINT}}, {{KW|_GL_LINE}}, and {{KW|_GL_FILL}}. The initial value is {{KW|_GL_FILL}} for both front- and back-facing polygons. +{{PageParameters}} +* OpenGL is using its own set of variable types to describe its command parameters. +* Use the following table to find the respective QB64 [[Variable Types]]. +{{OpenGLTypesPlugin}} {{PageDescription}} - -'''_glPolygonMode''' controls the interpretation of polygons for rasterization. {{Parameter|face}} describes which polygons {{Parameter|mode}} applies to: both front and back-facing polygons ({{KW|_GL_FRONT_AND_BACK}}). The polygon mode affects only the final rasterization of polygons. In particular, a polygon's vertices are lit and the polygon is clipped and possibly culled before these modes are applied. - -Three modes are defined and can be specified in {{Parameter|mode}}: - -; {{KW|_GL_POINT}} -: Polygon vertices that are marked as the start of a boundary edge are drawn as points. Point attributes such as {{KW|_GL_POINT_SIZE}} and {{KW|_GL_POINT_SMOOTH}} control the rasterization of the points. Polygon rasterization attributes other than {{KW|_GL_POLYGON_MODE}} have no effect. -; {{KW|_GL_LINE}} -: Boundary edges of the polygon are drawn as line segments. Line attributes such as {{KW|_GL_LINE_WIDTH}} and {{KW|_GL_LINE_SMOOTH}} control the rasterization of the lines. Polygon rasterization attributes other than {{KW|_GL_POLYGON_MODE}} have no effect. -; {{KW|_GL_FILL}} -: The interior of the polygon is filled. Polygon attributes such as {{KW|_GL_POLYGON_SMOOTH}} control the rasterization of the polygon. -== Examples == - -To draw a surface with outlined polygons, call {{InlineCode}}glPolygonMode(, ){{InlineCodeEnd}} - - -{{PageNotes}} - -Vertices are marked as boundary or nonboundary with an edge flag. Edge flags are generated internally by the GL when it decomposes triangle stips and fans. - - -{{PageErrors}} - -{{KW|_GL_INVALID_ENUM}} is generated if either {{Parameter|face}} or {{Parameter|mode}} is not an accepted value. - - -{{PageUseWith}} - -{{KW|_glGet}} with argument {{KW|_GL_POLYGON_MODE}} +* OpenGL's documentation is available in several places, so we won't reproduce it here for another time. +* The full description for this command can be found at [https://docs.microsoft.com/en-us/windows/win32/opengl/glpolygonmode Microsoft Docs] and is also valid for QB64 usage. {{PageSeeAlso}} - -[[_GL|SUB _GL]] -{{KW|_glLineWidth}}, {{KW|_glPointSize}} +* [[_GL|SUB _GL]] +* [[_glBegin]], [https://docs.microsoft.com/en-us/windows/win32/opengl/gledgeflag-functions _glEdgeFlag], [[_glEnd]], [[_glLineStipple]] +* [[_glLineWidth]], [[_glPointSize]], [[_glPolygonStipple]] -{{PageCopyright}} - -Copyright 1991-2006 Silicon Graphics, Inc. This document is licensed under the SGI Free Software B License. For details, see [http://oss.sgi.com/projects/FreeB/ http://oss.sgi.com/projects/FreeB/]. +{{PageNavigation}} +[[Category:Final]] diff --git a/internal/help/_glPolygonOffset__001000000100000.txt b/internal/help/_glPolygonOffset__001000000100000.txt index 6a5e657e5..5cd012817 100644 --- a/internal/help/_glPolygonOffset__001000000100000.txt +++ b/internal/help/_glPolygonOffset__001000000100000.txt @@ -1,41 +1,30 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:21:54}} -'''_glPolygonOffset:''' set the scale and units used to calculate depth values +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:51:10}} +{{DISPLAYTITLE:_glPolygonOffset}} +The '''_glPolygonOffset''' statement sets the scale and units OpenGL uses to calculate depth values. {{PageSyntax}} - - SUB _glPolygonOffset (BYVAL factor AS SINGLE, BYVAL units AS SINGLE) - void '''_glPolygonOffset'''(GLfloat {{Parameter|factor}}, GLfloat {{Parameter|units}}); +: '''_glPolygonOffset''' GLfloat {{Parameter|factor}}, GLfloat {{Parameter|units}} -; factor -: Specifies a scale factor that is used to create a variable depth offset for each polygon. The initial value is 0. -; units -: Is multiplied by an implementation-specific value to create a constant depth offset. The initial value is 0. +{{PageParameters}} +* OpenGL is using its own set of variable types to describe its command parameters. +* Use the following table to find the respective QB64 [[Variable Types]]. +{{OpenGLTypesPlugin}} {{PageDescription}} - -When {{KW|_GL_POLYGON_OFFSET_FILL}}, {{KW|_GL_POLYGON_OFFSET_LINE}}, or {{KW|_GL_POLYGON_OFFSET_POINT}} is enabled, each fragment's ''depth'' value will be offset after it is interpolated from the ''depth'' values of the appropriate vertices. The value of the offset is ''factor'' * ''DZ'' + ''r'' * ''units'', where ''DZ'' is a measurement of the change in depth relative to the screen area of the polygon, and ''r'' is the smallest value that is guaranteed to produce a resolvable offset for a given implementation. The offset is added before the depth test is performed and before the value is written into the depth buffer. - -'''_glPolygonOffset''' is useful for rendering hidden-line images, for applying decals to surfaces, and for rendering solids with highlighted edges. - - -{{PageUseWith}} - -{{KW|_glIsEnabled}} with argument {{KW|_GL_POLYGON_OFFSET_FILL}}, {{KW|_GL_POLYGON_OFFSET_LINE}}, or {{KW|_GL_POLYGON_OFFSET_POINT}}. - -{{KW|_glGet}} with argument {{KW|_GL_POLYGON_OFFSET_FACTOR}} or {{KW|_GL_POLYGON_OFFSET_UNITS}}. +* OpenGL's documentation is available in several places, so we won't reproduce it here for another time. +* The full description for this command can be found at [https://docs.microsoft.com/en-us/windows/win32/opengl/glpolygonoffset Microsoft Docs] and is also valid for QB64 usage. {{PageSeeAlso}} - -[[_GL|SUB _GL]] -{{KW|_glDepthFunc}}, {{KW|_glEnable}} +* [[_GL|SUB _GL]] +* [[_glDepthFunc]], [[_glDisable]], [[_glEnable]], [https://docs.microsoft.com/en-us/windows/win32/opengl/glgetbooleanv--glgetdoublev--glgetfloatv--glgetintegerv _glGet] +* [[_glIsEnabled]], [[_glLineWidth]], [[_glStencilOp]], [https://docs.microsoft.com/en-us/windows/win32/opengl/gltexenv-functions _glTexEnv] -{{PageCopyright}} - -Copyright 1991-2006 Silicon Graphics, Inc. This document is licensed under the SGI Free Software B License. For details, see [http://oss.sgi.com/projects/FreeB/ http://oss.sgi.com/projects/FreeB/]. +{{PageNavigation}} +[[Category:Final]] diff --git a/internal/help/_glReadBuffer__001000100000.txt b/internal/help/_glReadBuffer__001000100000.txt index b42d794ef..49164eeeb 100644 --- a/internal/help/_glReadBuffer__001000100000.txt +++ b/internal/help/_glReadBuffer__001000100000.txt @@ -1,50 +1,30 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:22:38}} -'''_glReadBuffer:''' select a color buffer source for pixel read operations from the current read framebuffer. +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:51:50}} +{{DISPLAYTITLE:_glReadBuffer}} +The '''_glReadBuffer''' statement selects a color buffer source for pixels. {{PageSyntax}} - - SUB _glReadBuffer (BYVAL mode AS _UNSIGNED LONG) - void '''_glReadBuffer'''(GLenum {{Parameter|mode}}); +: '''_glReadBuffer''' GLenum {{Parameter|mode}} -; mode -: Specifies a color buffer. Accepted values are {{KW|_GL_FRONT_LEFT}}, {{KW|_GL_FRONT_RIGHT}}, {{KW|_GL_BACK_LEFT}}, {{KW|_GL_BACK_RIGHT}}, {{KW|_GL_FRONT}}, {{KW|_GL_BACK}}, {{KW|_GL_LEFT}}, {{KW|_GL_RIGHT}}, and the constants {{KW|_GL_COLOR_ATTACHMENT''i''}}. +{{PageParameters}} +* OpenGL is using its own set of variable types to describe its command parameters. +* Use the following table to find the respective QB64 [[Variable Types]]. +{{OpenGLTypesPlugin}} {{PageDescription}} - -'''_glReadBuffer''' specifies which color buffer within the current bound {{KW|_GL_READ_FRAMEBUFFER}} will be used as the source for pixel reading commands. These commands include: {{KW|_glBlitFramebuffer}}, {{KW|_glReadPixels}}, {{KW|_glCopyTexImage1D}}, {{KW|_glCopyTexImage2D}}, {{KW|_glCopyTexSubImage1D}}, {{KW|_glCopyTexSubImage2D}}, and {{KW|_glCopyTexSubImage3D}}. - -{{Parameter|mode}} accepts one of twelve or more predefined values. If the [[default framebuffer]] (the zero [[framebuffer object]])is bound to {{KW|_GL_READ_FRAMEBUFFER}}, then the following enumerators can be used: {{KW|_GL_FRONT}}, {{KW|_GL_LEFT}}, and {{KW|_GL_FRONT_LEFT}} all name the front left buffer, {{KW|_GL_FRONT_RIGHT}} and {{KW|_GL_RIGHT}} name the front right buffer, and {{KW|_GL_BACK_LEFT}} and {{KW|_GL_BACK}} name the back left buffer. Nonstereo double-buffered configurations have only a front left and a back left buffer. Single-buffered configurations have a front left and a front right buffer if stereo, and only a front left buffer if nonstereo. - -If a non-zero framebuffer object is bound, then the constants {{KW|_GL_COLOR_ATTACHMENT''i''}} may be used to indicate the ''i''th color attachment, where ''i'' ranges from zero to the value of {{KW|_GL_MAX_COLOR_ATTACHMENTS}} minus one. - -It is an error to specify a nonexistent buffer to '''_glReadBuffer'''. - -For the default framebuffer, {{Parameter|mode}} is initially {{KW|_GL_FRONT}} in single-buffered configurations and {{KW|_GL_BACK}} in double-buffered configurations. For framebuffer objects, the default read buffer is {{KW|_GL_COLOR_ATTACHMENT0}}. - - -{{PageErrors}} - -{{KW|_GL_INVALID_ENUM}} is generated if {{Parameter|mode}} is not one of the twelve (or more) accepted values. - -{{KW|_GL_INVALID_OPERATION}} is generated if {{Parameter|mode}} specifies a buffer that does not exist. - - -{{PageUseWith}} - -{{KW|_glGet}} with argument {{KW|_GL_READ_BUFFER}} +* OpenGL's documentation is available in several places, so we won't reproduce it here for another time. +* The full description for this command can be found at [https://docs.microsoft.com/en-us/windows/win32/opengl/glreadbuffer Microsoft Docs] and is also valid for QB64 usage. {{PageSeeAlso}} - -[[_GL|SUB _GL]] -{{KW|_glBindFramebuffer}}, {{KW|_glDrawBuffer}}, {{KW|_glDrawBuffers}}, {{KW|_glReadPixels}} +* [[_GL|SUB _GL]] +* [[_glBegin]], [[_glCopyPixels]], [[_glDrawBuffer]], [[_glEnd]] +* [[_glReadPixels]] -{{PageCopyright}} - -Copyright 1991-2006 Silicon Graphics, Inc. Copyright 2011 Khronos Group. This document is licensed under the SGI Free Software B License. For details, see [http://oss.sgi.com/projects/FreeB/ http://oss.sgi.com/projects/FreeB/]. +{{PageNavigation}} +[[Category:Final]] diff --git a/internal/help/_glReadPixels__001000100000.txt b/internal/help/_glReadPixels__001000100000.txt index 6ed756fe1..e86f1d9bb 100644 --- a/internal/help/_glReadPixels__001000100000.txt +++ b/internal/help/_glReadPixels__001000100000.txt @@ -1,204 +1,30 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:22:39}} -'''_glReadPixels:''' read a block of pixels from the frame buffer +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:51:52}} +{{DISPLAYTITLE:_glReadPixels}} +The '''_glReadPixels''' statement reads a block of pixels from the framebuffer. {{PageSyntax}} - - SUB _glReadPixels (BYVAL x AS LONG, BYVAL y AS LONG, BYVAL width AS LONG, BYVAL height AS LONG, BYVAL format AS _UNSIGNED LONG, BYVAL type AS _UNSIGNED LONG, pixels AS _OFFSET) - void '''_glReadPixels'''(GLint {{Parameter|x}}, GLint {{Parameter|y}}, GLsizei {{Parameter|width}}, GLsizei {{Parameter|height}}, GLenum {{Parameter|format}}, GLenum {{Parameter|type}}, GLvoid * {{Parameter|data}}); +: '''_glReadPixels''' GLint {{Parameter|x}}, GLint {{Parameter|y}}, GLsizei {{Parameter|width}}, GLsizei {{Parameter|height}}, GLenum {{Parameter|format}}, GLenum {{Parameter|type}}, GLvoid {{Parameter|*pixels}} -; x, y -: Specify the window coordinates of the first pixel that is read from the frame buffer. This location is the lower left corner of a rectangular block of pixels. -; width, height -: Specify the dimensions of the pixel rectangle. {{Parameter|width}} and {{Parameter|height}} of one correspond to a single pixel. -{{Template:Glapi pixeltransferupparams|read=|}} +{{PageParameters}} +* OpenGL is using its own set of variable types to describe its command parameters. +* Use the following table to find the respective QB64 [[Variable Types]]. +{{OpenGLTypesPlugin}} {{PageDescription}} - -'''_glReadPixels''' returns pixel data from the frame buffer, starting with the pixel whose lower left corner is at location ({{Parameter|x}}, {{Parameter|y}}), into client memory starting at location {{Parameter|data}}. Several parameters control the processing of the pixel data before it is placed into client memory. These parameters are set with {{KW|_glPixelStore}}. This reference page describes the effects on '''_glReadPixels''' of most, but not all of the parameters specified by these three commands. - -If a non-zero named buffer object is bound to the {{KW|_GL_PIXEL_PACK_BUFFER}} target (see {{KW|_glBindBuffer}}) while a block of pixels is requested, {{Parameter|data}} is treated as a byte offset into the buffer object's data store rather than a pointer to client memory. - -'''_glReadPixels''' returns values from each pixel with lower left corner at (''x'' + ''i'', ''y'' + ''j'') for 0 <= ''i'' < ''width'' and 0 <= ''j'' < ''height''. This pixel is said to be the ''i''th pixel in the ''j''th row. Pixels are returned in row order from the lowest to the highest row, left to right in each row. - -{{Parameter|format}} specifies the format for the returned pixel values; accepted values are: - -; {{KW|_GL_STENCIL_INDEX}} -: Stencil values are read from the stencil buffer. Each index is converted to fixed point, shifted left or right depending on the value and sign of {{KW|_GL_INDEX_SHIFT}}, and added to {{KW|_GL_INDEX_OFFSET}}. If {{KW|_GL_MAP_STENCIL}} is {{KW|_GL_TRUE}}, indices are replaced by their mappings in the table {{KW|_GL_PIXEL_MAP_S_TO_S}}. -; {{KW|_GL_DEPTH_COMPONENT}} -: Depth values are read from the depth buffer. Each component is converted to floating point such that the minimum depth value maps to 0 and the maximum value maps to 1. Each component is then multiplied by {{KW|_GL_DEPTH_SCALE}}, added to {{KW|_GL_DEPTH_BIAS}}, and finally clamped to the range [0, 1]. -; {{KW|_GL_DEPTH_STENCIL}} -: Values are taken from both the depth and stencil buffers. The {{Parameter|type}} parameter must be {{KW|_GL_UNSIGNED_INT_24_8}} or {{KW|_GL_FLOAT_32_UNSIGNED_INT_24_8_REV}}. -; {{KW|_GL_RED}} -; {{KW|_GL_GREEN}} -; {{KW|_GL_BLUE}} -; {{KW|_GL_RGB}} -; {{KW|_GL_BGR}} -; {{KW|_GL_RGBA}} -; {{KW|_GL_BGRA}} -: Finally, the indices or components are converted to the proper format, as specified by {{Parameter|type}}. If {{Parameter|format}} is {{KW|_GL_STENCIL_INDEX}} and {{Parameter|type}} is not {{KW|_GL_FLOAT}}, each index is masked with the mask value given in the following table. If {{Parameter|type}} is {{KW|_GL_FLOAT}}, then each integer index is converted to single-precision floating-point format. - -If {{Parameter|format}} is {{KW|_GL_RED}}, {{KW|_GL_GREEN}}, {{KW|_GL_BLUE}}, {{KW|_GL_RGB}}, {{KW|_GL_BGR}}, {{KW|_GL_RGBA}}, or {{KW|_GL_BGRA}} and {{Parameter|type}} is not {{KW|_GL_FLOAT}}, each component is multiplied by the multiplier shown in the following table. If type is {{KW|_GL_FLOAT}}, then each component is passed as is (or converted to the client's single-precision floating-point format if it is different from the one used by the GL). - -{| class="wikitable" -|+ -! {{Parameter|type}} -! '''Index Mask''' -! '''Component Conversion''' -|+ -| {{KW|_GL_UNSIGNED_BYTE}} -| 28 - 1 -| (2^8 - 1)c -|+ -| {{KW|_GL_BYTE}} -| 27 - 1 -| \tfrac{(2^8 - 1)c - 1}{2} -|+ -| {{KW|_GL_UNSIGNED_SHORT}} -| 216 - 1 -| (2^{16} - 1)c -|+ -| {{KW|_GL_SHORT}} -| 215 - 1 -| \tfrac{(2^{16} - 1)c - 1}{2} -|+ -| {{KW|_GL_UNSIGNED_INT}} -| 232 - 1 -| (2^{32} - 1)c -|+ -| {{KW|_GL_INT}} -| 231 - 1 -| \tfrac{(2^{32} - 1)c - 1}{2} -|+ -| {{KW|_GL_HALF_FLOAT}} -| none -| ''c'' -|+ -| {{KW|_GL_FLOAT}} -| none -| ''c'' -|+ -| {{KW|_GL_UNSIGNED_BYTE_3_3_2}} -| 2N - 1 -| (2^N - 1)c -|+ -| {{KW|_GL_UNSIGNED_BYTE_2_3_3_REV}} -| 2N - 1 -| (2^N - 1)c -|+ -| {{KW|_GL_UNSIGNED_SHORT_5_6_5}} -| 2N - 1 -| (2^N - 1)c -|+ -| {{KW|_GL_UNSIGNED_SHORT_5_6_5_REV}} -| 2N - 1 -| (2^N - 1)c -|+ -| {{KW|_GL_UNSIGNED_SHORT_4_4_4_4}} -| 2N - 1 -| (2^N - 1)c -|+ -| {{KW|_GL_UNSIGNED_SHORT_4_4_4_4_REV}} -| 2N - 1 -| (2^N - 1)c -|+ -| {{KW|_GL_UNSIGNED_SHORT_5_5_5_1}} -| 2N - 1 -| (2^N - 1)c -|+ -| {{KW|_GL_UNSIGNED_SHORT_1_5_5_5_REV}} -| 2N - 1 -| (2^N - 1)c -|+ -| {{KW|_GL_UNSIGNED_INT_8_8_8_8}} -| 2N - 1 -| (2^N - 1)c -|+ -| {{KW|_GL_UNSIGNED_INT_8_8_8_8_REV}} -| 2N - 1 -| (2^N - 1)c -|+ -| {{KW|_GL_UNSIGNED_INT_10_10_10_2}} -| 2N - 1 -| (2^N - 1)c -|+ -| {{KW|_GL_UNSIGNED_INT_2_10_10_10_REV}} -| 2N - 1 -| (2^N - 1)c -|+ -| {{KW|_GL_UNSIGNED_INT_24_8}} -| 2N - 1 -| (2^N - 1)c -|+ -| {{KW|_GL_UNSIGNED_INT_10F_11F_11F_REV}} -| -- -| Special -|+ -| {{KW|_GL_UNSIGNED_INT_5_9_9_9_REV}} -| -- -| Special -|+ -| {{KW|_GL_FLOAT_32_UNSIGNED_INT_24_8_REV}} -| none -| ''c'' (Depth Only) -|} - -Return values are placed in memory as follows. If {{Parameter|format}} is {{KW|_GL_STENCIL_INDEX}}, {{KW|_GL_DEPTH_COMPONENT}}, {{KW|_GL_RED}}, {{KW|_GL_GREEN}}, or {{KW|_GL_BLUE}}, a single value is returned and the data for the ''i''th pixel in the ''j''th row is placed in location ''j'' * ''width'' + ''i''. {{KW|_GL_RGB}} and {{KW|_GL_BGR}} return three values, {{KW|_GL_RGBA}} and {{KW|_GL_BGRA}} return four values for each pixel, with all values corresponding to a single pixel occupying contiguous space in {{Parameter|data}}. Storage parameters set by {{KW|_glPixelStore}}, such as {{KW|_GL_PACK_LSB_FIRST}} and {{KW|_GL_PACK_SWAP_BYTES}}, affect the way that data is written into memory. See {{KW|_glPixelStore}} for a description. - - -{{PageNotes}} - -Values for pixels that lie outside the window connected to the current GL context are undefined. - -If an error is generated, no change is made to the contents of {{Parameter|data}}. - - -{{PageErrors}} - -{{KW|_GL_INVALID_ENUM}} is generated if {{Parameter|format}} or {{Parameter|type}} is not an accepted value. - -{{KW|_GL_INVALID_VALUE}} is generated if either {{Parameter|width}} or {{Parameter|height}} is negative. - -{{KW|_GL_INVALID_OPERATION}} is generated if {{Parameter|format}} is {{KW|_GL_STENCIL_INDEX}} and there is no stencil buffer. - -{{KW|_GL_INVALID_OPERATION}} is generated if {{Parameter|format}} is {{KW|_GL_DEPTH_COMPONENT}} and there is no depth buffer. - -{{KW|_GL_INVALID_OPERATION}} is generated if {{Parameter|format}} is {{KW|_GL_DEPTH_STENCIL}} and there is no depth buffer or if there is no stencil buffer. - -{{KW|_GL_INVALID_ENUM}} is generated if {{Parameter|format}} is {{KW|_GL_DEPTH_STENCIL}} and {{Parameter|type}} is not {{KW|_GL_UNSIGNED_INT_24_8}} or {{KW|_GL_FLOAT_32_UNSIGNED_INT_24_8_REV}}. - -{{KW|_GL_INVALID_OPERATION}} is generated if {{Parameter|type}} is one of {{KW|_GL_UNSIGNED_BYTE_3_3_2}}, {{KW|_GL_UNSIGNED_BYTE_2_3_3_REV}}, {{KW|_GL_UNSIGNED_SHORT_5_6_5}}, or {{KW|_GL_UNSIGNED_SHORT_5_6_5_REV}} and {{Parameter|format}} is not {{KW|_GL_RGB}}. - -{{KW|_GL_INVALID_OPERATION}} is generated if {{Parameter|type}} is one of {{KW|_GL_UNSIGNED_SHORT_4_4_4_4}}, {{KW|_GL_UNSIGNED_SHORT_4_4_4_4_REV}}, {{KW|_GL_UNSIGNED_SHORT_5_5_5_1}}, {{KW|_GL_UNSIGNED_SHORT_1_5_5_5_REV}}, {{KW|_GL_UNSIGNED_INT_8_8_8_8}}, {{KW|_GL_UNSIGNED_INT_8_8_8_8_REV}}, {{KW|_GL_UNSIGNED_INT_10_10_10_2}}, or {{KW|_GL_UNSIGNED_INT_2_10_10_10_REV}} and {{Parameter|format}} is neither {{KW|_GL_RGBA}} nor {{KW|_GL_BGRA}}. - -{{KW|_GL_INVALID_OPERATION}} is generated if a non-zero buffer object name is bound to the {{KW|_GL_PIXEL_PACK_BUFFER}} target and the buffer object's data store is currently mapped. - -{{KW|_GL_INVALID_OPERATION}} is generated if a non-zero buffer object name is bound to the {{KW|_GL_PIXEL_PACK_BUFFER}} target and the data would be packed to the buffer object such that the memory writes required would exceed the data store size. - -{{KW|_GL_INVALID_OPERATION}} is generated if a non-zero buffer object name is bound to the {{KW|_GL_PIXEL_PACK_BUFFER}} target and {{Parameter|data}} is not evenly divisible into the number of bytes needed to store in memory a datum indicated by {{Parameter|type}}. - -{{KW|_GL_INVALID_OPERATION}} is generated if {{KW|_GL_READ_FRAMEBUFFER_BINDING}} is non-zero, the read framebuffer is complete, and the value of {{KW|_GL_SAMPLE_BUFFERS}} for the read framebuffer is greater than zero. - - -{{PageUseWith}} - -{{KW|_glGet}} with argument {{KW|_GL_INDEX_MODE}} - -{{KW|_glGet}} with argument {{KW|_GL_PIXEL_PACK_BUFFER_BINDING}} +* OpenGL's documentation is available in several places, so we won't reproduce it here for another time. +* The full description for this command can be found at [https://docs.microsoft.com/en-us/windows/win32/opengl/glreadpixels Microsoft Docs] and is also valid for QB64 usage. {{PageSeeAlso}} - -[[_GL|SUB _GL]] -{{KW|_glBindFramebuffer}}, {{KW|_glClampColor}}, {{KW|_glDrawBuffers}}, {{KW|_glDrawBuffers}}, {{KW|_glPixelStore}} - -[[Pixel Transfer]], [[Pixel Buffer Object]] +* [[_GL|SUB _GL]] +* [[_glBegin]], [[_glCopyPixels]], [[_glDrawPixels]], [[_glEnd]] +* [https://docs.microsoft.com/en-us/windows/win32/opengl/glpixelmap _glPixelMap], [https://docs.microsoft.com/en-us/windows/win32/opengl/glpixelstore-functions _glPixelStore], [https://docs.microsoft.com/en-us/windows/win32/opengl/glpixeltransfer _glPixelTransfer], [[_glReadBuffer]] -{{PageCopyright}} - -Copyright 1991-2006 Silicon Graphics, Inc. This document is licensed under the SGI Free Software B License. For details, see [http://oss.sgi.com/projects/FreeB/ http://oss.sgi.com/projects/FreeB/]. +{{PageNavigation}} +[[Category:Final]] diff --git a/internal/help/_glScissor__001000000.txt b/internal/help/_glScissor__001000000.txt index 397afc469..654f63a72 100644 --- a/internal/help/_glScissor__001000000.txt +++ b/internal/help/_glScissor__001000000.txt @@ -1,47 +1,30 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:22:58}} +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:52:09}} {{DISPLAYTITLE:_glScissor}} -This will define the scissor box. +The '''_glScissor''' statement defines the scissor box. {{PageSyntax}} -; QB64: SUB [[_glScissor]] (BYVAL {{Parameter|x}} AS LONG, BYVAL {{Parameter|y}} AS LONG, BYVAL {{Parameter|width}} AS LONG, BYVAL {{Parameter|height}}) AS LONG) -; C/C++: void [[_glScissor]](GLint {{Parameter|x}}, GLint {{Parameter|y}}, GLsizei {{Parameter|width}}, GLsizei {{Parameter|height}}); +: '''_glScissor''' GLint {{Parameter|x}}, GLint {{Parameter|y}}, GLsizei {{Parameter|width}}, GLsizei {{Parameter|height}} {{PageParameters}} -* {{Parameter|x}}, {{Parameter|y}} Specify the lower left corner of the scissor box. Initially (0, 0). -* {{Parameter|width}}, {{Parameter|height}} Specify the width and height of the scissor box. When a GL context is first attached to a window, {{Parameter|width}} and {{Parameter|height}} are set to the dimensions of that window. +* OpenGL is using its own set of variable types to describe its command parameters. +* Use the following table to find the respective QB64 [[Variable Types]]. +{{OpenGLTypesPlugin}} {{PageDescription}} - -'''_glScissor''' defines a rectangle, called the scissor box, in window coordinates. The first two arguments, {{Parameter|x}} and {{Parameter|y}}, specify the lower left corner of the box. {{Parameter|width}} and {{Parameter|height}} specify the width and height of the box. - -To enable and disable the scissor test, call {{KW|_glEnable}} and {{KW|_glDisable}} with argument {{KW|_GL_SCISSOR_TEST}}. The test is initially disabled. While the test is enabled, only pixels that lie within the scissor box can be modified by drawing commands. Window coordinates have integer values at the shared corners of frame buffer pixels. {{InlineCode}}_glScissor(0,0,1,1){{InlineCodeEnd}} allows modification of only the lower left pixel in the window, and {{InlineCode}}_glScissor(0,0,0,0){{InlineCodeEnd}} doesn't allow modification of any pixels in the window. - -When the scissor test is disabled, it is as though the scissor box includes the entire window. - - -{{PageErrors}} -* {{KW|_GL_INVALID_VALUE}} is generated if either {{Parameter|width}} or {{Parameter|height}} is negative. - - -{{PageUseWith}} -* {{KW|_glGet}} with argument {{KW|_GL_SCISSOR_BOX}} -* {{KW|_glIsEnabled}} with argument {{KW|_GL_SCISSOR_TEST}} +* OpenGL's documentation is available in several places, so we won't reproduce it here for another time. +* The full description for this command can be found at [https://docs.microsoft.com/en-us/windows/win32/opengl/glscissor Microsoft Docs] and is also valid for QB64 usage. {{PageSeeAlso}} * [[_GL|SUB _GL]] -* {{KW|_glEnable|(GL_SCISSOR_TEST)}} -* {{KW|_glScissorArray}} -* {{KW|_glScissorIndexed}} -* {{KW|_glViewport}} - - -{{PageCopyright}} +* [[_glBegin]], [[_glEnable]], [[_glEnd]], [[_glIsEnabled]] +* [[_glViewport]] {{PageNavigation}} +[[Category:Final]] diff --git a/internal/help/_glStencilFunc__0010000001000.txt b/internal/help/_glStencilFunc__0010000001000.txt index e07e4d70f..240a7d2fe 100644 --- a/internal/help/_glStencilFunc__0010000001000.txt +++ b/internal/help/_glStencilFunc__0010000001000.txt @@ -1,80 +1,31 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:23:02}} -'''_glStencilFunc:''' set front and back function and reference value for stencil testing +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:52:14}} +{{DISPLAYTITLE:_glStencilFunc}} +The '''_glStencilFunc''' statement sets the statement and reference value for stencil testing. {{PageSyntax}} - - SUB _glStencilFunc (BYVAL func AS _UNSIGNED LONG, BYVAL ref AS LONG, BYVAL mask AS _UNSIGNED LONG) - void '''_glStencilFunc'''(GLenum {{Parameter|func}}, GLint {{Parameter|ref}}, GLuint {{Parameter|mask}}); +: '''_glStencilFunc''' GLenum {{Parameter|func}}, GLint {{Parameter|ref}}, GLuint {{Parameter|mask}} -; func -: Specifies the test function. Eight symbolic constants are valid: {{KW|_GL_NEVER}}, {{KW|_GL_LESS}}, {{KW|_GL_LEQUAL}}, {{KW|_GL_GREATER}}, {{KW|_GL_GEQUAL}}, {{KW|_GL_EQUAL}}, {{KW|_GL_NOTEQUAL}}, and {{KW|_GL_ALWAYS}}. The initial value is {{KW|_GL_ALWAYS}}. -; ref -: Specifies the reference value for the stencil test. {{Parameter|ref}} is clamped to the range [0, 2n - 1, where ''n'' is the number of bitplanes in the stencil buffer. The initial value is 0. -; mask -: Specifies a mask that is ANDed with both the reference value and the stored stencil value when the test is done. The initial value is all 1's. +{{PageParameters}} +* OpenGL is using its own set of variable types to describe its command parameters. +* Use the following table to find the respective QB64 [[Variable Types]]. +{{OpenGLTypesPlugin}} {{PageDescription}} - -Stenciling, like depth-buffering, enables and disables drawing on a per-pixel basis. Stencil planes are first drawn into using GL drawing primitives, then geometry and images are rendered using the stencil planes to mask out portions of the screen. Stenciling is typically used in multipass rendering algorithms to achieve special effects, such as decals, outlining, and constructive solid geometry rendering. - -The stencil test conditionally eliminates a pixel based on the outcome of a comparison between the reference value and the value in the stencil buffer. To enable and disable the test, call {{KW|_glEnable}} and {{KW|_glDisable}} with argument {{KW|_GL_STENCIL_TEST}}. To specify actions based on the outcome of the stencil test, call {{KW|_glStencilOp}} or {{KW|_glStencilOpSeparate}}. - -There can be two separate sets of {{Parameter|func}}, {{Parameter|ref}}, and {{Parameter|mask}} parameters; one affects back-facing polygons, and the other affects front-facing polygons as well as other non-polygon primitives. {{KW|_glStencilFunc}} sets both front and back stencil state to the same values. Use {{KW|_glStencilFuncSeparate}} to set front and back stencil state to different values. - -{{Parameter|func}} is a symbolic constant that determines the stencil comparison function. It accepts one of eight values, shown in the following list. {{Parameter|ref}} is an integer reference value that is used in the stencil comparison. It is clamped to the range [0, 2n - 1], where ''n'' is the number of bitplanes in the stencil buffer. {{Parameter|mask}} is bitwise ANDed with both the reference value and the stored stencil value, with the ANDed values participating in the comparison. - -If ''stencil'' represents the value stored in the corresponding stencil buffer location, the following list shows the effect of each comparison function that can be specified by {{Parameter|func}}. Only if the comparison succeeds is the pixel passed through to the next stage in the rasterization process (see {{KW|_glStencilOp}}). All tests treat ''stencil'' values as unsigned integers in the range [0, 2n - 1], where ''n'' is the number of bitplanes in the stencil buffer. - -The following values are accepted by {{Parameter|func}}: - -; {{KW|_GL_NEVER}} -: Always fails. -; {{KW|_GL_LESS}} -: Passes if ( {{Parameter|ref}} & {{Parameter|mask}} ) < ( ''stencil'' & {{Parameter|mask}} ). -; {{KW|_GL_LEQUAL}} -: Passes if ( {{Parameter|ref}} & {{Parameter|mask}} ) <= ( ''stencil'' & {{Parameter|mask}} ). -; {{KW|_GL_GREATER}} -: Passes if ( {{Parameter|ref}} & {{Parameter|mask}} ) > ( ''stencil'' & {{Parameter|mask}} ). -; {{KW|_GL_GEQUAL}} -: Passes if ( {{Parameter|ref}} & {{Parameter|mask}} ) >= ( ''stencil'' & {{Parameter|mask}} ). -; {{KW|_GL_EQUAL}} -: Passes if ( {{Parameter|ref}} & {{Parameter|mask}} ) = ( ''stencil'' & {{Parameter|mask}} ). -; {{KW|_GL_NOTEQUAL}} -: Passes if ( {{Parameter|ref}} & {{Parameter|mask}} ) != ( ''stencil'' & {{Parameter|mask}} ). -; {{KW|_GL_ALWAYS}} -: Always passes. - -{{PageNotes}} - -Initially, the stencil test is disabled. If there is no stencil buffer, no stencil modification can occur and it is as if the stencil test always passes. - -{{KW|_glStencilFunc}} is the same as calling {{KW|_glStencilFuncSeparate}} with {{Parameter|face}} set to {{KW|_GL_FRONT_AND_BACK}}. - - -{{PageErrors}} - -{{KW|_GL_INVALID_ENUM}} is generated if {{Parameter|func}} is not one of the eight accepted values. - - -{{PageUseWith}} - -{{KW|_glGet}} with argument {{KW|_GL_STENCIL_FUNC}}, {{KW|_GL_STENCIL_VALUE_MASK}}, {{KW|_GL_STENCIL_REF}}, {{KW|_GL_STENCIL_BACK_FUNC}}, {{KW|_GL_STENCIL_BACK_VALUE_MASK}}, {{KW|_GL_STENCIL_BACK_REF}}, or {{KW|_GL_STENCIL_BITS}} - -{{KW|_glIsEnabled}} with argument {{KW|_GL_STENCIL_TEST}} +* OpenGL's documentation is available in several places, so we won't reproduce it here for another time. +* The full description for this command can be found at [https://docs.microsoft.com/en-us/windows/win32/opengl/glstencilfunc Microsoft Docs] and is also valid for QB64 usage. {{PageSeeAlso}} - -[[_GL|SUB _GL]] -{{KW|_glEnable|(GL_STENCIL_TEST)}}, {{KW|_glLogicOp}}, {{KW|_glStencilFuncSeparate}}, {{KW|_glStencilMask}}, {{KW|_glStencilMaskSeparate}}, {{KW|_glStencilOp}}, {{KW|_glStencilOpSeparate}} - - -{{PageCopyright}} +* [[_GL|SUB _GL]] +* [[_glAlphaFunc]], [[_glBegin]], [[_glBlendFunc]], [[_glDepthFunc]] +* [[_glEnable]], [[_glEnd]], [[_glIsEnabled]], [[_glLogicOp]] +* [[_glStencilOp]] {{PageNavigation}} +[[Category:Final]] diff --git a/internal/help/_glStencilMask__0010000001000.txt b/internal/help/_glStencilMask__0010000001000.txt index 2ff9bc056..ddcb329b6 100644 --- a/internal/help/_glStencilMask__0010000001000.txt +++ b/internal/help/_glStencilMask__0010000001000.txt @@ -1,43 +1,30 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:23:03}} -'''_glStencilMask:''' control the front and back writing of individual bits in the stencil planes +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:52:16}} +{{DISPLAYTITLE:_glStencilMask}} +The '''_glStencilMask''' statement controls the writing of individual bits in the stencil planes. {{PageSyntax}} - - SUB _glStencilMask (BYVAL mask AS _UNSIGNED LONG) - void '''_glStencilMask'''(GLuint {{Parameter|mask}}); +: '''_glStencilMask''' GLuint {{Parameter|mask}} -; mask -: Specifies a bit mask to enable and disable writing of individual bits in the stencil planes. Initially, the mask is all 1's. +{{PageParameters}} +* OpenGL is using its own set of variable types to describe its command parameters. +* Use the following table to find the respective QB64 [[Variable Types]]. +{{OpenGLTypesPlugin}} {{PageDescription}} - -'''_glStencilMask''' controls the writing of individual bits in the stencil planes. The least significant ''n'' bits of {{Parameter|mask}}, where ''n'' is the number of bits in the stencil buffer, specify a mask. Where a 1 appears in the mask, it's possible to write to the corresponding bit in the stencil buffer. Where a 0 appears, the corresponding bit is write-protected. Initially, all bits are enabled for writing. - -There can be two separate {{Parameter|mask}} writemasks; one affects back-facing polygons, and the other affects front-facing polygons as well as other non-polygon primitives. {{KW|_glStencilMask}} sets both front and back stencil writemasks to the same values. Use {{KW|_glStencilMaskSeparate}} to set front and back stencil writemasks to different values. - - -{{PageNotes}} - -{{KW|_glStencilMask}} is the same as calling {{KW|_glStencilMaskSeparate}} with {{Parameter|face}} set to {{KW|_GL_FRONT_AND_BACK}}. - - -{{PageUseWith}} - -{{KW|_glGet}} with argument {{KW|_GL_STENCIL_WRITEMASK}}, {{KW|_GL_STENCIL_BACK_WRITEMASK}}, or {{KW|_GL_STENCIL_BITS}} +* OpenGL's documentation is available in several places, so we won't reproduce it here for another time. +* The full description for this command can be found at [https://docs.microsoft.com/en-us/windows/win32/opengl/glstencilmask Microsoft Docs] and is also valid for QB64 usage. {{PageSeeAlso}} - -[[_GL|SUB _GL]] -{{KW|_glClear}}, {{KW|_glClearBuffer}}, {{KW|_glColorMask}}, {{KW|_glDepthMask}}, {{KW|_glStencilFunc}}, {{KW|_glStencilFuncSeparate}}, {{KW|_glStencilMaskSeparate}}, {{KW|_glStencilOp}}, {{KW|_glStencilOpSeparate}} - - -{{PageCopyright}} +* [[_GL|SUB _GL]] +* [[_glBegin]], [[_glColorMask]], [[_glDepthMask]], [[_glEnd]] +* [[_glIndexMask]], [[_glStencilFunc]], [[_glStencilOp]] {{PageNavigation}} +[[Category:Final]] diff --git a/internal/help/_glStencilOp__00100000010.txt b/internal/help/_glStencilOp__00100000010.txt index 031ec33b9..71be2fd5e 100644 --- a/internal/help/_glStencilOp__00100000010.txt +++ b/internal/help/_glStencilOp__00100000010.txt @@ -1,80 +1,31 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:23:04}} -'''_glStencilOp:''' set front and back stencil test actions +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:52:18}} +{{DISPLAYTITLE:_glStencilOp}} +The '''_glStencilOp''' statement sets the stencil test actions. {{PageSyntax}} - - SUB _glStencilOp (BYVAL fail AS _UNSIGNED LONG, BYVAL zfail AS _UNSIGNED LONG, BYVAL zpass AS _UNSIGNED LONG) - void '''_glStencilOp'''(GLenum {{Parameter|sfail}}, GLenum {{Parameter|dpfail}}, GLenum {{Parameter|dppass}}); +: '''_glStencilOp''' GLenum {{Parameter|fail}}, GLenum {{Parameter|zfail}}, GLenum {{Parameter|zpass}} -; sfail -: Specifies the action to take when the stencil test fails. Eight symbolic constants are accepted: {{KW|_GL_KEEP}}, {{KW|_GL_ZERO}}, {{KW|_GL_REPLACE}}, {{KW|_GL_INCR}}, {{KW|_GL_INCR_WRAP}}, {{KW|_GL_DECR}}, {{KW|_GL_DECR_WRAP}}, and {{KW|_GL_INVERT}}. The initial value is {{KW|_GL_KEEP}}. -; dpfail -: Specifies the stencil action when the stencil test passes, but the depth test fails. {{Parameter|dpfail}} accepts the same symbolic constants as {{Parameter|sfail}}. The initial value is {{KW|_GL_KEEP}}. -; dppass -: Specifies the stencil action when both the stencil test and the depth test pass, or when the stencil test passes and either there is no depth buffer or depth testing is not enabled. {{Parameter|dppass}} accepts the same symbolic constants as {{Parameter|sfail}}. The initial value is {{KW|_GL_KEEP}}. +{{PageParameters}} +* OpenGL is using its own set of variable types to describe its command parameters. +* Use the following table to find the respective QB64 [[Variable Types]]. +{{OpenGLTypesPlugin}} {{PageDescription}} - -Stenciling, like depth-buffering, enables and disables drawing on a per-pixel basis. You draw into the stencil planes using GL drawing primitives, then render geometry and images, using the stencil planes to mask out portions of the screen. Stenciling is typically used in multipass rendering algorithms to achieve special effects, such as decals, outlining, and constructive solid geometry rendering. - -The stencil test conditionally eliminates a pixel based on the outcome of a comparison between the value in the stencil buffer and a reference value. To enable and disable the test, call {{KW|_glEnable}} and {{KW|_glDisable}} with argument {{KW|_GL_STENCIL_TEST}}; to control it, call {{KW|_glStencilFunc}} or {{KW|_glStencilFuncSeparate}}. - -There can be two separate sets of {{Parameter|sfail}}, {{Parameter|dpfail}}, and {{Parameter|dppass}} parameters; one affects back-facing polygons, and the other affects front-facing polygons as well as other non-polygon primitives. {{KW|_glStencilOp}} sets both front and back stencil state to the same values. Use {{KW|_glStencilOpSeparate}} to set front and back stencil state to different values. - -'''_glStencilOp''' takes three arguments that indicate what happens to the stored stencil value while stenciling is enabled. If the stencil test fails, no change is made to the pixel's color or depth buffers, and {{Parameter|sfail}} specifies what happens to the stencil buffer contents. The following eight actions are possible. - -; {{KW|_GL_KEEP}} -: Keeps the current value. -; {{KW|_GL_ZERO}} -: Sets the stencil buffer value to 0. -; {{KW|_GL_REPLACE}} -: Sets the stencil buffer value to ''ref'', as specified by {{KW|_glStencilFunc}}. -; {{KW|_GL_INCR}} -: Increments the current stencil buffer value. Clamps to the maximum representable unsigned value. -; {{KW|_GL_INCR_WRAP}} -: Increments the current stencil buffer value. Wraps stencil buffer value to zero when incrementing the maximum representable unsigned value. -; {{KW|_GL_DECR}} -: Decrements the current stencil buffer value. Clamps to 0. -; {{KW|_GL_DECR_WRAP}} -: Decrements the current stencil buffer value. Wraps stencil buffer value to the maximum representable unsigned value when decrementing a stencil buffer value of zero. -; {{KW|_GL_INVERT}} -: Bitwise inverts the current stencil buffer value. -Stencil buffer values are treated as unsigned integers. When incremented and decremented, values are clamped to 0 and 2n - 1, where ''n'' is the value returned by querying {{KW|_GL_STENCIL_BITS}}. - -The other two arguments to '''_glStencilOp''' specify stencil buffer actions that depend on whether subsequent depth buffer tests succeed ({{Parameter|dppass}}) or fail ({{Parameter|dpfail}}) (see {{KW|_glDepthFunc}}). The actions are specified using the same eight symbolic constants as {{Parameter|sfail}}. Note that {{Parameter|dpfail}} is ignored when there is no depth buffer, or when the depth buffer is not enabled. In these cases, {{Parameter|sfail}} and {{Parameter|dppass}} specify stencil action when the stencil test fails and passes, respectively. - - -{{PageNotes}} - -Initially the stencil test is disabled. If there is no stencil buffer, no stencil modification can occur and it is as if the stencil tests always pass, regardless of any call to '''_glStencilOp'''. - -{{KW|_glStencilOp}} is the same as calling {{KW|_glStencilOpSeparate}} with {{Parameter|face}} set to {{KW|_GL_FRONT_AND_BACK}}. - - -{{PageErrors}} - -{{KW|_GL_INVALID_ENUM}} is generated if {{Parameter|sfail}}, {{Parameter|dpfail}}, or {{Parameter|dppass}} is any value other than the defined constant values. - - -{{PageUseWith}} - -{{KW|_glGet}} with argument {{KW|_GL_STENCIL_FAIL}}, {{KW|_GL_STENCIL_PASS_DEPTH_PASS}}, {{KW|_GL_STENCIL_PASS_DEPTH_FAIL}}, {{KW|_GL_STENCIL_BACK_FAIL}}, {{KW|_GL_STENCIL_BACK_PASS_DEPTH_PASS}}, {{KW|_GL_STENCIL_BACK_PASS_DEPTH_FAIL}}, or {{KW|_GL_STENCIL_BITS}} - -{{KW|_glIsEnabled}} with argument {{KW|_GL_STENCIL_TEST}} +* OpenGL's documentation is available in several places, so we won't reproduce it here for another time. +* The full description for this command can be found at [https://docs.microsoft.com/en-us/windows/win32/opengl/glstencilop Microsoft Docs] and is also valid for QB64 usage. {{PageSeeAlso}} - -[[_GL|SUB _GL]] -{{KW|_glBlendFunc}}, {{KW|_glDepthFunc}}, {{KW|_glEnable}}, {{KW|_glLogicOp}}, {{KW|_glStencilFunc}}, {{KW|_glStencilFuncSeparate}}, {{KW|_glStencilMask}}, {{KW|_glStencilMaskSeparate}}, {{KW|_glStencilOpSeparate}} - - -{{PageCopyright}} +* [[_GL|SUB _GL]] +* [[_glAlphaFunc]], [[_glBegin]], [[_glBlendFunc]], [[_glDepthFunc]] +* [[_glEnable]], [[_glEnd]], [[_glIsEnabled]], [[_glLogicOp]] +* [[_glStencilFunc]] {{PageNavigation}} +[[Category:Final]] diff --git a/internal/help/_glTexImage1D__001001000011.txt b/internal/help/_glTexImage1D__001001000011.txt index fa246c220..f6663fbcc 100644 --- a/internal/help/_glTexImage1D__001001000011.txt +++ b/internal/help/_glTexImage1D__001001000011.txt @@ -1,139 +1,33 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:23:54}} -'''_glTexImage1D:''' specify a one-dimensional texture image +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:53:07}} +{{DISPLAYTITLE:_glTexImage1D}} +The '''_glTexImage1D''' statement specifies a one-dimensional texture image. {{PageSyntax}} - - SUB _glTexImage1D (BYVAL target AS _UNSIGNED LONG, BYVAL level AS LONG, BYVAL internalformat AS LONG, BYVAL width AS LONG, BYVAL border AS LONG, BYVAL format AS _UNSIGNED LONG, BYVAL type AS _UNSIGNED LONG, pixels AS _OFFSET) - void '''_glTexImage1D'''(GLenum {{Parameter|target}}, GLint {{Parameter|level}}, GLint {{Parameter|internalFormat}}, GLsizei {{Parameter|width}}, GLint {{Parameter|border}}, GLenum {{Parameter|format}}, GLenum {{Parameter|type}}, const GLvoid * {{Parameter|data}}); +: '''_glTexImage1D''' GLenum {{Parameter|target}}, GLint {{Parameter|level}}, GLint {{Parameter|internalformat}}, GLsizei {{Parameter|width}}, GLint {{Parameter|border}}, GLint {{Parameter|format}}, GLenum {{Parameter|type}}, const GLvoid {{Parameter|*pixels}} -; target -: Specifies the target texture. Must be {{KW|_GL_TEXTURE_1D}} or {{KW|_GL_PROXY_TEXTURE_1D}}. -; level -: Specifies the level-of-detail number. Level 0 is the base image level. Level ''n'' is the ''n''th mipmap reduction image. -; internalFormat -: Specifies the number of color components in the texture. Must be one of base internal formats given in Table 1, one of the sized internal formats given in Table 2, or one of the compressed internal formats given in Table 3, below. -; width -: Specifies the width of the texture image. All implementations support texture images that are at least 1024 texels wide. The height of the 1D texture image is 1. -; border -: This value must be 0. -{{glapi pixeltransferupparams|}} +{{PageParameters}} +* OpenGL is using its own set of variable types to describe its command parameters. +* Use the following table to find the respective QB64 [[Variable Types]]. +{{OpenGLTypesPlugin}} {{PageDescription}} - -Texturing maps a portion of a specified texture image onto each graphical primitive for which texturing is enabled. To enable and disable one-dimensional texturing, call {{KW|_glEnable}} and {{KW|_glDisable}} with argument {{KW|_GL_TEXTURE_1D}}. - -Texture images are defined with '''_glTexImage1D'''. The arguments describe the parameters of the texture image, such as width, width of the border, level-of-detail number (see {{KW|_glTexParameter}}), and the internal resolution and format used to store the image. The last three arguments describe how the image is represented in memory. - -If {{Parameter|target}} is {{KW|_GL_PROXY_TEXTURE_1D}}, no data is read from {{Parameter|data}}, but all of the texture image state is recalculated, checked for consistency, and checked against the implementation's capabilities. If the implementation cannot handle a texture of the requested texture size, it sets all of the image state to 0, but does not generate an error (see {{KW|_glGetError}}). To query for an entire mipmap array, use an image array level greater than or equal to 1. - -If {{Parameter|target}} is {{KW|_GL_TEXTURE_1D}}, data is read from {{Parameter|data}} as a sequence of signed or unsigned bytes, shorts, or longs, or single-precision floating-point values, depending on {{Parameter|type}}. These values are grouped into sets of one, two, three, or four values, depending on {{Parameter|format}}, to form elements. Each data byte is treated as eight 1-bit elements, with bit ordering determined by {{KW|_GL_UNPACK_LSB_FIRST}} (see {{KW|_glPixelStore}}). - -If a non-zero named buffer object is bound to the {{KW|_GL_PIXEL_UNPACK_BUFFER}} target (see {{KW|_glBindBuffer}}) while a texture image is specified, {{Parameter|data}} is treated as a byte offset into the buffer object's data store. - -The first element corresponds to the left end of the texture array. Subsequent elements progress left-to-right through the remaining texels in the texture array. The final element corresponds to the right end of the texture array. - -{{Parameter|format}} determines the composition of each element in {{Parameter|data}}. It can assume one of these symbolic values: - -; {{KW|_GL_RED}} -: Each element is a single red component. The GL converts it to floating point and assembles it into an RGBA element by attaching 0 for green and blue, and 1 for alpha. Each component is then multiplied by the signed scale factor {{KW|_GL_c_SCALE}}, added to the signed bias {{KW|_GL_c_BIAS}}, and clamped to the range [0,1]. -; {{KW|_GL_RG}} -: Each element is a red/green pair. The GL converts it to floating point and assembles it into an RGBA element by attaching 0 for blue, and 1 for alpha. Each component is then multiplied by the signed scale factor {{KW|_GL_c_SCALE}}, added to the signed bias {{KW|_GL_c_BIAS}}, and clamped to the range [0,1]. -; {{KW|_GL_RGB}} or {{KW|_GL_BGR}} -: Each element is an RGB triple. The GL converts it to floating point and assembles it into an RGBA element by attaching 1 for alpha. Each component is then multiplied by the signed scale factor {{KW|_GL_c_SCALE}}, added to the signed bias {{KW|_GL_c_BIAS}}, and clamped to the range [0,1]. -; {{KW|_GL_RGBA}} or {{KW|_GL_BGRA}} -: Each element contains all four components. Each component is multiplied by the signed scale factor {{KW|_GL_c_SCALE}}, added to the signed bias {{KW|_GL_c_BIAS}}, and clamped to the range [0,1]. -; {{KW|_GL_DEPTH_COMPONENT}} -: Each element is a single depth value. The GL converts it to floating point, multiplies by the signed scale factor {{KW|_GL_DEPTH_SCALE}}, adds the signed bias {{KW|_GL_DEPTH_BIAS}}, and clamps to the range [0,1]. -If an application wants to store the texture at a certain resolution or in a certain format, it can request the resolution and format with {{Parameter|internalFormat}}. The GL will choose an internal representation that closely approximates that requested by {{Parameter|internalFormat}}, but it may not match exactly. (The representations specified by {{KW|_GL_RED}}, {{KW|_GL_RG}}, {{KW|_GL_RGB}} and {{KW|_GL_RGBA}} must match exactly.) - -{{Parameter|internalFormat}} may be one of the base internal formats shown in Table 1, below - -{{glapi baseformattable}} - -{{Parameter|internalFormat}} may also be one of the sized internal formats shown in Table 2, below - -{{glapi internalformattable}} - -Finally, {{Parameter|internalFormat}} may also be one of the generic or compressed compressed texture formats shown in Table 3 below - -{{glapi compressedformattable}} - -If the {{Parameter|internalFormat}} parameter is one of the generic compressed formats, {{KW|_GL_COMPRESSED_RED}}, {{KW|_GL_COMPRESSED_RG}}, {{KW|_GL_COMPRESSED_RGB}}, or {{KW|_GL_COMPRESSED_RGBA}}, the GL will replace the internal format with the symbolic constant for a specific internal format and compress the texture before storage. If no corresponding internal format is available, or the GL can not compress that image for any reason, the internal format is instead replaced with a corresponding base internal format. - -If the {{Parameter|internalFormat}} parameter is {{KW|_GL_SRGB}}, {{KW|_GL_SRGB8}}, {{KW|_GL_SRGB_ALPHA}}or {{KW|_GL_SRGB8_ALPHA8}}, the texture is treated as if the red, green, or blue components are encoded in the sRGB color space. Any alpha component is left unchanged. The conversion from the sRGB encoded component cs to a linear component cl is: - -{{glapi srgb equation}} - -Assume cs is the sRGB component in the range [0,1]. - -Use the {{KW|_GL_PROXY_TEXTURE_1D}} target to try out a resolution and format. The implementation will update and recompute its best match for the requested storage resolution and format. To then query this state, call {{KW|_glGetTexLevelParameter}}. If the texture cannot be accommodated, texture state is set to 0. - -A one-component texture image uses only the red component of the RGBA color from {{Parameter|data}}. A two-component image uses the R and A values. A three-component image uses the R, G, and B values. A four-component image uses all of the RGBA components. - -Image-based shadowing can be enabled by comparing texture r coordinates to depth texture values to generate a boolean result. See {{KW|_glTexParameter}} for details on texture comparison. - - -{{PageNotes}} - -{{KW|_glPixelStore}} modes affect texture images. - -{{Parameter|data}} may be a null pointer. In this case texture memory is allocated to accommodate a texture of width {{Parameter|width}}. You can then download subtextures to initialize the texture memory. The image is undefined if the program tries to apply an uninitialized portion of the texture image to a primitive. - -'''_glTexImage1D''' specifies the one-dimensional texture for the current texture unit, specified with {{KW|_glActiveTexture}}. - - -{{PageErrors}} - -{{KW|_GL_INVALID_ENUM}} is generated if {{Parameter|target}} is not {{KW|_GL_TEXTURE_1D}} or {{KW|_GL_PROXY_TEXTURE_1D}}. - -{{KW|_GL_INVALID_ENUM}} is generated if {{Parameter|format}} is not an accepted format constant. Format constants other than {{KW|_GL_STENCIL_INDEX}} are accepted. - -{{KW|_GL_INVALID_ENUM}} is generated if {{Parameter|type}} is not a type constant. - -{{KW|_GL_INVALID_VALUE}} is generated if {{Parameter|level}} is less than 0. - -{{KW|_GL_INVALID_VALUE}} may be generated if {{Parameter|level}} is greater than log2(''max''), where ''max'' is the returned value of {{KW|_GL_MAX_TEXTURE_SIZE}}. - -{{KW|_GL_INVALID_VALUE}} is generated if {{Parameter|internalFormat}} is not one of the accepted resolution and format symbolic constants. - -{{KW|_GL_INVALID_VALUE}} is generated if {{Parameter|width}} is less than 0 or greater than {{KW|_GL_MAX_TEXTURE_SIZE}}. - -{{KW|_GL_INVALID_VALUE}} is generated if {{Parameter|border}} is not 0. - -{{KW|_GL_INVALID_OPERATION}} is generated if {{Parameter|type}} is one of {{KW|_GL_UNSIGNED_BYTE_3_3_2}}, {{KW|_GL_UNSIGNED_BYTE_2_3_3_REV}}, {{KW|_GL_UNSIGNED_SHORT_5_6_5}}, or {{KW|_GL_UNSIGNED_SHORT_5_6_5_REV}} and {{Parameter|format}} is not {{KW|_GL_RGB}}. - -{{KW|_GL_INVALID_OPERATION}} is generated if {{Parameter|type}} is one of {{KW|_GL_UNSIGNED_SHORT_4_4_4_4}}, {{KW|_GL_UNSIGNED_SHORT_4_4_4_4_REV}}, {{KW|_GL_UNSIGNED_SHORT_5_5_5_1}}, {{KW|_GL_UNSIGNED_SHORT_1_5_5_5_REV}}, {{KW|_GL_UNSIGNED_INT_8_8_8_8}}, {{KW|_GL_UNSIGNED_INT_8_8_8_8_REV}}, {{KW|_GL_UNSIGNED_INT_10_10_10_2}}, or {{KW|_GL_UNSIGNED_INT_2_10_10_10_REV}} and {{Parameter|format}} is neither {{KW|_GL_RGBA}} nor {{KW|_GL_BGRA}}. - -{{KW|_GL_INVALID_OPERATION}} is generated if {{Parameter|format}} is {{KW|_GL_DEPTH_COMPONENT}} and {{Parameter|internalFormat}} is not {{KW|_GL_DEPTH_COMPONENT}}, {{KW|_GL_DEPTH_COMPONENT16}}, {{KW|_GL_DEPTH_COMPONENT24}}, or {{KW|_GL_DEPTH_COMPONENT32}}. - -{{KW|_GL_INVALID_OPERATION}} is generated if {{Parameter|internalFormat}} is {{KW|_GL_DEPTH_COMPONENT}}, {{KW|_GL_DEPTH_COMPONENT16}}, {{KW|_GL_DEPTH_COMPONENT24}}, or {{KW|_GL_DEPTH_COMPONENT32}}, and {{Parameter|format}} is not {{KW|_GL_DEPTH_COMPONENT}}. - -{{KW|_GL_INVALID_OPERATION}} is generated if a non-zero buffer object name is bound to the {{KW|_GL_PIXEL_UNPACK_BUFFER}} target and the buffer object's data store is currently mapped. - -{{KW|_GL_INVALID_OPERATION}} is generated if a non-zero buffer object name is bound to the {{KW|_GL_PIXEL_UNPACK_BUFFER}} target and the data would be unpacked from the buffer object such that the memory reads required would exceed the data store size. - -{{KW|_GL_INVALID_OPERATION}} is generated if a non-zero buffer object name is bound to the {{KW|_GL_PIXEL_UNPACK_BUFFER}} target and {{Parameter|data}} is not evenly divisible into the number of bytes needed to store in memory a datum indicated by {{Parameter|type}}. - - -{{PageUseWith}} - -{{KW|_glGetTexImage}} - -{{KW|_glGet}} with argument {{KW|_GL_PIXEL_UNPACK_BUFFER_BINDING}} +* OpenGL's documentation is available in several places, so we won't reproduce it here for another time. +* The full description for this command can be found at [https://docs.microsoft.com/en-us/windows/win32/opengl/glteximage1d Microsoft Docs] and is also valid for QB64 usage. {{PageSeeAlso}} - -[[_GL|SUB _GL]] -{{KW|_glActiveTexture}}, {{KW|_glBindTexture}}, {{KW|_glTexBuffer}}, {{KW|_glTexBufferRange}}, {{KW|_glTexImage2D}}, {{KW|_glTexImage2DMultisample}}, {{KW|_glTexImage3D}}, {{KW|_glTexImage3DMultisample}}, {{KW|_glTexSubImage1D}}, {{KW|_glPixelStore}} - - -{{PageCopyright}} +* [[_GL|SUB _GL]] +* [[_glBegin]], [[_glCopyPixels]], [[_glCopyTexImage1D]], [[_glCopyTexImage2D]] +* [[_glCopyTexSubImage1D]], [[_glCopyTexSubImage2D]], [[_glDrawPixels]], [[_glEnd]] +* [https://docs.microsoft.com/en-us/windows/win32/opengl/glfog _glFog], [[_glGetTexImage]], [[_glIsEnabled]], [https://docs.microsoft.com/en-us/windows/win32/opengl/glpixelstore-functions _glPixelStore] +* [https://docs.microsoft.com/en-us/windows/win32/opengl/glpixeltransfer _glPixelTransfer], [https://docs.microsoft.com/en-us/windows/win32/opengl/gltexenv-functions _glTexEnv], [https://docs.microsoft.com/en-us/windows/win32/opengl/gltexgen-functions _glTexGen], [[_glTexImage2D]] +* [[_glTexSubImage1D]], [[_glTexSubImage2D]], [https://docs.microsoft.com/en-us/windows/win32/opengl/gltexparameter-functions _glTexParameter] {{PageNavigation}} +[[Category:Final]] diff --git a/internal/help/_glTexImage2D__001001000021.txt b/internal/help/_glTexImage2D__001001000021.txt index d47b5267b..7ef1ac521 100644 --- a/internal/help/_glTexImage2D__001001000021.txt +++ b/internal/help/_glTexImage2D__001001000021.txt @@ -1,157 +1,31 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:23:55}} -'''_glTexImage2D:''' specify a two-dimensional texture image +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:53:10}} +{{DISPLAYTITLE:_glTexImage2D}} +The '''_glTexImage2D''' statement specifies a two-dimensional texture image. {{PageSyntax}} - - SUB _glTexImage2D (BYVAL target AS _UNSIGNED LONG, BYVAL level AS LONG, BYVAL internalformat AS LONG, BYVAL width AS LONG, BYVAL height AS LONG, BYVAL border AS LONG, BYVAL format AS _UNSIGNED LONG, BYVAL type AS _UNSIGNED LONG, pixels AS _OFFSET) - void '''_glTexImage2D'''(GLenum {{Parameter|target}}, GLint {{Parameter|level}}, GLint {{Parameter|internalFormat}}, GLsizei {{Parameter|width}}, GLsizei {{Parameter|height}}, GLint {{Parameter|border}}, GLenum {{Parameter|format}}, GLenum {{Parameter|type}}, const GLvoid * {{Parameter|data}}); +: '''_glTexImage2D''' GLenum {{Parameter|target}}, GLint {{Parameter|level}}, GLint {{Parameter|internalformat}}, GLsizei {{Parameter|width}}, GLsizei {{Parameter|height}}, GLint {{Parameter|border}}, GLint {{Parameter|format}}, GLenum {{Parameter|type}}, const GLvoid {{Parameter|*pixels}} -; target -: Specifies the target texture. Must be {{KW|_GL_TEXTURE_2D}}, {{KW|_GL_PROXY_TEXTURE_2D}}, {{KW|_GL_TEXTURE_1D_ARRAY}}, {{KW|_GL_PROXY_TEXTURE_1D_ARRAY}}, {{KW|_GL_TEXTURE_RECTANGLE}}, {{KW|_GL_PROXY_TEXTURE_RECTANGLE}}, {{KW|_GL_TEXTURE_CUBE_MAP_POSITIVE_X}}, {{KW|_GL_TEXTURE_CUBE_MAP_NEGATIVE_X}}, {{KW|_GL_TEXTURE_CUBE_MAP_POSITIVE_Y}}, {{KW|_GL_TEXTURE_CUBE_MAP_NEGATIVE_Y}}, {{KW|_GL_TEXTURE_CUBE_MAP_POSITIVE_Z}}, {{KW|_GL_TEXTURE_CUBE_MAP_NEGATIVE_Z}}, or {{KW|_GL_PROXY_TEXTURE_CUBE_MAP}}. -; level -: Specifies the level-of-detail number. Level 0 is the base image level. Level ''n'' is the ''n''th mipmap reduction image. If {{Parameter|target}} is {{KW|_GL_TEXTURE_RECTANGLE}} or {{KW|_GL_PROXY_TEXTURE_RECTANGLE}}, {{Parameter|level}} must be 0. -; internalFormat -: Specifies the number of color components in the texture. Must be one of base internal formats given in Table 1, one of the sized internal formats given in Table 2, or one of the compressed internal formats given in Table 3, below. -; width -: Specifies the width of the texture image. All implementations support texture images that are at least 1024 texels wide. -; height -: Specifies the height of the texture image, or the number of layers in a texture array, in the case of the {{KW|_GL_TEXTURE_1D_ARRAY}} and {{KW|_GL_PROXY_TEXTURE_1D_ARRAY}} targets. All implementations support 2D texture images that are at least 1024 texels high, and texture arrays that are at least 256 layers deep. -; border -: This value must be 0. -{{glapi pixeltransferupparams}} +{{PageParameters}} +* OpenGL is using its own set of variable types to describe its command parameters. +* Use the following table to find the respective QB64 [[Variable Types]]. +{{OpenGLTypesPlugin}} {{PageDescription}} - -Texturing allows elements of an image array to be read by shaders. - -To define texture images, call '''_glTexImage2D'''. The arguments describe the parameters of the texture image, such as height, width, width of the border, level-of-detail number (see {{KW|_glTexParameter}}), and number of color components provided. The last three arguments describe how the image is represented in memory. - -If {{Parameter|target}} is {{KW|_GL_PROXY_TEXTURE_2D}}, {{KW|_GL_PROXY_TEXTURE_1D_ARRAY}}, {{KW|_GL_PROXY_TEXTURE_CUBE_MAP}}, or {{KW|_GL_PROXY_TEXTURE_RECTANGLE}}, no data is read from {{Parameter|data}}, but all of the texture image state is recalculated, checked for consistency, and checked against the implementation's capabilities. If the implementation cannot handle a texture of the requested texture size, it sets all of the image state to 0, but does not generate an error (see {{KW|_glGetError}}). To query for an entire mipmap array, use an image array level greater than or equal to 1. - -If {{Parameter|target}} is {{KW|_GL_TEXTURE_2D}}, {{KW|_GL_TEXTURE_RECTANGLE}} or one of the {{KW|_GL_TEXTURE_CUBE_MAP}} targets, data is read from {{Parameter|data}} as a sequence of signed or unsigned bytes, shorts, or longs, or single-precision floating-point values, depending on {{Parameter|type}}. These values are grouped into sets of one, two, three, or four values, depending on {{Parameter|format}}, to form elements. Each data byte is treated as eight 1-bit elements, with bit ordering determined by {{KW|_GL_UNPACK_LSB_FIRST}} (see {{KW|_glPixelStore}}). - -If {{Parameter|target}} is {{KW|_GL_TEXTURE_1D_ARRAY}}, data is interpreted as an array of one-dimensional images. - -If a non-zero named buffer object is bound to the {{KW|_GL_PIXEL_UNPACK_BUFFER}} target (see {{KW|_glBindBuffer}}) while a texture image is specified, {{Parameter|data}} is treated as a byte offset into the buffer object's data store. - -The first element corresponds to the lower left corner of the texture image. Subsequent elements progress left-to-right through the remaining texels in the lowest row of the texture image, and then in successively higher rows of the texture image. The final element corresponds to the upper right corner of the texture image. - -{{Parameter|format}} determines the composition of each element in {{Parameter|data}}. It can assume one of these symbolic values: - -; {{KW|_GL_RED}} -: Each element is a single red component. The GL converts it to floating point and assembles it into an RGBA element by attaching 0 for green and blue, and 1 for alpha. Each component is then multiplied by the signed scale factor {{KW|_GL_c_SCALE}}, added to the signed bias {{KW|_GL_c_BIAS}}, and clamped to the range [0,1]. -; {{KW|_GL_RG}} -: Each element is a red/green double. The GL converts it to floating point and assembles it into an RGBA element by attaching 0 for blue, and 1 for alpha. Each component is then multiplied by the signed scale factor {{KW|_GL_c_SCALE}}, added to the signed bias {{KW|_GL_c_BIAS}}, and clamped to the range [0,1]. -; {{KW|_GL_RGB}} -: ; {{KW|_GL_BGR}} -: Each element is an RGB triple. The GL converts it to floating point and assembles it into an RGBA element by attaching 1 for alpha. Each component is then multiplied by the signed scale factor {{KW|_GL_c_SCALE}}, added to the signed bias {{KW|_GL_c_BIAS}}, and clamped to the range [0,1]. -; {{KW|_GL_RGBA}} -: ; {{KW|_GL_BGRA}} -: Each element contains all four components. Each component is multiplied by the signed scale factor {{KW|_GL_c_SCALE}}, added to the signed bias {{KW|_GL_c_BIAS}}, and clamped to the range [0,1]. -; {{KW|_GL_DEPTH_COMPONENT}} -: Each element is a single depth value. The GL converts it to floating point, multiplies by the signed scale factor {{KW|_GL_DEPTH_SCALE}}, adds the signed bias {{KW|_GL_DEPTH_BIAS}}, and clamps to the range [0,1]. -; {{KW|_GL_DEPTH_STENCIL}} -: Each element is a pair of depth and stencil values. The depth component of the pair is interpreted as in {{KW|_GL_DEPTH_COMPONENT}}. The stencil component is interpreted based on specified the depth + stencil internal format. -If an application wants to store the texture at a certain resolution or in a certain format, it can request the resolution and format with {{Parameter|internalFormat}}. The GL will choose an internal representation that closely approximates that requested by {{Parameter|internalFormat}}, but it may not match exactly. (The representations specified by {{KW|_GL_RED}}, {{KW|_GL_RG}}, {{KW|_GL_RGB}}, and {{KW|_GL_RGBA}} must match exactly.) - -{{Parameter|internalFormat}} may be one of the base internal formats shown in Table 1, below - -{{glapi baseformattable}} - -{{Parameter|internalFormat}} may also be one of the sized internal formats shown in Table 2, below - -{{glapi internalformattable}} - -Finally, {{Parameter|internalFormat}} may also be one of the generic or compressed compressed texture formats shown in Table 3 below - -{{glapi compressedformattable}} - -If the {{Parameter|internalFormat}} parameter is one of the generic compressed formats, {{KW|_GL_COMPRESSED_RED}}, {{KW|_GL_COMPRESSED_RG}}, {{KW|_GL_COMPRESSED_RGB}}, or {{KW|_GL_COMPRESSED_RGBA}}, the GL will replace the internal format with the symbolic constant for a specific internal format and compress the texture before storage. If no corresponding internal format is available, or the GL can not compress that image for any reason, the internal format is instead replaced with a corresponding base internal format. - -If the {{Parameter|internalFormat}} parameter is {{KW|_GL_SRGB}}, {{KW|_GL_SRGB8}}, {{KW|_GL_SRGB_ALPHA}}, or {{KW|_GL_SRGB8_ALPHA8}}, the texture is treated as if the red, green, or blue components are encoded in the sRGB color space. Any alpha component is left unchanged. The conversion from the sRGB encoded component cs to a linear component cl is: - -{{glapi srgb equation}} - -Assume cs is the sRGB component in the range [0,1]. - -Use the {{KW|_GL_PROXY_TEXTURE_2D}}, {{KW|_GL_PROXY_TEXTURE_1D_ARRAY}}, {{KW|_GL_PROXY_TEXTURE_RECTANGLE}}, or {{KW|_GL_PROXY_TEXTURE_CUBE_MAP}} target to try out a resolution and format. The implementation will update and recompute its best match for the requested storage resolution and format. To then query this state, call {{KW|_glGetTexLevelParameter}}. If the texture cannot be accommodated, texture state is set to 0. - -A one-component texture image uses only the red component of the RGBA color extracted from {{Parameter|data}}. A two-component image uses the R and G values. A three-component image uses the R, G, and B values. A four-component image uses all of the RGBA components. - -Image-based shadowing can be enabled by comparing texture r coordinates to depth texture values to generate a boolean result. See {{KW|_glTexParameter}} for details on texture comparison. - - -{{PageNotes}} - -The {{KW|_glPixelStore}} mode affects texture images. - -{{Parameter|data}} may be a null pointer. In this case, texture memory is allocated to accommodate a texture of width {{Parameter|width}} and height {{Parameter|height}}. You can then download subtextures to initialize this texture memory. The image is undefined if the user tries to apply an uninitialized portion of the texture image to a primitive. - -'''_glTexImage2D''' specifies the two-dimensional texture for the current texture unit, specified with {{KW|_glActiveTexture}}. - - -{{PageErrors}} - -{{KW|_GL_INVALID_ENUM}} is generated if {{Parameter|target}} is not {{KW|_GL_TEXTURE_2D}}, {{KW|_GL_TEXTURE_1D_ARRAY}}, {{KW|_GL_TEXTURE_RECTANGLE}}, {{KW|_GL_PROXY_TEXTURE_2D}}, {{KW|_GL_PROXY_TEXTURE_1D_ARRAY}}, {{KW|_GL_PROXY_TEXTURE_RECTANGLE}}, {{KW|_GL_PROXY_TEXTURE_CUBE_MAP}}, {{KW|_GL_TEXTURE_CUBE_MAP_POSITIVE_X}}, {{KW|_GL_TEXTURE_CUBE_MAP_NEGATIVE_X}}, {{KW|_GL_TEXTURE_CUBE_MAP_POSITIVE_Y}}, {{KW|_GL_TEXTURE_CUBE_MAP_NEGATIVE_Y}}, {{KW|_GL_TEXTURE_CUBE_MAP_POSITIVE_Z}}, or {{KW|_GL_TEXTURE_CUBE_MAP_NEGATIVE_Z}}. - -{{KW|_GL_INVALID_ENUM}} is generated if {{Parameter|target}} is one of the six cube map 2D image targets and the width and height parameters are not equal. - -{{KW|_GL_INVALID_ENUM}} is generated if {{Parameter|type}} is not a type constant. - -{{KW|_GL_INVALID_VALUE}} is generated if {{Parameter|width}} is less than 0 or greater than {{KW|_GL_MAX_TEXTURE_SIZE}}. - -{{KW|_GL_INVALID_VALUE}} is generated if {{Parameter|target}} is not {{KW|_GL_TEXTURE_1D_ARRAY}} or {{KW|_GL_PROXY_TEXTURE_1D_ARRAY}} and {{Parameter|height}} is less than 0 or greater than {{KW|_GL_MAX_TEXTURE_SIZE}}. - -{{KW|_GL_INVALID_VALUE}} is generated if {{Parameter|target}} is {{KW|_GL_TEXTURE_1D_ARRAY}} or {{KW|_GL_PROXY_TEXTURE_1D_ARRAY}} and {{Parameter|height}} is less than 0 or greater than {{KW|_GL_MAX_ARRAY_TEXTURE_LAYERS}}. - -{{KW|_GL_INVALID_VALUE}} is generated if {{Parameter|level}} is less than 0. - -{{KW|_GL_INVALID_VALUE}} may be generated if {{Parameter|level}} is greater than log2(''max''), where ''max'' is the returned value of {{KW|_GL_MAX_TEXTURE_SIZE}}. - -{{KW|_GL_INVALID_VALUE}} is generated if {{Parameter|internalFormat}} is not one of the accepted resolution and format symbolic constants. - -{{KW|_GL_INVALID_VALUE}} is generated if {{Parameter|width}} or {{Parameter|height}} is less than 0 or greater than {{KW|_GL_MAX_TEXTURE_SIZE}}. - -{{KW|_GL_INVALID_VALUE}} is generated if {{Parameter|border}} is not 0. - -{{KW|_GL_INVALID_OPERATION}} is generated if {{Parameter|type}} is one of {{KW|_GL_UNSIGNED_BYTE_3_3_2}}, {{KW|_GL_UNSIGNED_BYTE_2_3_3_REV}}, {{KW|_GL_UNSIGNED_SHORT_5_6_5}}, {{KW|_GL_UNSIGNED_SHORT_5_6_5_REV}}, or {{KW|_GL_UNSIGNED_INT_10F_11F_11F_REV}}, and {{Parameter|format}} is not {{KW|_GL_RGB}}. - -{{KW|_GL_INVALID_OPERATION}} is generated if {{Parameter|type}} is one of {{KW|_GL_UNSIGNED_SHORT_4_4_4_4}}, {{KW|_GL_UNSIGNED_SHORT_4_4_4_4_REV}}, {{KW|_GL_UNSIGNED_SHORT_5_5_5_1}}, {{KW|_GL_UNSIGNED_SHORT_1_5_5_5_REV}}, {{KW|_GL_UNSIGNED_INT_8_8_8_8}}, {{KW|_GL_UNSIGNED_INT_8_8_8_8_REV}}, {{KW|_GL_UNSIGNED_INT_10_10_10_2}}, {{KW|_GL_UNSIGNED_INT_2_10_10_10_REV}}, or {{KW|_GL_UNSIGNED_INT_5_9_9_9_REV}}, and {{Parameter|format}} is neither {{KW|_GL_RGBA}} nor {{KW|_GL_BGRA}}. - -{{KW|_GL_INVALID_OPERATION}} is generated if {{Parameter|target}} is not {{KW|_GL_TEXTURE_2D}}, {{KW|_GL_PROXY_TEXTURE_2D}}, {{KW|_GL_TEXTURE_RECTANGLE}}, or {{KW|_GL_PROXY_TEXTURE_RECTANGLE}}, and {{Parameter|internalFormat}} is {{KW|_GL_DEPTH_COMPONENT}}, {{KW|_GL_DEPTH_COMPONENT16}}, {{KW|_GL_DEPTH_COMPONENT24}}, or {{KW|_GL_DEPTH_COMPONENT32F}}. - -{{KW|_GL_INVALID_OPERATION}} is generated if {{Parameter|format}} is {{KW|_GL_DEPTH_COMPONENT}} and {{Parameter|internalFormat}} is not {{KW|_GL_DEPTH_COMPONENT}}, {{KW|_GL_DEPTH_COMPONENT16}}, {{KW|_GL_DEPTH_COMPONENT24}}, or {{KW|_GL_DEPTH_COMPONENT32F}}. - -{{KW|_GL_INVALID_OPERATION}} is generated if {{Parameter|internalFormat}} is {{KW|_GL_DEPTH_COMPONENT}}, {{KW|_GL_DEPTH_COMPONENT16}}, {{KW|_GL_DEPTH_COMPONENT24}}, or {{KW|_GL_DEPTH_COMPONENT32F}}, and {{Parameter|format}} is not {{KW|_GL_DEPTH_COMPONENT}}. - -{{KW|_GL_INVALID_OPERATION}} is generated if a non-zero buffer object name is bound to the {{KW|_GL_PIXEL_UNPACK_BUFFER}} target and the buffer object's data store is currently mapped. - -{{KW|_GL_INVALID_OPERATION}} is generated if a non-zero buffer object name is bound to the {{KW|_GL_PIXEL_UNPACK_BUFFER}} target and the data would be unpacked from the buffer object such that the memory reads required would exceed the data store size. - -{{KW|_GL_INVALID_OPERATION}} is generated if a non-zero buffer object name is bound to the {{KW|_GL_PIXEL_UNPACK_BUFFER}} target and {{Parameter|data}} is not evenly divisible into the number of bytes needed to store in memory a datum indicated by {{Parameter|type}}. - -{{KW|_GL_INVALID_VALUE}} is generated if {{Parameter|target}} is {{KW|_GL_TEXTURE_RECTANGLE}} or {{KW|_GL_PROXY_TEXTURE_RECTANGLE}} and {{Parameter|level}} is not 0. - - -{{PageUseWith}} - -{{KW|_glGetTexImage}} - -{{KW|_glGet}} with argument {{KW|_GL_PIXEL_UNPACK_BUFFER_BINDING}} +* OpenGL's documentation is available in several places, so we won't reproduce it here for another time. +* The full description for this command can be found at [https://docs.microsoft.com/en-us/windows/win32/opengl/glteximage2d Microsoft Docs] and is also valid for QB64 usage. {{PageSeeAlso}} - -[[_GL|SUB _GL]] -{{KW|_glActiveTexture}}, {{KW|_glBindTexture}}, {{KW|_glTexImage1D}}, {{KW|_glTexImage2DMultisample}}, {{KW|_glTexImage3D}}, {{KW|_glTexImage3DMultisample}}, {{KW|_glTexSubImage2D}}, {{KW|_glPixelStore}} - - -{{PageCopyright}} +* [[_GL|SUB _GL]] +* [[_glBegin]], [[_glDrawPixels]], [[_glEnd]], [https://docs.microsoft.com/en-us/windows/win32/opengl/glfog _glFog] +* [[_glIsEnabled]], [https://docs.microsoft.com/en-us/windows/win32/opengl/glpixelstore-functions _glPixelStore], [https://docs.microsoft.com/en-us/windows/win32/opengl/glpixeltransfer _glPixelTransfer], [https://docs.microsoft.com/en-us/windows/win32/opengl/gltexenv-functions _glTexEnv] +* [https://docs.microsoft.com/en-us/windows/win32/opengl/gltexgen-functions _glTexGen], [[_glTexImage1D]], [https://docs.microsoft.com/en-us/windows/win32/opengl/gltexparameter-functions _glTexParameter] {{PageNavigation}} +[[Category:Final]] diff --git a/internal/help/_glTexSubImage1D__001001001000011.txt b/internal/help/_glTexSubImage1D__001001001000011.txt index c5240112e..10e0cfa5e 100644 --- a/internal/help/_glTexSubImage1D__001001001000011.txt +++ b/internal/help/_glTexSubImage1D__001001001000011.txt @@ -1,85 +1,33 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:24:01}} -'''_glTexSubImage1D:''' specify a one-dimensional texture subimage +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:53:16}} +{{DISPLAYTITLE:_glTexSubImage1D}} +The '''_glTexSubImage1D''' statement specifies a portion of an existing one-dimensional texture image. You cannot define a new texture with '''_glTexSubImage1D'''. {{PageSyntax}} - - SUB _glTexSubImage1D (BYVAL target AS _UNSIGNED LONG, BYVAL level AS LONG, BYVAL xoffset AS LONG, BYVAL width AS LONG, BYVAL format AS _UNSIGNED LONG, BYVAL type AS _UNSIGNED LONG, pixels AS _OFFSET) - void '''_glTexSubImage1D'''(GLenum {{Parameter|target}}, GLint {{Parameter|level}}, GLint {{Parameter|xoffset}}, GLsizei {{Parameter|width}}, GLenum {{Parameter|format}}, GLenum {{Parameter|type}}, const GLvoid * {{Parameter|data}}); +: '''_glTexSubImage1D''' GLenum {{Parameter|target}}, GLint {{Parameter|level}}, GLint {{Parameter|xoffset}}, GLsizei {{Parameter|width}}, GLenum {{Parameter|format}}, GLenum {{Parameter|type}}, const GLvoid {{Parameter|*pixels}} -; target -: Specifies the target texture. Must be {{KW|_GL_TEXTURE_1D}}. -; level -: Specifies the level-of-detail number. Level 0 is the base image level. Level ''n'' is the ''n''th mipmap reduction image. -; xoffset -: Specifies a texel offset in the x direction within the texture array. -; width -: Specifies the width of the texture subimage. -{{glapi pixeltransferupparams}} +{{PageParameters}} +* OpenGL is using its own set of variable types to describe its command parameters. +* Use the following table to find the respective QB64 [[Variable Types]]. +{{OpenGLTypesPlugin}} {{PageDescription}} - -Texturing maps a portion of a specified texture image onto each graphical primitive for which texturing is enabled. To enable or disable one-dimensional texturing, call {{KW|_glEnable}} and {{KW|_glDisable}} with argument {{KW|_GL_TEXTURE_1D}}. - -'''_glTexSubImage1D''' redefines a contiguous subregion of an existing one-dimensional texture image. The texels referenced by {{Parameter|data}} replace the portion of the existing texture array with x indices {{Parameter|xoffset}} and xoffset + width - 1, inclusive. This region may not include any texels outside the range of the texture array as it was originally specified. It is not an error to specify a subtexture with width of 0, but such a specification has no effect. - -If a non-zero named buffer object is bound to the {{KW|_GL_PIXEL_UNPACK_BUFFER}} target (see {{KW|_glBindBuffer}}) while a texture image is specified, {{Parameter|data}} is treated as a byte offset into the buffer object's data store. - - -{{PageNotes}} - -{{KW|_glPixelStore}} modes affect texture images. - -'''_glTexSubImage1D''' specifies a one-dimensional subtexture for the current texture unit, specified with {{KW|_glActiveTexture}}. - - -{{PageErrors}} - -{{KW|_GL_INVALID_ENUM}} is generated if {{Parameter|target}} is not one of the allowable values. - -{{KW|_GL_INVALID_ENUM}} is generated if {{Parameter|format}} is not an accepted format constant. - -{{KW|_GL_INVALID_ENUM}} is generated if {{Parameter|type}} is not a type constant. - -{{KW|_GL_INVALID_VALUE}} is generated if {{Parameter|level}} is less than 0. - -{{KW|_GL_INVALID_VALUE}} may be generated if {{Parameter|level}} is greater than log2(''max''), where ''max'' is the returned value of {{KW|_GL_MAX_TEXTURE_SIZE}}. - -{{KW|_GL_INVALID_VALUE}} is generated if ''xoffset'' < 0, or if ''xoffset'' + ''width'' > ''w'', where ''w'' is the {{KW|_GL_TEXTURE_WIDTH}}. Note that ''w'' includes twice the border width. - -{{KW|_GL_INVALID_VALUE}} is generated if {{Parameter|width}} is less than 0. - -{{KW|_GL_INVALID_OPERATION}} is generated if the texture array has not been defined by a previous {{KW|_glTexImage1D}} operation. - -{{KW|_GL_INVALID_OPERATION}} is generated if {{Parameter|type}} is one of {{KW|_GL_UNSIGNED_BYTE_3_3_2}}, {{KW|_GL_UNSIGNED_BYTE_2_3_3_REV}}, {{KW|_GL_UNSIGNED_SHORT_5_6_5}}, or {{KW|_GL_UNSIGNED_SHORT_5_6_5_REV}} and {{Parameter|format}} is not {{KW|_GL_RGB}}. - -{{KW|_GL_INVALID_OPERATION}} is generated if {{Parameter|type}} is one of {{KW|_GL_UNSIGNED_SHORT_4_4_4_4}}, {{KW|_GL_UNSIGNED_SHORT_4_4_4_4_REV}}, {{KW|_GL_UNSIGNED_SHORT_5_5_5_1}}, {{KW|_GL_UNSIGNED_SHORT_1_5_5_5_REV}}, {{KW|_GL_UNSIGNED_INT_8_8_8_8}}, {{KW|_GL_UNSIGNED_INT_8_8_8_8_REV}}, {{KW|_GL_UNSIGNED_INT_10_10_10_2}}, or {{KW|_GL_UNSIGNED_INT_2_10_10_10_REV}} and {{Parameter|format}} is neither {{KW|_GL_RGBA}} nor {{KW|_GL_BGRA}}. - -{{KW|_GL_INVALID_OPERATION}} is generated if a non-zero buffer object name is bound to the {{KW|_GL_PIXEL_UNPACK_BUFFER}} target and the buffer object's data store is currently mapped. - -{{KW|_GL_INVALID_OPERATION}} is generated if a non-zero buffer object name is bound to the {{KW|_GL_PIXEL_UNPACK_BUFFER}} target and the data would be unpacked from the buffer object such that the memory reads required would exceed the data store size. - -{{KW|_GL_INVALID_OPERATION}} is generated if a non-zero buffer object name is bound to the {{KW|_GL_PIXEL_UNPACK_BUFFER}} target and {{Parameter|data}} is not evenly divisible into the number of bytes needed to store in memory a datum indicated by {{Parameter|type}}. - - -{{PageUseWith}} - -{{KW|_glGetTexImage}} - -{{KW|_glGet}} with argument {{KW|_GL_PIXEL_UNPACK_BUFFER_BINDING}} +* OpenGL's documentation is available in several places, so we won't reproduce it here for another time. +* The full description for this command can be found at [https://docs.microsoft.com/en-us/windows/win32/opengl/gltexsubimage1d Microsoft Docs] and is also valid for QB64 usage. {{PageSeeAlso}} - -[[_GL|SUB _GL]] -{{KW|_glActiveTexture}}, {{KW|_glBindTexture}}, {{KW|_glTexSubImage2D}}, {{KW|_glTexSubImage3D}}, {{KW|_glCopyTexImage1D}}, {{KW|_glTexImage1D}}, {{KW|_glTexStorage1D}}, {{KW|_glTextureView}}, {{KW|_glPixelStore}} - - -{{PageCopyright}} +* [[_GL|SUB _GL]] +* [[_glCopyTexImage1D]], [[_glCopyTexImage2D]], [[_glCopyTexSubImage1D]], [[_glCopyTexSubImage2D]] +* [[_glDrawPixels]], [[_glEnable]], [https://docs.microsoft.com/en-us/windows/win32/opengl/glfog _glFog], [[_glGetTexImage]] +* [[_glIsEnabled]], [https://docs.microsoft.com/en-us/windows/win32/opengl/glpixelstore-functions _glPixelStore], [https://docs.microsoft.com/en-us/windows/win32/opengl/glpixeltransfer _glPixelTransfer], [https://docs.microsoft.com/en-us/windows/win32/opengl/gltexenv-functions _glTexEnv] +* [https://docs.microsoft.com/en-us/windows/win32/opengl/gltexgen-functions _glTexGen], [[_glTexImage1D]], [[_glTexImage2D]], [https://docs.microsoft.com/en-us/windows/win32/opengl/gltexparameter-functions _glTexParameter] +* [[_glTexSubImage2D]] {{PageNavigation}} +[[Category:Final]] diff --git a/internal/help/_glTexSubImage2D__001001001000021.txt b/internal/help/_glTexSubImage2D__001001001000021.txt index 3ecbe9fac..1be7648db 100644 --- a/internal/help/_glTexSubImage2D__001001001000021.txt +++ b/internal/help/_glTexSubImage2D__001001001000021.txt @@ -1,89 +1,33 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:24:03}} -'''_glTexSubImage2D:''' specify a two-dimensional texture subimage +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:53:18}} +{{DISPLAYTITLE:_glTexSubImage2D}} +The '''_glTexSubImage2D''' statement specifies a portion of an existing one-dimensional texture image. You cannot define a new texture with '''_glTexSubImage2D'''. {{PageSyntax}} - - SUB _glTexSubImage2D (BYVAL target AS _UNSIGNED LONG, BYVAL level AS LONG, BYVAL xoffset AS LONG, BYVAL yoffset AS LONG, BYVAL width AS LONG, BYVAL height AS LONG, BYVAL format AS _UNSIGNED LONG, BYVAL type AS _UNSIGNED LONG, pixels AS _OFFSET) - void '''_glTexSubImage2D'''(GLenum {{Parameter|target}}, GLint {{Parameter|level}}, GLint {{Parameter|xoffset}}, GLint {{Parameter|yoffset}}, GLsizei {{Parameter|width}}, GLsizei {{Parameter|height}}, GLenum {{Parameter|format}}, GLenum {{Parameter|type}}, const GLvoid * {{Parameter|data}}); +: '''_glTexSubImage2D''' GLenum {{Parameter|target}}, GLint {{Parameter|level}}, GLint {{Parameter|xoffset}}, GLint {{Parameter|yoffset}}, GLsizei {{Parameter|width}}, GLsizei {{Parameter|height}}, GLenum {{Parameter|format}}, GLenum {{Parameter|type}}, const GLvoid {{Parameter|*pixels}} -; target -: Specifies the target texture. Must be {{KW|_GL_TEXTURE_2D}}, {{KW|_GL_TEXTURE_CUBE_MAP_POSITIVE_X}}, {{KW|_GL_TEXTURE_CUBE_MAP_NEGATIVE_X}}, {{KW|_GL_TEXTURE_CUBE_MAP_POSITIVE_Y}}, {{KW|_GL_TEXTURE_CUBE_MAP_NEGATIVE_Y}}, {{KW|_GL_TEXTURE_CUBE_MAP_POSITIVE_Z}}, {{KW|_GL_TEXTURE_CUBE_MAP_NEGATIVE_Z}}, or {{KW|_GL_TEXTURE_1D_ARRAY}}. -; level -: Specifies the level-of-detail number. Level 0 is the base image level. Level ''n'' is the ''n''th mipmap reduction image. -; xoffset -: Specifies a texel offset in the x direction within the texture array. -; yoffset -: Specifies a texel offset in the y direction within the texture array. -; width -: Specifies the width of the texture subimage. -; height -: Specifies the height of the texture subimage. -{{Glapi pixeltransferupparams|}} +{{PageParameters}} +* OpenGL is using its own set of variable types to describe its command parameters. +* Use the following table to find the respective QB64 [[Variable Types]]. +{{OpenGLTypesPlugin}} {{PageDescription}} - -Texturing maps a portion of a specified texture image onto each graphical primitive for which texturing is enabled. - -'''_glTexSubImage2D''' redefines a contiguous subregion of an existing two-dimensional or one-dimensional array texture image. The texels referenced by {{Parameter|data}} replace the portion of the existing texture array with x indices {{Parameter|xoffset}} and ''xoffset'' + ''width'' - 1, inclusive, and y indices {{Parameter|yoffset}} and ''yoffset'' + ''height'' - 1, inclusive. This region may not include any texels outside the range of the texture array as it was originally specified. It is not an error to specify a subtexture with zero width or height, but such a specification has no effect. - -If a non-zero named buffer object is bound to the {{KW|_GL_PIXEL_UNPACK_BUFFER}} target (see {{KW|_glBindBuffer}}) while a texture image is specified, {{Parameter|data}} is treated as a byte offset into the buffer object's data store. - - -{{PageNotes}} - -{{KW|_glPixelStore}} modes affect texture images. - -'''_glTexSubImage2D''' specifies a two-dimensional subtexture for the current texture unit, specified with {{KW|_glActiveTexture}}. - - -{{PageErrors}} - -{{KW|_GL_INVALID_ENUM}} is generated if {{Parameter|target}} is not {{KW|_GL_TEXTURE_2D}}, {{KW|_GL_TEXTURE_CUBE_MAP_POSITIVE_X}}, {{KW|_GL_TEXTURE_CUBE_MAP_NEGATIVE_X}}, {{KW|_GL_TEXTURE_CUBE_MAP_POSITIVE_Y}}, {{KW|_GL_TEXTURE_CUBE_MAP_NEGATIVE_Y}}, {{KW|_GL_TEXTURE_CUBE_MAP_POSITIVE_Z}}, {{KW|_GL_TEXTURE_CUBE_MAP_NEGATIVE_Z}}, or {{KW|_GL_TEXTURE_1D_ARRAY}}. - -{{KW|_GL_INVALID_ENUM}} is generated if {{Parameter|format}} is not an accepted format constant. - -{{KW|_GL_INVALID_ENUM}} is generated if {{Parameter|type}} is not a type constant. - -{{KW|_GL_INVALID_VALUE}} is generated if {{Parameter|level}} is less than 0. - -{{KW|_GL_INVALID_VALUE}} may be generated if {{Parameter|level}} is greater than log2(''max''), where ''max'' is the returned value of {{KW|_GL_MAX_TEXTURE_SIZE}}. - -{{KW|_GL_INVALID_VALUE}} is generated if ''xoffset'' < 0, (''xoffset'' + ''width'') > ''w'', ''yoffset'' < 0, or (''yoffset'' + ''height'') > ''h'', where ''w'' is the {{KW|_GL_TEXTURE_WIDTH}} and ''h'' is the {{KW|_GL_TEXTURE_HEIGHT}}. - -{{KW|_GL_INVALID_VALUE}} is generated if {{Parameter|width}} or {{Parameter|height}} is less than 0. - -{{KW|_GL_INVALID_OPERATION}} is generated if the texture array has not been defined by a previous {{KW|_glTexImage2D}} operation. - -{{KW|_GL_INVALID_OPERATION}} is generated if {{Parameter|type}} is one of {{KW|_GL_UNSIGNED_BYTE_3_3_2}}, {{KW|_GL_UNSIGNED_BYTE_2_3_3_REV}}, {{KW|_GL_UNSIGNED_SHORT_5_6_5}}, or {{KW|_GL_UNSIGNED_SHORT_5_6_5_REV}} and {{Parameter|format}} is not {{KW|_GL_RGB}}. - -{{KW|_GL_INVALID_OPERATION}} is generated if {{Parameter|type}} is one of {{KW|_GL_UNSIGNED_SHORT_4_4_4_4}}, {{KW|_GL_UNSIGNED_SHORT_4_4_4_4_REV}}, {{KW|_GL_UNSIGNED_SHORT_5_5_5_1}}, {{KW|_GL_UNSIGNED_SHORT_1_5_5_5_REV}}, {{KW|_GL_UNSIGNED_INT_8_8_8_8}}, {{KW|_GL_UNSIGNED_INT_8_8_8_8_REV}}, {{KW|_GL_UNSIGNED_INT_10_10_10_2}}, or {{KW|_GL_UNSIGNED_INT_2_10_10_10_REV}} and {{Parameter|format}} is neither {{KW|_GL_RGBA}} nor {{KW|_GL_BGRA}}. - -{{KW|_GL_INVALID_OPERATION}} is generated if a non-zero buffer object name is bound to the {{KW|_GL_PIXEL_UNPACK_BUFFER}} target and the buffer object's data store is currently mapped. - -{{KW|_GL_INVALID_OPERATION}} is generated if a non-zero buffer object name is bound to the {{KW|_GL_PIXEL_UNPACK_BUFFER}} target and the data would be unpacked from the buffer object such that the memory reads required would exceed the data store size. - -{{KW|_GL_INVALID_OPERATION}} is generated if a non-zero buffer object name is bound to the {{KW|_GL_PIXEL_UNPACK_BUFFER}} target and {{Parameter|data}} is not evenly divisible into the number of bytes needed to store in memory a datum indicated by {{Parameter|type}}. - - -{{PageUseWith}} - -{{KW|_glGetTexImage}} - -{{KW|_glGet}} with argument {{KW|_GL_PIXEL_UNPACK_BUFFER_BINDING}} +* OpenGL's documentation is available in several places, so we won't reproduce it here for another time. +* The full description for this command can be found at [https://docs.microsoft.com/en-us/windows/win32/opengl/gltexsubimage2d Microsoft Docs] and is also valid for QB64 usage. {{PageSeeAlso}} - -[[_GL|SUB _GL]] -{{KW|_glActiveTexture}}, {{KW|_glBindTexture}}, {{KW|_glTexSubImage1D}}, {{KW|_glTexSubImage3D}}, {{KW|_glCopyTexImage2D}}, {{KW|_glTexImage2D}}, {{KW|_glTexStorage2D}}, {{KW|_glTextureView}}, {{KW|_glPixelStore}} - - -{{PageCopyright}} +* [[_GL|SUB _GL]] +* [[_glCopyTexImage1D]], [[_glCopyTexImage2D]], [[_glCopyTexSubImage1D]], [[_glCopyTexSubImage2D]] +* [[_glDrawPixels]], [[_glEnable]], [https://docs.microsoft.com/en-us/windows/win32/opengl/glfog _glFog], [[_glGetTexImage]] +* [[_glIsEnabled]], [https://docs.microsoft.com/en-us/windows/win32/opengl/glpixelstore-functions _glPixelStore], [https://docs.microsoft.com/en-us/windows/win32/opengl/glpixeltransfer _glPixelTransfer], [https://docs.microsoft.com/en-us/windows/win32/opengl/gltexenv-functions _glTexEnv] +* [https://docs.microsoft.com/en-us/windows/win32/opengl/gltexgen-functions _glTexGen], [[_glTexImage1D]], [[_glTexImage2D]], [[_glTexSubImage1D]] +* [[_glTexImage2D]], [https://docs.microsoft.com/en-us/windows/win32/opengl/gltexparameter-functions _glTexParameter] {{PageNavigation}} +[[Category:Final]] diff --git a/internal/help/_glViewport__0010000000.txt b/internal/help/_glViewport__0010000000.txt index 413f97de8..03aa0e2e5 100644 --- a/internal/help/_glViewport__0010000000.txt +++ b/internal/help/_glViewport__0010000000.txt @@ -1,50 +1,29 @@ -{{QBDLDATE:05-20-2022}} -{{QBDLTIME:23:24:35}} +{{QBDLDATE:07-31-2022}} +{{QBDLTIME:23:53:50}} {{DISPLAYTITLE:_glViewport}} -'''_glViewport:''' set the viewport +The '''_glViewport''' statement sets the viewport. {{PageSyntax}} - -;QB64:SUB _glViewport (BYVAL x AS LONG, BYVAL y AS LONG, BYVAL width AS LONG, BYVAL height AS LONG) -;C/C++:void '''_glViewport'''(GLint {{Parameter|x}}, GLint {{Parameter|y}}, GLsizei {{Parameter|width}}, GLsizei {{Parameter|height}}); +: '''_glViewport''' GLint {{Parameter|x}}, GLint {{Parameter|y}}, GLsizei {{Parameter|width}}, GLsizei {{Parameter|height}} -; x, y -: Specify the lower left corner of the viewport rectangle, in pixels. The initial value is (0,0). -; width, height -: Specify the width and height of the viewport. When a GL context is first attached to a window, {{Parameter|width}} and {{Parameter|height}} are set to the dimensions of that window. +{{PageParameters}} +* OpenGL is using its own set of variable types to describe its command parameters. +* Use the following table to find the respective QB64 [[Variable Types]]. +{{OpenGLTypesPlugin}} {{PageDescription}} - -'''_glViewport''' specifies the affine transformation of ''x'' and ''y'' from normalized device coordinates to window coordinates. Let (xnd, ynd) be normalized device coordinates. Then the window coordinates (xw, yw) are computed as follows: - -{{glapi viewport equations}} - -Viewport width and height are silently clamped to a range that depends on the implementation. To query this range, call {{KW|_glGet}} with argument {{KW|_GL_MAX_VIEWPORT_DIMS}}. - - -{{PageErrors}} - -{{KW|_GL_INVALID_VALUE}} is generated if either {{Parameter|width}} or {{Parameter|height}} is negative. - - -{{PageUseWith}} - -{{KW|_glGet}} with argument {{KW|_GL_VIEWPORT}} - -{{KW|_glGet}} with argument {{KW|_GL_MAX_VIEWPORT_DIMS}} +* OpenGL's documentation is available in several places, so we won't reproduce it here for another time. +* The full description for this command can be found at [https://docs.microsoft.com/en-us/windows/win32/opengl/glviewport Microsoft Docs] and is also valid for QB64 usage. {{PageSeeAlso}} - -[[_GL|SUB _GL]] -{{KW|_glDepthRange}}, {{KW|_glViewportArray}}, {{KW|_glViewportIndexed}} - - -{{PageCopyright}} +* [[_GL|SUB _GL]] +* [[_glBegin]], [[_glDepthRange]] {{PageNavigation}} +[[Category:Final]] diff --git a/internal/help/links.bin b/internal/help/links.bin index 806131736..89af81ffc 100644 --- a/internal/help/links.bin +++ b/internal/help/links.bin @@ -4,6 +4,9 @@ _ACOSH,_ACOSH _ALLOWFULLSCREEN,_ALLOWFULLSCREEN _ALPHA,_ALPHA _ALPHA32,_ALPHA32 +_ARCCOT,Mathematical Operations +_ARCCSC,Mathematical Operations +_ARCSEC,Mathematical Operations _ASIN,_ASIN _ASINH,_ASINH _ASSERT,_ASSERT @@ -50,11 +53,11 @@ _CONTROLCHR,_CONTROLCHR _CONTROLCHR,_CONTROLCHR (function) _COPYIMAGE,_COPYIMAGE _COPYPALETTE,_COPYPALETTE -_COT,Mathematical_Operations -_COTH,Mathematical_Operations -_COSH,Mathematical_Operations -_CSC,Mathematical_Operations -_CSCH,Mathematical_Operations +_COT,Mathematical Operations +_COTH,Mathematical Operations +_COSH,Mathematical Operations +_CSC,Mathematical Operations +_CSCH,Mathematical Operations _CV,_CV _CWD$,_CWD$ _D2G,_D2G @@ -86,6 +89,7 @@ _ECHO,_ECHO $ELSE,$ELSE $ELSEIF,$ELSEIF $END,$END IF +_ENVIRONCOUNT,_ENVIRONCOUNT $ERROR,$ERROR _ERRORLINE,_ERRORLINE _ERRORMESSAGE$,_ERRORMESSAGE$ @@ -143,6 +147,7 @@ _MEMGET,_MEMGET (function) _MEMIMAGE,_MEMIMAGE _MEMNEW,_MEMNEW _MEMPUT,_MEMPUT +_MEMSOUND,_MEMSOUND _MIDDLE,_SCREENMOVE _SCREENMOVE,_SCREENMOVE _MK$,_MK$ @@ -152,7 +157,6 @@ _MOUSEINPUT,_MOUSEINPUT _MOUSEMOVE,_MOUSEMOVE _MOUSEMOVEMENTX,_MOUSEMOVEMENTX _MOUSEMOVEMENTY,_MOUSEMOVEMENTY -_MOUSEPIPEOPEN,_MOUSEPIPEOPEN _MOUSESHOW,_MOUSESHOW _MOUSEWHEEL,_MOUSEWHEEL _MOUSEX,_MOUSEX @@ -196,6 +200,8 @@ _RGB32,_RGB32 _RGBA,_RGBA _RGBA32,_RGBA32 _ROUND,_ROUND +_SEC,Mathematical Operations +_SECH,Mathematical Operations _SCREENCLICK,_SCREENCLICK _SCREENEXISTS,_SCREENEXISTS $SCREENHIDE,$SCREENHIDE @@ -216,7 +222,7 @@ _SETBIT,_SETBIT _SHELLHIDE,_SHELLHIDE _SHL,_SHL _SHR,_SHR -_SINH,Mathematical_Operations +_SINH,Mathematical Operations _SNDBAL,_SNDBAL _SNDCLOSE,_SNDCLOSE _SNDCOPY,_SNDCOPY @@ -244,7 +250,7 @@ _SOURCE,_SOURCE (function) _STARTDIR$,_STARTDIR$ _STRCMP,_STRCMP _STRICMP,_STRICMP -_TANH,Mathematical_Operations +_TANH,Mathematical Operations _TITLE,_TITLE _TITLE$,_TITLE$ _TOGGLEBIT,_TOGGLEBIT @@ -276,12 +282,10 @@ BSAVE,BSAVE BYVAL,BYVAL CALL,CALL CALL,CALL ABSOLUTE -CALLS,CALLS CASE,CASE CASE,CASE ELSE CASE,CASE IS CDBL,CDBL -CDECL,CDECL CHAIN,CHAIN CHDIR,CHDIR CHR$,CHR$ @@ -306,8 +310,6 @@ CVS,CVS CVSMBF,CVSMBF DATA,DATA DATE$,DATE$ -DATE$,DATE$ (statement) -DECLARE,DECLARE (non-BASIC statement) DECLARE,DECLARE LIBRARY DECLARE,DECLARE DYNAMIC LIBRARY DEF,DEF SEG @@ -334,22 +336,18 @@ ENVIRON$,ENVIRON$ EOF,EOF EQV,EQV ERASE,ERASE -ERDEV,ERDEV -ERDEV$,ERDEV$ ERL,ERL ERR,ERR ERROR,ERROR EXIT,EXIT EXP,EXP FIELD,FIELD -FILEATTR,FILEATTR FILES,FILES FIX,FIX NEXT,FOR...NEXT FOR,FOR...NEXT NEXT,FOR...NEXT FOR,FOR (file statement) -FRE,FRE FREE,TIMER (statement) TIMER,TIMER (statement) FREEFILE,FREEFILE @@ -376,8 +374,6 @@ INT,INT INTEGER,INTEGER INTERRUPT,INTERRUPT INTERRUPTX,INTERRUPTX -IOCTL,IOCTL -IOCTL$,IOCTL$ KEY,KEY n KEY,KEY(n) KEY,KEY LIST @@ -486,12 +482,10 @@ SCREEN,SCREEN SEEK,SEEK SEEK,SEEK (statement) SELECT,SELECT CASE -SETMEM,SETMEM SGN,SGN SHARED,SHARED SHELL,SHELL SHELL,SHELL (function) -SIGNAL,SIGNAL SIN,SIN SINGLE,SINGLE SLEEP,SLEEP @@ -612,8 +606,8 @@ _glDrawBuffer,_glDrawBuffer _glDrawElements,_glDrawElements _glDrawPixels,_glDrawPixels _glEdgeFlag,_glEdgeFlag -_glEdgeFlagPointer,_glEdgeFlagPointer _glEdgeFlagv,_glEdgeFlagv +_glEdgeFlagPointer,_glEdgeFlagPointer _glEnable,_glEnable _glEnableClientState,_glEnableClientState _glEnd,_glEnd