gfx/layers/ipc/PLayer.ipdl
author ffxbld
Wed, 16 Feb 2011 16:16:20 -0800
branchGECKO20b12pre_20110216_RELBRANCH
changeset 62714 dab36a22bd1984894376a8c5a618779d2437bda9
parent 48137 e6299aaa482e4231d8c6ce214efe04b8cdff2440
child 94475 f4157e8c410708d76703f19e4dfb61859bfe32d8
permissions -rw-r--r--
Added tag FENNEC_4_0b5_RELEASE for changeset 9693e30b9c9c. CLOSED TREE a=release

/* -*- 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) 2010
 * the Initial Developer. All Rights Reserved.
 *
 * Contributor(s):
 *   Chris Jones <jones.chris.g@gmail.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;

namespace mozilla {
namespace layers {

/**
 * PLayer represents a layer shared across thread contexts.
 */

sync protocol PLayer {
    manager PLayers;

    /**
     * OWNERSHIP MODEL
     *
     * Roughly speaking, the child side "actually owns" a Layer.  This
     * is because the parent side is the "shadow"; when the child
     * releases a Layer, the parent's shadow is no longer meaningful.
     *
     * To implement this model, the concrete PLayerParent keeps a
     * strong ref to its Layer, so the Layer's lifetime is bound to
     * the PLayerParent's.  Then, when the Layer's refcount hits 0 on
     * the child side, we send __delete__() from the child to parent.
     * The parent then releases its Layer, which results in the Layer
     * being deleted "soon" (usually immediately).
     */
parent:
    __delete__();
};

} // layers
} // mozilla