blob: 62485f155f8bc2cd759eb3b69e8b3d5f3ca78dd1 [file] [log] [blame]
// Copyright 2013 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.
#ifndef CONTENT_PUBLIC_BROWSER_ANDROID_SYNCHRONOUS_COMPOSITOR_H_
#define CONTENT_PUBLIC_BROWSER_ANDROID_SYNCHRONOUS_COMPOSITOR_H_
#include "base/memory/ref_counted.h"
#include "content/common/content_export.h"
#include "gpu/command_buffer/service/in_process_command_buffer.h"
#include "ui/gfx/rect.h"
#include "ui/gfx/size.h"
class SkCanvas;
namespace cc {
class CompositorFrame;
class CompositorFrameAck;
}
namespace gfx {
class Transform;
};
namespace gpu {
class GLInProcessContext;
}
namespace content {
class SynchronousCompositorClient;
class WebContents;
struct CONTENT_EXPORT SynchronousCompositorMemoryPolicy {
// Memory limit for rendering and pre-rendering.
size_t bytes_limit;
// Limit of number of GL resources used for rendering and pre-rendering.
size_t num_resources_limit;
SynchronousCompositorMemoryPolicy();
bool operator==(const SynchronousCompositorMemoryPolicy& other) const;
bool operator!=(const SynchronousCompositorMemoryPolicy& other) const;
};
// Interface for embedders that wish to direct compositing operations
// synchronously under their own control. Only meaningful when the
// kEnableSyncrhonousRendererCompositor flag is specified.
class CONTENT_EXPORT SynchronousCompositor {
public:
// Must be called once per WebContents instance. Will create the compositor
// instance as needed, but only if |client| is non-NULL.
static void SetClientForWebContents(WebContents* contents,
SynchronousCompositorClient* client);
// Allows changing or resetting the client to NULL (this must be used if
// the client is being deleted prior to the DidDestroyCompositor() call
// being received by the client). Ownership of |client| remains with
// the caller.
virtual void SetClient(SynchronousCompositorClient* client) = 0;
static void SetGpuService(
scoped_refptr<gpu::InProcessCommandBuffer::Service> service);
// By default, synchronous compopsitor records the full layer, not only
// what is inside and around the view port. This can be used to switch
// between this record-full-layer behavior and normal record-around-viewport
// behavior.
static void SetRecordFullDocument(bool record_full_document);
// Synchronously initialize compositor for hardware draw. Can only be called
// while compositor is in software only mode, either after compositor is
// first created or after ReleaseHwDraw is called. It is invalid to
// DemandDrawHw before this returns true.
virtual bool InitializeHwDraw() = 0;
// Reverse of InitializeHwDraw above. Can only be called while hardware draw
// is already initialized. Brings compositor back to software only mode and
// releases all hardware resources.
virtual void ReleaseHwDraw() = 0;
// Get the share context of the compositor. The returned context is owned
// by the compositor and is only valid between InitializeHwDraw and
// ReleaseHwDraw.
virtual gpu::GLInProcessContext* GetShareContext() = 0;
// "On demand" hardware draw. The content is first clipped to |damage_area|,
// then transformed through |transform|, and finally clipped to |view_size|.
virtual scoped_ptr<cc::CompositorFrame> DemandDrawHw(
gfx::Size surface_size,
const gfx::Transform& transform,
gfx::Rect viewport,
gfx::Rect clip) = 0;
// For delegated rendering, return resources from parent compositor to this.
// Note that all resources must be returned before ReleaseHwDraw.
virtual void ReturnResources(const cc::CompositorFrameAck& frame_ack) = 0;
// "On demand" SW draw, into the supplied canvas (observing the transform
// and clip set there-in).
virtual bool DemandDrawSw(SkCanvas* canvas) = 0;
// Set the memory limit policy of this compositor.
virtual void SetMemoryPolicy(
const SynchronousCompositorMemoryPolicy& policy) = 0;
// Should be called by the embedder after the embedder had modified the
// scroll offset of the root layer (as returned by
// SynchronousCompositorClient::GetTotalRootLayerScrollOffset).
virtual void DidChangeRootLayerScrollOffset() = 0;
protected:
virtual ~SynchronousCompositor() {}
};
} // namespace content
#endif // CONTENT_PUBLIC_BROWSER_ANDROID_SYNCHRONOUS_COMPOSITOR_H_