components/viz/common/quads/compositor_frame.h

// Copyright 2012 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

#ifndef COMPONENTS_VIZ_COMMON_QUADS_COMPOSITOR_FRAME_H_
#define COMPONENTS_VIZ_COMMON_QUADS_COMPOSITOR_FRAME_H_

#include <memory>
#include <string>
#include <vector>

#include "components/viz/common/quads/compositor_frame_metadata.h"
#include "components/viz/common/quads/compositor_render_pass.h"
#include "components/viz/common/resources/transferable_resource.h"
#include "components/viz/common/surfaces/region_capture_bounds.h"
#include "components/viz/common/viz_common_export.h"

namespace base::trace_event {
class TracedValue;
}  // namespace base::trace_event

namespace viz {

// A CompositorFrame struct contains the complete output of a compositor meant
// for display. A CompositorFrame consists of a series of DrawQuads that
// describe placement of textures, solid colors, overlays and other
// CompositorFrames within an area specified by the parent compositor. DrawQuads
// may share common data referred to as SharedQuadState. A CompositorFrame also
// has |metadata| that refers to global graphical state associated with this
// frame.
class VIZ_COMMON_EXPORT CompositorFrame {
 public:
  CompositorFrame();
  CompositorFrame(CompositorFrame&& other);

  CompositorFrame(const CompositorFrame&) = delete;
  CompositorFrame& operator=(const CompositorFrame&) = delete;

  ~CompositorFrame();

  CompositorFrame& operator=(CompositorFrame&& other);

  float device_scale_factor() const { return metadata.device_scale_factor; }

  const gfx::Size& size_in_pixels() const {
    DCHECK(!render_pass_list.empty());
    return render_pass_list.back()->output_rect.size();
  }

  bool HasCopyOutputRequests() const;

  void AsValueInto(base::trace_event::TracedValue* value) const;
  std::string ToString() const;

  CompositorFrameMetadata metadata;
  std::vector<TransferableResource> resource_list;
  // This list is in the order that each CompositorRenderPass will be drawn.
  // The last one is the "root" CompositorRenderPass that all others are
  // directly or indirectly drawn into.
  CompositorRenderPassList render_pass_list;
};

}  // namespace viz

#endif  // COMPONENTS_VIZ_COMMON_QUADS_COMPOSITOR_FRAME_H_