src/video/drawing_context.hpp

   1 //  SuperTux
   2 //  Copyright (C) 2006 Matthias Braun <matze@braunis.de>
   3 //
   4 //  This program is free software: you can redistribute it and/or modify
   5 //  it under the terms of the GNU General Public License as published by
   6 //  the Free Software Foundation, either version 3 of the License, or
   7 //  (at your option) any later version.
   8 //
   9 //  This program is distributed in the hope that it will be useful,
  10 //  but WITHOUT ANY WARRANTY; without even the implied warranty of
  11 //  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12 //  GNU General Public License for more details.
  13 //
  14 //  You should have received a copy of the GNU General Public License
  15 //  along with this program.  If not, see <http://www.gnu.org/licenses/>.
  16
  17 #ifndef HEADER_SUPERTUX_VIDEO_DRAWING_CONTEXT_HPP
  18 #define HEADER_SUPERTUX_VIDEO_DRAWING_CONTEXT_HPP
  19
  20 #include <memory>
  21 #include <string>
  22 #include <vector>
  23 #include <stdint.h>
  24 #include <obstack.h>
  25
  26 #include "math/rectf.hpp"
  27 #include "math/vector.hpp"
  28 #include "video/color.hpp"
  29 #include "video/drawing_request.hpp"
  30 #include "video/font.hpp"
  31 #include "video/font_ptr.hpp"
  32 #include "video/texture.hpp"
  33
  34 class Surface;
  35 class Texture;
  36 class Renderer;
  37 class Lightmap;
  38
  39 inline int next_po2(int val)
  40 {
  41   int result = 1;
  42   while(result < val)
  43     result *= 2;
  44
  45   return result;
  46 }
  47
  48 /**
  49  * This class provides functions for drawing things on screen. It also
  50  * maintains a stack of transforms that are applied to graphics.
  51  */
  52 class DrawingContext
  53 {
  54 public:
  55   DrawingContext();
  56   ~DrawingContext();
  57
  58   void init_renderer();
  59
  60   /// Adds a drawing request for a surface into the request list.
  61   void draw_surface(SurfacePtr surface, const Vector& position,
  62                     int layer);
  63   /// Adds a drawing request for a surface into the request list.
  64   void draw_surface(SurfacePtr surface, const Vector& position,
  65                     float angle, const Color& color, const Blend& blend,
  66                     int layer);
  67   /// Adds a drawing request for part of a surface.
  68   void draw_surface_part(SurfacePtr surface, const Vector& source,
  69                          const Vector& size, const Vector& dest, int layer);
  70   /// Draws a text.
  71   void draw_text(FontPtr font, const std::string& text,
  72                  const Vector& position, FontAlignment alignment, int layer, Color color = Color(1.0,1.0,1.0));
  73
  74   /// Draws text on screen center (feed Vector.x with a 0).
  75   /// This is the same as draw_text() with a SCREEN_WIDTH/2 position and
  76   /// alignment set to LEFT_ALIGN
  77   void draw_center_text(FontPtr font, const std::string& text,
  78                         const Vector& position, int layer, Color color = Color(1.0,1.0,1.0));
  79   /// Draws a color gradient onto the whole screen */
  80   void draw_gradient(const Color& from, const Color& to, int layer);
  81   /// Fills a rectangle.
  82   void draw_filled_rect(const Vector& topleft, const Vector& size,
  83                         const Color& color, int layer);
  84   void draw_filled_rect(const Rectf& rect, const Color& color, int layer);
  85   void draw_filled_rect(const Rectf& rect, const Color& color, float radius, int layer);
  86
  87   void draw_inverse_ellipse(const Vector& pos, const Vector& size, const Color& color, int layer);
  88
  89   /// Processes all pending drawing requests and flushes the list.
  90   void do_drawing();
  91
  92   const Vector& get_translation() const
  93   {  return transform.translation;  }
  94
  95   void set_translation(const Vector& newtranslation)
  96   {  transform.translation = newtranslation;  }
  97
  98   void push_transform();
  99   void pop_transform();
 100
 101   /// Apply that effect in the next draws (effects are listed on surface.h).
 102   void set_drawing_effect(DrawingEffect effect);
 103   /// return currently applied drawing effect
 104   DrawingEffect get_drawing_effect() const;
 105   /// apply that alpha in the next draws (1.0 means fully opaque) */
 106   void set_alpha(float alpha);
 107   /// return currently set alpha
 108   float get_alpha() const;
 109
 110   /// on next update, set color to lightmap's color at position
 111   void get_light(const Vector& position, Color* color );
 112
 113   typedef ::Target Target;
 114   static const Target NORMAL = ::NORMAL;
 115   static const Target LIGHTMAP = ::LIGHTMAP;
 116   void push_target();
 117   void pop_target();
 118   void set_target(Target target);
 119
 120   void set_ambient_color( Color new_color );
 121
 122   /**
 123    * requests that a screenshot be taken after the next frame has been rendered
 124    */
 125   void take_screenshot();
 126
 127 private:
 128   typedef std::vector<DrawingRequest*> DrawingRequests;
 129
 130 private:
 131   void handle_drawing_requests(DrawingRequests& requests);
 132
 133 private:
 134   class Transform
 135   {
 136   public:
 137     Vector translation;
 138     DrawingEffect drawing_effect;
 139     float alpha;
 140
 141     Transform() :
 142       translation(),
 143       drawing_effect(NO_EFFECT),
 144       alpha(1.0f)
 145     { }
 146
 147     Vector apply(const Vector& v) const
 148     {
 149       return v - translation;
 150     }
 151   };
 152
 153 private:
 154   Renderer *renderer;
 155   Lightmap *lightmap;
 156
 157   /// the transform stack
 158   std::vector<Transform> transformstack;
 159   /// the currently active transform
 160   Transform transform;
 161
 162   std::vector<Blend> blend_stack;
 163   Blend blend_mode;
 164
 165   DrawingRequests drawing_requests;
 166   DrawingRequests lightmap_requests;
 167
 168   DrawingRequests* requests;
 169   Color ambient_color;
 170
 171   Target target;
 172   std::vector<Target> target_stack;
 173
 174   /* obstack holding the memory of the drawing requests */
 175   struct obstack obst;
 176
 177   bool screenshot_requested; /**< true if a screenshot should be taken after the next frame has been rendered */
 178
 179 private:
 180   DrawingContext(const DrawingContext&);
 181   DrawingContext& operator=(const DrawingContext&);
 182 };
 183
 184 #endif
 185
 186 /* EOF */