dom/webidl/KeyframeEffect.webidl
author Brian Birtles <birtles@gmail.com>
Mon, 20 May 2019 05:22:44 +0000
changeset 474511 df36c132c6b047cf4b2f81049215157ea7dad11a
parent 452483 f0a91d36587266d7454a450c6044d573664fbed5
child 481073 12653dd76667080596c6d71f01d4bc6457bb4527
permissions -rw-r--r--
Bug 1253476 - Make whitespace in Web Animations WebIDL definitions more consistent; r=bzbarsky Differential Revision: https://phabricator.services.mozilla.com/D30611

/* -*- Mode: IDL; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
/* 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/.
 *
 * The origin of this IDL file is
 * https://drafts.csswg.org/web-animations/#the-keyframeeffect-interfaces
 *
 * Copyright © 2015 W3C® (MIT, ERCIM, Keio), All Rights Reserved. W3C
 * liability, trademark and document use rules apply.
 */

enum IterationCompositeOperation {
  "replace",
  "accumulate"
};

dictionary KeyframeEffectOptions : EffectTiming {
  IterationCompositeOperation iterationComposite = "replace";
  CompositeOperation          composite = "replace";
};

// KeyframeEffect should run in the caller's compartment to do custom
// processing on the `keyframes` object.
[Func="Document::IsWebAnimationsEnabled",
 RunConstructorInCallerCompartment,
 Constructor((Element or CSSPseudoElement)? target,
             object? keyframes,
             optional (unrestricted double or KeyframeEffectOptions) options),
 Constructor(KeyframeEffect source)]
interface KeyframeEffect : AnimationEffect {
  attribute (Element or CSSPseudoElement)?  target;
  [Pref="dom.animations-api.compositing.enabled"]
  attribute IterationCompositeOperation     iterationComposite;
  [Pref="dom.animations-api.compositing.enabled"]
  attribute CompositeOperation              composite;
  [Throws] sequence<object> getKeyframes();
  [Throws] void             setKeyframes(object? keyframes);
};

// Non-standard extensions
dictionary AnimationPropertyValueDetails {
  required double             offset;
           DOMString          value;
           DOMString          easing;
  required CompositeOperation composite;
};

dictionary AnimationPropertyDetails {
  required DOMString                               property;
  required boolean                                 runningOnCompositor;
           DOMString                               warning;
  required sequence<AnimationPropertyValueDetails> values;
};

partial interface KeyframeEffect {
  [ChromeOnly, Throws] sequence<AnimationPropertyDetails> getProperties();
};