doc/parts/namespace/Shapes-Traits-BW.sxml

   1 <?xml version="1.0" encoding="UTF-8"?>
   2 <?xml-stylesheet type="text/xsl" href="formats/html.xsl"?>
   3
   4 <!-- This file is part of Shapes.                                           -->
   5 <!--                                                                        -->
   6 <!-- Shapes is free software: you can redistribute it and/or modify         -->
   7 <!-- it under the terms of the GNU General Public License as published by   -->
   8 <!-- the Free Software Foundation, either version 3 of the License, or      -->
   9 <!-- any later version.                                                     -->
  10 <!--                                                                        -->
  11 <!-- Shapes is distributed in the hope that it will be useful,              -->
  12 <!-- but WITHOUT ANY WARRANTY; without even the implied warranty of         -->
  13 <!-- MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the          -->
  14 <!-- GNU General Public License for more details.                           -->
  15 <!--                                                                        -->
  16 <!-- You should have received a copy of the GNU General Public License      -->
  17 <!-- along with Shapes.  If not, see <http://www.gnu.org/licenses/>.        -->
  18 <!--                                                                        -->
  19 <!-- Copyright 2015 Henrik Tidefelt                                         -->
  20
  21
  22 <book>
  23   <namespace>..Shapes..Traits..BW</namespace>
  24   <description>
  25     <p>Black and white color.</p>
  26   </description>
  27
  28   <title><self /></title>
  29   <up-link><parent-namespace /></up-link>
  30   <base href=<!--#expand-next-string-->"$(BASE)" />
  31   <examples-home href=<!--#expand-next-string-->"$(EXAMPLES)" />
  32   <shapes-version number=<!--#expand-next-string-->"$(SHAPES_VERSION)" />
  33   <external>
  34     <!--#include virtual="^/toc.xml" -->
  35   </external>
  36
  37   <top>
  38     <alphabetical-index/>
  39     <p>Color constants for the black and white color space.</p>
  40   </top>
  41
  42   <body>
  43
  44 <system-binding name="BLACK">
  45   <simple-value>
  46     <type><named-type name="Gray" /></type>
  47     <description>
  48       <p>Predefined color value.</p>
  49     </description>
  50   </simple-value>
  51 </system-binding>
  52 <system-binding name="WHITE">
  53   <simple-value>
  54     <type><named-type name="Gray" /></type>
  55     <description>
  56       <p>Predefined color value.</p>
  57     </description>
  58   </simple-value>
  59 </system-binding>
  60 <system-binding name="OCCLUDING">
  61   <simple-value>
  62     <type><named-type name="Gray" /></type>
  63     <description>
  64       <p>Color value with special interpretation.  If used as a color, it is the same as <value name="WHITE" />.  In a z-sorter (see <value namespace="..Shapes..Graphics3D" name="newZSorter" />), however, this color causes the surface not to be drawn at all.</p>
  65       <p>This is useful when one wants to draw a picture where lines are drawn on a surface, and one is not interested in filling the surface with any color, but the surface is needed never the less to occlude lines.  Not filling the surface with any color allows the lines to be drawn on any background, and will also generate an output with much smaller memory footprint.</p>
  66       <p>Note that a z-buffer always draws <em>all</em> visible line segments on top of the filled areas.</p>
  67     </description>
  68   </simple-value>
  69 </system-binding>
  70
  71   </body>
  72 </book>