doc/parts/types/graphics-2d.sxml

   1 <!-- This file is part of Shapes.                                           -->
   2 <!--                                                                        -->
   3 <!-- Shapes is free software: you can redistribute it and/or modify         -->
   4 <!-- it under the terms of the GNU General Public License as published by   -->
   5 <!-- the Free Software Foundation, either version 3 of the License, or      -->
   6 <!-- any later version.                                                     -->
   7 <!--                                                                        -->
   8 <!-- Shapes is distributed in the hope that it will be useful,              -->
   9 <!-- but WITHOUT ANY WARRANTY; without even the implied warranty of         -->
  10 <!-- MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the          -->
  11 <!-- GNU General Public License for more details.                           -->
  12 <!--                                                                        -->
  13 <!-- You should have received a copy of the GNU General Public License      -->
  14 <!-- along with Shapes.  If not, see <http://www.gnu.org/licenses/>.        -->
  15 <!--                                                                        -->
  16 <!-- Copyright 2008, 2009 Henrik Tidefelt                                   -->
  17
  18 <section id="types/graphics-2d">
  19 <title>Graphics in <str-2D /></title>
  20 <top>
  21         <p>Values of the types described here can be drawn (possibly after projection to <str-2D />).</p>
  22 </top>
  23
  24   <coretype name="Drawable">
  25     <abstraction>
  26                         <p>This is the common base type of drawable things in <str-2D />.</p>
  27     </abstraction>
  28         </coretype>
  29
  30   <coretype name="RasterImage">
  31                 <isa><named-type name="Drawable" /></isa>
  32     <abstraction>
  33                         <p>Rasterized image.</p>
  34     </abstraction>
  35                 <fields>
  36                         <type-field name="size_x">
  37                                 <type><named-type name="Integer" /></type>
  38                                 <description>Width in pixels.</description>
  39                         </type-field>
  40                         <type-field name="size_y">
  41                                 <type><named-type name="Integer" /></type>
  42                                 <description>Width in pixels.</description>
  43                         </type-field>
  44                         <type-field name="depth">
  45                                 <type><named-type name="Integer" /></type>
  46                                 <description>Bits per color component.</description>
  47                         </type-field>
  48                         <type-field name="space">
  49                                 <type><named-type name="ColorSpace" /></type>
  50                                 <description>Color space.</description>
  51                         </type-field>
  52                 </fields>
  53         </coretype>
  54
  55   <coretype name="CapStyle">
  56     <abstraction>
  57                         <p>The type for <dynamic namespace="..Shapes..Traits" name="cap" />.</p>
  58     </abstraction>
  59         </coretype>
  60
  61   <coretype name="JoinStyle">
  62     <abstraction>
  63                         <p>The type for <dynamic namespace="..Shapes..Traits" name="join" />.</p>
  64     </abstraction>
  65         </coretype>
  66
  67   <coretype name="Dash">
  68     <abstraction>
  69                         <p>The type for <dynamic namespace="..Shapes..Traits" name="dash" />.</p>
  70     </abstraction>
  71                 <description>
  72                         <p>The total length of the dash pattern can be obtained using <value namespace="..Shapes..Numeric..Math" name="abs" />.</p>
  73                 </description>
  74         </coretype>
  75
  76   <coretype name="Alpha">
  77     <abstraction>
  78                         <p>The type of values produced by <value namespace="..Shapes..Traits" name="alphashape" /> and <value namespace="..Shapes..Traits" name="alphaopacity" />, to be used with <dynamic namespace="..Shapes..Traits" name="strokingalpha" /> and <dynamic namespace="..Shapes..Traits" name="nonstrokingalpha" />.</p>
  79     </abstraction>
  80         </coretype>
  81
  82   <coretype name="ColorSpace">
  83     <abstraction>
  84                         <p>A parameterization of colors.</p>
  85     </abstraction>
  86                 <see-also>
  87                         <dynamic namespace="..Shapes..Traits" name="blend" />
  88                 </see-also>
  89         </coretype>
  90
  91 </section>