Rename paint data structures

third_party/WebKit/Source/platform/graphics/Canvas2DLayerBridge.cpp

 /*
  * Copyright (C) 2012 Google 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
@@ skipping 20 matching lines @@
 #include "gpu/command_buffer/client/gles2_interface.h"
 #include "gpu/command_buffer/client/gpu_memory_buffer_manager.h"
 #include "platform/Histogram.h"
 #include "platform/RuntimeEnabledFeatures.h"
 #include "platform/WebTaskRunner.h"
 #include "platform/graphics/CanvasMetrics.h"
 #include "platform/graphics/ExpensiveCanvasHeuristicParameters.h"
 #include "platform/graphics/GraphicsLayer.h"
 #include "platform/graphics/ImageBuffer.h"
 #include "platform/graphics/gpu/SharedContextRateLimiter.h"
+#include "platform/graphics/paint/PaintCanvas.h"
+#include "platform/graphics/paint/PaintSurface.h"
 #include "platform/instrumentation/tracing/TraceEvent.h"
 #include "public/platform/Platform.h"
 #include "public/platform/WebCompositorSupport.h"
 #include "public/platform/WebGraphicsContext3DProvider.h"
 #include "public/platform/WebScheduler.h"
 #include "public/platform/WebTraceLocation.h"
 #include "skia/ext/texture_handle.h"
 #include "third_party/skia/include/core/SkData.h"
-#include "third_party/skia/include/core/SkPictureRecorder.h"
-#include "third_party/skia/include/core/SkSurface.h"
 #include "third_party/skia/include/gpu/GrContext.h"
 #include "third_party/skia/include/gpu/gl/GrGLTypes.h"
 #include "wtf/PtrUtil.h"
 #include <memory>
 
 namespace {
 enum {
   InvalidMailboxIndex = -1,
   MaxCanvasAnimationBacklog = 2,  // Make sure the the GPU is never more than
                                   // two animation frames behind.
@@ skipping 13 matching lines @@
   std::unique_ptr<gfx::GpuMemoryBuffer> m_gpuMemoryBuffer;
 
   // The id of the CHROMIUM image.
   const GLuint m_imageId;
 
   // The id of the texture bound to the CHROMIUM image.
   const GLuint m_textureId;
 };
 #endif  // USE_IOSURFACE_FOR_2D_CANVAS
 
-static sk_sp<SkSurface> createSkSurface(GrContext* gr,
-                                        const IntSize& size,
-                                        int msaaSampleCount,
-                                        OpacityMode opacityMode,
-                                        sk_sp<SkColorSpace> colorSpace,
-                                        SkColorType colorType,
-                                        bool* surfaceIsAccelerated) {
+static sk_sp<PaintSurface> createSkSurface(GrContext* gr,

[danakj, 2017/01/20 23:34:15]

I feel like this should stay SkSurface and we should just wrap the canvas from
it with a passthru PaintCanvas

[enne (OOO), 2017/01/24 01:51:28]

Going to punt on this for now, given vmiura's comments.

+                                           const IntSize& size,
+                                           int msaaSampleCount,
+                                           OpacityMode opacityMode,
+                                           sk_sp<SkColorSpace> colorSpace,
+                                           SkColorType colorType,
+                                           bool* surfaceIsAccelerated) {
   if (gr)
     gr->resetContext();
 
   SkAlphaType alphaType =
       (Opaque == opacityMode) ? kOpaque_SkAlphaType : kPremul_SkAlphaType;
   SkImageInfo info = SkImageInfo::Make(size.width(), size.height(), colorType,
                                        alphaType, colorSpace);
   SkSurfaceProps disableLCDProps(0, kUnknown_SkPixelGeometry);
-  sk_sp<SkSurface> surface;
+  sk_sp<PaintSurface> surface;
 
   if (gr) {
     *surfaceIsAccelerated = true;
-    surface = SkSurface::MakeRenderTarget(
+    surface = PaintSurface::MakeRenderTarget(
         gr, SkBudgeted::kNo, info, msaaSampleCount,
         Opaque == opacityMode ? 0 : &disableLCDProps);
   }
 
   if (!surface) {
     *surfaceIsAccelerated = false;
-    surface = SkSurface::MakeRaster(
+    surface = PaintSurface::MakeRaster(
         info, Opaque == opacityMode ? 0 : &disableLCDProps);
   }
 
   if (surface) {
     if (opacityMode == Opaque) {
       surface->getCanvas()->clear(SK_ColorBLACK);
     } else {
       surface->getCanvas()->clear(SK_ColorTRANSPARENT);
     }
   }
@@ skipping 42 matching lines @@
 #if USE_IOSURFACE_FOR_2D_CANVAS
   clearCHROMIUMImageCache();
 #endif  // USE_IOSURFACE_FOR_2D_CANVAS
 
   m_layer.reset();
   DCHECK_EQ(0u, m_mailboxes.size());
 }
 
 void Canvas2DLayerBridge::startRecording() {
   DCHECK(m_isDeferralEnabled);
-  m_recorder = WTF::wrapUnique(new SkPictureRecorder);
-  SkCanvas* canvas =
+  m_recorder = WTF::wrapUnique(new PaintRecorder);
+  PaintCanvas* canvas =
       m_recorder->beginRecording(m_size.width(), m_size.height(), nullptr);
   // Always save an initial frame, to support resetting the top level matrix
   // and clip.
   canvas->save();
 
   if (m_imageBuffer) {
     m_imageBuffer->resetCanvas(canvas);
   }
   m_recordingPixelCount = 0;
 }
@@ skipping 305 matching lines @@
     return;
   }
 
   if (!isAccelerated()) {
     m_logger->reportHibernationEvent(
         HibernationAbortedDueToSwitchToUnacceleratedRendering);
     return;
   }
 
   TRACE_EVENT0("cc", "Canvas2DLayerBridge::hibernate");
-  sk_sp<SkSurface> tempHibernationSurface =
-      SkSurface::MakeRasterN32Premul(m_size.width(), m_size.height());
+  sk_sp<PaintSurface> tempHibernationSurface =
+      PaintSurface::MakeRasterN32Premul(m_size.width(), m_size.height());
   if (!tempHibernationSurface) {
     m_logger->reportHibernationEvent(HibernationAbortedDueToAllocationFailure);
     return;
   }
   // No HibernationEvent reported on success. This is on purppose to avoid
   // non-complementary stats. Each HibernationScheduled event is paired with
   // exactly one failure or exit event.
   flushRecordingOnly();
   // The following checks that the flush succeeded, which should always be the
   // case because flushRecordingOnly should only fail it it fails to allocate
   // a surface, and we have an early exit at the top of this function for when
   // 'this' does not already have a surface.
   DCHECK(!m_haveRecordedDrawCommands);
-  SkPaint copyPaint;
+  PaintFlags copyPaint;
   copyPaint.setBlendMode(SkBlendMode::kSrc);
   m_surface->draw(tempHibernationSurface->getCanvas(), 0, 0,
                   &copyPaint);  // GPU readback
   m_hibernationImage = tempHibernationSurface->makeImageSnapshot();
   m_surface.reset();  // destroy the GPU-backed buffer
   m_layer->clearTexture();
 #if USE_IOSURFACE_FOR_2D_CANVAS
   clearCHROMIUMImageCache();
 #endif  // USE_IOSURFACE_FOR_2D_CANVAS
   m_logger->didStartHibernating();
 }
 
 void Canvas2DLayerBridge::reportSurfaceCreationFailure() {
   if (!m_surfaceCreationFailedAtLeastOnce) {
     // Only count the failure once per instance so that the histogram may
     // reflect the proportion of Canvas2DLayerBridge instances with surface
     // allocation failures.
     CanvasMetrics::countCanvasContextUsage(
         CanvasMetrics::GPUAccelerated2DCanvasSurfaceCreationFailed);
     m_surfaceCreationFailedAtLeastOnce = true;
   }
 }
 
-SkSurface* Canvas2DLayerBridge::getOrCreateSurface(AccelerationHint hint) {
+PaintSurface* Canvas2DLayerBridge::getOrCreateSurface(AccelerationHint hint) {
   if (m_surface)
     return m_surface.get();
 
   if (m_layer && !isHibernating() && hint == PreferAcceleration &&
       m_accelerationMode != DisableAcceleration) {
     return nullptr;  // re-creation will happen through restore()
   }
 
   bool wantAcceleration = shouldAccelerate(hint);
   if (CANVAS2D_BACKGROUND_RENDER_SWITCH_TO_CPU && isHidden() &&
@@ skipping 30 matching lines @@
     if (surfaceIsAccelerated) {
       m_logger->reportHibernationEvent(HibernationEndedNormally);
     } else {
       if (isHidden())
         m_logger->reportHibernationEvent(
             HibernationEndedWithSwitchToBackgroundRendering);
       else
         m_logger->reportHibernationEvent(HibernationEndedWithFallbackToSW);
     }
 
-    SkPaint copyPaint;
+    PaintFlags copyPaint;
     copyPaint.setBlendMode(SkBlendMode::kSrc);
     m_surface->getCanvas()->drawImage(m_hibernationImage.get(), 0, 0,
                                       &copyPaint);
     m_hibernationImage.reset();
 
     if (m_imageBuffer)
       m_imageBuffer->updateGPUMemoryUsage();
 
     if (m_imageBuffer && !m_isDeferralEnabled)
       m_imageBuffer->resetCanvas(m_surface->getCanvas());
   }
 
   return m_surface.get();
 }
 
-SkCanvas* Canvas2DLayerBridge::canvas() {
+PaintCanvas* Canvas2DLayerBridge::canvas() {
   if (!m_isDeferralEnabled) {
-    SkSurface* s = getOrCreateSurface();
+    PaintSurface* s = getOrCreateSurface();
     return s ? s->getCanvas() : nullptr;
   }
   return m_recorder->getRecordingCanvas();
 }
 
 void Canvas2DLayerBridge::disableDeferral(DisableDeferralReason reason) {
   // Disabling deferral is permanent: once triggered by disableDeferral()
   // we stay in immediate mode indefinitely. This is a performance heuristic
   // that significantly helps a number of use cases. The rationale is that if
   // immediate rendering was needed once, it is likely to be needed at least
@@ skipping 12 matching lines @@
   CanvasMetrics::countCanvasContextUsage(
       CanvasMetrics::GPUAccelerated2DCanvasDeferralDisabled);
   flushRecordingOnly();
   // Because we will be discarding the recorder, if the flush failed
   // content will be lost -> force m_haveRecordedDrawCommands to false
   m_haveRecordedDrawCommands = false;
 
   m_isDeferralEnabled = false;
   m_recorder.reset();
   // install the current matrix/clip stack onto the immediate canvas
-  SkSurface* surface = getOrCreateSurface();
+  PaintSurface* surface = getOrCreateSurface();
   if (m_imageBuffer && surface)
     m_imageBuffer->resetCanvas(surface->getCanvas());
 }
 
 void Canvas2DLayerBridge::setImageBuffer(ImageBuffer* imageBuffer) {
   m_imageBuffer = imageBuffer;
   if (m_imageBuffer && m_isDeferralEnabled) {
     m_imageBuffer->resetCanvas(m_recorder->getRecordingCanvas());
   }
 }
@@ skipping 55 matching lines @@
           BLINK_FROM_HERE, WTF::bind(&hibernateWrapperForTesting,
                                      m_weakPtrFactory.createWeakPtr()));
     } else {
       Platform::current()->currentThread()->scheduler()->postIdleTask(
           BLINK_FROM_HERE,
           WTF::bind(&hibernateWrapper, m_weakPtrFactory.createWeakPtr()));
     }
   }
   if (!isHidden() && m_softwareRenderingWhileHidden) {
     flushRecordingOnly();
-    SkPaint copyPaint;
+    PaintFlags copyPaint;
     copyPaint.setBlendMode(SkBlendMode::kSrc);
 
-    sk_sp<SkSurface> oldSurface = std::move(m_surface);
+    sk_sp<PaintSurface> oldSurface = std::move(m_surface);
     m_surface.reset();
 
     m_softwareRenderingWhileHidden = false;
-    SkSurface* newSurface =
+    PaintSurface* newSurface =
         getOrCreateSurface(PreferAccelerationAfterVisibilityChange);
     if (newSurface) {
       if (oldSurface)
         oldSurface->draw(newSurface->getCanvas(), 0, 0, &copyPaint);
       if (m_imageBuffer && !m_isDeferralEnabled) {
         m_imageBuffer->resetCanvas(m_surface->getCanvas());
       }
     }
   }
   if (!isHidden() && isHibernating()) {
@@ skipping 118 matching lines @@
   gpu::gles2::GLES2Interface* sharedGL = nullptr;
   m_layer->clearTexture();
   m_contextProvider = WTF::wrapUnique(
       Platform::current()->createSharedOffscreenGraphicsContext3DProvider());
   if (m_contextProvider)
     sharedGL = m_contextProvider->contextGL();
 
   if (sharedGL && sharedGL->GetGraphicsResetStatusKHR() == GL_NO_ERROR) {
     GrContext* grCtx = m_contextProvider->grContext();
     bool surfaceIsAccelerated;
-    sk_sp<SkSurface> surface(
+    sk_sp<PaintSurface> surface(
         createSkSurface(grCtx, m_size, m_msaaSampleCount, m_opacityMode,
                         m_colorSpace, m_colorType, &surfaceIsAccelerated));
 
     if (!m_surface)
       reportSurfaceCreationFailure();
 
     // The current paradigm does not support switching from accelerated to
     // non-accelerated, which would be tricky due to changes to the layer tree,
     // which can only happen at specific times during the document lifecycle.
     // Therefore, we can only accept the restored surface if it is accelerated.
@@ skipping 275 matching lines @@
     default;
 
 void Canvas2DLayerBridge::Logger::reportHibernationEvent(
     HibernationEvent event) {
   DEFINE_STATIC_LOCAL(EnumerationHistogram, hibernationHistogram,
                       ("Canvas.HibernationEvents", HibernationEventCount));
   hibernationHistogram.count(event);
 }
 
 }  // namespace blink