Source/System/SystemGroups.dox

   1 #include "OSGConfig.h"
   2
   3 using namespace OSG;
   4
   5 /*! \defgroup GrpLibOSGSystem libOSGSystem
   6     \ingroup GrpByLib
   7  */
   8
   9 /*! \defgroup GrpSystem OpenSG System Library
  10
  11     \brief The System Library contains the main system-independent parts of
  12            OpenSG.
  13
  14     See \ref PageSystem for details.
  15  */
  16
  17 //*******************************************************************
  18 // Action
  19 //*******************************************************************
  20
  21 /*! \defgroup GrpSystemAction Action
  22     \ingroup GrpSystem
  23  */
  24
  25 /*! \defgroup GrpSystemActionBase Base
  26     \ingroup GrpSystemAction
  27  */
  28
  29 /*! \defgroup GrpSystemActionFuncs Functions
  30     \ingroup GrpSystemAction
  31  */
  32
  33 /*! \defgroup GrpSystemRenderAction Render Action
  34     \ingroup GrpSystemAction
  35  */
  36
  37 /*! \defgroup GrpSystemIntersectAction Intersect Action
  38     \ingroup GrpSystemAction
  39  */
  40
  41 //*******************************************************************
  42 // State
  43 //*******************************************************************
  44
  45 /*! \defgroup GrpSystemState State
  46     \ingroup GrpSystem
  47
  48     The OpenGL State Handling Group contains the wrapper classes for OpenGL
  49     state.
  50
  51     See \ref PageSystemState for details.
  52 */
  53
  54 /*! \defgroup GrpSystemStateBase Base
  55     \ingroup GrpSystemState
  56
  57     The OpenGL State Handling Group contains the wrapper classes for OpenGL
  58     state.
  59
  60     See \ref PageSystemState for details.
  61 */
  62
  63 /*! \defgroup GrpSystemStateBaseChunks Base Chunks
  64     \ingroup GrpSystemState
  65
  66     See \ref PageSystemState for details.
  67 */
  68
  69 /*! \defgroup GrpSystemStateFields Fields
  70     \ingroup GrpSystemState
  71 */
  72 /*! \defgroup GrpSystemStateFieldTraits Field Traits
  73     \ingroup GrpSystemStateFields
  74 */
  75 /*! \defgroup GrpSystemStateFieldHandle Field Handle
  76     \ingroup GrpSystemStateFields
  77 */
  78 /*! \defgroup GrpSystemStateFieldSFields Single-Field
  79     \ingroup GrpSystemStateFields
  80 */
  81 /*! \defgroup GrpSystemStateFieldMFields Multi-Fields
  82     \ingroup GrpSystemStateFields
  83 */
  84
  85 //*******************************************************************
  86 // Shader
  87 //*******************************************************************
  88
  89 /*! \defgroup GrpSystemShader Shader
  90     \ingroup GrpSystem
  91
  92     The OpenGL Shader Handling Group
  93
  94     See \ref PageSystemShader for details.
  95 */
  96
  97 /*! \defgroup GrpSystemShaderBase Base
  98     \ingroup GrpSystemShader
  99
 100     The OpenGL Shader Handling Group
 101
 102     See \ref PageSystemShader for details.
 103 */
 104
 105 /*! \defgroup GrpSystemShaderChunks Chunks
 106     \ingroup GrpSystemShader
 107
 108     The OpenGL Shader Handling Group
 109
 110     See \ref PageSystemShader for details.
 111 */
 112
 113 /*! \defgroup GrpSystemShaderVariables Variables
 114     \ingroup GrpSystemShader
 115
 116     The OpenGL Shader Handling Group
 117
 118     See \ref PageSystemShader for details.
 119 */
 120
 121 /*! \defgroup GrpSystemShaderSHLChunk SimpleSHLChunk
 122     \ingroup GrpSystemShader
 123
 124     The OpenGL Shader Handling Group
 125
 126     See \ref PageSystemShader for details.
 127 */
 128
 129 /*! \defgroup GrpSystemShaderSHLFuncs SHL Functions
 130     \ingroup GrpSystemShader
 131
 132     The OpenGL Shader Handling Group
 133
 134     See \ref PageSystemShader for details.
 135 */
 136
 137
 138 /*! \defgroup GrpSystemShaderFields Fields
 139     \ingroup GrpSystemShader
 140  */
 141
 142 /*! \defgroup GrpSystemShaderFieldTraits Field Traits
 143     \ingroup GrpSystemShaderFields
 144  */
 145
 146 /*! \defgroup GrpSystemShaderFieldSFields Single-Field
 147     \ingroup GrpSystemShaderFields
 148  */
 149
 150 /*! \defgroup GrpSystemShaderFieldMFields Multi-Fields
 151     \ingroup GrpSystemShaderFields
 152  */
 153
 154 //*******************************************************************
 155 // Rendering Backend
 156 //*******************************************************************
 157
 158 /*! \defgroup GrpSystemRenderingBackend Rendering Backend
 159     \ingroup GrpSystem
 160
 161     See \ref PageSystemRenderingBackend for details.
 162  */
 163
 164 /*! \defgroup GrpSystemRenderingBackendBase Base
 165     \ingroup GrpSystemRenderingBackend
 166  */
 167
 168 /*! \defgroup GrpSystemRenderingBackendTasks Threads / Tasks
 169     \ingroup GrpSystemRenderingBackend
 170  */
 171
 172 /*! \defgroup GrpSystemRenderingBackendTreeBuild Tree Builder
 173     \ingroup GrpSystemRenderingBackend
 174  */
 175
 176 /*! \defgroup GrpSystemRenderingBackendPools Pools
 177     \ingroup GrpSystemRenderingBackend
 178  */
 179
 180 /*! \defgroup GrpSystemRenderingBackendFieldTraits Field Traits
 181     \ingroup GrpSystemRenderingBackend
 182  */
 183
 184 /*! \defgroup GrpSystemRenderingBackendFieldSFields Single-Field
 185     \ingroup GrpSystemRenderingBackend
 186  */
 187
 188 /*! \defgroup GrpSystemRenderingBackendFieldMFields Multi-Fields
 189     \ingroup GrpSystemRenderingBackend
 190  */
 191
 192 //*******************************************************************
 193 // Material
 194 //*******************************************************************
 195
 196 /*! \defgroup GrpSystemMaterial Material
 197     \ingroup GrpSystem
 198  */
 199
 200 /*! \defgroup GrpSystemMaterialBase Base
 201     \ingroup GrpSystemMaterial
 202  */
 203
 204 /*! \defgroup GrpSystemMaterialFieldTraits Field Traits
 205     \ingroup GrpSystemMaterial
 206 */
 207 /*! \defgroup GrpSystemMaterialFieldHandle Field Handle
 208     \ingroup GrpSystemMaterial
 209 */
 210 /*! \defgroup GrpSystemMaterialFieldSFields Single-Field
 211     \ingroup GrpSystemMaterial
 212 */
 213 /*! \defgroup GrpSystemMaterialFieldMFields Multi-Fields
 214     \ingroup GrpSystemMaterial
 215 */
 216
 217 //*******************************************************************
 218 // FieldContainer
 219 //*******************************************************************
 220
 221 /*! \defgroup GrpSystemFieldContainer FieldContainer
 222     \ingroup GrpSystem
 223  */
 224
 225 /*! \defgroup GrpSystemFieldContainerMixins Mixins
 226     \ingroup GrpSystemFieldContainer
 227  */
 228
 229 /*! \defgroup GrpSystemFieldContainerAttachments Attachments
 230     \ingroup GrpSystemFieldContainer
 231  */
 232
 233 /*! \defgroup GrpSystemFieldContainerUtils Utils
 234     \ingroup GrpSystemFieldContainer
 235  */
 236
 237
 238 /*! \defgroup GrpSystemFieldContainerFields Fields
 239     \ingroup GrpSystemFieldContainer
 240  */
 241
 242 /*! \defgroup GrpSystemFieldContainerFieldTraits Field Traits
 243     \ingroup GrpSystemFieldContainerFields
 244  */
 245
 246 /*! \defgroup GrpSystemFieldContainerFieldSFields Single-Field
 247     \ingroup GrpSystemFieldContainerFields
 248  */
 249
 250 /*! \defgroup GrpSystemFieldContainerFieldMFields Multi-Fields
 251     \ingroup GrpSystemFieldContainerFields
 252  */
 253
 254 //*******************************************************************
 255 // MemoryObjects
 256 //*******************************************************************
 257
 258 /*! \defgroup GrpSystemMemoryObjects System Memory Objects
 259     \ingroup GrpSystem
 260  */
 261
 262 //*******************************************************************
 263 // NodeCores
 264 //*******************************************************************
 265
 266 /*! \defgroup GrpSystemNodeCores NodeCores
 267     \ingroup GrpSystem
 268  */
 269
 270 /*! \defgroup GrpSystemNodeCoresGroups Groups
 271     \ingroup GrpSystemNodeCores
 272  */
 273
 274 /*! \defgroup GrpSystemNodeCoreGroupsCores Cores
 275     \ingroup GrpSystemNodeCoresGroups
 276  */
 277 /*! \defgroup GrpSystemNodeCoreGroupsFieldTraits  Field Traits
 278     \ingroup GrpSystemNodeCoresGroups
 279  */
 280 /*! \defgroup GrpSystemNodeCoreGroupsFieldSFields  Single-Field
 281     \ingroup GrpSystemNodeCoresGroups
 282  */
 283 /*! \defgroup GrpSystemNodeCoreGroupsFieldMFields  Multi-Fields
 284     \ingroup GrpSystemNodeCoresGroups
 285  */
 286
 287
 288
 289 /*! \defgroup GrpSystemNodeCoresDrawables Drawables
 290     \ingroup GrpSystemNodeCores
 291  */
 292
 293 /*! \defgroup GrpSystemNodeCoreDrawablesCores Cores
 294     \ingroup GrpSystemNodeCoresDrawables
 295  */
 296 /*! \defgroup GrpSystemNodeCoreDrawablesFuncs Functions
 297     \ingroup GrpSystemNodeCoresDrawables
 298  */
 299 /*! \defgroup GrpSystemNodeCoreDrawablesHelper Helper
 300     \ingroup GrpSystemNodeCoresDrawables
 301  */
 302 /*! \defgroup GrpSystemNodeCoreDrawablesFieldTraits  Field Traits
 303     \ingroup GrpSystemNodeCoresDrawables
 304  */
 305 /*! \defgroup GrpSystemNodeCoreDrawablesFieldSFields  Single-Field
 306     \ingroup GrpSystemNodeCoresDrawables
 307  */
 308 /*! \defgroup GrpSystemNodeCoreDrawablesFieldMFields  Multi-Fields
 309     \ingroup GrpSystemNodeCoresDrawables
 310  */
 311
 312 //*******************************************************************
 313 // FileIO
 314 //*******************************************************************
 315
 316 /*! \defgroup GrpSystemFileIO FileIO
 317     \ingroup GrpSystem
 318  */
 319
 320 /*! \defgroup GrpSystemFileIOBase Base
 321     \ingroup GrpSystemFileIO
 322  */
 323
 324 /*! \defgroup GrpSystemFileIOHelper Helper
 325     \ingroup GrpSystemFileIO
 326  */
 327
 328 /*! \defgroup GrpSystemFileIOScanParse ScanParse Skel
 329     \ingroup GrpSystemFileIO
 330  */
 331
 332 /*! \defgroup GrpSystemFileIOOSG OSG
 333     \ingroup GrpSystemFileIO
 334  */
 335
 336 //*******************************************************************
 337 // GraphOp
 338 //*******************************************************************
 339
 340 /*! \defgroup GrpSystemGraphOp GraphOp - Base
 341     \ingroup GrpSystem
 342  */
 343
 344 //*******************************************************************
 345 // Image
 346 //*******************************************************************
 347
 348 /*! \defgroup GrpSystemImage Image
 349     \ingroup GrpSystem
 350  */
 351
 352 /*! \defgroup GrpSystemImageObj Image
 353     \ingroup GrpSystemImage
 354  */
 355 /*! \defgroup GrpSystemImageFuncs Functions
 356     \ingroup GrpSystemImage
 357  */
 358 /*! \defgroup GrpSystemImageHelper Helper
 359     \ingroup GrpSystemImage
 360  */
 361 /*! \defgroup GrpSystemImageFieldTraits  Field Traits
 362     \ingroup GrpSystemImage
 363  */
 364 /*! \defgroup GrpSystemImageFieldSFields Single-Field
 365     \ingroup GrpSystemImage
 366  */
 367 /*! \defgroup GrpSystemImageFieldMFields Multi-Fields
 368     \ingroup GrpSystemImage
 369  */
 370
 371 /*! \defgroup GrpSystemImageFileIOBase FileIO Base
 372     \ingroup GrpSystemImage
 373  */
 374
 375 //*******************************************************************
 376 // Window
 377 //*******************************************************************
 378
 379 /*! \defgroup GrpSystemWindow Window
 380     \ingroup GrpSystem
 381  */
 382
 383 /*! \defgroup GrpSystemWindowBase Base
 384     \ingroup GrpSystemWindow
 385  */
 386
 387 /*! \defgroup GrpSystemWindowCamera Camera
 388     \ingroup GrpSystemWindow
 389  */
 390
 391 /*! \defgroup GrpSystemWindowFieldTraits  Field Traits
 392     \ingroup GrpSystemWindow
 393 */
 394 /*! \defgroup GrpSystemWindowFieldSFields  Single-Field
 395     \ingroup GrpSystemWindow
 396 */
 397 /*! \defgroup GrpSystemWindowFieldMFields  Multi-Fields
 398     \ingroup GrpSystemWindow
 399 */
 400
 401 //*******************************************************************
 402 // Window FBO
 403 //*******************************************************************
 404
 405 /*! \defgroup GrpSystemWindowFBO FrameBufferObjects
 406     \ingroup GrpSystem
 407  */
 408
 409 /*! \defgroup GrpSystemWindowFBOObj Framebuffer Objects
 410     \ingroup GrpSystemWindowFBO
 411  */
 412
 413 /*! \defgroup GrpSystemWindowFBOFieldTraits  Field Traits
 414     \ingroup GrpSystemWindowFBO
 415 */
 416 /*! \defgroup GrpSystemWindowFBOFieldSFields  Single-Field
 417     \ingroup GrpSystemWindowFBO
 418 */
 419 /*! \defgroup GrpSystemWindowFBOFieldMFields  Multi-Fields
 420     \ingroup GrpSystemWindowFBO
 421 */
 422
 423 //*******************************************************************
 424 // Functions
 425 //*******************************************************************
 426
 427 /*! \defgroup GrpSystemFunctions Functions
 428     \ingroup GrpSystem
 429  */
 430
 431 //*******************************************************************
 432 // Statistics
 433 //*******************************************************************
 434
 435 /*! \defgroup GrpSystemStatistics Statistics
 436     \ingroup GrpSystem
 437
 438 Statistics contains general facilities for recording and collecting
 439 statistical data like counts and times. It is mainly used for collecting
 440 rendering statistics like the amount of time need for a frame or the number of
 441 visible polygons, but it can be used for any kind of statistics.
 442 See \ref PageSystemStatistics for more details
 443
 444 The \link OSG::StatElem StatElem \endlink OSG::StatElem is the basic unit that
 445 keeps a single statistical value.
 446
 447  */
 448
 449 /*! \defgroup GrpSystemStatisticsObj Statistics
 450     \ingroup GrpSystemStatistics
 451  */
 452
 453 /*! \defgroup GrpSystemStatisticsFieldTraits  Field Traits
 454     \ingroup GrpSystemStatistics
 455 */
 456 /*! \defgroup GrpSystemStatisticsFieldSFields  Single-Field
 457     \ingroup GrpSystemStatistics
 458 */
 459 /*! \defgroup GrpSystemStatisticsFieldMFields  Multi-Fields
 460     \ingroup GrpSystemStatistics
 461 */