git.cworth.org Git - vogl/blob - src/voglcommon/vogl_texture_state.h

   1 /**************************************************************************
   2  *
   3  * Copyright 2013-2014 RAD Game Tools and Valve Software
   4  * All Rights Reserved.
   5  *
   6  * Permission is hereby granted, free of charge, to any person obtaining a copy
   7  * of this software and associated documentation files (the "Software"), to deal
   8  * in the Software without restriction, including without limitation the rights
   9  * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
  10  * copies of the Software, and to permit persons to whom the Software is
  11  * furnished to do so, subject to the following conditions:
  12  *
  13  * The above copyright notice and this permission notice shall be included in
  14  * all copies or substantial portions of the Software.
  15  *
  16  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  17  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  18  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
  19  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  20  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
  21  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
  22  * THE SOFTWARE.
  23  *
  24  **************************************************************************/
  25
  26 // File: vogl_texture_state.h
  27 #ifndef VOGL_TEXTURE_STATE_H
  28 #define VOGL_TEXTURE_STATE_H
  29
  30 #include "vogl_core.h"
  31 #include "vogl_ktx_texture.h"
  32 #include "vogl_context_info.h"
  33 #include "vogl_general_context_state.h"
  34 #include "vogl_blob_manager.h"
  35 #include "vogl_vec.h"
  36
  37 class vogl_texture_state : public vogl_gl_object_state
  38 {
  39 public:
  40     vogl_texture_state();
  41     virtual ~vogl_texture_state();
  42
  43     virtual vogl_gl_object_state_type get_type() const
  44     {
  45         return cGLSTTexture;
  46     }
  47     virtual vogl_namespace_t get_handle_namespace() const
  48     {
  49         return VOGL_NAMESPACE_TEXTURES;
  50     }
  51
  52     // Creates snapshot of a texture handle
  53     virtual bool snapshot(const vogl_context_info &context_info, vogl_handle_remapper &remapper, GLuint64 handle, GLenum target);
  54
  55     // Creates and restores a texture
  56     virtual bool restore(const vogl_context_info &context_info, vogl_handle_remapper &remapper, GLuint64 &handle) const;
  57
  58     virtual bool remap_handles(vogl_handle_remapper &remapper);
  59
  60     virtual void clear();
  61
  62     virtual bool is_valid() const
  63     {
  64         return m_is_valid;
  65     }
  66
  67     virtual bool serialize(json_node &node, vogl_blob_manager &blob_manager) const;
  68     virtual bool deserialize(const json_node &node, const vogl_blob_manager &blob_manager);
  69
  70     virtual GLuint64 get_snapshot_handle() const
  71     {
  72         return m_snapshot_handle;
  73     }
  74
  75     GLenum get_target() const
  76     {
  77         return m_target;
  78     }
  79
  80     // Buffer textures will have a GL_TEXTURE_INTERNAL_FORMAT defined in m_params, but nothing else.
  81     GLuint get_buffer() const
  82     {
  83         return m_buffer;
  84     }
  85
  86     // Note: Multisampling textures may only have 1 sample!
  87     uint get_num_samples() const
  88     {
  89         return m_num_samples;
  90     }
  91
  92     vogl::ktx_texture &get_texture(uint sample_index = 0)
  93     {
  94         return m_textures[sample_index];
  95     }
  96
  97     const vogl::ktx_texture &get_texture(uint sample_index = 0) const
  98     {
  99         return m_textures[sample_index];
 100     }
 101
 102     const vogl_state_vector &get_params() const
 103     {
 104         return m_params;
 105     }
 106
 107     uint get_num_levels() const
 108     {
 109         return m_level_params[0].size();
 110     }
 111
 112     const vogl_state_vector &get_level_params(uint face, uint level) const
 113     {
 114         return m_level_params[face][level];
 115     }
 116
 117     // Content comparison, ignores handle.
 118     virtual bool compare_restorable_state(const vogl_gl_object_state &rhs_obj) const;
 119
 120 private:
 121     GLuint m_snapshot_handle;
 122     GLenum m_target;
 123     GLuint m_buffer;
 124
 125     uint m_num_samples;
 126     enum { cMaxSamples = 32 };
 127     vogl::ktx_texture m_textures[cMaxSamples];
 128
 129     vogl_state_vector m_params;
 130
 131     typedef vogl::vector<vogl_state_vector> vogl_state_vector_array;
 132
 133     enum
 134     {
 135         cCubeMapFaces = 6
 136     };
 137
 138     // For MSAA textures: m_level_params are the params of the original MSAA texture
 139     vogl_state_vector_array m_level_params[cCubeMapFaces];
 140
 141     bool m_is_unquerable;
 142     bool m_is_valid;
 143
 144     bool set_tex_parameter(GLenum pname) const;
 145 };
 146
 147 namespace vogl
 148 {
 149     VOGL_DEFINE_BITWISE_MOVABLE(vogl_texture_state);
 150 }
 151
 152 #endif // VOGL_TEXTURE_STATE_H