Difference between revisions of "Reference:Include Directive"
Jholsenback (talk | contribs) m (1 revision: Reference Migration Initial Load) |
(indexentry fix) |
||
| (2 intermediate revisions by one other user not shown) | |||
| Line 1: | Line 1: | ||
[[Category:Language Directives]] | [[Category:Language Directives]] | ||
| − | {{#indexentry:#include | + | {{#indexentry:#include}} |
| + | {{#indexentry:include}} | ||
| + | {{#indexentry:Directives, language, #include}} | ||
<p>The language allows include files to be specified by placing the line</p> | <p>The language allows include files to be specified by placing the line</p> | ||
<pre> | <pre> | ||
| Line 19: | Line 21: | ||
<p>It is typical to put standard include files in a special sub-directory. POV-Ray can only read files in the current directory or one referenced by the <code>Library_Path</code> option or <code>+L</code> switch. See the section | <p>It is typical to put standard include files in a special sub-directory. POV-Ray can only read files in the current directory or one referenced by the <code>Library_Path</code> option or <code>+L</code> switch. See the section | ||
| − | [[ | + | [[Reference:Scene Parsing Options#Library Paths|:library_path|Library Paths]].</p> |
| − | <p>You may use the <code>[[Reference:Declare and Local | + | <p>You may use the <code>[[Reference:Declare and Local Directives|:#local|#local]]</code> directive to declare identifiers which are temporary in duration and local to the include file in scope. For details see [[Reference:Declare and Local Directives#declare vs. local|#declare vs. #local]].</p> |
Latest revision as of 23:20, 3 May 2016
The language allows include files to be specified by placing the line
#include "filename.inc"
at any point in the input file. The filename may be specified by any valid string expression but it usually is a literal string enclosed in double quotes. It may be up to 40 characters long (or your computer's limit), including the two double-quote characters.
The include file is read in as if it were inserted at that point in the file. Using include is almost the same as cutting and pasting the entire contents of this file into your scene.
Include files may be nested. You may have at most 10 nested include files. There is no limit on un-nested include files.
Generally, include files have data for scenes but are not scenes in themselves. By convention scene files end in .pov and include files end with .inc.
It is legal to specify drive and directory information in the file specification however it is discouraged because it makes scene files less portable between various platforms. Use of full lower case is also recommended but not required.
Note: If you ever intend to distribute any source files you make for POV-Ray, remember that some operating systems have case-sensitive file names).
It is typical to put standard include files in a special sub-directory. POV-Ray can only read files in the current directory or one referenced by the Library_Path option or +L switch. See the section
Library Paths.
You may use the #local directive to declare identifiers which are temporary in duration and local to the include file in scope. For details see #declare vs. #local.