ViewVC Help
View File | Revision Log | Show Annotations | Download File | Root Listing
root/radiance/ray/src/hd/rhdisp.h
Revision: 3.15
Committed: Mon Jul 14 22:24:00 2003 UTC (21 years, 4 months ago) by schorsch
Content type: text/plain
Branch: MAIN
Changes since 3.14: +13 -1 lines
Log Message:
Instrumented headers against multiple inclusion and for use from C++.
Moved includes in headers out of "C" scope.

File Contents

# User Rev Content
1 schorsch 3.15 /* RCSid: $Id: rhdisp.h,v 3.14 2003/06/20 00:25:49 greg Exp $ */
2 gregl 3.1 /*
3     * Header for holodeck display drivers.
4     */
5 schorsch 3.15 #ifndef _RAD_RHDISP_H_
6     #define _RAD_RHDISP_H_
7    
8     #ifdef __cplusplus
9     extern "C" {
10     #endif
11 gregl 3.1
12     /* display requests */
13 gregl 3.4 #define DR_NOOP 0 /* to release from vain DR_ATTEN */
14 gregl 3.5 #define DR_BUNDLE 1 /* lone bundle request */
15 gregl 3.2 #define DR_ATTEN 2 /* request for attention */
16     #define DR_SHUTDOWN 3 /* shutdown request */
17     #define DR_NEWSET 4 /* new bundle set */
18 gregl 3.1 #define DR_ADDSET 5 /* add to current set */
19 gregl 3.9 #define DR_ADJSET 6 /* adjust set quantities */
20 gregl 3.5 #define DR_DELSET 7 /* delete from current set */
21 gregl 3.9 #define DR_KILL 8 /* kill rtrace process(es) */
22     #define DR_RESTART 9 /* restart rtrace */
23     #define DR_CLOBBER 10 /* clobber holodeck */
24 gwlarson 3.12 #define DR_VIEWPOINT 11 /* set desired eye position */
25 gregl 3.1
26     /* server responses */
27 gregl 3.9 #define DS_BUNDLE 32 /* computed bundle */
28     #define DS_ACKNOW 33 /* acknowledge request for attention */
29     #define DS_SHUTDOWN 34 /* end process and close connection */
30     #define DS_ADDHOLO 35 /* register new holodeck */
31     #define DS_STARTIMM 36 /* begin immediate bundle set */
32     #define DS_ENDIMM 37 /* end immediate bundle set */
33 gregl 3.10 #define DS_OUTSECT 38 /* render from outside sections */
34 gwlarson 3.11 #define DS_EYESEP 39 /* eye separation distance */
35 gregl 3.1
36     /*
37     * Normally, the server channel has priority, with the display process
38     * checking it frequently for new data. However, when the display process
39     * makes a request for attention (DR_ATTEN), the server will finish its
40     * current operations and flush its buffers, sending an acknowledge
41     * message (DS_ACKNOW) when it's done. This then allows the
42     * display process to send a long request to the holodeck server.
43     * Priority returns to normal after the following request.
44     */
45    
46 gregl 3.3 #ifndef BIGREQSIZ
47     #define BIGREQSIZ 512 /* big request size (bytes) */
48     #endif
49    
50 gregl 3.1 typedef struct {
51 greg 3.14 int16 type; /* message type */
52     int32 nbytes; /* number of additional bytes */
53 gregl 3.1 } MSGHEAD; /* message head */
54 gregl 3.6
55     /*
56     * The display process is started with three arguments. The first argument
57     * is the short name of the holodeck file, appropriate for window naming, etc.
58     * The second and third arguments are the file descriptor numbers assigned to
59     * the server's standard output and input, respectively. The stdin and stdout
60     * of the display process are used for normal communication with the server,
61     * and are connected to pipes going each way. It is entirely appropriate
62     * for the display process to borrow the server's stdin and stdout for reading
63 gregl 3.8 * and writing user commands from the list in rhdriver.h. If standard input
64 gregl 3.6 * is not available for reading, then a descriptor of -1 will be passed.
65     * The standard output will always be available for writing, though it
66     * may go to /dev/null.
67     */
68 schorsch 3.15
69     #ifdef __cplusplus
70     }
71     #endif
72     #endif /* _RAD_RHDISP_H_ */
73