Changeset 587 for trunk/Doc

Show
Ignore:
Timestamp:
03/09/07 08:43:36 (2 years ago)
Author:
allenb
Message:

Port over some documentation about statistics.

Files:

Legend:

Unmodified
Added
Removed
Modified
Copied
Moved

  • trunk/Doc/to_port/Window.dox

    r585 r587  
    2121 
    2222See \ref PageSystemWindowForegrounds for a description. 
    23 */ 
    24  
    25 /*! \defgroup GrpSystemWindowStatisticsForegrounds Statistics Foregrounds 
    26     \ingroup Foregrounds 
    27      
    28 Statistics Foregrounds are used to add statistics information after the 
    29 viewport is rendered. 
    30  
    31 See \ref PageSystemWindowForegroundStatistics for a description. 
    32 */ 
    33  
    34 /*! \defgroup GrpSystemWindowBackgrounds Backgrounds 
    35     \ingroup GrpSystemWindow 
    36      
    37 Backgrounds are responsible for clearing the viewport before rendering.  
    38  
    39 See \ref PageSystemWindowBackground for a description. 
    4023*/ 
    4124 
    …… 
    549532\endhint 
    550533 
    551 \subsection PageSystemWindowForegroundStatistics Statistics Foregrounds 
    552  
    553 The descendents of osg::StatisticsForeground can be used to print or draw 
    554 Statistics elements on the rendered image.  
    555  
    556 The osg::StatisticsCollector that is used to collect the elements needs to be 
    557 set in the foreground, as well as the list of osg::StatElemDesc IDs that 
    558 should be displayed. 
    559  
    560 \subsection PageSystemWindowForegroundStatisticsSimple Simple Statistics Foreground 
    561  
    562 \b NOTE: The osg::SimpleStatisticsForeground is still considered experimental 
    563 and can and probably will change! 
    564  
    565 osg::SimpleStatisticsForeground displays the statistics info as simple text 
    566 lines. They are displayed using a compiled-in font that can use an arbitrary 
    567 color and that can be arbitrarily resized, with the size per line given in 
    568 pixel.  
    569  
    570 The format of every element is given by a format string for every element that 
    571 is directly passed to osg::StatElem::putToString(), so go there to see the 
    572 possible options. 
    573  
    574 If no elementIDs are given all elements in the osg::StatCollector are display, 
    575 using the default format. 
    576  
    577 \subsection PageSystemWindowForegroundStatisticsGraphic Graphic Statistics Foreground 
    578  
    579 \b NOTE: The osg::GraphicStatisticsForeground is still considered experimental 
    580 and can and probably will change! 
    581  
    582 osg::GraphicStatisticsForeground displays the statistics info as one of a set 
    583 of graphical elements. The possible elements are:  
    584534 
    585535<ul>