cc/surfaces/surface_factory.h

   1 // Copyright 2014 The Chromium Authors. All rights reserved.
   2 // Use of this source code is governed by a BSD-style license that can be
   3 // found in the LICENSE file.
   4
   5 #ifndef CC_SURFACES_SURFACE_FACTORY_H_
   6 #define CC_SURFACES_SURFACE_FACTORY_H_
   7
   8 #include <set>
   9
  10 #include "base/callback_forward.h"
  11 #include "base/containers/scoped_ptr_hash_map.h"
  12 #include "base/memory/scoped_ptr.h"
  13 #include "base/memory/weak_ptr.h"
  14 #include "cc/output/compositor_frame.h"
  15 #include "cc/surfaces/surface_id.h"
  16 #include "cc/surfaces/surface_resource_holder.h"
  17 #include "cc/surfaces/surface_sequence.h"
  18 #include "cc/surfaces/surfaces_export.h"
  19
  20 namespace gfx {
  21 class Size;
  22 }
  23
  24 namespace cc {
  25 class CopyOutputRequest;
  26 class Surface;
  27 class SurfaceFactoryClient;
  28 class SurfaceManager;
  29
  30 enum class SurfaceDrawStatus { DRAW_SKIPPED, DRAWN };
  31
  32 // A SurfaceFactory is used to create surfaces that may share resources and
  33 // receive returned resources for frames submitted to those surfaces. Resources
  34 // submitted to frames created by a particular factory will be returned to that
  35 // factory's client when they are no longer being used. This is the only class
  36 // most users of surfaces will need to directly interact with.
  37 class CC_SURFACES_EXPORT SurfaceFactory
  38     : public base::SupportsWeakPtr<SurfaceFactory> {
  39  public:
  40   using DrawCallback = base::Callback<void(SurfaceDrawStatus)>;
  41
  42   SurfaceFactory(SurfaceManager* manager, SurfaceFactoryClient* client);
  43   ~SurfaceFactory();
  44
  45   void Create(SurfaceId surface_id);
  46   void Destroy(SurfaceId surface_id);
  47   void DestroyAll();
  48   // A frame can only be submitted to a surface created by this factory,
  49   // although the frame may reference surfaces created by other factories.
  50   // The callback is called the first time this frame is used to draw, or if
  51   // the frame is discarded.
  52   void SubmitCompositorFrame(SurfaceId surface_id,
  53                              scoped_ptr<CompositorFrame> frame,
  54                              const DrawCallback& callback);
  55   void RequestCopyOfSurface(SurfaceId surface_id,
  56                             scoped_ptr<CopyOutputRequest> copy_request);
  57
  58   SurfaceFactoryClient* client() { return client_; }
  59
  60   void ReceiveFromChild(const TransferableResourceArray& resources);
  61   void RefResources(const TransferableResourceArray& resources);
  62   void UnrefResources(const ReturnedResourceArray& resources);
  63
  64   SurfaceManager* manager() { return manager_; }
  65
  66   // This can be set to false if resources from this SurfaceFactory don't need
  67   // to have sync points set on them when returned from the Display, for
  68   // example if the Display shares a context with the creator.
  69   bool needs_sync_points() const { return needs_sync_points_; }
  70   void set_needs_sync_points(bool needs) { needs_sync_points_ = needs; }
  71
  72  private:
  73   SurfaceManager* manager_;
  74   SurfaceFactoryClient* client_;
  75   SurfaceResourceHolder holder_;
  76
  77   bool needs_sync_points_;
  78
  79   typedef base::ScopedPtrHashMap<SurfaceId, scoped_ptr<Surface>>
  80       OwningSurfaceMap;
  81   OwningSurfaceMap surface_map_;
  82
  83   DISALLOW_COPY_AND_ASSIGN(SurfaceFactory);
  84 };
  85
  86 }  // namespace cc
  87
  88 #endif  // CC_SURFACES_SURFACE_FACTORY_H_