cc: handling debug settings in new LayerTreeDebugState structure

cc/layer_tree_host.h

 // Copyright 2011 The Chromium Authors. All rights reserved.
 // Use of this source code is governed by a BSD-style license that can be
 // found in the LICENSE file.
 
 #ifndef CC_LAYER_TREE_HOST_H_
 #define CC_LAYER_TREE_HOST_H_
 
 #include <limits>
 
 #include "base/basictypes.h"
 #include "base/cancelable_callback.h"
 #include "base/hash_tables.h"
 #include "base/memory/ref_counted.h"
 #include "base/memory/scoped_ptr.h"
 #include "base/time.h"
 #include "cc/animation_events.h"
 #include "cc/cc_export.h"
 #include "cc/graphics_context.h"
+#include "cc/heads_up_display_layer.h"
 #include "cc/layer_tree_host_client.h"
 #include "cc/layer_tree_host_common.h"
 #include "cc/occlusion_tracker.h"
 #include "cc/prioritized_resource_manager.h"
 #include "cc/proxy.h"
 #include "cc/rate_limiter.h"
 #include "cc/rendering_stats.h"
 #include "cc/scoped_ptr_vector.h"
 #include "third_party/skia/include/core/SkColor.h"
 #include "ui/gfx/rect.h"
 
 #if defined(COMPILER_GCC)
 namespace BASE_HASH_NAMESPACE {
 template<>
 struct hash<WebKit::WebGraphicsContext3D*> {
   size_t operator()(WebKit::WebGraphicsContext3D* ptr) const {
     return hash<size_t>()(reinterpret_cast<size_t>(ptr));
   }
 };
 } // namespace BASE_HASH_NAMESPACE
 #endif // COMPILER
 
 namespace cc {
 
-class FontAtlas;
 class Layer;
 class LayerTreeHostImpl;
 class LayerTreeHostImplClient;
 class PrioritizedResourceManager;
 class ResourceUpdateQueue;
-class HeadsUpDisplayLayer;
 class Region;
 struct ScrollAndScaleSet;
 
-struct CC_EXPORT LayerTreeSettings {
-    LayerTreeSettings();
-    ~LayerTreeSettings();
+struct CC_EXPORT LayerTreeSwitches {

[egraether, 2012/11/22 00:23:15]

New structure LayerTreeSwitches holds values that can be changed while running.

[danakj, 2012/11/26 19:57:18]

This is great. The only concern I have here is that "Switches" is the word we
use for --these-things in the command line as well.

I'm not sure if I have any reasonable name suggestions though. What about
LayerTreeToggles?

[danakj, 2012/11/26 19:58:25]

Nat suggested LayerTreeDebugState, which I like. Let's do that?

+    LayerTreeSwitches();
+    ~LayerTreeSwitches();
 
-    bool acceleratePainting;
+    bool showFPSCounter;
+    bool showPlatformLayerTree;
     bool showDebugBorders;

[egraether, 2012/11/22 00:23:15]

Also holds showDebugBorders

-    bool showPlatformLayerTree;
+
     bool showPaintRects;
     bool showPropertyChangedRects;
     bool showSurfaceDamageRects;
     bool showScreenSpaceRects;
     bool showReplicaScreenSpaceRects;
     bool showOccludingRects;
     bool showNonOccludingRects;
+
+    bool showHudInfo() const;
+    bool showHudRects() const;

[danakj, 2012/11/26 19:57:18]

I like the name changes here a lot.

+
+    LayerTreeSwitches merge(const LayerTreeSwitches& other) const;

[danakj, 2012/11/26 19:57:18]

How about a static method that takes two instances as arguments? structs
shouldn't really have member methods.

+};
+
+struct CC_EXPORT LayerTreeSettings {
+    LayerTreeSettings();
+    ~LayerTreeSettings();
+
+    bool acceleratePainting;
     bool renderVSyncEnabled;
     bool perTilePaintingEnabled;
     bool partialSwapEnabled;
     bool acceleratedAnimationEnabled;
     bool pageScalePinchZoomEnabled;
     bool backgroundColorInsteadOfCheckerboard;
     bool showOverdrawInTracing;
     double refreshRate;
     size_t maxPartialTextureUpdates;
     gfx::Size defaultTileSize;
     gfx::Size maxUntiledLayerSize;
     gfx::Size minimumOcclusionTrackingSize;
 
-    bool showDebugInfo() const { return showPlatformLayerTree || showDebugRects(); }
-    bool showDebugRects() const { return showPaintRects || showPropertyChangedRects || showSurfaceDamageRects || showScreenSpaceRects || showReplicaScreenSpaceRects || showOccludingRects || showNonOccludingRects; }
+    LayerTreeSwitches initialSwitchSettings;

[egraether, 2012/11/22 00:23:15]

Initial switch values from the commandline get stored as substructure of
LayerTreeSettings.

What about inheriting LayerTreeSettings from LayerTreeSwitches instead?

[danakj, 2012/11/26 19:57:18]

initialSwitchValues? (or initialToggleValues?)

"Settings" is a bit overloaded here.

 };
 
 // Provides information on an Impl's rendering capabilities back to the LayerTreeHost
 struct CC_EXPORT RendererCapabilities {
     RendererCapabilities();
     ~RendererCapabilities();
 
     GLenum bestTextureFormat;
     bool contextHasCachedFrontBuffer;
     bool usingPartialSwap;
@@ skipping 83 matching lines @@
 
     void setAnimationEvents(scoped_ptr<AnimationEventsVector>, base::Time wallClockTime);
     virtual void didAddAnimation();
 
     Layer* rootLayer() { return m_rootLayer.get(); }
     const Layer* rootLayer() const { return m_rootLayer.get(); }
     void setRootLayer(scoped_refptr<Layer>);
 
     const LayerTreeSettings& settings() const { return m_settings; }
 
+    void setSwitches(const LayerTreeSwitches& switches);
+    const LayerTreeSwitches& switches() const { return m_switches; }
+
     void setViewportSize(const gfx::Size& layoutViewportSize, const gfx::Size& deviceViewportSize);
 
     const gfx::Size& layoutViewportSize() const { return m_layoutViewportSize; }
     const gfx::Size& deviceViewportSize() const { return m_deviceViewportSize; }
 
     void setPageScaleFactorAndLimits(float pageScaleFactor, float minPageScaleFactor, float maxPageScaleFactor);
 
     void setBackgroundColor(SkColor color) { m_backgroundColor = color; }
 
     void setHasTransparentBackground(bool transparent) { m_hasTransparentBackground = transparent; }
@@ skipping 14 matching lines @@
 
     // RateLimitClient implementation
     virtual void rateLimit() OVERRIDE;
 
     bool bufferedUpdates();
     bool requestPartialTextureUpdate();
 
     void setDeviceScaleFactor(float);
     float deviceScaleFactor() const { return m_deviceScaleFactor; }
 
-    void setShowFPSCounter(bool show);
     void setFontAtlas(scoped_ptr<FontAtlas>);
 
     HeadsUpDisplayLayer* hudLayer() const { return m_hudLayer.get(); }
 
     Proxy* proxy() const { return m_proxy.get(); }
 
 protected:
     LayerTreeHost(LayerTreeHostClient*, const LayerTreeSettings&);
     bool initialize(scoped_ptr<Thread> implThread);
 
@@ skipping 36 matching lines @@
     int m_numTimesRecreateShouldFail;
     int m_numFailedRecreateAttempts;
 
     scoped_refptr<Layer> m_rootLayer;
     scoped_refptr<HeadsUpDisplayLayer> m_hudLayer;
 
     scoped_ptr<PrioritizedResourceManager> m_contentsTextureManager;
     scoped_ptr<PrioritizedResource> m_surfaceMemoryPlaceholder;
 
     LayerTreeSettings m_settings;
+    LayerTreeSwitches m_switches;
 
     gfx::Size m_layoutViewportSize;
     gfx::Size m_deviceViewportSize;
     float m_deviceScaleFactor;
 
     bool m_visible;
 
     typedef base::hash_map<WebKit::WebGraphicsContext3D*, scoped_refptr<RateLimiter> > RateLimiterMap;
     RateLimiterMap m_rateLimiters;
 
     float m_pageScaleFactor;
     float m_minPageScaleFactor, m_maxPageScaleFactor;
     WebKit::WebTransformationMatrix m_implTransform;
     bool m_triggerIdleUpdates;
 
     SkColor m_backgroundColor;
     bool m_hasTransparentBackground;
 
     typedef ScopedPtrVector<PrioritizedResource> TextureList;
     size_t m_partialTextureUpdateRequests;
 
     static bool s_needsFilterContext;
 
     DISALLOW_COPY_AND_ASSIGN(LayerTreeHost);
 };
 
 }  // namespace cc
 
 #endif  // CC_LAYER_TREE_HOST_H_