Wiki source for KeyPgScreenunlock


Show raw source

{{fbdoc item="title" value="SCREENUNLOCK"}}----
Unlocks work page's framebuffer

{{fbdoc item="syntax"}}##
[[KeyPgDeclare|declare]] [[KeyPgSub|sub]] **Screenunlock** ( [[KeyPgByval|byval]] //startline// [[KeyPgAs|as]] [[KeyPgLong|long]] = -1, [[KeyPgByval|byval]] //endline// [[KeyPgAs|as]] [[KeyPgLong|long]] = -1 )
##
{{fbdoc item="usage"}}##
**Screenunlock** [ //start_line// ] [, //end_line// ]
##
{{fbdoc item="param"}}
##//startline//##
optional argument specifying first screen line to be updated. If omitted, top screen line is assumed.
##//endline//##
optional argument specifying last screen line to be updated. If omitted, bottom screen line is assumed.

{{fbdoc item="desc"}}
##**Screenunlock**## unlocks the current work page assuming it was previously locked by calling ##[[KeyPgScreenlock|Screenlock]]## and lets the system restart updating the screen regularly. When called with ##start_line## and ##end_line## , only the screen area between those lines is assumed to have changed, and will be updated.

An internal counter exists that remembers the screen lock state, thus ##**Screenunlock**## has an effect only on a screen that is locked. A screen that has not been locked with ##**Screenlock**## cannot get unlocked, however ##**Screenunlock**## still will force an update of given area or full screen.

Calls to ##**Screenunlock**## must be paired with matching calls to ##**[[KeyPgScreenlock|Screenlock]]**##. Only the first call to ##**[[KeyPgScreenlock|Screenlock]]**## actually performs a locking operation. Subsequent calls to ##**Screenlock**## only increment the lock counter. Conversely, ##**Screenunlock**## only decrements the lock counter until it reaches zero at which time the actual unlock operation will be performed. Using ##[[KeyPgScreengraphics|Screen]]## or ##[[KeyPgScreenres|Screenres]]## will release all locks and set the lock counter back to zero before changing screen modes.

All graphic statements automatically lock the screen before the function call, and unlock the screen afterwards, so you do not need to do this explicitly using ##**[[KeyPgScreenlock|Screenlock]]**## and ##**Screenunlock**##. You only need to lock the screen when you wish to access the screen (framebuffer) directly using ##[[KeyPgScreenptr|Screenptr]]## or when you wish to group several graphic statements together so their effects appear simultaneously on screen, thus avoiding potential screen flicker during screen updates.

Warning (""Win32"", Linux) : The screen is locked by stopping the thread that processes also the OS' events. This means the screen should be locked only for the short time required to redraw it, and no user input will be received while the screen is locked. When the induced lock time becomes too long, use preferably the method of double buffering (with ##[[KeyPgScreencopy|Screencopy]]##).

{{fbdoc item="ex"}}
See ##[[KeyPgScreenptr|Screenptr]]## example.

{{fbdoc item="lang"}}
- Not available in the //[[CompilerOptlang|-lang qb]]// dialect unless referenced with the alias ##**""__Screenunlock""**##.

{{fbdoc item="diff"}}
- New to ""FreeBASIC""

{{fbdoc item="see"}}
- ##[[KeyPgScreengraphics|Screen (Graphics)]]##
- ##[[KeyPgScreenlock|Screenlock]]##
- ##[[KeyPgScreenptr|Screenptr]]##

{{fbdoc item="back" value="CatPgGfxScreen|Screen Functions"}}
Valid XHTML :: Valid CSS: :: Powered by WikkaWiki



sf.net phatcode