Documented GVF_SAVE_VAR alongside other flags, and removed a query/doubt
[AROS.git] / rom / graphics / cwait.c
blob990de10e7a1b5f0659b4812c754a8a46e3d730ee
1 /*
2 Copyright © 1995-2007, The AROS Development Team. All rights reserved.
3 $Id$
5 Desc: Graphics function CWait()
6 Lang: english
7 */
8 #include <exec/types.h>
9 #include <graphics/copper.h>
10 #include "graphics_intern.h"
12 /*****************************************************************************
14 NAME */
15 #include <proto/graphics.h>
17 AROS_LH3(void, CWait,
19 /* SYNOPSIS */
20 AROS_LHA(struct UCopList *, ucl, A1),
21 AROS_LHA(WORD , v, D0),
22 AROS_LHA(WORD , h, D1),
24 /* LOCATION */
25 struct GfxBase *, GfxBase, 63, Graphics)
27 /* FUNCTION
28 Add a copper wait instruction to the given user copper list.
29 The copper is told to wait for a vertical beam position v and
30 a horizontal beam position h.
31 If you are using CWAIT() a call to CWait() and CBump() will
32 be made.
34 INPUTS
35 ucl - pointer to a UCopList structure
36 v - vertical beam position (relative to top of viewport)
37 h - horizontal beam position
39 RESULT
41 NOTES
43 EXAMPLE
45 BUGS
46 It's illegal to wait for horizontal values greater than 222 decimal!
48 SEE ALSO
49 CINIT(), CMOVE(), CEND(), graphics/copper.h
51 INTERNALS
53 HISTORY
55 *****************************************************************************/
57 AROS_LIBFUNC_INIT
59 struct CopIns * copIns = ucl->CopList->CopPtr;
60 copIns->OpCode = COPPER_WAIT;
61 copIns->u3.u4.u1.VWaitPos = v;
62 copIns->u3.u4.u2.HWaitPos = h;
64 AROS_LIBFUNC_EXIT
65 } /* CMove */