Difference between revisions of "Reference:Introduction"

From POV-Wiki
Jump to navigation Jump to search
m (Reverted edits by Jholsenback (talk) to last revision by ThorstenFroehlich)
m (cleanup round 2)
Line 1: Line 1:
 
__NOTOC__
 
__NOTOC__
 
<!--<sectiondesc desc=<"reference introduction">--->
 
<!--<sectiondesc desc=<"reference introduction">--->
−
<p>This book provides a reference for the Persistence of Vision Ray-Tracer
+
<p>This is the <em>Reference</em> section, and it applies to all platforms for which this version of POV-Ray has been ported. The platform-specific documentation is available in a separate section.</p>
−
(POV-Ray). The documentation applies to all platforms to which this version of POV-Ray
+
<p>Excluding this introduction, the reference section is divided into three main parts.</p>
−
is ported. The platform-specific documentation is available for each platform separately.</p>
+
<ol>
−
 
+
  <li>The [[Reference:Command-Line and INI-File Options|Command-line Options]] section for controlling and configuring POV-Ray.</li>
−
<p>This book is divided into these main parts:</p>
+
  <li>The [[Reference:Scene Description Language|Scene Description Language]] section for the programming rules and syntax used in POV-Ray.</li>
 +
  <li>The [[Reference:Scene File Elements|Scene File Elements]] section that details the <em>camera</em> and <em>lighting</em> types that are available,<br>and the vast array of built-in <em>objects</em>, <em>patterns</em> and <em>textures</em> used to construct scene files.</li>
 +
</ol>
  
 +
<p>New users may find it more convenient to begin with the <em>Introduction to Pov-Ray</em> or [[Documentation:Tutorial Table of Contents|tutorial]] section, followed by the platform-specific documentation, in order to become more familiar your versions platform-specific features.</p>
 +
<p>Additional notes about this documentation are as follows:</p>
 
<ol>
 
