gecko-dev/gfx/layers/ipc/RemoteContentController.h
Ryan Hunt a624f81f28 Bug 1298246 - Update documentation for APZ IPDL protocols. r=kats
MozReview-Commit-ID: 6IYNycFmu7z

--HG--
extra : rebase_source : 917aecd0b7dafc09db21c6993eb6eca0f01a8eba
2016-08-25 16:42:55 -07:00

93 lines
3 KiB
C++

/* -*- Mode: C++; tab-width: 8; indent-tabs-mode: nil; c-basic-offset: 2 -*-
* vim: sw=2 ts=8 et :
*/
/* 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_layers_RemoteContentController_h
#define mozilla_layers_RemoteContentController_h
#include "mozilla/layers/GeckoContentController.h"
#include "mozilla/layers/PAPZParent.h"
namespace mozilla {
namespace dom {
class TabParent;
}
namespace layers {
/**
* RemoteContentController implements PAPZChild and is used to access a
* GeckoContentController that lives in a different process.
*
* RemoteContentController lives on the compositor thread. All methods can
* be called off the compositor thread and will get dispatched to the right
* thread, with the exception of RequestContentRepaint and NotifyFlushComplete,
* which must be called on the repaint thread, which in this case is the compositor
* thread.
*/
class RemoteContentController : public GeckoContentController
, public PAPZParent
{
using GeckoContentController::TapType;
using GeckoContentController::APZStateChange;
public:
RemoteContentController();
virtual ~RemoteContentController();
virtual void RequestContentRepaint(const FrameMetrics& aFrameMetrics) override;
virtual void HandleTap(TapType aTapType,
const LayoutDevicePoint& aPoint,
Modifiers aModifiers,
const ScrollableLayerGuid& aGuid,
uint64_t aInputBlockId) override;
virtual void PostDelayedTask(already_AddRefed<Runnable> aTask, int aDelayMs) override;
virtual bool IsRepaintThread() override;
virtual void DispatchToRepaintThread(already_AddRefed<Runnable> aTask) override;
virtual bool GetTouchSensitiveRegion(CSSRect* aOutRegion) override;
virtual void NotifyAPZStateChange(const ScrollableLayerGuid& aGuid,
APZStateChange aChange,
int aArg) override;
virtual void UpdateOverscrollVelocity(float aX, float aY, bool aIsRootContent) override;
virtual void UpdateOverscrollOffset(float aX, float aY, bool aIsRootContent) override;
virtual void SetScrollingRootContent(bool aIsRootContent) override;
virtual void NotifyMozMouseScrollEvent(const FrameMetrics::ViewID& aScrollId,
const nsString& aEvent) override;
virtual void NotifyFlushComplete() override;
virtual bool RecvUpdateHitRegion(const nsRegion& aRegion) override;
virtual void ActorDestroy(ActorDestroyReason aWhy) override;
virtual void Destroy() override;
private:
MessageLoop* mCompositorThread;
bool mCanSend;
// Mutex protecting members below accessed from multiple threads.
mozilla::Mutex mMutex;
nsRegion mTouchSensitiveRegion;
};
} // namespace layers
} // namespace mozilla
#endif // mozilla_layers_RemoteContentController_h