widget/WindowSurface.h
author Lee Salzman <lsalzman@mozilla.com>
Thu, 01 Dec 2016 12:15:58 -0500
changeset 356870 4c70e3cc4da2be30a6e7e80a8b92c3de24dcd1d8
parent 345077 586815d86b50e44a1cc48c734c4da6efcd8ae8ff
child 356871 f72af5a4c1327d87a9eee376ff0f77f10191ff86
permissions -rw-r--r--
Bug 1319554 - allow WindowSurfaceX11Image to render to any visual format. r=rhunt a=gchang MozReview-Commit-ID: JW4REAg1AKn

/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*-
 *
 * This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/. */

#ifndef _MOZILLA_WIDGET_WINDOW_SURFACE_H
#define _MOZILLA_WIDGET_WINDOW_SURFACE_H

#include "mozilla/gfx/2D.h"
#include "Units.h"

namespace mozilla {
namespace widget {

// A class for drawing to double-buffered windows.
class WindowSurface {
public:
  virtual ~WindowSurface() {}

  // Locks a region of the window for drawing, returning a draw target
  // capturing the bounds of the provided region.
  // Implementations must permit invocation from any thread.
  virtual already_AddRefed<gfx::DrawTarget> Lock(const LayoutDeviceIntRegion& aRegion) = 0;

  // Swaps the provided invalid region from the back buffer to the window.
  // Implementations must permit invocation from any thread.
  virtual void Commit(const LayoutDeviceIntRegion& aInvalidRegion) = 0;

  // Whether the window surface represents a fallback method.
  virtual bool IsFallback() const { return false; }
};

}  // namespace widget
}  // namespace mozilla

#endif // _MOZILLA_WIDGET_WINDOW_SURFACE_H