/* 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/. */

using mozilla::gfx::IntRect from "mozilla/gfx/Rect.h";
using mozilla::gfx::IntSize from "mozilla/gfx/Point.h";
using mozilla::layers::CompositorScrollUpdate from "mozilla/layers/CompositorScrollUpdate.h";
using mozilla::void_t from "mozilla/ipc/IPCCore.h";

include "mozilla/GfxMessageUtils.h";
include "mozilla/layers/LayersMessageUtils.h";

namespace mozilla {
namespace layers {

/**
 * The PUiCompositorController protocol is used to pause and resume the
 * compositor from the UI thread. Primarily used on Android to coordinate registering and
 * releasing the surface with the compositor.
 */
[NeedsOtherPid, ParentProc=compositor, ChildProc=Parent]
sync protocol PUiCompositorController
{

parent:
  // Pause/resume the compositor. These are intended to be used on mobile, when
  // the compositor needs to pause/resume in lockstep with the application.
  sync Pause();
  sync Resume() returns (bool aOutResumed);
  sync ResumeAndResize(int32_t aX, int32_t aY, int32_t aWidth, int32_t aHeight)
    returns (bool aOutResumed);

  async InvalidateAndRender();
  async MaxToolbarHeight(int32_t aHeight);
  async FixedBottomOffset(int32_t aOffset);
  async DefaultClearColor(uint32_t aColor);
  async RequestScreenPixels(uint64_t aRequestId, IntRect aSourceRect, IntSize aDestSize);
  async EnableLayerUpdateNotifications(bool aEnable);
child:
  async ToolbarAnimatorMessageFromCompositor(int32_t aMessage);
  async NotifyCompositorScrollUpdate(CompositorScrollUpdate aUpdate);
  // Returns when the child side has finished using the HardwareBuffer,
  // indicating that the parent side can now release it.
  async ScreenPixels(uint64_t aRequestId, FileDescriptor? aHardwareBuffer, FileDescriptor? aAcquireFence)
    returns (void_t ok);
};

} // layers
} // mozilla