gecko-dev/gfx/layers/ipc/PCompositor.ipdl
2011-12-15 15:07:25 -05:00

90 lines
2.9 KiB
Plaintext

/* -*- Mode: C++; tab-width: 8; indent-tabs-mode: nil; c-basic-offset: 2 -*-
* vim: sw=2 ts=8 et :
*/
/* ***** BEGIN LICENSE BLOCK *****
* Version: MPL 1.1/GPL 2.0/LGPL 2.1
*
* The contents of this file are subject to the Mozilla Public License Version
* 1.1 (the "License"); you may not use this file except in compliance with
* the License. You may obtain a copy of the License at:
* http://www.mozilla.org/MPL/
*
* Software distributed under the License is distributed on an "AS IS" basis,
* WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
* for the specific language governing rights and limitations under the
* License.
*
* The Original Code is Mozilla Code.
*
* The Initial Developer of the Original Code is
* The Mozilla Foundation
* Portions created by the Initial Developer are Copyright (C) 2011
* the Initial Developer. All Rights Reserved.
*
* Contributor(s):
* Benoit Girard <bgirard@mozilla.com>
*
* Alternatively, the contents of this file may be used under the terms of
* either the GNU General Public License Version 2 or later (the "GPL"), or
* the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
* in which case the provisions of the GPL or the LGPL are applicable instead
* of those above. If you wish to allow use of your version of this file only
* under the terms of either the GPL or the LGPL, and not to allow others to
* use your version of this file under the terms of the MPL, indicate your
* decision by deleting the provisions above and replace them with the notice
* and other provisions required by the GPL or the LGPL. If you do not delete
* the provisions above, a recipient may use your version of this file under
* the terms of any one of the MPL, the GPL or the LGPL.
*
* ***** END LICENSE BLOCK ***** */
include protocol PLayers;
using mozilla::LayersBackend;
using mozilla::null_t;
namespace mozilla {
namespace layers {
// The Compositor needs to know about the widget to initialize the LayerManager.
struct ViewWidget {
uintptr_t widgetPtr;
};
// Gives platform specific information about the widget to initialize the LayerManager.
union WidgetDescriptor {
ViewWidget;
null_t;
};
// Cocoa: The widget needs to have access to the native context for resizing
struct NativeContext {
uintptr_t nativeContext;
};
/**
* The PCompositor protocol is used to manage communication between
* the main thread and the compositor thread context. It's primary
* purpose is to manage the PLayers sub protocol.
*/
rpc protocol PCompositor
{
// Compositor can manage many Layer Manager (PLayers)
manages PLayers;
parent:
rpc Init();
async PLayers(LayersBackend backend, WidgetDescriptor widgetDescriptor);
child:
// We create the LayerManager async thus we need to notify
// content that we have a native context to attach to the widget.
async NativeContextCreated(NativeContext aNativeContext);
};
} // layers
} // mozilla