Documented GVF_SAVE_VAR alongside other flags, and removed a query/doubt
[AROS.git] / rom / graphics / getvpmodeid.c
blob735f0134ad178f68de297063c4d00f2cbaf66cf5
1 /*
2 Copyright © 1995-2010, The AROS Development Team. All rights reserved.
3 $Id$
5 Desc: Graphics function GetVPModeID()
6 Lang: english
7 */
8 #include <aros/debug.h>
9 #include <graphics/view.h>
10 #include <graphics/modeid.h>
11 #include <hidd/graphics.h>
12 #include <proto/graphics.h>
14 #include "graphics_intern.h"
15 #include "dispinfo.h"
16 #include "gfxfuncsupport.h"
18 /*****************************************************************************
20 NAME */
21 #include <proto/graphics.h>
23 AROS_LH1(ULONG, GetVPModeID,
25 /* SYNOPSIS */
26 AROS_LHA(struct ViewPort *, vp, A0),
28 /* LOCATION */
29 struct GfxBase *, GfxBase, 132, Graphics)
31 /* FUNCTION
32 returns the normal display modeID, if one is currently associated
33 with this ViewPort
35 INPUTS
36 vp - pointer to ViewPort structure
38 RESULT
39 modeID - a 32 bit DisplayInfoRecord identifier associated
40 with this ViewPort, or INVALID_ID
42 NOTES
44 EXAMPLE
46 BUGS
48 SEE ALSO
49 ModeNotAvailable(), graphics/displayinfo.h
51 INTERNALS
53 HISTORY
56 ******************************************************************************/
58 AROS_LIBFUNC_INIT
60 ULONG modeid;
62 if (vp->ColorMap)
63 /* If we have a colormap, get ModeID from it */
64 modeid = vp->ColorMap->VPModeID;
65 else if (IS_HIDD_BM(vp->RasInfo->BitMap))
66 modeid = GET_BM_MODEID(vp->RasInfo->BitMap);
67 else
68 modeid = INVALID_ID;
70 D(bug(" GetVPModeID returning %x\n", modeid));
71 return modeid;
73 AROS_LIBFUNC_EXIT
74 } /* GetVPModeID */