Source/WebCore/animation/KeyframeEffect.idl

/*
 * Copyright (C) 2018 Apple Inc. 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. ``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
 * 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.
 */

typedef USVString CSSOMString;

[
    EnabledAtRuntime=WebAnimations,
    Exposed=Window,
    JSGenerateToNativeObject,
] interface KeyframeEffect : AnimationEffect {
    [CallWith=GlobalObject, MayThrowException] constructor(Element? target, object? keyframes, optional (unrestricted double or KeyframeEffectOptions) options);
    [CallWith=GlobalObject, MayThrowException] constructor(KeyframeEffect source);

    attribute Element? target;
    [MayThrowException] attribute CSSOMString? pseudoElement;
    [EnabledAtRuntime=WebAnimationsCompositeOperations] attribute IterationCompositeOperation iterationComposite;
    [EnabledAtRuntime=WebAnimationsCompositeOperations] attribute CompositeOperation composite;
    [CallWith=GlobalObject, ImplementedAs=getBindingsKeyframes] sequence<object> getKeyframes();
    [MayThrowException, CallWith=GlobalObject, ImplementedAs=setBindingsKeyframes] void setKeyframes(object? keyframes);
};

dictionary BasePropertyIndexedKeyframe {
    (sequence<double?> or double?) offset = [];
    (sequence<DOMString> or DOMString) easing = [];
    (sequence<CompositeOperationOrAuto> or CompositeOperationOrAuto) composite = [];
};

dictionary BaseKeyframe {
    double? offset = null;
    DOMString easing = "linear";
    CompositeOperationOrAuto composite = "auto";
};

[
    JSGenerateToJSObject
] dictionary BaseComputedKeyframe {
     double? offset = null;
     double computedOffset;
     DOMString easing = "linear";
     CompositeOperationOrAuto composite = "auto";
};