gpu/command_buffer/service/gles2_cmd_decoder.h

   1 // Copyright (c) 2012 The Chromium Authors. All rights reserved.
   2 // Use of this source code is governed by a BSD-style license that can be
   3 // found in the LICENSE file.
   4
   5 // This file contains the GLES2Decoder class.
   6
   7 #ifndef GPU_COMMAND_BUFFER_SERVICE_GLES2_CMD_DECODER_H_
   8 #define GPU_COMMAND_BUFFER_SERVICE_GLES2_CMD_DECODER_H_
   9
  10 #include <string>
  11 #include <vector>
  12
  13 #include "base/basictypes.h"
  14 #include "base/callback_forward.h"
  15 #include "base/macros.h"
  16 #include "base/memory/ref_counted.h"
  17 #include "base/memory/weak_ptr.h"
  18 #include "base/time/time.h"
  19 #include "build/build_config.h"
  20 #include "gpu/command_buffer/common/capabilities.h"
  21 #include "gpu/command_buffer/common/constants.h"
  22 #include "gpu/command_buffer/service/common_decoder.h"
  23 #include "gpu/gpu_export.h"
  24
  25 namespace gfx {
  26 class GLContext;
  27 class GLSurface;
  28 class Size;
  29 }
  30
  31 namespace gpu {
  32
  33 struct Mailbox;
  34
  35 namespace gles2 {
  36
  37 class ContextGroup;
  38 class ErrorState;
  39 class GLES2Util;
  40 class ImageManager;
  41 class Logger;
  42 class QueryManager;
  43 class Texture;
  44 class VertexArrayManager;
  45 class ValuebufferManager;
  46 struct ContextState;
  47
  48 struct DisallowedFeatures {
  49   DisallowedFeatures()
  50       : gpu_memory_manager(false),
  51         npot_support(false) {
  52   }
  53
  54   bool gpu_memory_manager;
  55   bool npot_support;
  56 };
  57
  58 typedef base::Callback<void(const std::string& key,
  59                             const std::string& shader)> ShaderCacheCallback;
  60
  61 // This class implements the AsyncAPIInterface interface, decoding GLES2
  62 // commands and calling GL.
  63 class GPU_EXPORT GLES2Decoder : public base::SupportsWeakPtr<GLES2Decoder>,
  64                                 public CommonDecoder {
  65  public:
  66   typedef error::Error Error;
  67   typedef base::Callback<bool(uint32 id)> WaitSyncPointCallback;
  68
  69   // The default stencil mask, which has all bits set.  This really should be a
  70   // GLuint, but we can't #include gl_bindings.h in this file without causing
  71   // macro redefinitions.
  72   static const unsigned int kDefaultStencilMask;
  73
  74   // Creates a decoder.
  75   static GLES2Decoder* Create(ContextGroup* group);
  76
  77   ~GLES2Decoder() override;
  78
  79   bool initialized() const {
  80     return initialized_;
  81   }
  82
  83   void set_initialized() {
  84     initialized_ = true;
  85   }
  86
  87   bool unsafe_es3_apis_enabled() const {
  88     return unsafe_es3_apis_enabled_;
  89   }
  90
  91   void set_unsafe_es3_apis_enabled(bool enabled) {
  92     unsafe_es3_apis_enabled_ = enabled;
  93   }
  94
  95   bool debug() const {
  96     return debug_;
  97   }
  98
  99   // Set to true to call glGetError after every command.
 100   void set_debug(bool debug) {
 101     debug_ = debug;
 102   }
 103
 104   bool log_commands() const {
 105     return log_commands_;
 106   }
 107
 108   // Set to true to LOG every command.
 109   void set_log_commands(bool log_commands) {
 110     log_commands_ = log_commands;
 111   }
 112
 113   // Initializes the graphics context. Can create an offscreen
 114   // decoder with a frame buffer that can be referenced from the parent.
 115   // Takes ownership of GLContext.
 116   // Parameters:
 117   //  surface: the GL surface to render to.
 118   //  context: the GL context to render to.
 119   //  offscreen: whether to make the context offscreen or not. When FBO 0 is
 120   //      bound, offscreen contexts render to an internal buffer, onscreen ones
 121   //      to the surface.
 122   //  offscreen_size: the size if the GL context is offscreen.
 123   // Returns:
 124   //   true if successful.
 125   virtual bool Initialize(const scoped_refptr<gfx::GLSurface>& surface,
 126                           const scoped_refptr<gfx::GLContext>& context,
 127                           bool offscreen,
 128                           const gfx::Size& offscreen_size,
 129                           const DisallowedFeatures& disallowed_features,
 130                           const std::vector<int32>& attribs) = 0;
 131
 132   // Destroys the graphics context.
 133   virtual void Destroy(bool have_context) = 0;
 134
 135   // Set the surface associated with the default FBO.
 136   virtual void SetSurface(const scoped_refptr<gfx::GLSurface>& surface) = 0;
 137
 138   virtual void ProduceFrontBuffer(const Mailbox& mailbox) = 0;
 139
 140   // Resize an offscreen frame buffer.
 141   virtual bool ResizeOffscreenFrameBuffer(const gfx::Size& size) = 0;
 142
 143   // Make this decoder's GL context current.
 144   virtual bool MakeCurrent() = 0;
 145
 146   // Gets the GLES2 Util which holds info.
 147   virtual GLES2Util* GetGLES2Util() = 0;
 148
 149   // Gets the associated GLContext.
 150   virtual gfx::GLContext* GetGLContext() = 0;
 151
 152   // Gets the associated ContextGroup
 153   virtual ContextGroup* GetContextGroup() = 0;
 154
 155   virtual Capabilities GetCapabilities() = 0;
 156
 157   // Restores all of the decoder GL state.
 158   virtual void RestoreState(const ContextState* prev_state) = 0;
 159
 160   // Restore States.
 161   virtual void RestoreActiveTexture() const = 0;
 162   virtual void RestoreAllTextureUnitBindings(
 163       const ContextState* prev_state) const = 0;
 164   virtual void RestoreActiveTextureUnitBinding(unsigned int target) const = 0;
 165   virtual void RestoreBufferBindings() const = 0;
 166   virtual void RestoreFramebufferBindings() const = 0;
 167   virtual void RestoreRenderbufferBindings() = 0;
 168   virtual void RestoreGlobalState() const = 0;
 169   virtual void RestoreProgramBindings() const = 0;
 170   virtual void RestoreTextureState(unsigned service_id) const = 0;
 171   virtual void RestoreTextureUnitBindings(unsigned unit) const = 0;
 172
 173   virtual void ClearAllAttributes() const = 0;
 174   virtual void RestoreAllAttributes() const = 0;
 175
 176   virtual void SetIgnoreCachedStateForTest(bool ignore) = 0;
 177
 178   // Gets the QueryManager for this context.
 179   virtual QueryManager* GetQueryManager() = 0;
 180
 181   // Gets the VertexArrayManager for this context.
 182   virtual VertexArrayManager* GetVertexArrayManager() = 0;
 183
 184   // Gets the ImageManager for this context.
 185   virtual ImageManager* GetImageManager() = 0;
 186
 187   // Gets the ValuebufferManager for this context.
 188   virtual ValuebufferManager* GetValuebufferManager() = 0;
 189
 190   // Process any pending queries. Returns false if there are no pending queries.
 191   virtual bool ProcessPendingQueries(bool did_finish) = 0;
 192
 193   // Returns false if there are no idle work to be made.
 194   virtual bool HasMoreIdleWork() = 0;
 195
 196   virtual void PerformIdleWork() = 0;
 197
 198   // Sets a callback which is called when a glResizeCHROMIUM command
 199   // is processed.
 200   virtual void SetResizeCallback(
 201       const base::Callback<void(gfx::Size, float)>& callback) = 0;
 202
 203   // Get the service texture ID corresponding to a client texture ID.
 204   // If no such record is found then return false.
 205   virtual bool GetServiceTextureId(uint32 client_texture_id,
 206                                    uint32* service_texture_id);
 207
 208   // Provides detail about a lost context if one occurred.
 209   virtual error::ContextLostReason GetContextLostReason() = 0;
 210
 211   // Clears a level sub area of a texture
 212   // Returns false if a GL error should be generated.
 213   virtual bool ClearLevel(Texture* texture,
 214                           unsigned target,
 215                           int level,
 216                           unsigned format,
 217                           unsigned type,
 218                           int xoffset,
 219                           int yoffset,
 220                           int width,
 221                           int height) = 0;
 222
 223   virtual ErrorState* GetErrorState() = 0;
 224
 225   // A callback for messages from the decoder.
 226   virtual void SetShaderCacheCallback(const ShaderCacheCallback& callback) = 0;
 227
 228   // Sets the callback for waiting on a sync point. The callback returns the
 229   // scheduling status (i.e. true if the channel is still scheduled).
 230   virtual void SetWaitSyncPointCallback(
 231       const WaitSyncPointCallback& callback) = 0;
 232
 233   virtual void WaitForReadPixels(base::Closure callback) = 0;
 234   virtual uint32 GetTextureUploadCount() = 0;
 235   virtual base::TimeDelta GetTotalTextureUploadTime() = 0;
 236   virtual base::TimeDelta GetTotalProcessingCommandsTime() = 0;
 237   virtual void AddProcessingCommandsTime(base::TimeDelta) = 0;
 238
 239   // Returns true if the context was lost either by GL_ARB_robustness, forced
 240   // context loss or command buffer parse error.
 241   virtual bool WasContextLost() const = 0;
 242
 243   // Returns true if the context was lost specifically by GL_ARB_robustness.
 244   virtual bool WasContextLostByRobustnessExtension() const = 0;
 245
 246   // Lose this context.
 247   virtual void MarkContextLost(error::ContextLostReason reason) = 0;
 248
 249   virtual Logger* GetLogger() = 0;
 250
 251   virtual void BeginDecoding();
 252   virtual void EndDecoding();
 253
 254   virtual const ContextState* GetContextState() = 0;
 255
 256  protected:
 257   GLES2Decoder();
 258
 259  private:
 260   bool initialized_;
 261   bool debug_;
 262   bool log_commands_;
 263   bool unsafe_es3_apis_enabled_;
 264
 265   DISALLOW_COPY_AND_ASSIGN(GLES2Decoder);
 266 };
 267
 268 }  // namespace gles2
 269 }  // namespace gpu
 270
 271 #endif  // GPU_COMMAND_BUFFER_SERVICE_GLES2_CMD_DECODER_H_