<ol>
−
<li>This introduction together with a complete reference on
+
<li><em>Windows</em> documentation is accessible using the POV-Ray program's <em>Help</em> menu or by pressing the F1 key.</li>
−
<!--<linkto "Setting POV-Ray Options">POV-Ray Options</linkto>--->[[Documentation:Tutorial Section 2.2#Setting POV-Ray Options|POV-Ray Options]] which explains
+
<li><em>Mac OS</em> documentation is also available via the <em>Help</em> menu and for viewing with a web browser.</li>
−
options (set either by command line switches or by INI file keywords) that
+
<li><em>Unix/Linux</em> documentation is available in <em>html only</em> and by default is typically found in <code>/usr/local/share/povray-3.?/html</code></li>
−
tell POV-Ray how to render the scenes.</li>
+
<li>See the section [[Reference:Notation and Basic Assumptions|Notation and Basic Assumptions]] for more about the notation used throughout this documentation.</li>
−
 
 
−
<li>A complete reference on <!--<linkto "Scene Description Language">Scene Description Language</linkto>--->[[Reference:Scene Description Language|Scene Description Language]]
 
−
in which you describe the scene.</li>
 
−
 
 
−
<li>A complete reference on the <!--<linkto "Include Files">Standard Include Files</linkto>--->[[Documentation:Reference Section 7#Include Files|Standard Include Files]]
 
−
that come with the POV-Ray package, to be used in your scenes.</li>
 
−
 
 
−
<li> Finally, a consolidation of the POV-Ray Scene Description Language
 
−
in the <!--<linkto "Quick Reference">Quick Reference</linkto>--->[[Documentation:Reference Section 8#Quick Reference|Quick Reference]].
 
 
</ol>
 
</ol>
−
 
−
<p>This book covers only the generic parts of the program which are common
 
−
to each version.</p>
 
−
<p class="Note"><strong>Note:</strong> Each version has platform-specific documentation not
 
−
included here.</p>
 
−
<p>We recommend you finish reading the tutorial book then read the platform-specific information before using this reference.</p>
 
−
 
−
<p>The platform-specific docs will show you how to render a sample scene and
 
−
will give you detailed description of the platform-specific features.</p>
 
−
 
−
<p>The Windows version documentation is available on the POV-Ray program's
 
−
Help menu or by pressing the F1 key while in the program.</p>
 
−
 
−
<p>The Mac platform documentation is available via the <em>Help</em> menu
 
−
as well as for viewing using a regular web browser.  Details may be found in
 
−
the <em>POV-Ray MacOS Read Me</em> which contains information
 
−
specific to the Mac version of POV-Ray. It is best to read this document
 
−
first.</p>
 
−
 
−
<p>The Unix / Linux version documentation can be found at the same place as
 
−
the platform independent part.  Usually that is
 
−
<code>/usr/local/share/povray-3.?/html</code></p>
 
−
 
−
<p>More about the notation used throughout this book may be found in the section
 
−
[[Reference:Notation and Basic Assumptions|Notation and Basic Assumptions]].</p>
 
−
 
−
==Contents==
 
−
#<strong>[[Reference:Command-Line and INI-File Options|Command-line Options]]</strong>
 
−
##[[Reference:Animation Options|Animation Options]]
 
−
##[[Reference:General Output Options|General Output Options]]
 
−
##[[Reference:Display Output Options|Display Output Options]]
 
−
##[[Reference:File Output Options|File Output Options]]
 
−
##[[Reference:Scene Parsing Options|Scene Parsing Options]]
 
−
##[[Reference:Shell Command Options|Shell-out to Operating System]]
 
−
##[[Reference:Text Output Options|Text Output]]
 
−
##[[Reference:Tracing Options|Tracing Options]]
 
−
#<strong>[[Reference:Scene Description Language|Scene Description Language]]</strong>
 
−
##[[Reference:Scene Description Language#Language Basics|Language Basics]]
 
−
###[[Reference:Keywords|Keywords]]
 
−
###[[Reference:Identifiers|Identifiers]]
 
−
###[[Reference:Comments|Comments]]
 
−
###[[Reference:Numeric Expressions|Numeric Expressions]]
 
−
###[[Reference:Vector Expressions|Vector Expressions]]
 
−
###[[Reference:Color Expressions|Color Expressions]]
 
−
###[[Reference:Function|User-Defined Functions]]
 
−
###[[Reference:Strings|Strings]]
 
−
###[[Reference:Array|Arrays]]
 
−
###[[Reference:Spline|Splines]]
 
−
##[[Reference:Language Directives|Language Directives]]
 
−
###[[Reference:Include Directive|Include Directive]]
 
−
###[[Reference:Declare and Local Directives|Declare and Local Directives]]
 
−
###[[Reference:File I/O Directives|File I/O Directives]]
 
−
###[[Reference:Default Directive|Default Directive]]
 
−
###[[Reference:Version Directive|Version Directive]]
 
−
###[[Reference:Conditional Directives|Conditional Directives]]
 
−
###[[Reference:User Message Directives|User Message Directives]]
 
−
###[[Reference:User Defined Macros|User Defined Macros]]
 
−
#<strong>Scene</strong>
 
−
##[[Reference:Global Settings|Global Settings]]
 
−
##[[Reference:Camera|Camera]]
 
−
##Atmospheric Effects
 
−
###[[Reference:Atmospheric Media|Atmospheric Media]]
 
−
###[[Reference:Background|Background]]
 
−
###[[Reference:Fog|Fog]]
 
−
###[[Reference:Sky Sphere|Sky Sphere]]
 
−
###[[Reference:Rainbow|Rainbow]]
 
−
#<strong>Lighting</strong>
 
−
##[[Reference:Light Source|Light Sources]]
 
−
###[[Reference:Light Source#Point Lights|Point Lights]]
 
−
###[[Reference:Light Source#Spotlights|Spotlights]]
 
−
###[[Reference:Light Source#Cylindrical Lights|Cylindrical Lights]]
 
−
###[[Reference:Light Source#Parallel Lights|Parallel Lights]]
 
−
###[[Reference:Light Source#Area Lights|Area Lights]]
 
−
##[[Reference:Light Group|Light Groups]]
 
−
##[[Reference:Radiosity|Radiosity]]
 
−
##[[Reference:Photons|Photons]]
 
−
#<strong>[[Reference:Object|Objects]]</strong>
 
−
##[[Reference:Object#Finite Solid Primitives|Finite Solid Primitives]]
 
−
###[[Reference:Blob|Blob]]
 
−
###[[Reference:Box|Box]]
 
−
###[[Reference:Cone|Cone]]
 
−
###[[Reference:Cylinder|Cylinder]]
 
−
###[[Reference:Height Field|Height Field]]
 
−
###[[Reference:Isosurface|Isosurface]]
 
−
###[[Reference:Julia Fractal|Julia Fractal]]
 
−
###[[Reference:Lathe|Lathe]]
 
−
###[[Reference:Ovus|Ovus]]
 
−
###[[Reference:Parametric|Parametric]]
 
−
###[[Reference:Prism|Prism]]
 
−
###[[Reference:Sphere|Sphere]]
 
−
###[[Reference:Sphere Sweep|Sphere Sweep]]
 
−
###[[Reference:Superellipsoid|Superquadric Ellipsoid]]
 
−
###[[Reference:Sor|Surface of Revolution]]
 
−
###[[Reference:Text|Text]]
 
−
###[[Reference:Torus|Torus]]
 
−
##[[Reference:Object#Finite Patch Primitives|Finite Patch Primitives]]
 
−
###[[Reference:Bicubic Patch|Bicubic Patch]]
 
−
###[[Reference:Disc|Disc]]
 
−
###[[Reference:Mesh|Mesh]]
 
−
###[[Reference:Mesh2|Mesh2]]
 
−
###[[Reference:Polygon|Polygon]]
 
−
###[[Reference:Triangle|Triangle]]
 
−
###[[Reference:Smooth Triangle|Smooth Triangle]]
 
−
##[[Reference:Object#Infinite Solid Primitives|Infinite Solid Primitives]]
 
−
###[[Reference:Plane|Plane]]
 
−
###[[Reference:Poly|Poly]]
 
−
###[[Reference:Cubic|Cubic]]
 
−
###[[Reference:Quartic|Quartic]]
 
−
###[[Reference:Polynomial|Polynomial]]
 
−
###[[Reference:Quadric|Quadric]]
 
−
##[[Reference:Object#Constructive Solid Geometry|Constructive Solid Geometry]]
 
−
###[[Reference:Object#Inside and Outside|Inside and Outside]]
 
−
###[[Reference:Union|Union]]
 
−
###[[Reference:Intersection|Intersection]]
 
−
###[[Reference:Difference|Difference]]
 
−
###[[Reference:Merge|Merge]]
 
−
##[[Reference:Object#Object Modifiers|Object Modifiers]]
 
−
#<strong>[[Reference:Texture|Textures]]</strong>
 
−
##[[Reference:Pigment|Pigment]]
 
−
##[[Reference:Normal|Normal]]
 
−
##[[Reference:Finish|Finish]]
 
−
##[[Reference:Halo|Halo]]
 
−
##[[Reference:Patterned Textures|Patterned Textures]]
 
−
##[[Reference:Layered Textures|Layered Textures]]
 
−
##[[Reference:UV Mapping|UV Mapping]]
 
−
##[[Reference:Triangle Texture Interpolation|Triangle Texture Interpolation]]
 
−
##[[Reference:Interior Texture|Interior Texture]]
 
−
##[[Reference:Cutaway Textures|Cutaway Textures]]
 
−
#<strong>[[Reference:Media|Media]]</strong>
 
−
##[[Reference:Media#Media Types|Media Types]]
 
−
##[[Reference:Media#Sampling Parameters & Methods|Sampling Parameters & Methods]]
 
−
##[[Reference:Media#Density|Density]]
 
−
#<strong>[[Reference:Pattern|Patterns]]</strong>
 
−
##[[Reference:Pattern#General Patterns|General Patterns]]
 
−
###[[Reference:Agate Pattern|Agate]]
 
−
###[[Reference:Boxed Pattern|Boxed]]
 
−
###[[Reference:Bozo Pattern|Bozo]]
 
−
###[[Reference:Brick Pattern|Brick]]
 
−
###[[Reference:Bumps Pattern|Bumps]]
 
−
###[[Reference:Cubic Pattern|Cubic]]
 
−
###[[Reference:Cylindrical Pattern|Cylindrical]]
 
−
###[[Reference:Density_File Pattern|Density_File]]
 
−
###[[Reference:Dents Pattern|Dents]]
 
−
###[[Reference:Facets Pattern|Facets]]
 
−
###[[Reference:Fractal Pattern|Fractal Patterns]]
 
−
###[[Reference:Function Pattern|Function as pattern]]
 
−
###[[Reference:Gradient Pattern|Gradient]]
 
−
###[[Reference:Granite Pattern|Granite]]
 
−
###[[Reference:Hexagon Pattern|Hexagon]]
 
−
###[[Reference:Leopard Pattern|Leopard]]
 
−
###[[Reference:Marble Pattern|Marble]]
 
−
###[[Reference:Onion Pattern|Onion]]
 
−
###[[Reference:Pavement Pattern|Pavement]]
 
−
###[[Reference:Pigment Pattern|Pigment Pattern]]
 
−
###[[Reference:Planar Pattern|Planar]]
 
−
###[[Reference:Quilted Pattern|Quilted]]
 
−
###[[Reference:Radial Pattern|Radial]]
 
−
###[[Reference:Ripples Pattern|Ripples]]
 
−
###[[Reference:Spherical Pattern|Spherical]]
 
−
###[[Reference:Spiral1 Pattern|Spiral1]]
 
−
###[[Reference:Spiral2 Pattern|Spiral2]]
 
−
###[[Reference:Spotted Pattern|Spotted]]
 
−
###[[Reference:Square Pattern|Square]]
 
−
###[[Reference:Tiling Pattern|Tiling]]
 
−
###[[Reference:Waves Pattern|Waves]]
 
−
###[[Reference:Wood Pattern|Wood]]
 
−
###[[Reference:Wrinkles Pattern|Wrinkles]]
 
−
##[[Reference:Pattern#Discontinuous Patterns|Discontinuous Patterns]]
 
−
###[[Reference:Cells Pattern|Cells]]
 
−
###[[Reference:Checker Pattern|Checker]]
 
−
###[[Reference:Crackle Pattern|Crackle Patterns]]
 
−
###[[Reference:Object Pattern|Object Pattern]]
 
−
###[[Reference:Triangular Pattern|Triangular]]
 
−
##[[Reference:Pattern#Normal-Dependent Patterns|Normal-Dependent Patterns]]
 
−
###[[Reference:Aoi Pattern|Aoi]]
 
−
###[[Reference:Slope Pattern|Slope]]
 
−
##[[Reference:Pattern#Special Patterns|Special Patterns]]
 
−
###[[Reference:Average Pattern|Average]]
 
−
###[[Reference:Image Pattern|Image Pattern]]
 
−
##[[Reference:Pattern#Pattern Modifiers|Pattern Modifiers]]
 
−
#<strong>Include Files</strong>
 
−
##Main Files
 
−
###[[Reference:Arrays.inc|arrays.inc]]
 
−
###[[Reference:Chars.inc|chars.inc]]
 
−
###[[Reference:Colors.inc|colors.inc]]
 
−
###[[Reference:Consts.inc|consts.inc]]
 
−
###[[Reference:Debug.inc|debug.inc]]
 
−
###[[Reference:Finish.inc|finish.inc]]
 
−
###[[Reference:Functions.inc|functions.inc]]
 
−
###[[Reference:Glass.inc|glass.inc, glass_old.inc]]
 
−
###[[Reference:Math.inc|math.inc]]
 
−
###[[Reference:Metals.inc|metals.inc]]
 
−
###[[Reference:Golds.inc|golds.inc]]
 
−
###[[Reference:Rand.inc|rand.inc]]
 
−
###[[Reference:Shapes.inc|shapes.inc]]
 
−
###[[Reference:Shapes2.inc|shapes2.inc]]
 
−
###[[Reference:Shapesq.inc|shapesq.inc]]
 
−
###[[Reference:Skies.inc|skies.inc]]
 
−
###[[Reference:Stars.inc|stars.inc]]
 
−
###[[Reference:Stones.inc|stones.inc]]
 
−
###[[Reference:Stdinc.inc|stdinc.inc]]
 
−
###[[Reference:Strings.inc|strings.inc]]
 
−
###[[Reference:Textures.inc|textures.inc]]
 
−
###[[Reference:Transforms.inc|transforms.inc]]
 
−
###[[Reference:Woodmaps.inc|woodmaps.inc]]
 
−
###[[Reference:Woods.inc|woods.inc]]
 
−
###[[Reference:Logo.inc|logo.inc]]
 
−
###[[Reference:Rad_def.inc|rad_def.inc]]
 
−
###[[Reference:Screen.inc|screen.inc]]
 
−
###[[Reference:Sunpos.inc|sunpos.inc]]
 
−
##Old Files
 
−
###[[Reference:Glass_old.inc|glass_old.inc]]
 
−
###[[Reference:Shapes_old.inc|shapes_old.inc]]
 
−
###[[Reference:Stage1.inc|stage1.inc]]
 
−
###[[Reference:Stdcam.inc|stdcam.inc]]
 
−
###[[Reference:Stones1.inc|stones1.inc]]
 
−
###[[Reference:Stones2.inc|stones2.inc]]
 
−
##Other Files
 
−
###[[Reference:Font Files|font files (*.ttf)]]
 
−
###[[Reference:Color_Map Files|color_map files (*.map)]]
 
−
###[[Reference:Image Files|image files (*.png, *.pot, *.df3)]]
 

Revision as of 22:26, 5 August 2012

This is the Reference section, and it applies to all platforms for which this version of POV-Ray has been ported. The platform-specific documentation is available in a separate section.

Excluding this introduction, the reference section is divided into three main parts.

  1. The Command-line Options section for controlling and configuring POV-Ray.
  2. The Scene Description Language section for the programming rules and syntax used in POV-Ray.
  3. The Scene File Elements section that details the camera and lighting types that are available,
    and the vast array of built-in objects, patterns and textures used to construct scene files.

New users may find it more convenient to begin with the Introduction to Pov-Ray or tutorial section, followed by the platform-specific documentation, in order to become more familiar your versions platform-specific features.

Additional notes about this documentation are as follows:

  1. Windows documentation is accessible using the POV-Ray program's Help menu or by pressing the F1 key.
  2. Mac OS documentation is also available via the Help menu and for viewing with a web browser.
  3. Unix/Linux documentation is available in html only and by default is typically found in /usr/local/share/povray-3.?/html
  4. See the section Notation and Basic Assumptions for more about the notation used throughout this documentation.
Retrieved from "https://wiki.povray.org/content?title=Reference:Introduction&oldid=7496"