Commit 6503a1ff authored by slevy's avatar slevy
Browse files

Document pixelaspect, chromaparams/chromacmap, snapset, snapshot -q.

parent 772c7f9a
......@@ -251,6 +251,10 @@ e.g. <CODE>winsize 400x350+20-10</CODE>,
also sets position of graphics window, with +X and +Y measured from
left/top, -X and -Y measured from right/bottom of screen.</P>
<DT><B>pixelaspect <I>ASPECT</I></B><DD>
<P>Specify that the display has non-square pixels. The default is <CODE>pixelaspect 1.0</CODE>. To render images where each pixel is twice as wide as it is tall -- e.g. for a side-by-side stereo display where each left/right half is stretched to the width of the full screen -- use <CODE>pixelaspect 2</CODE>.</P>
<P>This doesn't work perfectly. Points are still drawn by OpenGL, which assumes that pixels are square even if they aren't. So in the above example, a large point will look stretched into a horizontal ellipse. If this is troublesome, you might use <CODE>ptsize</CODE> to limit the maximum pixel size of points, and turn polygons on. Polygons are correctly shaped as specified by <CODE>pixelaspect</CODE>.</P>
<DT><B>detach [full|hide] [<I>+XPOS+YPOS</I>]</B><DD>
<P>Detach graphics window from GUI control strip and optionally
specify position of control strip. With <CODE>full</CODE> or <CODE>hide</CODE>,
......@@ -306,7 +310,7 @@ to revert. Otherwise, turning partiview's stereo on
will just show the left eye's view -- displacing the viewpoint
but nothing else.</P>
<DT><B>snapset [<CODE>-n</CODE> <I>FRAMENO</I>] <I>FILESTEM</I> [<I>FRAMENO</I>]</B><DD>
<DT><B>snapset [<CODE>-n</CODE> <I>FRAMENO</I>] [<CODE>-q</CODE> <I>JPEGQUAL</I>] <I>FILESTEM</I> [<I>FRAMENO</I>]</B><DD>
<P>Set parameters for future <CODE>snapshot</CODE> commands.
<I>FILESTEM</I> may be a printf format string with frame number as
argument, e.g. <CODE>snapset pix/%04d.ppm</CODE>, generating image names
......@@ -314,10 +318,11 @@ of <CODE>pix/0000.ppm</CODE>, <CODE>pix/0001.ppm</CODE>, etc.
If <I>FILESTEM</I> contains no % sign, then <CODE>.%03d.ppm.gz</CODE> is
appended to it, so <CODE>snapset ./pix/fred</CODE>
yields snapshot images named <CODE>./pix/fred.000.ppm.gz</CODE> etc.</P>
<P>Frame number <I>FRAMENO</I> (default 0) increments with each snapshot taken.</P>
<P>Frame number <I>FRAMENO</I> (default 0) increments with each snapshot taken.
<CODE>-q</CODE> sets the quality of JPEG images (default <CODE>-q 97</CODE>). It's ignored for other image types.</P>
<DT><B>snapshot [<I>FRAMENO</I> | <I>FILENAME</I>]</B><DD>
<DT><B>snapshot [<CODE>-q</CODE> <I>JPEGQUAL</I>] [<I>FRAMENO</I> | <I>FILENAME</I>]</B><DD>
<P>Capture a snapshot image of the current view.</P>
<P>Either give <CODE>snapshot</CODE> an explicit filename,
or else specify a file format string with <CODE>snapset</CODE>
......@@ -328,6 +333,7 @@ With neither <I>FRAMENO</I> nor <I>FILENAME</I>,
<P>If built with the JPEG and/or PNG libraries, <CODE>partiview</CODE> can write those types of images directly (determined by suffix: jpg, jpeg, png, ppm).
Writing other image types, it generally invokes the ImageMagick program <CODE>convert(1)</CODE>,
which must be installed and be on the user's $PATH.</P>
<P><CODE>-q</CODE> sets the quality of JPEG images, up to 100 (default <CODE>-q 97</CODE>). It's ignored for other image types.</P>
<P><CODE>Convert</CODE> is never needed if the <CODE>snapset</CODE> <I>FILESTEM</I> ends in
<CODE>.ppm.gz</CODE> (invokes gzip rather than convert) or <CODE>.ppm</CODE>
(no external program required).</P>
......
......@@ -22,6 +22,7 @@ keystroke commands, often combined with moving the mouse.</P>
<BLOCKQUOTE><CODE>
<PRE>
? print summary of keystroke commands to terminal
TAB change focus to command window for Control Commands
S/s toggle STEREO mode (need blue/red glasses :-)
modes: mono redcyan crosseyed glasses
......
No preview for this file type
......@@ -31,6 +31,9 @@
<!--
$Log$
Revision 1.30 2017/08/02 04:16:35 slevy
Document pixelaspect, chromaparams/chromacmap, snapset, snapshot -q.
Revision 1.29 2016/09/11 13:43:48 slevy
Yes partiview really requires FLTK 1.3.x now.
Be consistent about which shell we're using in examples (bash now, not csh).
......@@ -985,6 +988,13 @@ e.g. <tt/winsize 400x350+20-10/,
also sets position of graphics window, with +X and +Y measured from
left/top, -X and -Y measured from right/bottom of screen.
<tag>
pixelaspect <it/ASPECT/
</tag>
Specify that the display has non-square pixels. The default is <tt/pixelaspect 1.0/. To render images where each pixel is twice as wide as it is tall -- e.g. for a side-by-side stereo display where each left/right half is stretched to the width of the full screen -- use <tt/pixelaspect 2/.
This doesn't work perfectly. Points are still drawn by OpenGL, which assumes that pixels are square even if they aren't. So in the above example, a large point will look stretched into a horizontal ellipse. If this is troublesome, you might use <tt/ptsize/ to limit the maximum pixel size of points, and turn polygons on. Polygons are correctly shaped as specified by <tt/pixelaspect/.
<tag>
detach [full|hide] [<it/+XPOS+YPOS/]
</tag>
......@@ -1043,6 +1053,8 @@ Virtual-world eyes will be separated by distance
See also the <tt/winsize/ and <tt/detach/ commands
for control over graphics window size and placement.
See also the <tt/chromadepth/ command for Chromatek color-based "stereo".
Beware: some systems which support hardware ("glasses")
stereo also require that the display be set to a
stereo-capable video mode. Partiview does not do this
......@@ -1055,7 +1067,25 @@ will just show the left eye's view -- displacing the viewpoint
but nothing else.
<tag>
snapset [<tt/-n/ <it/FRAMENO/] <it/FILESTEM/ [<it/FRAMENO/]
chromadepth [on|off]
</tag>
Enable "Chromatek" stereo mode. When on, it re-colors objects based on distance (controlled by <tt/chromaparams/ and <tt/chromacmap/). This works with Chromatek glasses, which have a diffraction grating which displaces objects based on their colors - when wearing them, red things look nearer than blue things.
Before enabling <tt/chromadepth/, use the <tt/chromacmap/ and <tt/chromaparams/ commands to set a red-to-blue colormap and corresponding distance range. A sample scene using <tt/chromadepth/ stereo is the file <tt/hipchroma/ in the <tt/data/ directory.
This feature was created in collaboration with Carl Hultquist of University of Cape Town, at the request of Prof. Anthony Fairall.
<tag>
chromacmap [<it/chromadepthcolorcmap/]
</tag>
Loads a colormap used when <tt/chromadepth/ is enabled. A sample colormap is distributed in the <tt/data/ directory as <tt/chromadepth.cmap/.
<tag>
chromaparams [<it/neardist/ <it/fardist/]
When <tt/chromadepth/ is enabled, the range of eye-to-object distances from <it/neardist/ to <it/fardist/ is mapped to the range of colors given by <tt/chromacmap/. See the sample file <tt>data/hipchroma</tt>.
<tag>
snapset [<tt/-n/ <it/FRAMENO/] [<tt/-q/ <it/JPEGQUAL/] <it/FILESTEM/ [<it/FRAMENO/]
</tag>
Set parameters for future <tt/snapshot/ commands.
<it/FILESTEM/ may be a printf format string with frame number as
......@@ -1066,10 +1096,11 @@ appended to it, so <tt>snapset ./pix/fred</tt>
yields snapshot images named <tt>./pix/fred.000.ppm.gz</tt> etc.
<p>
Frame number <it/FRAMENO/ (default 0) increments with each snapshot taken.
<tt/-q/ sets the quality of JPEG images (default <tt/-q 97/). It's ignored for other image types.
<p>
<tag>
snapshot [<it/FRAMENO/ | <it/FILENAME/]
snapshot [<tt/-q/ <it/JPEGQUAL/] [<it/FRAMENO/ | <it/FILENAME/]
</tag>
Capture a snapshot image of the current view.
......@@ -1085,6 +1116,8 @@ If built with the JPEG and/or PNG libraries, <tt/partiview/ can write those type
Writing other image types, it generally invokes the ImageMagick program <tt/convert(1)/,
which must be installed and be on the user's $PATH.
<tt/-q/ sets the quality of JPEG images, up to 100 (default <tt/-q 97/). It's ignored for other image types.
<tt/Convert/ is never needed if the <tt/snapset/ <it/FILESTEM/ ends in
<tt/.ppm.gz/ (invokes gzip rather than convert) or <tt/.ppm/
(no external program required).
......@@ -2464,6 +2497,7 @@ keystroke commands, often combined with moving the mouse.
<tscreen><verb>
? print summary of keystroke commands to terminal
TAB change focus to command window for Control Commands
S/s toggle STEREO mode (need blue/red glasses :-)
modes: mono redcyan crosseyed glasses
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment