1K-3D(1)                          User Commands                         K-3D(1)
2
3
4

NAME

6       k3d-renderframe - Part of a simple system for queueing K-3D render jobs
7       on the local host
8

SYNOPIS

10       k3d-renderframe [options] [directory ...]
11

DESCRIPTION

13       Extracted from http://www.k-3d.org/wiki/Network_Rendering
14
15              Currently, K-3D implements a simple system for queueing  render‐
16              ing  jobs on the local host. When the user initiates a job (such
17              as rendering a preview image, rendering a final frame,  or  ren‐
18              dering  an  animation),  a  job directory is created (usually in
19              /tmp, although this can be configured). The job  directory  con‐
20              tains a lock file, a control file named control.k3d, and one-to-
21              many numbered frame directories.  The  name  of  the  lock  file
22              changes to flag the sta.IP tus of the job as "ready", "running",
23              "complete",  or  "error".  The  control.k3d  file  is  currently
24              unused.   Each  frame  directory contains a lock file, a control
25              file named control.k3d and  zero-to-many  frame  resources.  The
26              name of the lock file changes to flag the status of the frame as
27              "ready", "running", "complete", or "error". The control.k3d file
28              is  an  XML  file  that encodes a set of operations that must be
29              completed successfully to change the status of  the  frame  from
30              "ready"  to  "complete". Three types of operation are allowed: a
31              "render" operation that executes a pre-configured render command
32              using  a fixed set of command-line arguments, a "copy" operation
33              that copies a file from one filesystem location to another;  and
34              a "view" operation that displays a bitmap image using the user's
35              choice of image viewer. The frame resources are  inputs  to  the
36              render engine, such as RIB files, texture images, shaders, etc.
37
38              The  k3d-renderjob  executable  is  run  with  the path to a job
39              directory as an argument. k3d-renderjob  updates  the  job  lock
40              file,  iterating over each frame directory, spawning an instance
41              of k3d-renderframe for each frame (one at a  time).  k3d-render‐
42              frame  is run with the path to a frame directory as an argument,
43              updating the frame lock file, reading the control file, and exe‐
44              cuting the operations that it specifies.
45
46       -h, --help
47              prints this help information and exits
48
49       --version
50              prints program version information and exits
51

AUTHOR

53       Written by Manuel A. Fernandez Montecelo <manuel.montezelo@gmail.com>
54
56       Copyright (c) 1995-2010, Timothy M. Shead.  All Rights Reserved.
57       This  software  is  licensed  under the terms of the GNU General Public
58       License; see the source for copying conditions.  There is NO  warranty;
59       not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
60
61

SEE ALSO

63       The K-3D Home Page: http://www.k-3d.org
64
65
66
67K-3D Version 0.8.0.2               June 2010                           K-3D(1)
Impressum