ViewVC Help
View File | Revision Log | Show Annotations | Download File | Root Listing
root/radiance/ray/src/hd/rhdriver.h
Revision: 3.14
Committed: Wed Jun 17 15:44:07 1998 UTC (25 years, 9 months ago) by gwlarson
Content type: text/plain
Branch: MAIN
Changes since 3.13: +13 -1 lines
Log Message:
added dev_auxcom() for auxiliary command handling

File Contents

# Content
1 /* Copyright (c) 1998 Silicon Graphics, Inc. */
2
3 /* SCCSid "$SunId$ SGI" */
4
5 /*
6 * Header file for holodeck device driver routines.
7 */
8
9 #include "view.h"
10
11 extern struct driver {
12 char *name; /* holodeck name or title */
13 VIEW v; /* base view parameters */
14 int hres, vres; /* base view resolution */
15 int ifd; /* input file descriptor (for select) */
16 } odev; /* our open device */
17
18 extern int imm_mode; /* bundles are being delivered immediately */
19
20 extern double eyesepdist; /* world eye separation distance */
21
22 /* user commands */
23 #define DC_SETVIEW 0 /* set the base view */
24 #define DC_GETVIEW 1 /* print the current base view */
25 #define DC_LASTVIEW 2 /* restore previous view */
26 #define DC_PAUSE 3 /* pause the current calculation */
27 #define DC_RESUME 4 /* resume the calculation */
28 #define DC_REDRAW 5 /* redraw from server */
29 #define DC_KILL 6 /* kill rtrace process(es) */
30 #define DC_RESTART 7 /* restart rtrace process(es) */
31 #define DC_CLOBBER 8 /* clobber holodeck file */
32 #define DC_QUIT 9 /* quit the program */
33
34 #define DC_NCMDS 10 /* number of commands */
35
36 /* dev_input() returns flags from above */
37 #define DFL(dc) (1<<(dc))
38
39 #define CTRL(c) ((c)-'@')
40 /* commands entered in display window */
41 #define DV_INIT {'\0','v','l','p','\r',CTRL('L'),'K','R','C','q'}
42 /* commands entered on stdin */
43 #define DC_INIT {"VIEW=","where","last","pause","resume","redraw",\
44 "kill","restart","clobber","quit"}
45
46
47 /************************************************************************
48 * Driver routines (all are required):
49
50
51 void
52 dev_open(nm) : prepare the device
53 char *nm; : appropriate title bar annotation
54
55 Sets fields of odev structure and prepares the display for i/o.
56 The base view type, horizontal and vertical view angles and other
57 default parameters in odev.v should also be assigned.
58
59
60 int
61 dev_view(nv) : set base view parameters
62 VIEW *nv; : the new view
63
64 Updates the display for the given base view change.
65 Look for nv==&odev.v when making view current after dev_input()
66 returns DEV_NEWVIEW flag. Return 1 on success, or 0 if the
67 new view would conflict with device requirements. In the latter
68 case, reset parameters in nv to make it more agreeable, calling
69 error(COMMAND, "appropriate user warning").
70
71
72 void
73 dev_clear() : clear device memory
74
75 Clear the device memory in preparation for fresh data. Clearing
76 the screen is optional.
77
78
79 void
80 dev_value(c, p, v) : register new point of light
81 COLR c; : pixel color (RGBE)
82 FVECT p; : world intersection point
83 FVECT v; : ray direction vector
84
85 Add the given color point to the display output queue. If imm_mode is
86 non-zero, then values are being sent in rapid succession.
87
88
89 int
90 dev_flush() : flush the output and prepare for select call
91
92 Updates display, taking any pending action required before select(2) call.
93 Returns non-zero if there is device input available.
94
95
96 int
97 dev_input() : process pending display input
98
99 Called when odev struct file descriptor shows input is ready.
100 Returns flags indicating actions to take in the control process.
101 If the DC_VIEW or DC_RESIZE flag is returned, the odev
102 structure must be updated beforehand.
103
104 void
105 dev_auxcom(cmd, args) : process auxiliary command
106 char *cmd, *args; : command name and argument string
107
108 Execute an auxiliary command (not one of those listed at the head of
109 this file). The cmd argument points to the command name itself, and
110 the args argument points to a string with the rest of the input line.
111 If the command isn't known or there ARE no auxiliary commands, print
112 an appropriate COMMAND error message and return.
113
114
115 VIEW *
116 dev_auxview(n, hv) : return nth auxiliary view
117 int n; : auxiliary view number
118 int hv[2]; : returned horiz. and vert. image resolution
119
120 Return the nth auxiliary view associated with the current base view.
121 The hv entries are assigned the horizontal and vertical view resolution,
122 respectively. Function returns NULL if there are no more auxiliary
123 views. The zeroeth auxiliary view is the base view itself.
124
125
126 void
127 dev_close() : close the display
128
129 Close the display device and free up resources in preparation for exit.
130 Set odev.v.type=0 and odev.hres=odev.vres=0 when done.
131
132
133 ************************************************************************/
134
135
136 extern VIEW *dev_auxview();