Documented GVF_SAVE_VAR alongside other flags, and removed a query/doubt
[AROS.git] / rom / graphics / coercemode.c
blob757a90d4059cafac30d710a2ebb689228371ae5c
1 /*
2 Copyright © 1995-2007, The AROS Development Team. All rights reserved.
3 $Id$
5 Desc: Graphics function CoerceMode()
6 Lang: english
7 */
8 #include <aros/debug.h>
9 #include <graphics/view.h>
11 #include "graphics_intern.h"
13 /*****************************************************************************
15 NAME */
16 #include <proto/graphics.h>
18 AROS_LH3(ULONG, CoerceMode,
20 /* SYNOPSIS */
21 AROS_LHA(struct ViewPort *, RealViewPort, A0),
22 AROS_LHA(ULONG, MonitorID, D0),
23 AROS_LHA(ULONG, Flags, D1),
25 /* LOCATION */
26 struct GfxBase *, GfxBase, 156, Graphics)
28 /* FUNCTION
29 Determine the best mode in the MonitorID to coerce RealViewPort to.
31 INPUTS
32 RealViewPort - ViewPort to coerce
33 MonitorID - Monitor number to coerce to
34 (i.e. a mode masked with MONITOR_ID_MASK)
35 Flags - PRESERVE_COLORS - keep the number of bitplanes
36 in the ViewPort
37 AVOID_FLICKER - do not coerce to an interlace mode
39 RESULT
40 ID - ID of best mode to coerce to, or INVALID_ID if could not coerce
42 NOTES
44 EXAMPLE
46 BUGS
47 This function is unimplemented.
49 SEE ALSO
51 INTERNALS
53 HISTORY
56 ******************************************************************************/
58 AROS_LIBFUNC_INIT
60 /* TODO: Write graphics/CoerceMode() */
61 aros_print_not_implemented ("CoerceMode");
63 return INVALID_ID;
65 AROS_LIBFUNC_EXIT
66 } /* CoerceMode */