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/graphics/CompositingReasons.h"
  37 #include "platform/graphics/PaintInvalidationReason.h"
  38 #include "public/platform/WebGraphicsLayerDebugInfo.h"
  39
  40 #include "wtf/Vector.h"
  41
  42 namespace blink {
  43
  44 class GraphicsLayerDebugInfo final : public WebGraphicsLayerDebugInfo {
  45 public:
  46     GraphicsLayerDebugInfo();
  47     ~GraphicsLayerDebugInfo() override;
  48
  49     void appendAsTraceFormat(WebString* out) const override;
  50
  51     GraphicsLayerDebugInfo* clone() const;
  52
  53     void setDebugName(const String& name) { m_debugName = name; }
  54     CompositingReasons compositingReasons() const { return m_compositingReasons; }
  55     void setCompositingReasons(CompositingReasons reasons) { m_compositingReasons = reasons; }
  56     void setOwnerNodeId(int id) { m_ownerNodeId = id; }
  57
  58     void appendAnnotatedInvalidateRect(const FloatRect&, PaintInvalidationReason);
  59     void clearAnnotatedInvalidateRects();
  60
  61 private:
  62     void appendAnnotatedInvalidateRects(JSONObject*) const;
  63     void appendCompositingReasons(JSONObject*) const;
  64     void appendDebugName(JSONObject*) const;
  65     void appendOwnerNodeId(JSONObject*) const;
  66
  67     struct AnnotatedInvalidationRect {
  68         FloatRect rect;
  69         PaintInvalidationReason reason;
  70     };
  71
  72     String m_debugName;
  73     CompositingReasons m_compositingReasons;
  74     int m_ownerNodeId;
  75     Vector<AnnotatedInvalidationRect> m_invalidations;
  76     Vector<AnnotatedInvalidationRect> m_previousInvalidations;
  77 };
  78
  79 } // namespace blink
  80
  81 #endif