Help Center
Help CenterFreeBASIC

ScreenListfunction

Finds available fullscreen video modes

Screen Functionsfunctiondocumented

Syntax

Declare Function ScreenList ( ByVal depth As Long = 0 ) As Long

Parameters

NameDescription
depththe color depth for which the list of modes is requested (supported depths are 8, 15, 16, 24 and 32)

Return value


returns 0, when there are no more resolutions to read.

Description


It works like the Dir function: the first call to the function requires the depth parameter to be specified, it returns the lowest supported resolution for the requested depth. Further calls to ScreenList without arguments returns the next resolutions. When no more resolutions are available, ScreenList returns 0.

The result of ScreenList is encoded as a 32 bit value, with the screen width as the High Word and the height as the Low Word.

Resolutions are returned from lowest to highest supported ones.

It is safe to call this function before any graphics mode has been set.

Remarks

Usage


result = ScreenList( [ depth ] )

Dialect Differences


  • Not available in the -lang qb dialect unless referenced with the alias __Screenlist.

Differences from QB


  • New to FreeBASIC

See also


Example


Dim As Long mode

Dim As UInteger w, h



Print "Resolutions supported at 8 bits per pixel:"



mode = ScreenList(8)

While (mode <> 0)

    w = HiWord(mode)

    h = LoWord(mode)

    Print w & "x" & h

    mode = ScreenList()

Wend

Reference

  • Documented in KeyPgScreenlist.html