Difference between revisions of "PRINTMODE (function)"

From QB64 Wiki
Jump to navigation Jump to search
imported>Clippy
m
imported>SMcNeill
(style guidelines)
Line 1: Line 1:
 
{{DISPLAYTITLE:_PRINTMODE (function)}}
 
{{DISPLAYTITLE:_PRINTMODE (function)}}
The '''_PRINTMODE''' function returns the present {{KW|_PRINTMODE}} status as a numerical value from 1 to 3 in graphic screen modes only.
+
The [[_PRINTMODE (function)|_PRINTMODE]] function returns the current [[_PRINTMODE]] status as a numerical value from 1 to 3 in graphic screen modes.
  
  
 
{{PageSyntax}}
 
{{PageSyntax}}
:::current_print_mode = '''_PRINTMODE'''[({{Parameter|image_handle}})]
+
: {{Parameter|currentPrintMode}} = [[_PRINTMODE (function)|_PRINTMODE]][({{Parameter|imageHandle&}})]
  
  
 
{{Parameters}}
 
{{Parameters}}
* If no brackets and ''image_handle'' parameter are given, the current [[_DEST|destination]] [[SCREEN]] page or image is assumed.
+
* If no {{Parameter|imageHandle&}} is given, the current [[_DEST|destination]] [[SCREEN]] page or image is assumed.
* If the handle value enclosed in brackets is 0 then the current program [[SCREEN]] page is assumed.
 
  
  
 
{{PageDescription}}
 
{{PageDescription}}
 
* Returns a status value from 1 to 3 designating the current mode setting:
 
* Returns a status value from 1 to 3 designating the current mode setting:
::::'''1''': mode is _KEEPBACKGROUND
+
** '''1''': mode is _KEEPBACKGROUND
::::'''2''': mode is _ONLYBACKGROUND
+
** '''2''': mode is _ONLYBACKGROUND
::::'''3''': mode is _FILLBACKGROUND (default)
+
** '''3''': mode is _FILLBACKGROUND '''(default)'''
* '''The _PRINTMODE statement and function can only be used in graphic screen modes, NOT SCREEN 0'''
+
* '''The [[_PRINTMODE]] statement and function can only be used in graphic screen modes, not SCREEN 0'''
  
  

Revision as of 20:09, 8 September 2017

The _PRINTMODE function returns the current _PRINTMODE status as a numerical value from 1 to 3 in graphic screen modes.


Syntax

currentPrintMode = _PRINTMODE[(imageHandle&)]


Parameters

  • If no imageHandle& is given, the current destination SCREEN page or image is assumed.


Description

  • Returns a status value from 1 to 3 designating the current mode setting:
    • 1: mode is _KEEPBACKGROUND
    • 2: mode is _ONLYBACKGROUND
    • 3: mode is _FILLBACKGROUND (default)
  • The _PRINTMODE statement and function can only be used in graphic screen modes, not SCREEN 0


See also



Navigation:
Keyword Reference - Alphabetical
Keyword Reference - By Usage
Main Wiki Page