--- ray/src/hd/rhdriver.h 1997/12/31 09:06:54 3.11 +++ ray/src/hd/rhdriver.h 2003/02/22 02:07:25 3.21 @@ -1,7 +1,4 @@ -/* Copyright (c) 1997 Silicon Graphics, Inc. */ - -/* SCCSid "$SunId$ SGI" */ - +/* RCSid: $Id: rhdriver.h,v 3.21 2003/02/22 02:07:25 greg Exp $ */ /* * Header file for holodeck device driver routines. */ @@ -10,36 +7,43 @@ extern struct driver { char *name; /* holodeck name or title */ - VIEW v; /* preferred view parameters */ - int hres, vres; /* device resolution */ + VIEW v; /* base view parameters */ + int hres, vres; /* base view resolution */ int ifd; /* input file descriptor (for select) */ + int firstuse; /* non-zero if driver can't recycle samples */ + int inpready; /* number of unprocessed input events */ } odev; /* our open device */ +extern char odev_args[]; /* command arguments, if any */ + extern int imm_mode; /* bundles are being delivered immediately */ +extern double eyesepdist; /* world eye separation distance */ + /* user commands */ -#define DC_SETVIEW 0 /* set the view */ -#define DC_GETVIEW 1 /* print the current view */ +#define DC_SETVIEW 0 /* set the base view */ +#define DC_GETVIEW 1 /* print the current base view */ #define DC_LASTVIEW 2 /* restore previous view */ -#define DC_PAUSE 3 /* pause the current calculation */ -#define DC_RESUME 4 /* resume the calculation */ -#define DC_REDRAW 5 /* redraw from server */ -#define DC_KILL 6 /* kill rtrace process(es) */ -#define DC_RESTART 7 /* restart rtrace process(es) */ -#define DC_CLOBBER 8 /* clobber holodeck file */ -#define DC_QUIT 9 /* quit the program */ +#define DC_FOCUS 3 /* view focus */ +#define DC_PAUSE 4 /* pause the current calculation */ +#define DC_RESUME 5 /* resume the calculation */ +#define DC_REDRAW 6 /* redraw from server */ +#define DC_KILL 7 /* kill rtrace process(es) */ +#define DC_RESTART 8 /* restart rtrace process(es) */ +#define DC_CLOBBER 9 /* clobber holodeck file */ +#define DC_QUIT 10 /* quit the program */ -#define DC_NCMDS 10 /* number of commands */ +#define DC_NCMDS 11 /* number of commands */ /* dev_input() returns flags from above */ #define DFL(dc) (1<<(dc)) #define CTRL(c) ((c)-'@') /* commands entered in display window */ -#define DV_INIT {'\0','v','l','p','\r',CTRL('L'),'K','R','C','q'} +#define DV_INIT {'\0','v','l','f','p','\r',CTRL('L'),'K','R','C','q'} /* commands entered on stdin */ -#define DC_INIT {"VIEW=","where","last","pause","resume","redraw",\ - "kill","restart","clobber","quit"} +#define DC_INIT {"VIEW=","where","last","frame","pause","resume",\ + "redraw","kill","restart","clobber","quit"} /************************************************************************ @@ -51,15 +55,15 @@ dev_open(nm) : prepare the device char *nm; : appropriate title bar annotation Sets fields of odev structure and prepares the display for i/o. -The view type, horizontal and vertical view angles and other default -parameters in odev.v should also be assigned. +The base view type, horizontal and vertical view angles and other +default parameters in odev.v should also be assigned. int -dev_view(nv) : set display view parameters +dev_view(nv) : set base view parameters VIEW *nv; : the new view -Updates the display for the given view change. +Updates the display for the given base view change. Look for nv==&odev.v when making view current after dev_input() returns DEV_NEWVIEW flag. Return 1 on success, or 0 if the new view would conflict with device requirements. In the latter @@ -68,20 +72,28 @@ error(COMMAND, "appropriate user warning"). void -dev_value(c, p, v) : register new point of light +dev_clear() : clear device memory + +Clear the device memory in preparation for fresh data. Clearing +the screen is optional. + + +void +dev_value(c, d, p) : register new point of light COLR c; : pixel color (RGBE) +FVECT d; : ray direction vector FVECT p; : world intersection point -FVECT v; : ray direction vector Add the given color point to the display output queue. If imm_mode is -non-zero, then values are being sent in rapid succession. +non-zero, then values are being sent in rapid succession. If p is NULL, +then the point is at infinity. int dev_flush() : flush the output and prepare for select call Updates display, taking any pending action required before select(2) call. -Returns non-zero if there is device input available. +Returns non-zero if there is device input available, setting odev.inpready. int @@ -90,10 +102,55 @@ dev_input() : process pending display input Called when odev struct file descriptor shows input is ready. Returns flags indicating actions to take in the control process. If the DC_VIEW or DC_RESIZE flag is returned, the odev -structure must be updated beforehand. +structure must be updated beforehand. If the DC_FOCUS +flag is set, then odev_args contains the frame dimensions. +No events shall remain when this function returns, +and odev.inpready will therefore be 0. +void +dev_auxcom(cmd, args) : process auxiliary command +char *cmd, *args; : command name and argument string +Execute an auxiliary command (not one of those listed at the head of +this file). The cmd argument points to the command name itself, and +the args argument points to a string with the rest of the input line. +If the command isn't known or there ARE no auxiliary commands, print +an appropriate COMMAND error message and return. + + +VIEW * +dev_auxview(n, hv) : return nth auxiliary view +int n; : auxiliary view number +int hv[2]; : returned horiz. and vert. image resolution + +Return the nth auxiliary view associated with the current base view. +The hv entries are assigned the horizontal and vertical view resolution, +respectively. Function returns NULL if there are no more auxiliary +views. The zeroeth auxiliary view is the base view itself. + + void +dev_section(gf, pf) : add geometry and ports for rendering +char *gf; : geometry file name +char *pf; : portal file name(s) + +Add the given geometry file to the list of geometry to render for +intermediate views if direct geometry rendering is available. The +second argument gives the name(s) of any portal geometry files +associated with this section. Multiple portal file names are separated +by spaces. A single octree file will be given for the geometry, ending +in the ".oct" suffix. Portal files will be given as zero or more +Radiance scene description file names. If no portals are given for +this section, the string may be NULL. The character strings are +guaranteed to be static (or permanently allocated) such that they may +be safely stored as a pointer. The same pointers or file lists may be +(and often are) given repeatedly. If a given geometry file does not +exist, the call should be silently ignored. If gf is NULL, then the +last section has been given, and the display can be updated with the +new information. + + +void dev_close() : close the display Close the display device and free up resources in preparation for exit. @@ -101,3 +158,8 @@ Set odev.v.type=0 and odev.hres=odev.vres=0 when done. ************************************************************************/ + + +extern VIEW *dev_auxview(); + +extern int2 *beam_view();