third_party/WebKit/Source/modules/webgl/WebGLRenderingContext.cpp

/*
 * Copyright (C) 2009 Apple Inc. All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 *
 * THIS SOFTWARE IS PROVIDED BY APPLE COMPUTER, INC. ``AS IS'' AND ANY
 * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
 * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL APPLE COMPUTER, INC. OR
 * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
 * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
 * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */

#include "modules/webgl/WebGLRenderingContext.h"

#include "bindings/modules/v8/OffscreenCanvasRenderingContext2DOrWebGLRenderingContextOrWebGL2RenderingContext.h"
#include "bindings/modules/v8/RenderingContext.h"
#include "core/frame/LocalFrame.h"
#include "core/frame/Settings.h"
#include "core/loader/FrameLoader.h"
#include "core/loader/FrameLoaderClient.h"
#include "gpu/command_buffer/client/gles2_interface.h"
#include "modules/webgl/ANGLEInstancedArrays.h"
#include "modules/webgl/EXTBlendMinMax.h"
#include "modules/webgl/EXTDisjointTimerQuery.h"
#include "modules/webgl/EXTFragDepth.h"
#include "modules/webgl/EXTShaderTextureLOD.h"
#include "modules/webgl/EXTTextureFilterAnisotropic.h"
#include "modules/webgl/EXTsRGB.h"
#include "modules/webgl/OESElementIndexUint.h"
#include "modules/webgl/OESStandardDerivatives.h"
#include "modules/webgl/OESTextureFloat.h"
#include "modules/webgl/OESTextureFloatLinear.h"
#include "modules/webgl/OESTextureHalfFloat.h"
#include "modules/webgl/OESTextureHalfFloatLinear.h"
#include "modules/webgl/OESVertexArrayObject.h"
#include "modules/webgl/WebGLCompressedTextureASTC.h"
#include "modules/webgl/WebGLCompressedTextureATC.h"
#include "modules/webgl/WebGLCompressedTextureETC.h"
#include "modules/webgl/WebGLCompressedTextureETC1.h"
#include "modules/webgl/WebGLCompressedTexturePVRTC.h"
#include "modules/webgl/WebGLCompressedTextureS3TC.h"
#include "modules/webgl/WebGLCompressedTextureS3TCsRGB.h"
#include "modules/webgl/WebGLContextEvent.h"
#include "modules/webgl/WebGLDebugRendererInfo.h"
#include "modules/webgl/WebGLDebugShaders.h"
#include "modules/webgl/WebGLDepthTexture.h"
#include "modules/webgl/WebGLDrawBuffers.h"
#include "modules/webgl/WebGLLoseContext.h"
#include "platform/graphics/gpu/DrawingBuffer.h"
#include "public/platform/Platform.h"
#include "public/platform/WebGraphicsContext3DProvider.h"
#include "wtf/CheckedNumeric.h"
#include <memory>

