Difference between revisions of "HEIGHT"

From QB64 Wiki
Jump to navigation Jump to search
imported>Odin
m (1 revision imported)
imported>Odin
 
Line 1: Line 1:
#REDIRECT [[_HEIGHT, _WIDTH]]
{{DISPLAYTITLE:_HEIGHT}}
The [[_HEIGHT]] function returns the height of an image handle or of the current write page.
 
 
{{PageSyntax}}
: {{Parameter|columns&}} = [[_HEIGHT]][({{Parameter|imageHandle&}})]
 
 
{{PageDescription}}
* If {{Parameter|imageHandle&}} is omitted, it's assumed to be the handle of the current [[SCREEN]] or write page.
* To get the height of the current program [[SCREEN|screen]] window use zero for the handle value or nothing: {{Parameter|lines&}} = [[_HEIGHT]](0) ''or'' {{Parameter|lines&}} = [[_HEIGHT]]
* If the image specified by {{Parameter|imageHandle&}} is in text only([[SCREEN]] 0) mode, the number of characters per row is returned.
* If the image specified by {{Parameter|imageHandle&}} is in graphics mode, the number of pixels per row is returned.
* If {{Parameter|imageHandle&}} is an invalid handle, then an [[ERROR Codes|invalid handle error]] is returned.
* The last visible pixel coordinate of a program [[SCREEN|screen]] is '''[[_HEIGHT]] - 1'''.
 
 
 
{{PageSeeAlso}}
* [[_WIDTH (function)]], [[_LOADIMAGE]], [[_NEWIMAGE]]
* [[Bitmaps]]
 
 
{{PageNavigation}}

Latest revision as of 18:16, 20 January 2020

The _HEIGHT function returns the height of an image handle or of the current write page.


Syntax

columns& = _HEIGHT[(imageHandle&)]


Description

  • If imageHandle& is omitted, it's assumed to be the handle of the current SCREEN or write page.
  • To get the height of the current program screen window use zero for the handle value or nothing: lines& = _HEIGHT(0) or lines& = _HEIGHT
  • If the image specified by imageHandle& is in text only(SCREEN 0) mode, the number of characters per row is returned.
  • If the image specified by imageHandle& is in graphics mode, the number of pixels per row is returned.
  • If imageHandle& is an invalid handle, then an invalid handle error is returned.
  • The last visible pixel coordinate of a program screen is _HEIGHT - 1.


See also



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