| N F O _ G E T S C P A R A M S ( )
| | | | | SOURCE: qdev_autodocs.txt 1.163 (12/09/2014) English AMIGA - NFO_#?
----------------------------------------------------------------------------
NAME
nfo_getscparams() - Obtains modeid and/or depth from
given 'screen'.
SYNOPSIS
res = nfo_getscparams(screen, modeid, depth);
BOOL nfo_getscparams(struct Screen *, ULONG *, UWORD *);
FUNCTION
This function allows to get screenmode and/or depth in
two ways. It can get modeid of currently passed 'screen'
(which can be the active one) or from the 'Workbench'
screen. Additionally if 'Workbench' is closed then it
tries to load 'screenmode.prefs' from: 'ENV:Sys/' and if
that fails then from archive at: 'EnvArc:Sys/' or from:
'SYS:Prefs/Env-Archive/Sys/'.
INPUTS
screen - Screen pointer or NULL('Workbench') or -1 to
read from file only.
modeid - Address of ULONG container or NULL if data is
not to be obtained.
depth - Address of UWORD container or NULL if data is
not to be obtained.
RETURNS
Returns TRUE upon success or FALSE if something went
wrong.
BASES
SysBase, (DOSBase), GfxBase, (IntuitionBase)
NOTES
Passing NULL to 'modeid' and 'depth' at the same time
is considered no-op.
If you want to fetch 'Workbench' params with NULL in
'screen' then you should inspect 'modeid' with
'nfo_findgfxsm()', because the result might be read
from 'screenmode.prefs' and that need not to be valid!
SEE ALSO
ctl_getsmparams(), ctl_setsmparams()
EXAMPLE
None.
BUGS
None known.
----------------------------------------------------------------------------
| |
| |