Source/WebCore/Modules/webvr/VRDisplay.idl

/*
 * Copyright (C) 2017 Igalia S.L. All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 *
 * THIS SOFTWARE IS PROVIDED BY APPLE INC. AND ITS CONTRIBUTORS ``AS IS''
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
 * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL APPLE INC. OR ITS CONTRIBUTORS
 * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
 * THE POSSIBILITY OF SUCH DAMAGE.
 */

[
    ActiveDOMObject,
    EnabledAtRuntime=WebVR,
] interface VRDisplay : EventTarget {
    readonly attribute boolean isConnected;
    readonly attribute boolean isPresenting;

    readonly attribute VRDisplayCapabilities capabilities; // FIXME: [SameObject]

    readonly attribute VRStageParameters? stageParameters;

    VREyeParameters getEyeParameters(VREye whichEye);

    readonly attribute unsigned long displayId;

    readonly attribute DOMString displayName;

    boolean getFrameData(VRFrameData frameData);

    [NewObject] VRPose getPose();

    void resetPose();

    attribute double depthNear;
    attribute double depthFar;

    // RequestAnimationFrameCallback equates to FrameRequestCallback.
    long requestAnimationFrame(RequestAnimationFrameCallback callback);
    void cancelAnimationFrame(unsigned long handle);

    Promise<void> requestPresent(sequence<VRLayerInit> layers);

    Promise<void> exitPresent();

    sequence<VRLayerInit> getLayers();

    void submitFrame();
};