Source/System/Window/Base/OSGBackground.fcd

   1 <?xml version="1.0" ?>
   2
   3 <FieldContainer
   4    name="Background"
   5    parent="AttachmentContainer"
   6    library="System"
   7    structure="abstract"
   8    pointerfieldtypes="both"
   9    systemcomponent="true"
  10    parentsystemcomponent="true"
  11    docGroupBase="GrpSystemWindow"
  12    >
  13
  14   Background is the base class for all background/buffer clearing.  See \ref
  15   PageSystemWindowBackground for a description.
  16
  17   \ext
  18
  19   To create a new Background the method that has be overridden is
  20   clear(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="clearStencilBit"
  27          type="Int32"
  28          cardinality="single"
  29          visibility="external"
  30          defaultValue="-1"
  31          access="public"
  32          >
  33         Usually 0 is used to clear all stencil bitplanes
  34     (clear is deactivated if smaller zero).
  35   </Field>
  36   <Field
  37          name="depth"
  38          type="Real32"
  39          cardinality="single"
  40          visibility="external"
  41          defaultValue="1.f"
  42          access="public"
  43          >
  44         Depth value for clear, defaults to 1.
  45   </Field>
  46   <Field
  47      name="clearDepth"
  48      type="bool"
  49      cardinality="single"
  50      visibility="external"
  51      defaultValue="true"
  52      access="public"
  53     >
  54     Whether to clear the depth buffer or not
  55   </Field>
  56   <Field
  57      name="clearColor"
  58      type="bool"
  59      cardinality="single"
  60      visibility="external"
  61      defaultValue="true"
  62      access="public"
  63      >
  64     Whether to clear the color buffer or not
  65   </Field>
  66 </FieldContainer>