source/core/sampler.h

   1 #ifndef MSP_GL_SAMPLER_H_
   2 #define MSP_GL_SAMPLER_H_
   3
   4 #include <msp/datafile/objectloader.h>
   5 #include "color.h"
   6 #include "gl.h"
   7 #include "predicate.h"
   8
   9 namespace Msp {
  10 namespace GL {
  11
  12 enum TextureFilter
  13 {
  14         /// No filtering
  15         NEAREST,
  16
  17         /// Bilinear filtering
  18         LINEAR,
  19
  20         /// Mipmapping without filtering
  21         NEAREST_MIPMAP_NEAREST,
  22
  23         /// Linear filtering between two mipmap levels
  24         NEAREST_MIPMAP_LINEAR,
  25
  26         /// Bilinear filtering on the closest mipmap level
  27         LINEAR_MIPMAP_NEAREST,
  28
  29         /// Trilinear filtering between two mipmap levels
  30         LINEAR_MIPMAP_LINEAR
  31 };
  32
  33
  34 enum TextureWrap
  35 {
  36         /// Tile the texture infinitely
  37         REPEAT,
  38
  39         /// Extend the texels at the edge of the texture to infinity
  40         CLAMP_TO_EDGE,
  41
  42         /// Sampling outside the texture will return border color
  43         CLAMP_TO_BORDER,
  44
  45         /// Tile the texture, with every other repetition mirrored
  46         MIRRORED_REPEAT
  47 };
  48
  49
  50 /**
  51 Samplers are used to access texture data in shaders.  To use a sampler with a
  52 texture, bind it to the same texture unit.  Each texture has a default sampler
  53 which is used if no external sampler is bound.
  54
  55 A texture is generally rendered at a size that's either smaller or larger than
  56 its native size, so that the texture coordinates do not exactly correspond to
  57 the texels of the texture.  The kind of filtering used, if any, is determined
  58 by the minification and magnification filter parameters.  The default is LINEAR
  59 for magnification and NEAREST_MIPMAP_LINEAR for minification.
  60
  61 If texture coordinates fall outside of the principal range of the texture,
  62 wrapping is applied.  The default for all directions is REPEAT.
  63 */
  64 class Sampler
  65 {
  66         friend class PipelineState;
  67
  68 public:
  69         class Loader: public DataFile::ObjectLoader<Sampler>
  70         {
  71         public:
  72                 Loader(Sampler &);
  73         private:
  74                 void init();
  75
  76                 void border_color(float, float, float, float);
  77                 void compare(Predicate);
  78                 void filter(TextureFilter);
  79                 void mag_filter(TextureFilter);
  80                 void max_anisotropy(float);
  81                 void min_filter(TextureFilter);
  82                 void wrap(TextureWrap);
  83                 void wrap_r(TextureWrap);
  84                 void wrap_s(TextureWrap);
  85                 void wrap_t(TextureWrap);
  86         };
  87
  88 private:
  89         enum ParameterMask
  90         {
  91                 MIN_FILTER = 1,
  92                 MAG_FILTER = 2,
  93                 MAX_ANISOTROPY = 4,
  94                 WRAP_S = 8,
  95                 WRAP_T = 16,
  96                 WRAP_R = 32,
  97                 BORDER_COLOR = 64,
  98                 COMPARE = 128
  99         };
 100
 101         unsigned id;
 102         TextureFilter min_filter;
 103         TextureFilter mag_filter;
 104         float max_anisotropy;
 105         TextureWrap wrap_s;
 106         TextureWrap wrap_t;
 107         TextureWrap wrap_r;
 108         Color border_color;
 109         bool compare;
 110         Predicate cmp_func;
 111         mutable int dirty_params;
 112
 113 public:
 114         Sampler();
 115
 116 private:
 117         void update() const;
 118
 119 public:
 120         void set_min_filter(TextureFilter);
 121         void set_mag_filter(TextureFilter);
 122
 123         /** Sets filter for both minification and magnification.  If a mipmapping
 124         filter is specified, LINEAR is used for magnification. */
 125         void set_filter(TextureFilter);
 126
 127         TextureFilter get_min_filter() const { return min_filter; }
 128         TextureFilter get_mag_filter() const { return mag_filter; }
 129
 130         void set_max_anisotropy(float);
 131         float get_max_anisotropy() const { return max_anisotropy; }
 132
 133         /** Sets the wrapping mode for all coordinates. */
 134         void set_wrap(TextureWrap);
 135
 136         void set_wrap_s(TextureWrap);
 137         void set_wrap_t(TextureWrap);
 138         void set_wrap_r(TextureWrap);
 139
 140         void set_border_color(const Color &);
 141         const Color &get_border_color() const { return border_color; }
 142
 143         /** Disables depth comparison. */
 144         void disable_compare();
 145
 146         /** Enables depth comparison and sets the compare function.  Only has an
 147         effect when used with a depth texture.  When depth comparison is enabled,
 148         the third component of the texture coordinate is compared against the texel
 149         value, and the result is returned as the texture sample.*/
 150         void set_compare(Predicate);
 151
 152         bool is_compare_enabled() const { return compare; }
 153         Predicate get_compare_function() const { return cmp_func; }
 154
 155         void refresh() const { if(dirty_params) update(); }
 156
 157         void set_debug_name(const std::string &);
 158 };
 159
 160
 161 bool is_mipmapped(TextureFilter);
 162 GLenum get_gl_filter(TextureFilter);
 163 GLenum get_gl_wrap(TextureWrap);
 164
 165 void operator>>(const LexicalConverter &, TextureFilter &);
 166 void operator>>(const LexicalConverter &, TextureWrap &);
 167
 168 } // namespace GL
 169 } // namespace Msp
 170
 171 #endif