[cgkit-commits] cgkit2/doc/tex ribexport.tex,1.5,1.6

[Matthias B. <mb...@us...>]

Update of /cvsroot/cgkit/cgkit2/doc/tex
In directory sc8-pr-cvs1.sourceforge.net:/tmp/cvs-serv24271/doc/tex

Modified Files:
	ribexport.tex 
Log Message:
Added support for globals 'rib' and 'pixelfilter'. The output parameter can now also contain entire output specs or be None do disable any RiDisplay() call.

Index: ribexport.tex
===================================================================
RCS file: /cvsroot/cgkit/cgkit2/doc/tex/ribexport.tex,v
retrieving revision 1.5
retrieving revision 1.6
diff -C2 -d -r1.5 -r1.6
*** ribexport.tex	20 Sep 2005 13:41:19 -0000	1.5
--- ribexport.tex	16 Oct 2005 12:31:06 -0000	1.6
***************
*** 14,18 ****
  \begin{tableiii}{l|l|l}{code}{Option}{Default}{Description}
  \lineiii{camera}{\code{None}}{Camera object to be used}
! \lineiii{output}{\code{None}}{Output image file name}
  \lineiii{output_framebuffer}{\code{True}}{Framebuffer output?}
  \lineiii{bake}{\code{False}}{Activate texture baking mode}
--- 14,18 ----
  \begin{tableiii}{l|l|l}{code}{Option}{Default}{Description}
  \lineiii{camera}{\code{None}}{Camera object to be used}
! \lineiii{output}{\code{None}}{Output image file name or output specs}
  \lineiii{output_framebuffer}{\code{True}}{Framebuffer output?}
  \lineiii{bake}{\code{False}}{Activate texture baking mode}
***************
*** 24,34 ****
  If \code{None} is specified the first camera found in the scene is used.
  
! \var{output} is the output image file name. If \code{None} is specified
! the global \code{"output"} setting will be used. If this setting is not
! available the output will be called \code{"out.tif"}.
  
  \var{output_framebuffer} is a flag that specifies if a framebuffer
  display should be opened in addition to writing the output image file
! to disk.
  
  If \var{bake} is \code{True} the exported scene will bake a texture map
--- 24,36 ----
  If \code{None} is specified the first camera found in the scene is used.
  
! \var{output} is the output image file name or a list of output specifiers.
! Each specifier is a 4-tuple (\var{filename}, \var{type}, \var{mode},
! \var{params}) containing the parameters for a \function{RiDisplay()} call.
! The additional parameters must be given as a dictionary. \var{output} can
! also be \code{None} in which case no \function{RiDisplay()} call is made.
  
  \var{output_framebuffer} is a flag that specifies if a framebuffer
  display should be opened in addition to writing the output image file
! to disk. This flag is only used when \var{output} is a string.
  
  If \var{bake} is \code{True} the exported scene will bake a texture map
***************
*** 46,53 ****
  \begin{tableiii}{l|l|l}{code}{Option}{Default}{Description}
  \lineiii{displaymode}{\code{"rgb"}}{Display mode}
! \lineiii{output}{\code{None}}{Output image file name}
! \lineiii{pixelsamples}{\code{(2,2)}}{Number of pixel samples}
  \lineiii{resolution}{\code{(640,480)}}{Output image resolution}
  \lineiii{shadingrate}{\code{1.0}}{Shading rate}
  \end{tableiii}
  
--- 48,57 ----
  \begin{tableiii}{l|l|l}{code}{Option}{Default}{Description}
  \lineiii{displaymode}{\code{"rgb"}}{Display mode}
! \lineiii{output}{\code{None}}{Output image file name or output specs (see abvove)}
  \lineiii{resolution}{\code{(640,480)}}{Output image resolution}
+ \lineiii{pixelsamples}{\code{(2,2)}}{Number of pixel samples}
  \lineiii{shadingrate}{\code{1.0}}{Shading rate}
+ \lineiii{pixelfilter}{\code{None}}{Pixel filter setting}
+ \lineiii{rib}{\code{None}}{Additional global RIB requests}
  \end{tableiii}
  
***************
*** 56,62 ****
  to switch between "rgb" (default) and "rgba".
  
! \var{output} is the image output name (see above).
! 
! \var{pixelsamples} is a 2-tuple containing the pixel samples setting.
  
  \var{resolution} is either a 2-tuple (\var{width}, \var{height}) or a 3-tuple 
--- 60,65 ----
  to switch between "rgb" (default) and "rgba".
  
! \var{output} is the image output name or a list of output specifiers 
! (see above).
  
  \var{resolution} is either a 2-tuple (\var{width}, \var{height}) or a 3-tuple 
***************
*** 64,69 ****
--- 67,81 ----
  image resolution.
  
+ \var{pixelsamples} is a 2-tuple containing the pixel samples setting.
+ 
  \var{shadingrate} contains the shading rate setting.
  
+ \var{pixelfilter} is a 2-tuple (\var{filter}, (\var{xwidth}, \var{ywidth}))
+ that sets the pixel filter to use. If \code{None} is passed the default
+ pixel filter of the renderer is used. Example: ("gaussian", (2,2))
+ 
+ \var{rib} is a string containing additional RIB requests that are written
+ in front of the frames.
+ 
  It is possible to attach user RIB requests to an object simply by
  adding a string attribute called \code{rib}. When present this string