blob: 9036d856b3b010a0f6c36e2c8be8cfa47eca4010 [file] [log] [blame]
// Copyright 2014 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.
#include <stddef.h>
#include <stdint.h>
#include <map>
#include <memory>
#include <set>
#include <unordered_set>
#include <vector>
#include "base/callback.h"
#include "base/macros.h"
#include "base/memory/weak_ptr.h"
#include "cc/output/copy_output_request.h"
#include "cc/quads/render_pass_id.h"
#include "cc/surfaces/frame_sink_id.h"
#include "cc/surfaces/surface_factory.h"
#include "cc/surfaces/surface_id.h"
#include "cc/surfaces/surface_sequence.h"
#include "cc/surfaces/surfaces_export.h"
#include "ui/gfx/geometry/size.h"
namespace ui {
class LatencyInfo;
namespace cc {
class CompositorFrame;
class CopyOutputRequest;
class SurfaceManager;
class SurfaceFactory;
class SurfaceResourceHolder;
class CC_SURFACES_EXPORT Surface {
using DrawCallback = SurfaceFactory::DrawCallback;
Surface(const SurfaceId& id, SurfaceFactory* factory);
const SurfaceId& surface_id() const { return surface_id_; }
const SurfaceId& previous_frame_surface_id() const {
return previous_frame_surface_id_;
void SetPreviousFrameSurface(Surface* surface);
void QueueFrame(CompositorFrame frame, const DrawCallback& draw_callback);
void RequestCopyOfOutput(std::unique_ptr<CopyOutputRequest> copy_request);
// Adds each CopyOutputRequest in the current frame to copy_requests. The
// caller takes ownership of them.
void TakeCopyOutputRequests(
std::multimap<RenderPassId, std::unique_ptr<CopyOutputRequest>>*
// Returns the most recent frame that is eligible to be rendered.
// If the CompositorFrame's DelegateFrameData is null then there is
// no eligible frame.
const CompositorFrame& GetEligibleFrame();
// Returns a number that increments by 1 every time a new frame is enqueued.
int frame_index() const { return frame_index_; }
void TakeLatencyInfo(std::vector<ui::LatencyInfo>* latency_info);
void RunDrawCallbacks();
base::WeakPtr<SurfaceFactory> factory() { return factory_; }
// Add a SurfaceSequence that must be satisfied before the Surface is
// destroyed.
void AddDestructionDependency(SurfaceSequence sequence);
// Satisfy all destruction dependencies that are contained in sequences, and
// remove them from sequences.
void SatisfyDestructionDependencies(
std::unordered_set<SurfaceSequence, SurfaceSequenceHash>* sequences,
std::unordered_set<FrameSinkId, FrameSinkIdHash>* valid_id_namespaces);
size_t GetDestructionDependencyCount() const {
return destruction_dependencies_.size();
const std::vector<SurfaceId>& referenced_surfaces() const {
return referenced_surfaces_;
bool destroyed() const { return destroyed_; }
void set_destroyed(bool destroyed) { destroyed_ = destroyed; }
void UnrefFrameResources(DelegatedFrameData* frame_data);
void ClearCopyRequests();
SurfaceId surface_id_;
SurfaceId previous_frame_surface_id_;
base::WeakPtr<SurfaceFactory> factory_;
// TODO(jamesr): Support multiple frames in flight.
CompositorFrame current_frame_;
int frame_index_;
bool destroyed_;
std::vector<SurfaceSequence> destruction_dependencies_;
// This surface may have multiple BeginFrameSources if it is
// on multiple Displays.
std::set<BeginFrameSource*> begin_frame_sources_;
std::vector<SurfaceId> referenced_surfaces_;
DrawCallback draw_callback_;
} // namespace cc