gecko-dev/gfx/webrender_bindings/WebRenderAPI.cpp

1110 строки
42 KiB
C++

/* -*- Mode: C++; tab-width: 8; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
/* vim: set ts=8 sts=2 et sw=2 tw=80: */
/* 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/. */
#include "WebRenderAPI.h"
#include "gfxPrefs.h"
#include "LayersLogging.h"
#include "mozilla/webrender/RendererOGL.h"
#include "mozilla/gfx/gfxVars.h"
#include "mozilla/layers/CompositorThread.h"
#include "mozilla/webrender/RenderCompositor.h"
#include "mozilla/widget/CompositorWidget.h"
#include "mozilla/layers/SynchronousTask.h"
#include "TextDrawTarget.h"
#define WRDL_LOG(...)
/*
#define WRDL_LOG(...) printf_stderr("WRDL(%p): " __VA_ARGS__)
#define WRDL_LOG(...) if (XRE_IsContentProcess()) { \
printf_stderr("WRDL(%p): " __VA_ARGS__); \
}
*/
namespace mozilla {
namespace wr {
using layers::Stringify;
MOZ_DEFINE_MALLOC_SIZE_OF(WebRenderMallocSizeOf)
class NewRenderer : public RendererEvent {
public:
NewRenderer(wr::DocumentHandle** aDocHandle,
layers::CompositorBridgeParent* aBridge, int32_t* aMaxTextureSize,
bool* aUseANGLE, bool* aUseDComp, bool* aUseTripleBuffering,
RefPtr<widget::CompositorWidget>&& aWidget,
layers::SynchronousTask* aTask, LayoutDeviceIntSize aSize,
layers::SyncHandle* aHandle)
: mDocHandle(aDocHandle),
mMaxTextureSize(aMaxTextureSize),
mUseANGLE(aUseANGLE),
mUseDComp(aUseDComp),
mUseTripleBuffering(aUseTripleBuffering),
mBridge(aBridge),
mCompositorWidget(std::move(aWidget)),
mTask(aTask),
mSize(aSize),
mSyncHandle(aHandle) {
MOZ_COUNT_CTOR(NewRenderer);
}
~NewRenderer() { MOZ_COUNT_DTOR(NewRenderer); }
virtual void Run(RenderThread& aRenderThread, WindowId aWindowId) override {
layers::AutoCompleteTask complete(mTask);
UniquePtr<RenderCompositor> compositor =
RenderCompositor::Create(std::move(mCompositorWidget));
if (!compositor) {
// RenderCompositor::Create puts a message into gfxCriticalNote if it is
// nullptr
return;
}
*mUseANGLE = compositor->UseANGLE();
*mUseDComp = compositor->UseDComp();
*mUseTripleBuffering = compositor->UseTripleBuffering();
bool supportLowPriorityTransactions = true; // TODO only for main windows.
wr::Renderer* wrRenderer = nullptr;
if (!wr_window_new(
aWindowId, mSize.width, mSize.height,
supportLowPriorityTransactions, gfxPrefs::WebRenderPictureCaching(),
compositor->gl(),
aRenderThread.ProgramCache() ? aRenderThread.ProgramCache()->Raw()
: nullptr,
aRenderThread.Shaders() ? aRenderThread.Shaders()->RawShaders()
: nullptr,
aRenderThread.ThreadPool().Raw(), &WebRenderMallocSizeOf,
mDocHandle, &wrRenderer, mMaxTextureSize)) {
// wr_window_new puts a message into gfxCriticalNote if it returns false
return;
}
MOZ_ASSERT(wrRenderer);
RefPtr<RenderThread> thread = &aRenderThread;
auto renderer =
MakeUnique<RendererOGL>(std::move(thread), std::move(compositor),
aWindowId, wrRenderer, mBridge);
if (wrRenderer && renderer) {
wr::WrExternalImageHandler handler = renderer->GetExternalImageHandler();
wr_renderer_set_external_image_handler(wrRenderer, &handler);
}
if (renderer) {
layers::SyncObjectHost* syncObj = renderer->GetSyncObject();
if (syncObj) {
*mSyncHandle = syncObj->GetSyncHandle();
}
}
aRenderThread.AddRenderer(aWindowId, std::move(renderer));
}
private:
wr::DocumentHandle** mDocHandle;
int32_t* mMaxTextureSize;
bool* mUseANGLE;
bool* mUseDComp;
bool* mUseTripleBuffering;
layers::CompositorBridgeParent* mBridge;
RefPtr<widget::CompositorWidget> mCompositorWidget;
layers::SynchronousTask* mTask;
LayoutDeviceIntSize mSize;
layers::SyncHandle* mSyncHandle;
};
class RemoveRenderer : public RendererEvent {
public:
explicit RemoveRenderer(layers::SynchronousTask* aTask) : mTask(aTask) {
MOZ_COUNT_CTOR(RemoveRenderer);
}
~RemoveRenderer() { MOZ_COUNT_DTOR(RemoveRenderer); }
virtual void Run(RenderThread& aRenderThread, WindowId aWindowId) override {
aRenderThread.RemoveRenderer(aWindowId);
layers::AutoCompleteTask complete(mTask);
}
private:
layers::SynchronousTask* mTask;
};
TransactionBuilder::TransactionBuilder(bool aUseSceneBuilderThread)
: mUseSceneBuilderThread(aUseSceneBuilderThread) {
mTxn = wr_transaction_new(mUseSceneBuilderThread);
}
TransactionBuilder::~TransactionBuilder() { wr_transaction_delete(mTxn); }
void TransactionBuilder::SetLowPriority(bool aIsLowPriority) {
wr_transaction_set_low_priority(mTxn, aIsLowPriority);
}
void TransactionBuilder::UpdateEpoch(PipelineId aPipelineId, Epoch aEpoch) {
wr_transaction_update_epoch(mTxn, aPipelineId, aEpoch);
}
void TransactionBuilder::SetRootPipeline(PipelineId aPipelineId) {
wr_transaction_set_root_pipeline(mTxn, aPipelineId);
}
void TransactionBuilder::RemovePipeline(PipelineId aPipelineId) {
wr_transaction_remove_pipeline(mTxn, aPipelineId);
}
void TransactionBuilder::SetDisplayList(
gfx::Color aBgColor, Epoch aEpoch, mozilla::LayerSize aViewportSize,
wr::WrPipelineId pipeline_id, const wr::LayoutSize& content_size,
wr::BuiltDisplayListDescriptor dl_descriptor, wr::Vec<uint8_t>& dl_data) {
wr_transaction_set_display_list(mTxn, aEpoch, ToColorF(aBgColor),
aViewportSize.width, aViewportSize.height,
pipeline_id, content_size, dl_descriptor,
&dl_data.inner);
}
void TransactionBuilder::ClearDisplayList(Epoch aEpoch,
wr::WrPipelineId aPipelineId) {
wr_transaction_clear_display_list(mTxn, aEpoch, aPipelineId);
}
void TransactionBuilder::GenerateFrame() {
wr_transaction_generate_frame(mTxn);
}
void TransactionBuilder::InvalidateRenderedFrame() {
wr_transaction_invalidate_rendered_frame(mTxn);
}
void TransactionBuilder::UpdateDynamicProperties(
const nsTArray<wr::WrOpacityProperty>& aOpacityArray,
const nsTArray<wr::WrTransformProperty>& aTransformArray) {
wr_transaction_update_dynamic_properties(
mTxn, aOpacityArray.IsEmpty() ? nullptr : aOpacityArray.Elements(),
aOpacityArray.Length(),
aTransformArray.IsEmpty() ? nullptr : aTransformArray.Elements(),
aTransformArray.Length());
}
bool TransactionBuilder::IsEmpty() const {
return wr_transaction_is_empty(mTxn);
}
bool TransactionBuilder::IsResourceUpdatesEmpty() const {
return wr_transaction_resource_updates_is_empty(mTxn);
}
void TransactionBuilder::SetWindowParameters(
const LayoutDeviceIntSize& aWindowSize,
const LayoutDeviceIntRect& aDocumentRect) {
wr::DeviceIntSize wrWindowSize;
wrWindowSize.width = aWindowSize.width;
wrWindowSize.height = aWindowSize.height;
wr::DeviceIntRect wrDocRect;
wrDocRect.origin.x = aDocumentRect.x;
wrDocRect.origin.y = aDocumentRect.y;
wrDocRect.size.width = aDocumentRect.width;
wrDocRect.size.height = aDocumentRect.height;
wr_transaction_set_window_parameters(mTxn, &wrWindowSize, &wrDocRect);
}
void TransactionBuilder::UpdateScrollPosition(
const wr::WrPipelineId& aPipelineId,
const layers::ScrollableLayerGuid::ViewID& aScrollId,
const wr::LayoutPoint& aScrollPosition) {
wr_transaction_scroll_layer(mTxn, aPipelineId, aScrollId, aScrollPosition);
}
TransactionWrapper::TransactionWrapper(Transaction* aTxn) : mTxn(aTxn) {}
void TransactionWrapper::AppendTransformProperties(
const nsTArray<wr::WrTransformProperty>& aTransformArray) {
wr_transaction_append_transform_properties(
mTxn, aTransformArray.IsEmpty() ? nullptr : aTransformArray.Elements(),
aTransformArray.Length());
}
void TransactionWrapper::UpdateScrollPosition(
const wr::WrPipelineId& aPipelineId,
const layers::ScrollableLayerGuid::ViewID& aScrollId,
const wr::LayoutPoint& aScrollPosition) {
wr_transaction_scroll_layer(mTxn, aPipelineId, aScrollId, aScrollPosition);
}
void TransactionWrapper::UpdatePinchZoom(float aZoom) {
wr_transaction_pinch_zoom(mTxn, aZoom);
}
/*static*/ already_AddRefed<WebRenderAPI> WebRenderAPI::Create(
layers::CompositorBridgeParent* aBridge,
RefPtr<widget::CompositorWidget>&& aWidget, const wr::WrWindowId& aWindowId,
LayoutDeviceIntSize aSize) {
MOZ_ASSERT(aBridge);
MOZ_ASSERT(aWidget);
static_assert(
sizeof(size_t) == sizeof(uintptr_t),
"The FFI bindings assume size_t is the same size as uintptr_t!");
wr::DocumentHandle* docHandle = nullptr;
int32_t maxTextureSize = 0;
bool useANGLE = false;
bool useDComp = false;
bool useTripleBuffering = false;
layers::SyncHandle syncHandle = 0;
// Dispatch a synchronous task because the DocumentHandle object needs to be
// created on the render thread. If need be we could delay waiting on this
// task until the next time we need to access the DocumentHandle object.
layers::SynchronousTask task("Create Renderer");
auto event = MakeUnique<NewRenderer>(
&docHandle, aBridge, &maxTextureSize, &useANGLE, &useDComp,
&useTripleBuffering, std::move(aWidget), &task, aSize, &syncHandle);
RenderThread::Get()->RunEvent(aWindowId, std::move(event));
task.Wait();
if (!docHandle) {
return nullptr;
}
return RefPtr<WebRenderAPI>(
new WebRenderAPI(docHandle, aWindowId, maxTextureSize, useANGLE,
useDComp, useTripleBuffering, syncHandle))
.forget();
}
already_AddRefed<WebRenderAPI> WebRenderAPI::Clone() {
wr::DocumentHandle* docHandle = nullptr;
wr_api_clone(mDocHandle, &docHandle);
RefPtr<WebRenderAPI> renderApi =
new WebRenderAPI(docHandle, mId, mMaxTextureSize, mUseANGLE, mUseDComp,
mUseTripleBuffering, mSyncHandle);
renderApi->mRootApi = this; // Hold root api
renderApi->mRootDocumentApi = this;
return renderApi.forget();
}
already_AddRefed<WebRenderAPI> WebRenderAPI::CreateDocument(
LayoutDeviceIntSize aSize, int8_t aLayerIndex) {
wr::DeviceIntSize wrSize;
wrSize.width = aSize.width;
wrSize.height = aSize.height;
wr::DocumentHandle* newDoc;
wr_api_create_document(mDocHandle, &newDoc, wrSize, aLayerIndex);
RefPtr<WebRenderAPI> api(new WebRenderAPI(newDoc, mId, mMaxTextureSize,
mUseANGLE, mUseDComp,
mUseTripleBuffering, mSyncHandle));
api->mRootApi = this;
return api.forget();
}
wr::WrIdNamespace WebRenderAPI::GetNamespace() {
return wr_api_get_namespace(mDocHandle);
}
WebRenderAPI::~WebRenderAPI() {
if (!mRootDocumentApi) {
wr_api_delete_document(mDocHandle);
}
if (!mRootApi) {
RenderThread::Get()->SetDestroyed(GetId());
layers::SynchronousTask task("Destroy WebRenderAPI");
auto event = MakeUnique<RemoveRenderer>(&task);
RunOnRenderThread(std::move(event));
task.Wait();
wr_api_shut_down(mDocHandle);
}
wr_api_delete(mDocHandle);
}
void WebRenderAPI::UpdateDebugFlags(uint32_t aFlags) {
if (mDebugFlags.mBits != aFlags) {
mDebugFlags.mBits = aFlags;
wr_api_set_debug_flags(mDocHandle, mDebugFlags);
}
}
void WebRenderAPI::SendTransaction(TransactionBuilder& aTxn) {
UpdateDebugFlags(gfx::gfxVars::WebRenderDebugFlags());
wr_api_send_transaction(mDocHandle, aTxn.Raw(), aTxn.UseSceneBuilderThread());
}
bool WebRenderAPI::HitTest(const wr::WorldPoint& aPoint,
wr::WrPipelineId& aOutPipelineId,
layers::ScrollableLayerGuid::ViewID& aOutScrollId,
gfx::CompositorHitTestInfo& aOutHitInfo) {
static_assert(DoesCompositorHitTestInfoFitIntoBits<16>(),
"CompositorHitTestFlags MAX value has to be less than number "
"of bits in uint16_t");
uint16_t serialized = static_cast<uint16_t>(aOutHitInfo.serialize());
const bool result = wr_api_hit_test(mDocHandle, aPoint, &aOutPipelineId,
&aOutScrollId, &serialized);
if (result) {
aOutHitInfo.deserialize(serialized);
}
return result;
}
void WebRenderAPI::Readback(const TimeStamp& aStartTime, gfx::IntSize size,
const Range<uint8_t>& buffer) {
class Readback : public RendererEvent {
public:
explicit Readback(layers::SynchronousTask* aTask, TimeStamp aStartTime,
gfx::IntSize aSize, const Range<uint8_t>& aBuffer)
: mTask(aTask), mStartTime(aStartTime), mSize(aSize), mBuffer(aBuffer) {
MOZ_COUNT_CTOR(Readback);
}
~Readback() { MOZ_COUNT_DTOR(Readback); }
virtual void Run(RenderThread& aRenderThread, WindowId aWindowId) override {
aRenderThread.UpdateAndRender(aWindowId, VsyncId(), mStartTime,
/* aRender */ true, Some(mSize),
Some(mBuffer), false);
layers::AutoCompleteTask complete(mTask);
}
layers::SynchronousTask* mTask;
TimeStamp mStartTime;
gfx::IntSize mSize;
const Range<uint8_t>& mBuffer;
};
// Disable debug flags during readback. See bug 1436020.
UpdateDebugFlags(0);
layers::SynchronousTask task("Readback");
auto event = MakeUnique<Readback>(&task, aStartTime, size, buffer);
// This event will be passed from wr_backend thread to renderer thread. That
// implies that all frame data have been processed when the renderer runs this
// read-back event. Then, we could make sure this read-back event gets the
// latest result.
RunOnRenderThread(std::move(event));
task.Wait();
UpdateDebugFlags(gfx::gfxVars::WebRenderDebugFlags());
}
void WebRenderAPI::ClearAllCaches() { wr_api_clear_all_caches(mDocHandle); }
void WebRenderAPI::Pause() {
class PauseEvent : public RendererEvent {
public:
explicit PauseEvent(layers::SynchronousTask* aTask) : mTask(aTask) {
MOZ_COUNT_CTOR(PauseEvent);
}
~PauseEvent() { MOZ_COUNT_DTOR(PauseEvent); }
virtual void Run(RenderThread& aRenderThread, WindowId aWindowId) override {
aRenderThread.Pause(aWindowId);
layers::AutoCompleteTask complete(mTask);
}
layers::SynchronousTask* mTask;
};
layers::SynchronousTask task("Pause");
auto event = MakeUnique<PauseEvent>(&task);
// This event will be passed from wr_backend thread to renderer thread. That
// implies that all frame data have been processed when the renderer runs this
// event.
RunOnRenderThread(std::move(event));
task.Wait();
}
bool WebRenderAPI::Resume() {
class ResumeEvent : public RendererEvent {
public:
explicit ResumeEvent(layers::SynchronousTask* aTask, bool* aResult)
: mTask(aTask), mResult(aResult) {
MOZ_COUNT_CTOR(ResumeEvent);
}
~ResumeEvent() { MOZ_COUNT_DTOR(ResumeEvent); }
virtual void Run(RenderThread& aRenderThread, WindowId aWindowId) override {
*mResult = aRenderThread.Resume(aWindowId);
layers::AutoCompleteTask complete(mTask);
}
layers::SynchronousTask* mTask;
bool* mResult;
};
bool result = false;
layers::SynchronousTask task("Resume");
auto event = MakeUnique<ResumeEvent>(&task, &result);
// This event will be passed from wr_backend thread to renderer thread. That
// implies that all frame data have been processed when the renderer runs this
// event.
RunOnRenderThread(std::move(event));
task.Wait();
return result;
}
void WebRenderAPI::NotifyMemoryPressure() {
wr_api_notify_memory_pressure(mDocHandle);
}
void WebRenderAPI::AccumulateMemoryReport(MemoryReport* aReport) {
wr_api_accumulate_memory_report(mDocHandle, aReport);
}
void WebRenderAPI::WakeSceneBuilder() { wr_api_wake_scene_builder(mDocHandle); }
void WebRenderAPI::FlushSceneBuilder() {
wr_api_flush_scene_builder(mDocHandle);
}
void WebRenderAPI::WaitFlushed() {
class WaitFlushedEvent : public RendererEvent {
public:
explicit WaitFlushedEvent(layers::SynchronousTask* aTask) : mTask(aTask) {
MOZ_COUNT_CTOR(WaitFlushedEvent);
}
~WaitFlushedEvent() { MOZ_COUNT_DTOR(WaitFlushedEvent); }
virtual void Run(RenderThread& aRenderThread, WindowId aWindowId) override {
layers::AutoCompleteTask complete(mTask);
}
layers::SynchronousTask* mTask;
};
layers::SynchronousTask task("WaitFlushed");
auto event = MakeUnique<WaitFlushedEvent>(&task);
// This event will be passed from wr_backend thread to renderer thread. That
// implies that all frame data have been processed when the renderer runs this
// event.
RunOnRenderThread(std::move(event));
task.Wait();
}
void WebRenderAPI::Capture() {
uint8_t bits = 3; // TODO: get from JavaScript
const char* path = "wr-capture"; // TODO: get from JavaScript
wr_api_capture(mDocHandle, path, bits);
}
void TransactionBuilder::Clear() { wr_resource_updates_clear(mTxn); }
void TransactionBuilder::Notify(wr::Checkpoint aWhen,
UniquePtr<NotificationHandler> aEvent) {
wr_transaction_notify(mTxn, aWhen,
reinterpret_cast<uintptr_t>(aEvent.release()));
}
void TransactionBuilder::AddImage(ImageKey key,
const ImageDescriptor& aDescriptor,
wr::Vec<uint8_t>& aBytes) {
wr_resource_updates_add_image(mTxn, key, &aDescriptor, &aBytes.inner);
}
void TransactionBuilder::AddBlobImage(BlobImageKey key,
const ImageDescriptor& aDescriptor,
wr::Vec<uint8_t>& aBytes) {
wr_resource_updates_add_blob_image(mTxn, key, &aDescriptor, &aBytes.inner);
}
void TransactionBuilder::AddExternalImage(
ImageKey key, const ImageDescriptor& aDescriptor, ExternalImageId aExtID,
wr::WrExternalImageBufferType aBufferType, uint8_t aChannelIndex) {
wr_resource_updates_add_external_image(mTxn, key, &aDescriptor, aExtID,
aBufferType, aChannelIndex);
}
void TransactionBuilder::AddExternalImageBuffer(
ImageKey aKey, const ImageDescriptor& aDescriptor,
ExternalImageId aHandle) {
auto channelIndex = 0;
AddExternalImage(aKey, aDescriptor, aHandle,
wr::WrExternalImageBufferType::ExternalBuffer, channelIndex);
}
void TransactionBuilder::UpdateImageBuffer(ImageKey aKey,
const ImageDescriptor& aDescriptor,
wr::Vec<uint8_t>& aBytes) {
wr_resource_updates_update_image(mTxn, aKey, &aDescriptor, &aBytes.inner);
}
void TransactionBuilder::UpdateBlobImage(BlobImageKey aKey,
const ImageDescriptor& aDescriptor,
wr::Vec<uint8_t>& aBytes,
const wr::LayoutIntRect& aDirtyRect) {
wr_resource_updates_update_blob_image(mTxn, aKey, &aDescriptor, &aBytes.inner,
aDirtyRect);
}
void TransactionBuilder::UpdateExternalImage(
ImageKey aKey, const ImageDescriptor& aDescriptor, ExternalImageId aExtID,
wr::WrExternalImageBufferType aBufferType, uint8_t aChannelIndex) {
wr_resource_updates_update_external_image(mTxn, aKey, &aDescriptor, aExtID,
aBufferType, aChannelIndex);
}
void TransactionBuilder::UpdateExternalImageWithDirtyRect(
ImageKey aKey, const ImageDescriptor& aDescriptor, ExternalImageId aExtID,
wr::WrExternalImageBufferType aBufferType,
const wr::DeviceIntRect& aDirtyRect, uint8_t aChannelIndex) {
wr_resource_updates_update_external_image_with_dirty_rect(
mTxn, aKey, &aDescriptor, aExtID, aBufferType, aChannelIndex, aDirtyRect);
}
void TransactionBuilder::SetImageVisibleArea(BlobImageKey aKey,
const wr::DeviceIntRect& aArea) {
wr_resource_updates_set_blob_image_visible_area(mTxn, aKey, &aArea);
}
void TransactionBuilder::DeleteImage(ImageKey aKey) {
wr_resource_updates_delete_image(mTxn, aKey);
}
void TransactionBuilder::DeleteBlobImage(BlobImageKey aKey) {
wr_resource_updates_delete_blob_image(mTxn, aKey);
}
void TransactionBuilder::AddRawFont(wr::FontKey aKey, wr::Vec<uint8_t>& aBytes,
uint32_t aIndex) {
wr_resource_updates_add_raw_font(mTxn, aKey, &aBytes.inner, aIndex);
}
void TransactionBuilder::AddFontDescriptor(wr::FontKey aKey,
wr::Vec<uint8_t>& aBytes,
uint32_t aIndex) {
wr_resource_updates_add_font_descriptor(mTxn, aKey, &aBytes.inner, aIndex);
}
void TransactionBuilder::DeleteFont(wr::FontKey aKey) {
wr_resource_updates_delete_font(mTxn, aKey);
}
void TransactionBuilder::AddFontInstance(
wr::FontInstanceKey aKey, wr::FontKey aFontKey, float aGlyphSize,
const wr::FontInstanceOptions* aOptions,
const wr::FontInstancePlatformOptions* aPlatformOptions,
wr::Vec<uint8_t>& aVariations) {
wr_resource_updates_add_font_instance(mTxn, aKey, aFontKey, aGlyphSize,
aOptions, aPlatformOptions,
&aVariations.inner);
}
void TransactionBuilder::DeleteFontInstance(wr::FontInstanceKey aKey) {
wr_resource_updates_delete_font_instance(mTxn, aKey);
}
class FrameStartTime : public RendererEvent {
public:
explicit FrameStartTime(const TimeStamp& aTime) : mTime(aTime) {
MOZ_COUNT_CTOR(FrameStartTime);
}
~FrameStartTime() { MOZ_COUNT_DTOR(FrameStartTime); }
virtual void Run(RenderThread& aRenderThread, WindowId aWindowId) override {
auto renderer = aRenderThread.GetRenderer(aWindowId);
if (renderer) {
renderer->SetFrameStartTime(mTime);
}
}
private:
TimeStamp mTime;
};
void WebRenderAPI::SetFrameStartTime(const TimeStamp& aTime) {
auto event = MakeUnique<FrameStartTime>(aTime);
RunOnRenderThread(std::move(event));
}
void WebRenderAPI::RunOnRenderThread(UniquePtr<RendererEvent> aEvent) {
auto event = reinterpret_cast<uintptr_t>(aEvent.release());
wr_api_send_external_event(mDocHandle, event);
}
DisplayListBuilder::DisplayListBuilder(PipelineId aId,
const wr::LayoutSize& aContentSize,
size_t aCapacity)
: mActiveFixedPosTracker(nullptr) {
MOZ_COUNT_CTOR(DisplayListBuilder);
mWrState = wr_state_new(aId, aContentSize, aCapacity);
}
DisplayListBuilder::~DisplayListBuilder() {
MOZ_COUNT_DTOR(DisplayListBuilder);
wr_state_delete(mWrState);
}
void DisplayListBuilder::Save() { wr_dp_save(mWrState); }
void DisplayListBuilder::Restore() { wr_dp_restore(mWrState); }
void DisplayListBuilder::ClearSave() { wr_dp_clear_save(mWrState); }
usize DisplayListBuilder::Dump(usize aIndent, const Maybe<usize>& aStart,
const Maybe<usize>& aEnd) {
return wr_dump_display_list(mWrState, aIndent, aStart.ptrOr(nullptr),
aEnd.ptrOr(nullptr));
}
void DisplayListBuilder::Finalize(wr::LayoutSize& aOutContentSize,
BuiltDisplayList& aOutDisplayList) {
wr_api_finalize_builder(mWrState, &aOutContentSize, &aOutDisplayList.dl_desc,
&aOutDisplayList.dl.inner);
}
Maybe<wr::WrClipId> DisplayListBuilder::PushStackingContext(
const wr::LayoutRect& aBounds, const wr::WrClipId* aClipNodeId,
const WrAnimationProperty* aAnimation, const float* aOpacity,
const gfx::Matrix4x4* aTransform, wr::TransformStyle aTransformStyle,
const gfx::Matrix4x4* aPerspective, const wr::MixBlendMode& aMixBlendMode,
const nsTArray<wr::WrFilterOp>& aFilters, bool aIsBackfaceVisible,
const wr::RasterSpace& aRasterSpace) {
MOZ_ASSERT(mClipChainLeaf.isNothing(),
"Non-empty leaf from clip chain given, but not used with SC!");
wr::LayoutTransform matrix;
if (aTransform) {
matrix = ToLayoutTransform(*aTransform);
}
const wr::LayoutTransform* maybeTransform = aTransform ? &matrix : nullptr;
wr::LayoutTransform perspective;
if (aPerspective) {
perspective = ToLayoutTransform(*aPerspective);
}
const wr::LayoutTransform* maybePerspective =
aPerspective ? &perspective : nullptr;
WRDL_LOG("PushStackingContext b=%s t=%s\n", mWrState,
Stringify(aBounds).c_str(),
aTransform ? Stringify(*aTransform).c_str() : "none");
bool outIsReferenceFrame = false;
uintptr_t outReferenceFrameId = 0;
wr_dp_push_stacking_context(
mWrState, aBounds, aClipNodeId, aAnimation, aOpacity, maybeTransform,
aTransformStyle, maybePerspective, aMixBlendMode, aFilters.Elements(),
aFilters.Length(), aIsBackfaceVisible, aRasterSpace, &outIsReferenceFrame,
&outReferenceFrameId);
return outIsReferenceFrame ? Some(wr::WrClipId{outReferenceFrameId})
: Nothing();
}
void DisplayListBuilder::PopStackingContext(bool aIsReferenceFrame) {
WRDL_LOG("PopStackingContext\n", mWrState);
wr_dp_pop_stacking_context(mWrState, aIsReferenceFrame);
}
wr::WrClipChainId DisplayListBuilder::DefineClipChain(
const Maybe<wr::WrClipChainId>& aParent,
const nsTArray<wr::WrClipId>& aClips) {
uint64_t clipchainId =
wr_dp_define_clipchain(mWrState, aParent ? &(aParent->id) : nullptr,
aClips.Elements(), aClips.Length());
WRDL_LOG("DefineClipChain id=%" PRIu64 " p=%s clips=%zu\n", mWrState,
clipchainId, aParent ? Stringify(aParent->id).c_str() : "(nil)",
aClips.Length());
return wr::WrClipChainId{clipchainId};
}
wr::WrClipId DisplayListBuilder::DefineClip(
const Maybe<wr::WrClipId>& aParentId, const wr::LayoutRect& aClipRect,
const nsTArray<wr::ComplexClipRegion>* aComplex,
const wr::WrImageMask* aMask) {
size_t clip_id =
wr_dp_define_clip(mWrState, aParentId.ptrOr(nullptr), aClipRect,
aComplex ? aComplex->Elements() : nullptr,
aComplex ? aComplex->Length() : 0, aMask);
WRDL_LOG("DefineClip id=%zu p=%s r=%s m=%p b=%s complex=%zu\n", mWrState,
clip_id, aParentId ? Stringify(aParentId->id).c_str() : "(nil)",
Stringify(aClipRect).c_str(), aMask,
aMask ? Stringify(aMask->rect).c_str() : "none",
aComplex ? aComplex->Length() : 0);
return wr::WrClipId{clip_id};
}
void DisplayListBuilder::PushClip(const wr::WrClipId& aClipId) {
WRDL_LOG("PushClip id=%zu\n", mWrState, aClipId.id);
wr_dp_push_clip(mWrState, aClipId);
}
void DisplayListBuilder::PopClip() {
WRDL_LOG("PopClip\n", mWrState);
wr_dp_pop_clip(mWrState);
}
wr::WrClipId DisplayListBuilder::DefineStickyFrame(
const wr::LayoutRect& aContentRect, const float* aTopMargin,
const float* aRightMargin, const float* aBottomMargin,
const float* aLeftMargin, const StickyOffsetBounds& aVerticalBounds,
const StickyOffsetBounds& aHorizontalBounds,
const wr::LayoutVector2D& aAppliedOffset) {
size_t id = wr_dp_define_sticky_frame(
mWrState, aContentRect, aTopMargin, aRightMargin, aBottomMargin,
aLeftMargin, aVerticalBounds, aHorizontalBounds, aAppliedOffset);
WRDL_LOG("DefineSticky id=%zu c=%s t=%s r=%s b=%s l=%s v=%s h=%s a=%s\n",
mWrState, id, Stringify(aContentRect).c_str(),
aTopMargin ? Stringify(*aTopMargin).c_str() : "none",
aRightMargin ? Stringify(*aRightMargin).c_str() : "none",
aBottomMargin ? Stringify(*aBottomMargin).c_str() : "none",
aLeftMargin ? Stringify(*aLeftMargin).c_str() : "none",
Stringify(aVerticalBounds).c_str(),
Stringify(aHorizontalBounds).c_str(),
Stringify(aAppliedOffset).c_str());
return wr::WrClipId{id};
}
Maybe<wr::WrClipId> DisplayListBuilder::GetScrollIdForDefinedScrollLayer(
layers::ScrollableLayerGuid::ViewID aViewId) const {
if (aViewId == layers::ScrollableLayerGuid::NULL_SCROLL_ID) {
return Some(wr::RootScrollNode());
}
auto it = mScrollIds.find(aViewId);
if (it == mScrollIds.end()) {
return Nothing();
}
return Some(it->second);
}
wr::WrClipId DisplayListBuilder::DefineScrollLayer(
const layers::ScrollableLayerGuid::ViewID& aViewId,
const Maybe<wr::WrClipId>& aParentId, const wr::LayoutRect& aContentRect,
const wr::LayoutRect& aClipRect) {
auto it = mScrollIds.find(aViewId);
if (it != mScrollIds.end()) {
return it->second;
}
// We haven't defined aViewId before, so let's define it now.
size_t numericScrollId = wr_dp_define_scroll_layer(
mWrState, aViewId, aParentId.ptrOr(nullptr), aContentRect, aClipRect);
WRDL_LOG("DefineScrollLayer id=%" PRIu64 "/%zu p=%s co=%s cl=%s\n", mWrState,
aViewId, numericScrollId,
aParentId ? Stringify(aParentId->id).c_str() : "(nil)",
Stringify(aContentRect).c_str(), Stringify(aClipRect).c_str());
auto clipId = wr::WrClipId{numericScrollId};
mScrollIds[aViewId] = clipId;
return clipId;
}
void DisplayListBuilder::PushClipAndScrollInfo(
const wr::WrClipId* aScrollId, const wr::WrClipChainId* aClipChainId,
const Maybe<wr::LayoutRect>& aClipChainLeaf) {
if (aScrollId) {
WRDL_LOG("PushClipAndScroll s=%zu c=%s\n", mWrState, aScrollId->id,
aClipChainId ? Stringify(aClipChainId->id).c_str() : "none");
wr_dp_push_clip_and_scroll_info(
mWrState, *aScrollId, aClipChainId ? &(aClipChainId->id) : nullptr);
}
mClipChainLeaf = aClipChainLeaf;
}
void DisplayListBuilder::PopClipAndScrollInfo(const wr::WrClipId* aScrollId) {
if (aScrollId) {
WRDL_LOG("PopClipAndScroll\n", mWrState);
wr_dp_pop_clip_and_scroll_info(mWrState);
}
mClipChainLeaf.reset();
}
void DisplayListBuilder::PushRect(const wr::LayoutRect& aBounds,
const wr::LayoutRect& aClip,
bool aIsBackfaceVisible,
const wr::ColorF& aColor) {
wr::LayoutRect clip = MergeClipLeaf(aClip);
WRDL_LOG("PushRect b=%s cl=%s c=%s\n", mWrState, Stringify(aBounds).c_str(),
Stringify(clip).c_str(), Stringify(aColor).c_str());
wr_dp_push_rect(mWrState, aBounds, clip, aIsBackfaceVisible, aColor);
}
void DisplayListBuilder::PushClearRect(const wr::LayoutRect& aBounds) {
wr::LayoutRect clip = MergeClipLeaf(aBounds);
WRDL_LOG("PushClearRect b=%s c=%s\n", mWrState, Stringify(aBounds).c_str(),
Stringify(clip).c_str());
wr_dp_push_clear_rect(mWrState, aBounds, clip);
}
void DisplayListBuilder::PushLinearGradient(
const wr::LayoutRect& aBounds, const wr::LayoutRect& aClip,
bool aIsBackfaceVisible, const wr::LayoutPoint& aStartPoint,
const wr::LayoutPoint& aEndPoint, const nsTArray<wr::GradientStop>& aStops,
wr::ExtendMode aExtendMode, const wr::LayoutSize aTileSize,
const wr::LayoutSize aTileSpacing) {
wr_dp_push_linear_gradient(mWrState, aBounds, MergeClipLeaf(aClip),
aIsBackfaceVisible, aStartPoint, aEndPoint,
aStops.Elements(), aStops.Length(), aExtendMode,
aTileSize, aTileSpacing);
}
void DisplayListBuilder::PushRadialGradient(
const wr::LayoutRect& aBounds, const wr::LayoutRect& aClip,
bool aIsBackfaceVisible, const wr::LayoutPoint& aCenter,
const wr::LayoutSize& aRadius, const nsTArray<wr::GradientStop>& aStops,
wr::ExtendMode aExtendMode, const wr::LayoutSize aTileSize,
const wr::LayoutSize aTileSpacing) {
wr_dp_push_radial_gradient(mWrState, aBounds, MergeClipLeaf(aClip),
aIsBackfaceVisible, aCenter, aRadius,
aStops.Elements(), aStops.Length(), aExtendMode,
aTileSize, aTileSpacing);
}
void DisplayListBuilder::PushImage(
const wr::LayoutRect& aBounds, const wr::LayoutRect& aClip,
bool aIsBackfaceVisible, wr::ImageRendering aFilter, wr::ImageKey aImage,
bool aPremultipliedAlpha, const wr::ColorF& aColor) {
wr::LayoutSize size;
size.width = aBounds.size.width;
size.height = aBounds.size.height;
PushImage(aBounds, aClip, aIsBackfaceVisible, size, size, aFilter, aImage,
aPremultipliedAlpha, aColor);
}
void DisplayListBuilder::PushImage(
const wr::LayoutRect& aBounds, const wr::LayoutRect& aClip,
bool aIsBackfaceVisible, const wr::LayoutSize& aStretchSize,
const wr::LayoutSize& aTileSpacing, wr::ImageRendering aFilter,
wr::ImageKey aImage, bool aPremultipliedAlpha, const wr::ColorF& aColor) {
wr::LayoutRect clip = MergeClipLeaf(aClip);
WRDL_LOG("PushImage b=%s cl=%s s=%s t=%s\n", mWrState,
Stringify(aBounds).c_str(), Stringify(clip).c_str(),
Stringify(aStretchSize).c_str(), Stringify(aTileSpacing).c_str());
wr_dp_push_image(mWrState, aBounds, clip, aIsBackfaceVisible, aStretchSize,
aTileSpacing, aFilter, aImage, aPremultipliedAlpha, aColor);
}
void DisplayListBuilder::PushYCbCrPlanarImage(
const wr::LayoutRect& aBounds, const wr::LayoutRect& aClip,
bool aIsBackfaceVisible, wr::ImageKey aImageChannel0,
wr::ImageKey aImageChannel1, wr::ImageKey aImageChannel2,
wr::WrColorDepth aColorDepth, wr::WrYuvColorSpace aColorSpace,
wr::ImageRendering aRendering) {
wr_dp_push_yuv_planar_image(mWrState, aBounds, MergeClipLeaf(aClip),
aIsBackfaceVisible, aImageChannel0,
aImageChannel1, aImageChannel2, aColorDepth,
aColorSpace, aRendering);
}
void DisplayListBuilder::PushNV12Image(
const wr::LayoutRect& aBounds, const wr::LayoutRect& aClip,
bool aIsBackfaceVisible, wr::ImageKey aImageChannel0,
wr::ImageKey aImageChannel1, wr::WrColorDepth aColorDepth,
wr::WrYuvColorSpace aColorSpace, wr::ImageRendering aRendering) {
wr_dp_push_yuv_NV12_image(mWrState, aBounds, MergeClipLeaf(aClip),
aIsBackfaceVisible, aImageChannel0, aImageChannel1,
aColorDepth, aColorSpace, aRendering);
}
void DisplayListBuilder::PushYCbCrInterleavedImage(
const wr::LayoutRect& aBounds, const wr::LayoutRect& aClip,
bool aIsBackfaceVisible, wr::ImageKey aImageChannel0,
wr::WrColorDepth aColorDepth, wr::WrYuvColorSpace aColorSpace,
wr::ImageRendering aRendering) {
wr_dp_push_yuv_interleaved_image(mWrState, aBounds, MergeClipLeaf(aClip),
aIsBackfaceVisible, aImageChannel0,
aColorDepth, aColorSpace, aRendering);
}
void DisplayListBuilder::PushIFrame(const wr::LayoutRect& aBounds,
bool aIsBackfaceVisible,
PipelineId aPipeline,
bool aIgnoreMissingPipeline) {
wr_dp_push_iframe(mWrState, aBounds, MergeClipLeaf(aBounds),
aIsBackfaceVisible, aPipeline, aIgnoreMissingPipeline);
}
void DisplayListBuilder::PushBorder(const wr::LayoutRect& aBounds,
const wr::LayoutRect& aClip,
bool aIsBackfaceVisible,
const wr::LayoutSideOffsets& aWidths,
const Range<const wr::BorderSide>& aSides,
const wr::BorderRadius& aRadius,
wr::AntialiasBorder aAntialias) {
MOZ_ASSERT(aSides.length() == 4);
if (aSides.length() != 4) {
return;
}
wr_dp_push_border(mWrState, aBounds, MergeClipLeaf(aClip), aIsBackfaceVisible,
aAntialias, aWidths, aSides[0], aSides[1], aSides[2],
aSides[3], aRadius);
}
void DisplayListBuilder::PushBorderImage(
const wr::LayoutRect& aBounds, const wr::LayoutRect& aClip,
bool aIsBackfaceVisible, const wr::LayoutSideOffsets& aWidths,
wr::ImageKey aImage, const int32_t aWidth, const int32_t aHeight,
const wr::SideOffsets2D<int32_t>& aSlice,
const wr::SideOffsets2D<float>& aOutset,
const wr::RepeatMode& aRepeatHorizontal,
const wr::RepeatMode& aRepeatVertical) {
wr_dp_push_border_image(mWrState, aBounds, MergeClipLeaf(aClip),
aIsBackfaceVisible, aWidths, aImage, aWidth, aHeight,
aSlice, aOutset, aRepeatHorizontal, aRepeatVertical);
}
void DisplayListBuilder::PushBorderGradient(
const wr::LayoutRect& aBounds, const wr::LayoutRect& aClip,
bool aIsBackfaceVisible, const wr::LayoutSideOffsets& aWidths,
const int32_t aWidth, const int32_t aHeight,
const wr::SideOffsets2D<int32_t>& aSlice,
const wr::LayoutPoint& aStartPoint, const wr::LayoutPoint& aEndPoint,
const nsTArray<wr::GradientStop>& aStops, wr::ExtendMode aExtendMode,
const wr::SideOffsets2D<float>& aOutset) {
wr_dp_push_border_gradient(mWrState, aBounds, MergeClipLeaf(aClip),
aIsBackfaceVisible, aWidths, aWidth, aHeight,
aSlice, aStartPoint, aEndPoint, aStops.Elements(),
aStops.Length(), aExtendMode, aOutset);
}
void DisplayListBuilder::PushBorderRadialGradient(
const wr::LayoutRect& aBounds, const wr::LayoutRect& aClip,
bool aIsBackfaceVisible, const wr::LayoutSideOffsets& aWidths,
const wr::LayoutPoint& aCenter, const wr::LayoutSize& aRadius,
const nsTArray<wr::GradientStop>& aStops, wr::ExtendMode aExtendMode,
const wr::SideOffsets2D<float>& aOutset) {
wr_dp_push_border_radial_gradient(mWrState, aBounds, MergeClipLeaf(aClip),
aIsBackfaceVisible, aWidths, aCenter,
aRadius, aStops.Elements(), aStops.Length(),
aExtendMode, aOutset);
}
void DisplayListBuilder::PushText(const wr::LayoutRect& aBounds,
const wr::LayoutRect& aClip,
bool aIsBackfaceVisible,
const wr::ColorF& aColor,
wr::FontInstanceKey aFontKey,
Range<const wr::GlyphInstance> aGlyphBuffer,
const wr::GlyphOptions* aGlyphOptions) {
wr_dp_push_text(mWrState, aBounds, MergeClipLeaf(aClip), aIsBackfaceVisible,
aColor, aFontKey, &aGlyphBuffer[0], aGlyphBuffer.length(),
aGlyphOptions);
}
void DisplayListBuilder::PushLine(const wr::LayoutRect& aClip,
bool aIsBackfaceVisible,
const wr::Line& aLine) {
wr::LayoutRect clip = MergeClipLeaf(aClip);
wr_dp_push_line(mWrState, &clip, aIsBackfaceVisible, &aLine.bounds,
aLine.wavyLineThickness, aLine.orientation, &aLine.color,
aLine.style);
}
void DisplayListBuilder::PushShadow(const wr::LayoutRect& aRect,
const wr::LayoutRect& aClip,
bool aIsBackfaceVisible,
const wr::Shadow& aShadow) {
wr_dp_push_shadow(mWrState, aRect, MergeClipLeaf(aClip), aIsBackfaceVisible,
aShadow);
}
void DisplayListBuilder::PopAllShadows() { wr_dp_pop_all_shadows(mWrState); }
void DisplayListBuilder::PushBoxShadow(
const wr::LayoutRect& aRect, const wr::LayoutRect& aClip,
bool aIsBackfaceVisible, const wr::LayoutRect& aBoxBounds,
const wr::LayoutVector2D& aOffset, const wr::ColorF& aColor,
const float& aBlurRadius, const float& aSpreadRadius,
const wr::BorderRadius& aBorderRadius,
const wr::BoxShadowClipMode& aClipMode) {
wr_dp_push_box_shadow(mWrState, aRect, MergeClipLeaf(aClip),
aIsBackfaceVisible, aBoxBounds, aOffset, aColor,
aBlurRadius, aSpreadRadius, aBorderRadius, aClipMode);
}
Maybe<layers::ScrollableLayerGuid::ViewID>
DisplayListBuilder::GetContainingFixedPosScrollTarget(
const ActiveScrolledRoot* aAsr) {
return mActiveFixedPosTracker
? mActiveFixedPosTracker->GetScrollTargetForASR(aAsr)
: Nothing();
}
void DisplayListBuilder::SetHitTestInfo(
const layers::ScrollableLayerGuid::ViewID& aScrollId,
gfx::CompositorHitTestInfo aHitInfo) {
static_assert(DoesCompositorHitTestInfoFitIntoBits<16>(),
"CompositorHitTestFlags MAX value has to be less than number "
"of bits in uint16_t");
wr_set_item_tag(mWrState, aScrollId,
static_cast<uint16_t>(aHitInfo.serialize()));
}
void DisplayListBuilder::ClearHitTestInfo() { wr_clear_item_tag(mWrState); }
DisplayListBuilder::FixedPosScrollTargetTracker::FixedPosScrollTargetTracker(
DisplayListBuilder& aBuilder, const ActiveScrolledRoot* aAsr,
layers::ScrollableLayerGuid::ViewID aScrollId)
: mParentTracker(aBuilder.mActiveFixedPosTracker),
mBuilder(aBuilder),
mAsr(aAsr),
mScrollId(aScrollId) {
aBuilder.mActiveFixedPosTracker = this;
}
DisplayListBuilder::FixedPosScrollTargetTracker::
~FixedPosScrollTargetTracker() {
mBuilder.mActiveFixedPosTracker = mParentTracker;
}
Maybe<layers::ScrollableLayerGuid::ViewID>
DisplayListBuilder::FixedPosScrollTargetTracker::GetScrollTargetForASR(
const ActiveScrolledRoot* aAsr) {
return aAsr == mAsr ? Some(mScrollId) : Nothing();
}
already_AddRefed<gfxContext> DisplayListBuilder::GetTextContext(
wr::IpcResourceUpdateQueue& aResources,
const layers::StackingContextHelper& aSc,
layers::WebRenderLayerManager* aManager, nsDisplayItem* aItem,
nsRect& aBounds, const gfx::Point& aDeviceOffset) {
if (!mCachedTextDT) {
mCachedTextDT = new layout::TextDrawTarget(*this, aResources, aSc, aManager,
aItem, aBounds);
mCachedContext = gfxContext::CreateOrNull(mCachedTextDT, aDeviceOffset);
} else {
mCachedTextDT->Reinitialize(aResources, aSc, aManager, aItem, aBounds);
mCachedContext->SetDeviceOffset(aDeviceOffset);
mCachedContext->SetMatrix(Matrix());
}
RefPtr<gfxContext> tmp = mCachedContext;
return tmp.forget();
}
} // namespace wr
} // namespace mozilla
extern "C" {
void wr_transaction_notification_notified(uintptr_t aHandler,
mozilla::wr::Checkpoint aWhen) {
auto handler = reinterpret_cast<mozilla::wr::NotificationHandler*>(aHandler);
handler->Notify(aWhen);
// TODO: it would be better to get a callback when the object is destroyed on
// the rust side and delete then.
delete handler;
}
} // extern C