Source/System/Window/FrameBufferObjects/OSGFrameBufferObject.fcd

   1 <?xml version="1.0"?>
   2
   3 <FieldContainer
   4     name="FrameBufferObject"
   5     parent="AttachmentContainer"
   6     library="System"
   7     pointerfieldtypes="both"
   8     structure="concrete"
   9     systemcomponent="true"
  10     parentsystemcomponent="true"
  11     decoratable="false"
  12     docGroupBase="GrpSystemWindowFBO"
  13     >
  14     Framebuffer object. Encapsulates FBOs as defined by the EXT_framebuffer_object
  15     OpenGL extension.
  16     <Field
  17         name="GLId"
  18         type="GLenum"
  19         cardinality="single"
  20         visibility="internal"
  21         access="public"
  22         defaultValue="0"
  23         fieldFlags="FClusterLocal"
  24         >
  25         The OpenGL texture id for this frame buffer object.
  26     </Field>
  27     <Field
  28         name="multiSampleGLId"
  29         type="GLenum"
  30         cardinality="single"
  31         visibility="internal"
  32         access="public"
  33         defaultValue="0"
  34         fieldFlags="FClusterLocal"
  35         >
  36         The OpenGL texture id for this frame buffer object.
  37     </Field>
  38     <Field
  39         name="colorAttachments"
  40         type="FrameBufferAttachmentPtr"
  41         cardinality="multi"
  42         visibility="external"
  43         access="public"
  44         >
  45         GL_COLOR_ATTACHMENTX slots, position defines X.
  46         This defines the target buffers for color attachments.
  47     </Field>
  48     <Field
  49         name="drawBuffers"
  50         type="GLenum"
  51         cardinality="multi"
  52         visibility="external"
  53         access="public"
  54         defaultValue="0"
  55         >
  56         The target draw buffers.  ex: GL_COLOR_ATTACHMENT0.
  57         These are used to call DrawBuffers to tell OpenGL what targets
  58         to render into.
  59     </Field>
  60     <Field
  61         name="depthAttachment"
  62         type="FrameBufferAttachmentPtr"
  63         cardinality="single"
  64         visibility="external"
  65         access="public"
  66         >
  67         GL_DEPTH_ATTACHMENT slot. The target for depth values.
  68     </Field>
  69     <Field
  70         name="stencilAttachment"
  71         type="FrameBufferAttachmentPtr"
  72         cardinality="single"
  73         visibility="external"
  74         access="public"
  75         >
  76         GL_STENCIL_ATTACHMENT slot.
  77     </Field>
  78     <Field
  79         name="width"
  80         type="UInt16"
  81         cardinality="single"
  82         visibility="external"
  83         access="public"
  84         defaultValue="0"
  85         >
  86     </Field>
  87     <Field
  88         name="height"
  89         type="UInt16"
  90         cardinality="single"
  91         visibility="external"
  92         access="public"
  93         defaultValue="0"
  94         >
  95     </Field>
  96
  97     <Field
  98         name="postProcessOnDeactivate"
  99         type="bool"
 100         cardinality="single"
 101         visibility="external"
 102         access="public"
 103         defaultValue="false"
 104         >
 105         Enable to check and generate mipmap level or copy the texture buffer
 106         result back to the image
 107     </Field>
 108
 109
 110     <Field
 111         name="enableMultiSample"
 112         type="bool"
 113         cardinality="single"
 114         visibility="external"
 115         access="public"
 116         defaultValue="false"
 117         >
 118     </Field>
 119
 120     <Field
 121         name="colorSamples"
 122         type="UInt32"
 123         cardinality="single"
 124         visibility="external"
 125         access="public"
 126         defaultValue="4"
 127         >
 128     </Field>
 129
 130     <Field
 131         name="coverageSamples"
 132         type="UInt32"
 133         cardinality="single"
 134         visibility="external"
 135         access="public"
 136         defaultValue="4"
 137         >
 138     </Field>
 139
 140     <Field
 141         name="fixedSampleLocation"
 142         type="bool"
 143         cardinality="single"
 144         visibility="external"
 145         access="public"
 146         defaultValue="true"
 147         >
 148     </Field>
 149
 150
 151     <Field
 152         name="msaaColorAttachments"
 153         type="FrameBufferAttachmentPtr"
 154         cardinality="multi"
 155         visibility="internal"
 156         access="protected"
 157         fieldFlags="FClusterLocal,FThreadLocal"
 158         >
 159         GL_COLOR_ATTACHMENTX slots, position defines X.
 160         This defines the target buffers for color attachments.
 161     </Field>
 162     <Field
 163         name="msaaDepthAttachment"
 164         type="FrameBufferAttachmentPtr"
 165         cardinality="single"
 166         visibility="internal"
 167         access="protected"
 168         fieldFlags="FClusterLocal,FThreadLocal"
 169         >
 170         GL_DEPTH_ATTACHMENT slot. The target for depth values.
 171     </Field>
 172     <Field
 173         name="msaaStencilAttachment"
 174         type="FrameBufferAttachmentPtr"
 175         cardinality="single"
 176         visibility="internal"
 177         access="protected"
 178         fieldFlags="FClusterLocal,FThreadLocal"
 179         >
 180         GL_STENCIL_ATTACHMENT slot.
 181     </Field>
 182
 183 </FieldContainer>