Source code

Revision control

Copy as Markdown

Other Tools

/* -*- 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 */
include LayersSurfaces;
include LayersMessages;
include "mozilla/GfxMessageUtils.h";
include "mozilla/layers/WebRenderMessageUtils.h";
include WebRenderMessages;
include protocol PCompositorBridge;
include protocol PTexture;
using mozilla::layers::APZTestData from "mozilla/layers/APZTestData.h";
using mozilla::layers::FrameUniformityData from "mozilla/layers/FrameUniformityData.h";
using mozilla::layers::ScrollableLayerGuid from "mozilla/layers/ScrollableLayerGuid.h";
using struct mozilla::layers::TextureFactoryIdentifier from "mozilla/layers/CompositorTypes.h";
using struct mozilla::layers::TextureInfo from "mozilla/layers/CompositorTypes.h";
using mozilla::layers::CompositionPayload from "mozilla/layers/LayersTypes.h";
using mozilla::layers::CompositableHandle from "mozilla/layers/LayersTypes.h";
using mozilla::wr::BuiltDisplayListDescriptor from "mozilla/webrender/webrender_ffi.h";
using mozilla::wr::RenderReasons from "mozilla/webrender/webrender_ffi.h";
using mozilla::wr::IdNamespace from "mozilla/webrender/WebRenderTypes.h";
using mozilla::wr::MaybeIdNamespace from "mozilla/webrender/WebRenderTypes.h";
using mozilla::wr::ExternalImageKeyPair from "mozilla/webrender/WebRenderTypes.h";
[MoveOnly] using mozilla::layers::DisplayListData from "mozilla/layers/RenderRootTypes.h";
[MoveOnly] using mozilla::layers::MaybeTransactionData from "mozilla/layers/RenderRootTypes.h";
using mozilla::layers::FocusTarget from "mozilla/layers/FocusTarget.h";
using mozilla::layers::TransactionId from "mozilla/layers/LayersTypes.h";
using mozilla::VsyncId from "mozilla/VsyncDispatcher.h";
namespace mozilla {
namespace layers {
[ManualDealloc, ParentImpl=virtual]
sync protocol PWebRenderBridge
manager PCompositorBridge;
sync EnsureConnected()
returns (TextureFactoryIdentifier textureFactoryIdentifier, MaybeIdNamespace maybeIdNamespace, nsCString error);
async NewCompositable(CompositableHandle handle, TextureInfo info);
async ReleaseCompositable(CompositableHandle compositable);
async DeleteCompositorAnimations(uint64_t[] aIds);
async SetDisplayList(DisplayListData displayList,
OpDestroy[] toDestroy, uint64_t fwdTransactionId, TransactionId transactionId,
bool containsSVGGroup,
VsyncId vsyncId, TimeStamp vsyncStartTime,
TimeStamp refreshStartTime, TimeStamp txnStartTime, nsCString txnURL, TimeStamp fwdTime,
CompositionPayload[] payloads);
async EmptyTransaction(FocusTarget focusTarget,
MaybeTransactionData transationData,
OpDestroy[] toDestroy, uint64_t fwdTransactionId, TransactionId transactionId,
VsyncId vsyncId, TimeStamp vsyncStartTime,
TimeStamp refreshStartTime, TimeStamp txnStartTime,
nsCString txnURL, TimeStamp fwdTime,
CompositionPayload[] payloads);
async SetFocusTarget(FocusTarget focusTarget);
async UpdateResources(IdNamespace aIdNamespace, OpUpdateResource[] aResourceUpdates,
RefCountedShmem[] aSmallShmems, Shmem[] aLargeShmems);
async ParentCommands(IdNamespace aIdNamespace, WebRenderParentCommand[] commands);
sync GetSnapshot(PTexture texture) returns (bool aNeedsYFlip);
async ClearCachedResources();
async ClearAnimationResources();
async SetDefaultClearColor(uint32_t aColor);
// Invalidate rendered frame
async InvalidateRenderedFrame();
// Schedule a composite if one isn't already scheduled.
async ScheduleComposite(RenderReasons aReasons);
// Save the frame capture to disk
async Capture();
// Start capturing each frame to disk. See
// nsIDOMWindowUtils::wrStartCaptureSequence for documentation.
async StartCaptureSequence(nsCString aPath, uint32_t aFlags);
// Stop the captures started by StartCaptureSequence. See
// nsIDOMWindowUtils::wrStopCaptureSequence for documentation.
async StopCaptureSequence();
// Replacement for PCompositorBridge::SyncWithCompositor, but for WR. We need
// it on PWebRenderBridge because it associated with a particular top-level
// window, and PCompositorBridge doesn't allow doing that in a secure manner.
sync SyncWithCompositor();
// Tell the compositor to notify APZ that a target scroll frame has been
// confirmed for an input event.
async SetConfirmedTargetAPZC(uint64_t aInputBlockId, ScrollableLayerGuid[] aTargets);
// Testing APIs
// Enter test mode, set the sample time to sampleTime, and resample
// animations. sampleTime must not be null.
sync SetTestSampleTime(TimeStamp sampleTime);
// Leave test mode and resume normal compositing
sync LeaveTestMode();
// Returns the |OMTAValue| for the compositor animation with the given id.
sync GetAnimationValue(uint64_t aCompositorAnimationsId) returns (OMTAValue value);
// The next time the display list tree is composited, add this async scroll offset
// in CSS pixels for the given ViewID.
// Useful for testing rendering of async scrolling.
sync SetAsyncScrollOffset(ViewID scrollId, float x, float y);
// The next time the display list is composited, include this async zoom in
// for the given ViewID.
// Useful for testing rendering of async zooming.
sync SetAsyncZoom(ViewID scrollId, float zoom);
// Flush any pending APZ repaints to the main thread.
async FlushApzRepaints();
// Get a copy of the compositor-side APZ test data instance for this
// layers id.
sync GetAPZTestData() returns (APZTestData data);
// Child requests frame uniformity measurements
sync GetFrameUniformity() returns (FrameUniformityData data);
async Shutdown();
sync ShutdownSync();
async WrUpdated(IdNamespace aNewIdNamespace, TextureFactoryIdentifier textureFactoryIdentifier);
async WrReleasedImages(ExternalImageKeyPair[] pairs);
async __delete__();
} // layers
} // mozilla