Difference between revisions of "Reference Talk:Introduction"
Jump to navigation
Jump to search
Jholsenback (talk | contribs) (additional layout changes) |
Jholsenback (talk | contribs) m (some additional rework) |
||
(5 intermediate revisions by the same user not shown) | |||
Line 1: | Line 1: | ||
− | = | + | __NOTOC__ |
− | <p>The | + | <!--<sectiondesc desc=<"reference introduction">---> |
+ | <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. Excluding this introduction, the reference section is divided into three main parts:</p> | ||
+ | |||
<ol> | <ol> | ||
− | <li> | + | <li>[[Reference:Command-Line and INI-File Options|Command-line Options]]</li> |
− | <li> | + | <li>[[Reference:Scene Description Language|Scene Description Language]]</li> |
− | <li> | + | <li>[[Reference:Scene Description File|Scene Description File]]</li> |
− | |||
− | |||
− | |||
− | |||
</ol> | </ol> | ||
+ | |||
+ | <p>New users may find it more convenient to begin with the [[Documentation:Tutorial Table of Contents|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:</p> | ||
+ | <ul> | ||
+ | <li>The Windows version of the documentation is accessible using the POV-Ray program's <em>Help</em> menu or by pressing the F1 key while in the program.</li> | ||
+ | <li>The Mac version of the documentation is also available via the <em>Help</em> menu and for viewing with a web browser. See the <em>POV-Ray MacOS Read Me</em> for more details.</li> | ||
+ | <li>The Unix/Linux version of the documentation is available in <em>html only</em> and by default is typically found in <code>/usr/local/share/povray-3.?/html</code></li> | ||
+ | <li>See the section [[Reference:Notation and Basic Assumptions|Notation and Basic Assumptions]] for more about the notation used throughout this documentation.</li> | ||
+ | </ul> | ||
==Contents== | ==Contents== | ||
Line 42: | Line 48: | ||
###[[Reference:User Message Directives|User Message Directives]] | ###[[Reference:User Message Directives|User Message Directives]] | ||
###[[Reference:User Defined Macros|User Defined Macros]] | ###[[Reference:User Defined Macros|User Defined Macros]] | ||
− | #<strong>[[Reference: | + | #<strong>[[Reference:Scene Description File|Scene Description File]]</strong> |
##[[Reference:Global Settings|Global Settings]] | ##[[Reference:Global Settings|Global Settings]] | ||
+ | ###[[Reference:Global Settings#ADC_Bailout|adc_bailout]] | ||
+ | ###[[Reference:Global Settings#Ambient_Light|ambient_light]] | ||
+ | ###[[Reference:Global Settings#Assumed_Gamma|assumed_gama]] | ||
+ | ###[[Reference:Global Settings#HF_Gray_16|hf_gray_16]] | ||
+ | ###[[Reference:Global Settings#Irid_Wavelength|irid_wavelength]] | ||
+ | ###[[Reference:Global Settings#Charset|charset]] | ||
+ | ###[[Reference:Global Settings#Max_Trace_Level|max_trace_level]] | ||
+ | ###[[Reference:Global Settings#Mm_Per_Unit|mm_per_unit]] | ||
+ | ###[[Reference:Global Settings#Number_Of_Waves|number_of_waves]] | ||
+ | ###[[Reference:Global Settings#Noise_generator|noise_generator]] | ||
+ | ###[[Reference:Global Settings#Subsurface|subsurface]] | ||
##[[Reference:Camera|Camera]] | ##[[Reference:Camera|Camera]] | ||
+ | ###[[Reference:Camera#Placing the Camera|Placing the Camera]] | ||
+ | ###[[Reference:Camera#Types of Projection|Types of Projections]] | ||
+ | ###[[Reference:Camera#Placing the Camera|Placing the Camera]] | ||
+ | ###[[Reference:Camera#Focal Blur|Focal Blur]] | ||
+ | ###[[Reference:Camera#Camera Ray Perturbation|Camera Ray Perturbation]] | ||
+ | ###[[Reference:Camera#Camera Identifiers|Camera Identifiers]] | ||
+ | ##[[Reference:Lighting Types|Lighting Types]] | ||
+ | ###[[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]] | ||
+ | ##[[Reference:Transformations|Transformations]] | ||
+ | ###[[Reference:Transformations#Translate|translate]] | ||
+ | ###[[Reference:Transformations#Scale|scale]] | ||
+ | ###[[Reference:Transformations#Rotate|rotate]] | ||
+ | ###[[Reference:Transformations#Matrix|matrix]] | ||
+ | ##[[Reference:Object|Objects]] | ||
+ | ###[[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]] | ||
+ | ##[[Reference:Texture|Textures]] | ||
+ | ###[[Reference:Pigment|Pigment]] | ||
+ | ###[[Reference:Normal|Normal]] | ||
+ | ###[[Reference:Finish|Finish]] | ||
+ | ####[[Reference:Finish#Ambient|Ambient]] | ||
+ | ####[[Reference:Finish#Emission|Emission]] | ||
+ | ####[[Reference:Finish#Diffuse Reflection Items|Diffuse Reflection Items]] | ||
+ | ####[[Reference:Finish#Highlights|Highlights]] | ||
+ | ####[[Reference:Finish#Specular Reflection|Specular Reflection]] | ||
+ | ####[[Reference:Finish#Conserve Energy for Reflection|Conserve Energy for Reflection]] | ||
+ | ####[[Reference:Finish#Iridescence|Iridescence]] | ||
+ | ###[[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]] | ||
+ | ##[[Reference:Pattern|Patterns]] | ||
+ | ###[[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]] | ||
##[[Reference:Atmospheric Effects|Atmospheric Effects]] | ##[[Reference:Atmospheric Effects|Atmospheric Effects]] | ||
###[[Reference:Atmospheric Effects#Atmospheric Media|Atmospheric Media]] | ###[[Reference:Atmospheric Effects#Atmospheric Media|Atmospheric Media]] | ||
Line 51: | Line 196: | ||
###[[Reference:Atmospheric Effects#Sky Sphere|Sky Sphere]] | ###[[Reference:Atmospheric Effects#Sky Sphere|Sky Sphere]] | ||
###[[Reference:Atmospheric Effects#Rainbow|Rainbow]] | ###[[Reference:Atmospheric Effects#Rainbow|Rainbow]] | ||
− | + | ##[[Reference:Media|Media]] | |
− | ##[[Reference: | + | ###[[Reference:Media#Media Types|Media Types]] |
− | ###[[Reference: | + | ###[[Reference:Media#Sampling Parameters & Methods|Sampling Parameters & Methods]] |
− | ###[[Reference: | + | ###[[Reference:Media#Density|Density]] |
− | ###[[Reference: | + | ##[[Reference:Include Files|Include Files]] |
− | + | ###[[Reference:Include Files#Main Files|Main Files]] | |
− | ###[[Reference: | + | ####[[Reference:Arrays.inc|arrays.inc]] |
− | ##[[Reference: | + | ####[[Reference:Chars.inc|chars.inc]] |
− | ##[[Reference: | + | ####[[Reference:Colors.inc|colors.inc]] |
− | ##[[Reference: | + | ####[[Reference:Consts.inc|consts.inc]] |
− | # | + | ####[[Reference:Debug.inc|debug.inc]] |
− | ##[[Reference: | + | ####[[Reference:Finish.inc|finish.inc]] |
− | ###[[Reference: | + | ####[[Reference:Functions.inc|functions.inc]] |
− | ###[[Reference: | + | ####[[Reference:Glass.inc|glass.inc, glass_old.inc]] |
− | ###[[Reference: | + | ####[[Reference:Math.inc|math.inc]] |
− | ###[[Reference: | + | ####[[Reference:Metals.inc|metals.inc]] |
− | ###[[Reference: | + | ####[[Reference:Golds.inc|golds.inc]] |
− | ###[[Reference: | + | ####[[Reference:Rand.inc|rand.inc]] |
− | ###[[Reference: | + | ####[[Reference:Shapes.inc|shapes.inc]] |
− | ###[[Reference: | + | ####[[Reference:Shapes2.inc|shapes2.inc]] |
− | ###[[Reference: | + | ####[[Reference:Shapesq.inc|shapesq.inc]] |
− | ###[[Reference: | + | ####[[Reference:Skies.inc|skies.inc]] |
− | ###[[Reference: | + | ####[[Reference:Stars.inc|stars.inc]] |
− | ###[[Reference: | + | ####[[Reference:Stones.inc|stones.inc]] |
− | ###[[Reference: | + | ####[[Reference:Stdinc.inc|stdinc.inc]] |
− | ###[[Reference: | + | ####[[Reference:Strings.inc|strings.inc]] |
− | ###[[Reference: | + | ####[[Reference:Textures.inc|textures.inc]] |
− | ###[[Reference: | + | ####[[Reference:Transforms.inc|transforms.inc]] |
− | ###[[Reference: | + | ####[[Reference:Woodmaps.inc|woodmaps.inc]] |
− | ##[[Reference: | + | ####[[Reference:Woods.inc|woods.inc]] |
− | ###[[Reference: | + | ####[[Reference:Logo.inc|logo.inc]] |
− | ###[[Reference: | + | ####[[Reference:Rad_def.inc|rad_def.inc]] |
− | ###[[Reference: | + | ####[[Reference:Screen.inc|screen.inc]] |
− | ###[[Reference: | + | ####[[Reference:Sunpos.inc|sunpos.inc]] |
− | ###[[Reference: | + | ###[[Reference:Include Files#Old Files|Old Files]] |
− | ###[[Reference: | + | ####[[Reference:Glass_old.inc|glass_old.inc]] |
− | ###[[Reference: | + | ####[[Reference:Shapes_old.inc|shapes_old.inc]] |
− | ##[[Reference: | + | ####[[Reference:Stage1.inc|stage1.inc]] |
− | ###[[Reference: | + | ####[[Reference:Stdcam.inc|stdcam.inc]] |
− | ###[[Reference: | + | ####[[Reference:Stones1.inc|stones1.inc]] |
− | ###[[Reference: | + | ####[[Reference:Stones2.inc|stones2.inc]] |
− | ###[[Reference: | + | ###[[Reference:Include Files#Other Files|Older Files]] |
− | ###[[Reference: | + | ####[[Reference:Font Files|font files (*.ttf)]] |
− | ###[[Reference: | + | ####[[Reference:Color_Map Files|color_map files (*.map)]] |
− | # | + | ####[[Reference:Image Files|image files (*.png, *.pot, *.df3)]] |
− | ###[[Reference: | + | |
− | # | + | ==Changes== |
− | ###[[Reference: | + | <p>The following are changes that I'd like to see made to the new layout</p> |
− | + | <ol> | |
− | + | <li>Move the <em>Language Basics</em> sub-section into it's own file, add a brief passage and a table of contents for the sub-sections that follow.</li> | |
− | + | <li>Create a new file <em>The Scene</em> (maybe there's a better name) to serve as a table of contents for the sub-sections in this group.</li> | |
− | + | <li>Create a new file <em>Atmospheric Effects</em> and merge those single files as sub-sections of the proposed single file.</li> | |
− | + | <li>Create a new file <em>Lighting Types</em> to serve as an introduction and table of contents for the sub-sections that follow.</li> | |
− | + | <li>Moved the <em>Patterns</em> section up one in the order, so that it's after <em>Textures</em>.</li> | |
− | + | <li>Create a new file <em>Include Files</em> and add an introduction, also add the sub-sections <em>Main Files</em>, <em>Old Files</em>, and <em>Older Files</em> to that file. Add links to each include file.</li> | |
− | + | <li>Did <em>not</em> add the <em>Quick Reference</em> maybe we should consider dropping that section.</li> | |
− | + | </ol> | |
− | + | ||
− | + | <p>Additional changes listed here:</p> | |
− | + | * moved hexagon and square patterns to the <em>Discontinuous Patterns</em> sub-section --[[User:Jholsenback|jholsenback]] 13:52, 6 April 2012 (UTC) | |
− | + | * changes outlined below: --[[User:Jholsenback|jholsenback]] 17:17, 11 April 2012 (UTC) | |
− | + | # expanded the table of contents based on feedback | |
− | + | # three major sections now | |
− | + | # added transformations | |
− | + | # minor shuffling in topic order | |
− | + | * added reworked narrative --[[User:Jholsenback|jholsenback]] 14:57, 12 April 2012 (UTC) | |
− | ### | ||
− | # | ||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− |
Latest revision as of 17:24, 21 April 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:
New users may find it more convenient to begin with the 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:
- The Windows version of the documentation is accessible using the POV-Ray program's Help menu or by pressing the F1 key while in the program.
- The Mac version of the documentation is also available via the Help menu and for viewing with a web browser. See the POV-Ray MacOS Read Me for more details.
- The Unix/Linux version of the documentation is available in html only and by default is typically found in
/usr/local/share/povray-3.?/html
- See the section Notation and Basic Assumptions for more about the notation used throughout this documentation.
Contents
- Command-line Options
- Scene Description Language
- Scene Description File
- Global Settings
- Camera
- Lighting Types
- Transformations
- Objects
- Textures
- Patterns
- Atmospheric Effects
- Media
- Include Files
- Main Files
- arrays.inc
- chars.inc
- colors.inc
- consts.inc
- debug.inc
- finish.inc
- functions.inc
- glass.inc, glass_old.inc
- math.inc
- metals.inc
- golds.inc
- rand.inc
- shapes.inc
- shapes2.inc
- shapesq.inc
- skies.inc
- stars.inc
- stones.inc
- stdinc.inc
- strings.inc
- textures.inc
- transforms.inc
- woodmaps.inc
- woods.inc
- logo.inc
- rad_def.inc
- screen.inc
- sunpos.inc
- Old Files
- Older Files
- Main Files
Changes
The following are changes that I'd like to see made to the new layout
- Move the Language Basics sub-section into it's own file, add a brief passage and a table of contents for the sub-sections that follow.
- Create a new file The Scene (maybe there's a better name) to serve as a table of contents for the sub-sections in this group.
- Create a new file Atmospheric Effects and merge those single files as sub-sections of the proposed single file.
- Create a new file Lighting Types to serve as an introduction and table of contents for the sub-sections that follow.
- Moved the Patterns section up one in the order, so that it's after Textures.
- Create a new file Include Files and add an introduction, also add the sub-sections Main Files, Old Files, and Older Files to that file. Add links to each include file.
- Did not add the Quick Reference maybe we should consider dropping that section.
Additional changes listed here:
- moved hexagon and square patterns to the Discontinuous Patterns sub-section --jholsenback 13:52, 6 April 2012 (UTC)
- changes outlined below: --jholsenback 17:17, 11 April 2012 (UTC)
- expanded the table of contents based on feedback
- three major sections now
- added transformations
- minor shuffling in topic order
- added reworked narrative --jholsenback 14:57, 12 April 2012 (UTC)