SkTraceMemoryDump.h

Go to the documentation of this file.

/*
 * Copyright 2015 Google Inc.
 *
 * Use of this source code is governed by a BSD-style license that can be
 * found in the LICENSE file.
 */
 
#ifndef SkTraceMemoryDump_DEFINED
#define SkTraceMemoryDump_DEFINED
 
#include "include/core/SkTypes.h"
 
class SkDiscardableMemory;
 
class SK_API SkTraceMemoryDump {
public:
    enum LevelOfDetail {
        // Dump only the minimal details to get the total memory usage (Usually just the totals).
        kLight_LevelOfDetail,
 
        // Dump the detailed breakdown of the objects in the caches.
        kObjectsBreakdowns_LevelOfDetail
    };
 
    virtual void dumpNumericValue(const char* dumpName,
                                  const char* valueName,
                                  const char* units,
                                  uint64_t value) = 0;
 
    virtual void dumpStringValue(const char* /*dumpName*/,
                                 const char* /*valueName*/,
                                 const char* /*value*/) { }
 
    virtual void setMemoryBacking(const char* dumpName,
                                  const char* backingType,
                                  const char* backingObjectId) = 0;
 
    virtual void setDiscardableMemoryBacking(
        const char* dumpName,
        const SkDiscardableMemory& discardableMemoryObject) = 0;
 
    virtual LevelOfDetail getRequestedDetails() const = 0;
 
    virtual bool shouldDumpWrappedObjects() const { return true; }
 
    virtual void dumpWrappedState(const char* /*dumpName*/, bool /*isWrappedObject*/) {}
 
    virtual bool shouldDumpUnbudgetedObjects() const { return true; }
 
    virtual void dumpBudgetedState(const char* /*dumpName*/, bool /*isBudgeted*/) {}
 
protected:
    virtual ~SkTraceMemoryDump() = default;
    SkTraceMemoryDump() = default;
    SkTraceMemoryDump(const SkTraceMemoryDump&) = delete;
    SkTraceMemoryDump& operator=(const SkTraceMemoryDump&) = delete;
};
 
#endif