Changeset 4458 in orxonox.OLD for orxonox/trunk/src/lib/graphics/graphics_engine.cc

Timestamp:

Jun 1, 2005, 11:51:44 PM (19 years ago)

Author:

bensch

Message:

orxonox/trunk: graphicsEngine and TextEngine documented

File:

• orxonox/trunk/src/lib/graphics/graphics_engine.cc (modified) (3 diffs)

orxonox/trunk/src/lib/graphics/graphics_engine.cc

@@ -165 +165 @@
 }
 
+/**
+   \brief sets Fullscreen mode
+   \param fullscreen true if fullscreen, false if windowed
+*/
 void GraphicsEngine::setFullscreen(bool fullscreen)
 {
@@ -171 +175 @@
 }
 
+/**
+   \brief sets the background color
+   \param red the red part of the background
+   \param blue the blue part of the background
+   \param green the green part of the background
+   \param alpha the alpha part of the background
+*/
 void GraphicsEngine::setBackgroundColor(GLclampf red, GLclampf green, GLclampf blue, GLclampf alpha)
 {
@@ -290 +301 @@
 }
 
-
+/**
+   \brief ticks the Text
+   \param dt the time passed
+*/
 void GraphicsEngine::tick(float dt)
 {
-        if( unlikely(this->bDisplayFPS))
-        {
-          this->currentFPS = 1.0/dt;
+  if( unlikely(this->bDisplayFPS))
+    {
+      this->currentFPS = 1.0/dt;
       if( unlikely(this->currentFPS > this->maxFPS)) this->maxFPS = this->currentFPS;
-          if( unlikely(this->currentFPS < this->minFPS)) this->minFPS = this->currentFPS;
-          
-          char tmpChar1[20];
-          sprintf(tmpChar1, "Current:  %4.0f", this->currentFPS);
-          this->geTextCFPS->setText(tmpChar1);
-          char tmpChar2[20];
-          sprintf(tmpChar2, "Max:    %4.0f", this->maxFPS);
-          this->geTextMaxFPS->setText(tmpChar2);
-          char tmpChar3[20];
-          sprintf(tmpChar3, "Min:    %4.0f", this->minFPS);
-          this->geTextMinFPS->setText(tmpChar3);
-        }
-}
-  
+      if( unlikely(this->currentFPS < this->minFPS)) this->minFPS = this->currentFPS;
+      
+      char tmpChar1[20];
+      sprintf(tmpChar1, "Current:  %4.0f", this->currentFPS);
+      this->geTextCFPS->setText(tmpChar1);
+      char tmpChar2[20];
+      sprintf(tmpChar2, "Max:    %4.0f", this->maxFPS);
+      this->geTextMaxFPS->setText(tmpChar2);
+      char tmpChar3[20];
+      sprintf(tmpChar3, "Min:    %4.0f", this->minFPS);
+      this->geTextMinFPS->setText(tmpChar3);
+    }
+}
+  
+/**
+   \brief displays the Frames per second
+   \param display if the text should be displayed
+
+   \todo this is dangerous
+*/
 void GraphicsEngine::displayFPS(bool display)
 {
-        if( display)
-        {
-                this->geTextCFPS = TextEngine::getInstance()->createText("fonts/druid.ttf", 35, TEXT_DYNAMIC, 0, 255, 0);
-                this->geTextCFPS->setAlignment(TEXT_ALIGN_LEFT);
-                this->geTextCFPS->setPosition(5, 500);
-                this->geTextMaxFPS = TextEngine::getInstance()->createText("fonts/druid.ttf", 35, TEXT_DYNAMIC, 0, 255, 0);
-                this->geTextMaxFPS->setAlignment(TEXT_ALIGN_LEFT);
-                this->geTextMaxFPS->setPosition(5, 530);
-                this->geTextMinFPS = TextEngine::getInstance()->createText("fonts/druid.ttf", 35, TEXT_DYNAMIC, 0, 255, 0);
-                this->geTextMinFPS->setAlignment(TEXT_ALIGN_LEFT);
-                this->geTextMinFPS->setPosition(5, 560);        
-        }
-        this->bDisplayFPS = display;
-}
-
-  
+  if( display)
+    {
+      this->geTextCFPS = TextEngine::getInstance()->createText("fonts/druid.ttf", 35, TEXT_DYNAMIC, 0, 255, 0);
+      this->geTextCFPS->setAlignment(TEXT_ALIGN_LEFT);
+      this->geTextCFPS->setPosition(5, 500);
+      this->geTextMaxFPS = TextEngine::getInstance()->createText("fonts/druid.ttf", 35, TEXT_DYNAMIC, 0, 255, 0);
+      this->geTextMaxFPS->setAlignment(TEXT_ALIGN_LEFT);
+      this->geTextMaxFPS->setPosition(5, 530);
+      this->geTextMinFPS = TextEngine::getInstance()->createText("fonts/druid.ttf", 35, TEXT_DYNAMIC, 0, 255, 0);
+      this->geTextMinFPS->setAlignment(TEXT_ALIGN_LEFT);
+      this->geTextMinFPS->setPosition(5, 560);  
+    }
+  this->bDisplayFPS = display;
+}
+
+