Source/System/Window/Base/OSGForeground.fcd

   1 <?xml version="1.0"?>
   2
   3 <FieldContainer
   4    name="Foreground"
   5    parent="AttachmentContainer"
   6    library="System"
   7    pointerfieldtypes="both"
   8    structure="abstract"
   9    systemcomponent="true"
  10    parentsystemcomponent="true"
  11    docGroupBase="GrpSystemWindow"
  12    >
  13
  14   Foreground is the base class for all foreground rendering.  See \ref
  15   PageSystemWindowForegrounds for a description.
  16
  17   \ext
  18
  19   To create a new Foreground the method that has be overridden is
  20   draw(DrawActionBase * action, Viewport * port);. It can directly call OpenGL
  21   commands, but should restore the state after it's done.
  22
  23   \endext
  24
  25   <Field
  26          name="active"
  27          type="bool"
  28          cardinality="single"
  29          visibility="external"
  30          defaultValue="true"
  31          access="public"
  32          >
  33         Activate the grabber.
  34   </Field>
  35 </FieldContainer>