namespace blink {

// An helper function for the two create() methods. The return value is an
// indicate of whether the create() should return nullptr or not.
static bool shouldCreateContext(WebGraphicsContext3DProvider* contextProvider) {
  if (!contextProvider)
    return false;
  gpu::gles2::GLES2Interface* gl = contextProvider->contextGL();
  std::unique_ptr<Extensions3DUtil> extensionsUtil =
      Extensions3DUtil::create(gl);
  if (!extensionsUtil)
    return false;
  if (extensionsUtil->supportsExtension("GL_EXT_debug_marker")) {
    String contextLabel(
        String::format("WebGLRenderingContext-%p", contextProvider));
    gl->PushGroupMarkerEXT(0, contextLabel.ascii().data());
  }
  return true;
}

CanvasRenderingContext* WebGLRenderingContext::Factory::create(
    ScriptState* scriptState,
    OffscreenCanvas* offscreenCanvas,
    const CanvasContextCreationAttributes& attrs) {
  std::unique_ptr<WebGraphicsContext3DProvider> contextProvider(
      createWebGraphicsContext3DProvider(scriptState, attrs, 1));
  if (!shouldCreateContext(contextProvider.get()))
    return nullptr;

  WebGLRenderingContext* renderingContext = new WebGLRenderingContext(
      offscreenCanvas, std::move(contextProvider), attrs);
  if (!renderingContext->drawingBuffer())
    return nullptr;
  renderingContext->initializeNewContext();
  renderingContext->registerContextExtensions();

  return renderingContext;
}

CanvasRenderingContext* WebGLRenderingContext::Factory::create(
    HTMLCanvasElement* canvas,
    const CanvasContextCreationAttributes& attrs,
    Document&) {
  std::unique_ptr<WebGraphicsContext3DProvider> contextProvider(
      createWebGraphicsContext3DProvider(canvas, attrs, 1));
  if (!shouldCreateContext(contextProvider.get()))
    return nullptr;

  WebGLRenderingContext* renderingContext =
      new WebGLRenderingContext(canvas, std::move(contextProvider), attrs);
  if (!renderingContext->drawingBuffer()) {
    canvas->dispatchEvent(WebGLContextEvent::create(
        EventTypeNames::webglcontextcreationerror, false, true,
        "Could not create a WebGL context."));
    return nullptr;
  }
  renderingContext->initializeNewContext();
  renderingContext->registerContextExtensions();

  return renderingContext;
}

void WebGLRenderingContext::Factory::onError(HTMLCanvasElement* canvas,
                                             const String& error) {
  canvas->dispatchEvent(WebGLContextEvent::create(
      EventTypeNames::webglcontextcreationerror, false, true, error));
}

WebGLRenderingContext::WebGLRenderingContext(
    HTMLCanvasElement* passedCanvas,
    std::unique_ptr<WebGraphicsContext3DProvider> contextProvider,
    const CanvasContextCreationAttributes& requestedAttributes)
    : WebGLRenderingContextBase(passedCanvas,
                                std::move(contextProvider),
                                requestedAttributes,
                                1) {}

WebGLRenderingContext::WebGLRenderingContext(
    OffscreenCanvas* passedOffscreenCanvas,
    std::unique_ptr<WebGraphicsContext3DProvider> contextProvider,
    const CanvasContextCreationAttributes& requestedAttributes)
    : WebGLRenderingContextBase(passedOffscreenCanvas,
                                std::move(contextProvider),
                                requestedAttributes,
                                1) {}

WebGLRenderingContext::~WebGLRenderingContext() {}

void WebGLRenderingContext::setCanvasGetContextResult(
    RenderingContext& result) {
  result.setWebGLRenderingContext(this);
}

void WebGLRenderingContext::setOffscreenCanvasGetContextResult(
    OffscreenRenderingContext& result) {
  result.setWebGLRenderingContext(this);
}

ImageBitmap* WebGLRenderingContext::transferToImageBitmap(
    ScriptState* scriptState) {
  return transferToImageBitmapBase(scriptState);
}

void WebGLRenderingContext::registerContextExtensions() {
  // Register extensions.
  static const char* const bothPrefixes[] = {
      "", "WEBKIT_", 0,
  };

  registerExtension<ANGLEInstancedArrays>(m_angleInstancedArrays);
  registerExtension<EXTBlendMinMax>(m_extBlendMinMax);
  registerExtension<EXTDisjointTimerQuery>(m_extDisjointTimerQuery);
  registerExtension<EXTFragDepth>(m_extFragDepth);
  registerExtension<EXTShaderTextureLOD>(m_extShaderTextureLOD);
  registerExtension<EXTsRGB>(m_extsRGB);
  registerExtension<EXTTextureFilterAnisotropic>(
      m_extTextureFilterAnisotropic, ApprovedExtension, bothPrefixes);
  registerExtension<OESElementIndexUint>(m_oesElementIndexUint);
  registerExtension<OESStandardDerivatives>(m_oesStandardDerivatives);
  registerExtension<OESTextureFloat>(m_oesTextureFloat);
  registerExtension<OESTextureFloatLinear>(m_oesTextureFloatLinear);
  registerExtension<OESTextureHalfFloat>(m_oesTextureHalfFloat);
  registerExtension<OESTextureHalfFloatLinear>(m_oesTextureHalfFloatLinear);
  registerExtension<OESVertexArrayObject>(m_oesVertexArrayObject);
  registerExtension<WebGLCompressedTextureASTC>(m_webglCompressedTextureASTC,
                                                DraftExtension);
  registerExtension<WebGLCompressedTextureATC>(m_webglCompressedTextureATC,
                                               ApprovedExtension, bothPrefixes);
  registerExtension<WebGLCompressedTextureETC>(m_webglCompressedTextureETC,
                                               DraftExtension);
  registerExtension<WebGLCompressedTextureETC1>(m_webglCompressedTextureETC1);
  registerExtension<WebGLCompressedTexturePVRTC>(
      m_webglCompressedTexturePVRTC, ApprovedExtension, bothPrefixes);
  registerExtension<WebGLCompressedTextureS3TC>(
      m_webglCompressedTextureS3TC, ApprovedExtension, bothPrefixes);
  registerExtension<WebGLCompressedTextureS3TCsRGB>(
      m_webglCompressedTextureS3TCsRGB, DraftExtension, bothPrefixes);
  registerExtension<WebGLDebugRendererInfo>(m_webglDebugRendererInfo);
  registerExtension<WebGLDebugShaders>(m_webglDebugShaders);
  registerExtension<WebGLDepthTexture>(m_webglDepthTexture, ApprovedExtension,
                                       bothPrefixes);
  registerExtension<WebGLDrawBuffers>(m_webglDrawBuffers);
  registerExtension<WebGLLoseContext>(m_webglLoseContext, ApprovedExtension,
                                      bothPrefixes);
}

DEFINE_TRACE(WebGLRenderingContext) {
  visitor->trace(m_angleInstancedArrays);
  visitor->trace(m_extBlendMinMax);
  visitor->trace(m_extDisjointTimerQuery);
  visitor->trace(m_extFragDepth);
  visitor->trace(m_extShaderTextureLOD);
  visitor->trace(m_extsRGB);
  visitor->trace(m_extTextureFilterAnisotropic);
  visitor->trace(m_oesTextureFloat);
  visitor->trace(m_oesTextureFloatLinear);
  visitor->trace(m_oesTextureHalfFloat);
  visitor->trace(m_oesTextureHalfFloatLinear);
  visitor->trace(m_oesStandardDerivatives);
  visitor->trace(m_oesVertexArrayObject);
  visitor->trace(m_oesElementIndexUint);
  visitor->trace(m_webglLoseContext);
  visitor->trace(m_webglDebugRendererInfo);
  visitor->trace(m_webglDebugShaders);
  visitor->trace(m_webglDrawBuffers);
  visitor->trace(m_webglCompressedTextureASTC);
  visitor->trace(m_webglCompressedTextureATC);
  visitor->trace(m_webglCompressedTextureETC);
  visitor->trace(m_webglCompressedTextureETC1);
  visitor->trace(m_webglCompressedTexturePVRTC);
  visitor->trace(m_webglCompressedTextureS3TC);
  visitor->trace(m_webglCompressedTextureS3TCsRGB);
  visitor->trace(m_webglDepthTexture);
  WebGLRenderingContextBase::trace(visitor);
}

DEFINE_TRACE_WRAPPERS(WebGLRenderingContext) {
  // Extensions are managed base WebGLRenderingContextBase.
  WebGLRenderingContextBase::traceWrappers(visitor);
}

}  // namespace blink