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/surfaces/surface_id.h"
  15 #include "cc/surfaces/surface_resource_holder.h"
  16 #include "cc/surfaces/surface_sequence.h"
  17 #include "cc/surfaces/surfaces_export.h"
  18
  19 namespace gfx {
  20 class Size;
  21 }
  22
  23 namespace cc {
  24 class CompositorFrame;
  25 class CopyOutputRequest;
  26 class Surface;
  27 class SurfaceFactoryClient;
  28 class SurfaceManager;
  29
  30 // A SurfaceFactory is used to create surfaces that may share resources and
  31 // receive returned resources for frames submitted to those surfaces. Resources
  32 // submitted to frames created by a particular factory will be returned to that
  33 // factory's client when they are no longer being used. This is the only class
  34 // most users of surfaces will need to directly interact with.
  35 class CC_SURFACES_EXPORT SurfaceFactory
  36     : public base::SupportsWeakPtr<SurfaceFactory> {
  37  public:
  38   SurfaceFactory(SurfaceManager* manager, SurfaceFactoryClient* client);
  39   ~SurfaceFactory();
  40
  41   void Create(SurfaceId surface_id, const gfx::Size& size);
  42   void Destroy(SurfaceId surface_id);
  43   void DestroyOnSequence(SurfaceId surface_id,
  44                          const std::set<SurfaceSequence>& dependency_set);
  45   void DestroyAll();
  46   // A frame can only be submitted to a surface created by this factory,
  47   // although the frame may reference surfaces created by other factories.
  48   // The callback is called the first time this frame is used to draw.
  49   void SubmitFrame(SurfaceId surface_id,
  50                    scoped_ptr<CompositorFrame> frame,
  51                    const base::Closure& callback);
  52   void RequestCopyOfSurface(SurfaceId surface_id,
  53                             scoped_ptr<CopyOutputRequest> copy_request);
  54
  55   SurfaceFactoryClient* client() { return client_; }
  56
  57   void ReceiveFromChild(const TransferableResourceArray& resources);
  58   void RefResources(const TransferableResourceArray& resources);
  59   void UnrefResources(const ReturnedResourceArray& resources);
  60
  61   SurfaceManager* manager() { return manager_; }
  62
  63  private:
  64   SurfaceManager* manager_;
  65   SurfaceFactoryClient* client_;
  66   SurfaceResourceHolder holder_;
  67
  68   typedef base::ScopedPtrHashMap<SurfaceId, Surface> OwningSurfaceMap;
  69   base::ScopedPtrHashMap<SurfaceId, Surface> surface_map_;
  70
  71   DISALLOW_COPY_AND_ASSIGN(SurfaceFactory);
  72 };
  73
  74 }  // namespace cc
  75
  76 #endif  // CC_SURFACES_SURFACE_FACTORY_H_