set_ray_output(3G)

NAME

set_ray_output, inq_ray_output − enable/disable automatic ray trace output to screen; inquire current state of ray trace output

SYNOPSIS

C Syntax:

void set_ray_output(fildes,scene_id,screen_on);
int fildes,scene_id,screen_on;

void inq_ray_output(fildes,scene_id,screen_on);
int fildes,scene_id,*screen_on;

FORTRAN77 Syntax:

subroutine set_ray_output(fildes,scene_id,screen_on)
integer*4 fildes,scene_id,screen_on

subroutine inq_ray_output(fildes,scene_id,screen_on)
integer*4 fildes,scene_id,screen_on

Pascal Syntax:

procedure set_ray_output(fildes,scene_id,screen_on:integer);

procedure inq_ray_output(fildes,scene_id:integer;
var screen_on:integer);

DESCRIPTION

Input Parameters

fildes Integer file descriptor returned by gopen when an I/O path to a graphics device is opened.

scene_id Scene identifier; as returned by create_scene.

Input/Output Parameters

screen_on If TRUE (1), the ray tracing image is output to the screen as well as to a bitmap file during computation. If FALSE (0), output goes only into the bitmap file.

Discussion

The RGB image created by a ray tracing computation is always written into a bitmap file for later output with output_scene. If screen_on is TRUE (1), however, the image is also written to the screen as the computation progresses. Note that the output to the screen is affected by the current state of Starbase. Commands such as display_enable and write_enable, which modify screen output must be set appropriately or the displayed image may not match the file image.

If the display is an 8-plane device, the output to the screen will be dithered to 8-bit color (the image written to the bitmap file is always 24 bits). The dithering procedure can be controlled by calling set_ray_dither_parms prior to computation.

NOTES

Ray tracing parameters do not affect radiosity renderings of scene_id.
This command cannot be stored in a segment.

ERRORS

Invalid file descriptor.
Invalid scene_id.
Invalid value for screen_on.

DEFAULTS

screen_on = TRUE (1): screen output is on.

Museum

Related Articles