src/third_party/WebKit/Source/platform/graphics/GraphicsLayerDebugInfo.h

   1 /*
   2  * Copyright (C) 2014 Google Inc. All rights reserved.
   3  *
   4  * Redistribution and use in source and binary forms, with or without
   5  * modification, are permitted provided that the following conditions are
   6  * met:
   7  *
   8  *     * Redistributions of source code must retain the above copyright
   9  * notice, this list of conditions and the following disclaimer.
  10  *     * Redistributions in binary form must reproduce the above
  11  * copyright notice, this list of conditions and the following disclaimer
  12  * in the documentation and/or other materials provided with the
  13  * distribution.
  14  *     * Neither the name of Google Inc. nor the names of its
  15  * contributors may be used to endorse or promote products derived from
  16  * this software without specific prior written permission.
  17  *
  18  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  19  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  20  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  21  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  22  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  23  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  24  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  25  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  26  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  27  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  28  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  29  */
  30
  31 #ifndef GraphicsLayerDebugInfo_h
  32 #define GraphicsLayerDebugInfo_h
  33
  34 #include "platform/JSONValues.h"
  35 #include "platform/geometry/FloatRect.h"
  36 #include "platform/geometry/LayoutRect.h"
  37 #include "platform/graphics/CompositingReasons.h"
  38 #include "platform/graphics/PaintInvalidationReason.h"
  39 #include "public/platform/WebGraphicsLayerDebugInfo.h"
  40
  41 #include "wtf/Vector.h"
  42
  43 namespace blink {
  44
  45 class GraphicsLayerDebugInfo final : public WebGraphicsLayerDebugInfo {
  46 public:
  47     GraphicsLayerDebugInfo();
  48     virtual ~GraphicsLayerDebugInfo();
  49
  50     virtual void appendAsTraceFormat(WebString* out) const override;
  51
  52     GraphicsLayerDebugInfo* clone() const;
  53
  54     void setDebugName(const String& name) { m_debugName = name; }
  55     CompositingReasons compositingReasons() const { return m_compositingReasons; }
  56     void setCompositingReasons(CompositingReasons reasons) { m_compositingReasons = reasons; }
  57     void setOwnerNodeId(int id) { m_ownerNodeId = id; }
  58     Vector<LayoutRect>& currentLayoutRects() { return m_currentLayoutRects; }
  59
  60     void appendAnnotatedInvalidateRect(const FloatRect&, PaintInvalidationReason);
  61     void clearAnnotatedInvalidateRects();
  62
  63 private:
  64     void appendLayoutRects(JSONObject*) const;
  65     void appendAnnotatedInvalidateRects(JSONObject*) const;
  66     void appendCompositingReasons(JSONObject*) const;
  67     void appendDebugName(JSONObject*) const;
  68     void appendOwnerNodeId(JSONObject*) const;
  69
  70     struct AnnotatedInvalidationRect {
  71         FloatRect rect;
  72         PaintInvalidationReason reason;
  73     };
  74
  75     String m_debugName;
  76     CompositingReasons m_compositingReasons;
  77     int m_ownerNodeId;
  78     Vector<LayoutRect> m_currentLayoutRects;
  79     Vector<AnnotatedInvalidationRect> m_invalidations;
  80     Vector<AnnotatedInvalidationRect> m_previousInvalidations;
  81 };
  82
  83 } // namespace blink
  84
  85 #endif