Documentation|MaterialAnimator|Resources|Client: Explained use of Mat…

…erialVariantSpec
skyjake · Dec 15, 2014 · 29faaf6 · 29faaf6
1 parent aefa188
commit 29faaf6
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 3 deletions.
diff --git a/doomsday/client/include/resource/materialanimator.h b/doomsday/client/include/resource/materialanimator.h
@@ -38,8 +38,11 @@
  * Animator for a Material within a given client side usage context.
  *
  * Each usage context has it's own Material animator for an independent animation
- * timelines. Additionally, contexts define a @ref MaterialVariantSpec which dictates
- * how the various dependent resources are interpreted within that context.
+ * timeline. Additionally, contexts define a @ref MaterialVariantSpec which dictates
+ * how the various dependent resources are interpreted within that context. (This is
+ * necessary because of the quirky behavior of the id Tech 1 map renderer, where the
+ * texture dimensions are interpreted differently according to whether it is used on
+ * a "floor" or "wall" map surface).
  */
 class MaterialAnimator
 {

diff --git a/doomsday/client/src/resource/materialanimator.cpp b/doomsday/client/src/resource/materialanimator.cpp
@@ -239,7 +239,7 @@ DENG2_PIMPL(MaterialAnimator)
         short tics;   ///< Remaining (sharp) tics in the current stage.
         float inter;  ///< Intermark from the current stage to the next [0..1].
 
-        String description() const {
+        String synopsis() const {
             return String("stage: %1 tics: %2 inter: %3").arg(stage).arg(tics).arg(inter);
         }
     };