dom/canvas/ClientWebGLExtensions.h

   1 /* -*- Mode: C++; tab-width: 20; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
   2 /* This Source Code Form is subject to the terms of the Mozilla Public
   3  * License, v. 2.0. If a copy of the MPL was not distributed with this
   4  * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
   5
   6 #ifndef CLIENTWEBGLEXTENSIONS_H_
   7 #define CLIENTWEBGLEXTENSIONS_H_
   8
   9 #include "WebGLExtensions.h"
  10 #include "ClientWebGLContext.h"
  11
  12 namespace mozilla {
  13
  14 class ClientWebGLExtensionBase : public nsWrapperCache {
  15   friend ClientWebGLContext;
  16
  17  protected:
  18   WeakPtr<ClientWebGLContext> mContext;
  19
  20  public:
  21   NS_INLINE_DECL_CYCLE_COLLECTING_NATIVE_REFCOUNTING(ClientWebGLExtensionBase)
  22   NS_DECL_CYCLE_COLLECTION_SCRIPT_HOLDER_NATIVE_CLASS(ClientWebGLExtensionBase)
  23
  24  protected:
  25   explicit ClientWebGLExtensionBase(ClientWebGLContext& context)
  26       : mContext(&context) {}
  27   virtual ~ClientWebGLExtensionBase() = default;
  28
  29  public:
  30   ClientWebGLContext* GetParentObject() const { return mContext.get(); }
  31 };
  32
  33 // -
  34
  35 // To be used for implementations of ClientWebGLExtensionBase
  36 #define DEFINE_WEBGL_EXTENSION_GOOP(_WebGLBindingType, _Extension)             \
  37   JSObject* Client##_Extension::WrapObject(JSContext* cx,                      \
  38                                            JS::Handle<JSObject*> givenProto) { \
  39     return dom::_WebGLBindingType##_Binding::Wrap(cx, this, givenProto);       \
  40   }                                                                            \
  41   Client##_Extension::Client##_Extension(ClientWebGLContext& aClient)          \
  42       : ClientWebGLExtensionBase(aClient) {}
  43
  44 // Many extensions have no methods.  This is a shorthand for declaring client
  45 // versions of such classes.
  46 #define DECLARE_SIMPLE_WEBGL_EXTENSION(_Extension)                           \
  47   class Client##_Extension : public ClientWebGLExtensionBase {               \
  48    public:                                                                   \
  49     virtual JSObject* WrapObject(JSContext* cx,                              \
  50                                  JS::Handle<JSObject*> givenProto) override; \
  51     explicit Client##_Extension(ClientWebGLContext&);                        \
  52   };
  53
  54 ////
  55
  56 class ClientWebGLExtensionCompressedTextureASTC
  57     : public ClientWebGLExtensionBase {
  58  public:
  59   virtual JSObject* WrapObject(JSContext* cx,
  60                                JS::Handle<JSObject*> givenProto) override;
  61   explicit ClientWebGLExtensionCompressedTextureASTC(ClientWebGLContext&);
  62
  63   void GetSupportedProfiles(dom::Nullable<nsTArray<nsString>>& retval) const {
  64     if (MOZ_UNLIKELY(!mContext)) {
  65       AutoJsWarning("getSupportedProfiles: Extension is `invalidated`.");
  66       return;
  67     }
  68     mContext->GetSupportedProfilesASTC(retval);
  69   }
  70 };
  71
  72 DECLARE_SIMPLE_WEBGL_EXTENSION(WebGLExtensionFloatBlend)
  73
  74 DECLARE_SIMPLE_WEBGL_EXTENSION(WebGLExtensionCompressedTextureBPTC)
  75
  76 DECLARE_SIMPLE_WEBGL_EXTENSION(WebGLExtensionCompressedTextureES3)
  77
  78 DECLARE_SIMPLE_WEBGL_EXTENSION(WebGLExtensionCompressedTextureETC1)
  79
  80 DECLARE_SIMPLE_WEBGL_EXTENSION(WebGLExtensionCompressedTexturePVRTC)
  81
  82 DECLARE_SIMPLE_WEBGL_EXTENSION(WebGLExtensionCompressedTextureRGTC)
  83
  84 DECLARE_SIMPLE_WEBGL_EXTENSION(WebGLExtensionFBORenderMipmap)
  85
  86 DECLARE_SIMPLE_WEBGL_EXTENSION(WebGLExtensionCompressedTextureS3TC)
  87
  88 DECLARE_SIMPLE_WEBGL_EXTENSION(WebGLExtensionCompressedTextureS3TC_SRGB)
  89
  90 DECLARE_SIMPLE_WEBGL_EXTENSION(WebGLExtensionDebugRendererInfo)
  91
  92 class ClientWebGLExtensionDebugShaders : public ClientWebGLExtensionBase {
  93  public:
  94   virtual JSObject* WrapObject(JSContext* cx,
  95                                JS::Handle<JSObject*> givenProto) override;
  96   explicit ClientWebGLExtensionDebugShaders(ClientWebGLContext&);
  97
  98   void GetTranslatedShaderSource(const WebGLShaderJS& shader,
  99                                  nsAString& retval) const {
 100     if (MOZ_UNLIKELY(!mContext)) {
 101       AutoJsWarning("getTranslatedShaderSource: Extension is `invalidated`.");
 102       return;
 103     }
 104     mContext->GetTranslatedShaderSource(shader, retval);
 105   }
 106 };
 107
 108 DECLARE_SIMPLE_WEBGL_EXTENSION(WebGLExtensionDepthTexture)
 109
 110 DECLARE_SIMPLE_WEBGL_EXTENSION(WebGLExtensionElementIndexUint)
 111
 112 DECLARE_SIMPLE_WEBGL_EXTENSION(WebGLExtensionEXTColorBufferFloat)
 113
 114 DECLARE_SIMPLE_WEBGL_EXTENSION(WebGLExtensionFragDepth)
 115
 116 class ClientWebGLExtensionLoseContext : public ClientWebGLExtensionBase {
 117  public:
 118   virtual JSObject* WrapObject(JSContext* cx,
 119                                JS::Handle<JSObject*> givenProto) override;
 120   explicit ClientWebGLExtensionLoseContext(ClientWebGLContext&);
 121
 122   void LoseContext() {
 123     if (MOZ_UNLIKELY(!mContext)) {
 124       AutoJsWarning("loseContext: Extension is `invalidated`.");
 125       return;
 126     }
 127     mContext->EmulateLoseContext();
 128   }
 129   void RestoreContext() {
 130     if (MOZ_UNLIKELY(!mContext)) {
 131       AutoJsWarning("restoreContext: Extension is `invalidated`.");
 132       return;
 133     }
 134     mContext->RestoreContext(webgl::LossStatus::LostManually);
 135   }
 136 };
 137
 138 DECLARE_SIMPLE_WEBGL_EXTENSION(WebGLExtensionSRGB)
 139
 140 DECLARE_SIMPLE_WEBGL_EXTENSION(WebGLExtensionStandardDerivatives)
 141
 142 DECLARE_SIMPLE_WEBGL_EXTENSION(WebGLExtensionShaderTextureLod)
 143
 144 DECLARE_SIMPLE_WEBGL_EXTENSION(WebGLExtensionTextureFilterAnisotropic)
 145
 146 DECLARE_SIMPLE_WEBGL_EXTENSION(WebGLExtensionTextureFloat)
 147
 148 DECLARE_SIMPLE_WEBGL_EXTENSION(WebGLExtensionTextureFloatLinear)
 149
 150 DECLARE_SIMPLE_WEBGL_EXTENSION(WebGLExtensionTextureHalfFloat)
 151
 152 DECLARE_SIMPLE_WEBGL_EXTENSION(WebGLExtensionTextureHalfFloatLinear)
 153
 154 DECLARE_SIMPLE_WEBGL_EXTENSION(WebGLExtensionTextureNorm16)
 155
 156 DECLARE_SIMPLE_WEBGL_EXTENSION(WebGLExtensionColorBufferFloat)
 157
 158 DECLARE_SIMPLE_WEBGL_EXTENSION(WebGLExtensionColorBufferHalfFloat)
 159
 160 class ClientWebGLExtensionDrawBuffers : public ClientWebGLExtensionBase {
 161  public:
 162   virtual JSObject* WrapObject(JSContext* cx,
 163                                JS::Handle<JSObject*> givenProto) override;
 164   explicit ClientWebGLExtensionDrawBuffers(ClientWebGLContext&);
 165
 166   void DrawBuffersWEBGL(const dom::Sequence<GLenum>& buffers) {
 167     if (MOZ_UNLIKELY(!mContext)) {
 168       AutoJsWarning("drawBuffersWEBGL: Extension is `invalidated`.");
 169       return;
 170     }
 171     mContext->DrawBuffers(buffers);
 172   }
 173 };
 174
 175 class ClientWebGLExtensionVertexArray : public ClientWebGLExtensionBase {
 176  public:
 177   virtual JSObject* WrapObject(JSContext* cx,
 178                                JS::Handle<JSObject*> givenProto) override;
 179   explicit ClientWebGLExtensionVertexArray(ClientWebGLContext&);
 180
 181   already_AddRefed<WebGLVertexArrayJS> CreateVertexArrayOES() {
 182     if (MOZ_UNLIKELY(!mContext)) {
 183       AutoJsWarning("createVertexArrayOES: Extension is `invalidated`.");
 184       return nullptr;
 185     }
 186     return mContext->CreateVertexArray();
 187   }
 188   void DeleteVertexArrayOES(WebGLVertexArrayJS* array) {
 189     if (MOZ_UNLIKELY(!mContext)) {
 190       AutoJsWarning("deleteVertexArrayOES: Extension is `invalidated`.");
 191       return;
 192     }
 193     mContext->DeleteVertexArray(array);
 194   }
 195   bool IsVertexArrayOES(const WebGLVertexArrayJS* array) {
 196     if (MOZ_UNLIKELY(!mContext)) {
 197       AutoJsWarning("isVertexArrayOES: Extension is `invalidated`.");
 198       return false;
 199     }
 200     return mContext->IsVertexArray(array);
 201   }
 202   void BindVertexArrayOES(WebGLVertexArrayJS* array) {
 203     if (MOZ_UNLIKELY(!mContext)) {
 204       AutoJsWarning("bindVertexArrayOES: Extension is `invalidated`.");
 205       return;
 206     }
 207     mContext->BindVertexArray(array);
 208   }
 209 };
 210
 211 class ClientWebGLExtensionInstancedArrays : public ClientWebGLExtensionBase {
 212  public:
 213   virtual JSObject* WrapObject(JSContext* cx,
 214                                JS::Handle<JSObject*> givenProto) override;
 215   explicit ClientWebGLExtensionInstancedArrays(ClientWebGLContext&);
 216
 217   void DrawArraysInstancedANGLE(GLenum mode, GLint first, GLsizei count,
 218                                 GLsizei primcount) {
 219     if (MOZ_UNLIKELY(!mContext)) {
 220       AutoJsWarning("drawArraysInstancedANGLE: Extension is `invalidated`.");
 221       return;
 222     }
 223     mContext->DrawArraysInstanced(mode, first, count, primcount);
 224   }
 225   void DrawElementsInstancedANGLE(GLenum mode, GLsizei count, GLenum type,
 226                                   WebGLintptr offset, GLsizei primcount) {
 227     if (MOZ_UNLIKELY(!mContext)) {
 228       AutoJsWarning("drawElementsInstancedANGLE: Extension is `invalidated`.");
 229       return;
 230     }
 231     mContext->DrawElementsInstanced(mode, count, type, offset, primcount,
 232                                     FuncScopeId::drawElementsInstanced);
 233   }
 234   void VertexAttribDivisorANGLE(GLuint index, GLuint divisor) {
 235     if (MOZ_UNLIKELY(!mContext)) {
 236       AutoJsWarning("vertexAttribDivisorANGLE: Extension is `invalidated`.");
 237       return;
 238     }
 239     mContext->VertexAttribDivisor(index, divisor);
 240   }
 241 };
 242
 243 DECLARE_SIMPLE_WEBGL_EXTENSION(WebGLExtensionBlendMinMax)
 244
 245 class ClientWebGLExtensionDisjointTimerQuery : public ClientWebGLExtensionBase {
 246  public:
 247   virtual JSObject* WrapObject(JSContext* cx,
 248                                JS::Handle<JSObject*> givenProto) override;
 249   explicit ClientWebGLExtensionDisjointTimerQuery(ClientWebGLContext&);
 250
 251   already_AddRefed<WebGLQueryJS> CreateQueryEXT() const {
 252     if (MOZ_UNLIKELY(!mContext)) {
 253       AutoJsWarning("createQueryEXT: Extension is `invalidated`.");
 254       return nullptr;
 255     }
 256     return mContext->CreateQuery();
 257   }
 258   void DeleteQueryEXT(WebGLQueryJS* query) const {
 259     if (MOZ_UNLIKELY(!mContext)) {
 260       AutoJsWarning("deleteQueryEXT: Extension is `invalidated`.");
 261       return;
 262     }
 263     mContext->DeleteQuery(query);
 264   }
 265   bool IsQueryEXT(const WebGLQueryJS* query) const {
 266     if (MOZ_UNLIKELY(!mContext)) {
 267       AutoJsWarning("isQueryEXT: Extension is `invalidated`.");
 268       return false;
 269     }
 270     return mContext->IsQuery(query);
 271   }
 272   void BeginQueryEXT(GLenum target, WebGLQueryJS& query) const {
 273     if (MOZ_UNLIKELY(!mContext)) {
 274       AutoJsWarning("beginQueryEXT: Extension is `invalidated`.");
 275       return;
 276     }
 277     mContext->BeginQuery(target, query);
 278   }
 279   void EndQueryEXT(GLenum target) const {
 280     if (MOZ_UNLIKELY(!mContext)) {
 281       AutoJsWarning("endQueryEXT: Extension is `invalidated`.");
 282       return;
 283     }
 284     mContext->EndQuery(target);
 285   }
 286   void QueryCounterEXT(WebGLQueryJS& query, GLenum target) const {
 287     if (MOZ_UNLIKELY(!mContext)) {
 288       AutoJsWarning("queryCounterEXT: Extension is `invalidated`.");
 289       return;
 290     }
 291     mContext->QueryCounter(query, target);
 292   }
 293   void GetQueryEXT(JSContext* cx, GLenum target, GLenum pname,
 294                    JS::MutableHandle<JS::Value> retval) const {
 295     if (MOZ_UNLIKELY(!mContext)) {
 296       AutoJsWarning("getQueryEXT: Extension is `invalidated`.");
 297       return;
 298     }
 299     mContext->GetQuery(cx, target, pname, retval);
 300   }
 301   void GetQueryObjectEXT(JSContext* cx, WebGLQueryJS& query, GLenum pname,
 302                          JS::MutableHandle<JS::Value> retval) const {
 303     if (MOZ_UNLIKELY(!mContext)) {
 304       AutoJsWarning("getQueryObjectEXT: Extension is `invalidated`.");
 305       return;
 306     }
 307     mContext->GetQueryParameter(cx, query, pname, retval);
 308   }
 309 };
 310
 311 class ClientWebGLExtensionExplicitPresent : public ClientWebGLExtensionBase {
 312  public:
 313   virtual JSObject* WrapObject(JSContext* cx,
 314                                JS::Handle<JSObject*> givenProto) override;
 315   explicit ClientWebGLExtensionExplicitPresent(ClientWebGLContext&);
 316
 317   void Present() const {
 318     if (MOZ_UNLIKELY(!mContext)) {
 319       AutoJsWarning("present: Extension is `invalidated`.");
 320       return;
 321     }
 322     mContext->OnBeforePaintTransaction();
 323   }
 324 };
 325
 326 class ClientWebGLExtensionMOZDebug : public ClientWebGLExtensionBase {
 327  public:
 328   virtual JSObject* WrapObject(JSContext* cx,
 329                                JS::Handle<JSObject*> givenProto) override;
 330   explicit ClientWebGLExtensionMOZDebug(ClientWebGLContext&);
 331
 332   void GetParameter(JSContext* cx, GLenum pname,
 333                     JS::MutableHandle<JS::Value> retval,
 334                     ErrorResult& er) const {
 335     if (MOZ_UNLIKELY(!mContext)) {
 336       AutoJsWarning("getParameter: Extension is `invalidated`.");
 337       return;
 338     }
 339     mContext->MOZDebugGetParameter(cx, pname, retval, er);
 340   }
 341 };
 342
 343 class ClientWebGLExtensionMultiview : public ClientWebGLExtensionBase {
 344  public:
 345   virtual JSObject* WrapObject(JSContext* cx,
 346                                JS::Handle<JSObject*> givenProto) override;
 347   explicit ClientWebGLExtensionMultiview(ClientWebGLContext&);
 348
 349   void FramebufferTextureMultiviewOVR(const GLenum target,
 350                                       const GLenum attachment,
 351                                       WebGLTextureJS* const texture,
 352                                       const GLint level,
 353                                       const GLint baseViewIndex,
 354                                       const GLsizei numViews) const {
 355     if (MOZ_UNLIKELY(!mContext)) {
 356       AutoJsWarning(
 357           "framebufferTextureMultiviewOVR: Extension is `invalidated`.");
 358       return;
 359     }
 360     mContext->FramebufferTextureMultiview(target, attachment, texture, level,
 361                                           baseViewIndex, numViews);
 362   }
 363 };
 364
 365 }  // namespace mozilla
 366
 367 #endif  // CLIENTWEBGLEXTENSIONS_H_