wine/include/windows.ui.composition.idl

/*
 * Copyright (C) 2023 Mohamad Al-Jaf
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2.1 of the License, or (at your option) any later version.
 *
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA
 */

#ifdef __WIDL__
#pragma winrt ns_prefix
#endif

import "inspectable.idl";
import "asyncinfo.idl";
import "eventtoken.idl";
import "windowscontracts.idl";
import "windows.foundation.idl";
import "windows.foundation.numerics.idl";
/* import "windows.graphics.idl"; */
import "windows.graphics.directx.idl";
import "windows.graphics.effects.idl";
import "windows.system.idl";
import "windows.ui.idl";
import "windows.ui.core.idl";

namespace Windows.UI.Composition {
    typedef enum CompositionBackfaceVisibility CompositionBackfaceVisibility;
    typedef enum CompositionBitmapInterpolationMode CompositionBitmapInterpolationMode;
    typedef enum CompositionBorderMode CompositionBorderMode;
    typedef enum CompositionColorSpace CompositionColorSpace;
    typedef enum CompositionCompositeMode CompositionCompositeMode;
    typedef enum CompositionStretch CompositionStretch;

    interface IColorKeyFrameAnimation;
    interface ICompositionBrush;
    interface ICompositionBrushFactory;
    interface ICompositionClip;
    interface ICompositionClip2;
    interface ICompositionClipFactory;
    interface ICompositionEasingFunction;
    interface ICompositionEasingFunctionFactory;
    interface ICompositionEasingFunctionStatics;
    interface ICompositionSurface;
    interface ICompositionSurfaceBrush;
    interface ICompositionSurfaceBrush2;
    interface ICompositionSurfaceBrush3;
    interface IContainerVisual;
    interface IContainerVisualFactory;
    interface ISpriteVisual;
    interface ISpriteVisual2;
    interface IVisual;
    interface IVisual2;
    interface IVisual3;
    interface IVisual4;
    interface IVisualCollection;
    interface IVisualFactory;

    runtimeclass ColorKeyFrameAnimation;
    runtimeclass CompositionBrush;
    runtimeclass CompositionClip;
    runtimeclass CompositionEasingFunction;
    runtimeclass CompositionObject;
    runtimeclass CompositionSurfaceBrush;
    runtimeclass ContainerVisual;
    runtimeclass KeyFrameAnimation;
    runtimeclass SpriteVisual;
    runtimeclass Visual;
    runtimeclass VisualCollection;

    declare {
        interface Windows.Foundation.AsyncOperationCompletedHandler<Windows.UI.Composition.ICompositionSurface *>;
        interface Windows.Foundation.IAsyncOperation<Windows.UI.Composition.ICompositionSurface *>;
        interface Windows.Foundation.Collections.IIterable<Windows.UI.Composition.Visual *>;
        interface Windows.Foundation.Collections.IIterator<Windows.UI.Composition.Visual *>;
    }

    [
        contract(Windows.Foundation.UniversalApiContract, 2.0)
    ]
    enum CompositionBackfaceVisibility
    {
        Inherit = 0,
        Visible = 1,
        Hidden  = 2,
    };

    [
        contract(Windows.Foundation.UniversalApiContract, 2.0)
    ]
    enum CompositionBitmapInterpolationMode
    {
        NearestNeighbor                = 0,
        Linear                         = 1,
        [contract(Windows.Foundation.UniversalApiContract, 8.0)]
        MagLinearMinLinearMipLinear    = 2,
        [contract(Windows.Foundation.UniversalApiContract, 8.0)]
        MagLinearMinLinearMipNearest   = 3,
        [contract(Windows.Foundation.UniversalApiContract, 8.0)]
        MagLinearMinNearestMipLinear   = 4,
        [contract(Windows.Foundation.UniversalApiContract, 8.0)]
        MagLinearMinNearestMipNearest  = 5,
        [contract(Windows.Foundation.UniversalApiContract, 8.0)]
        MagNearestMinLinearMipLinear   = 6,
        [contract(Windows.Foundation.UniversalApiContract, 8.0)]
        MagNearestMinLinearMipNearest  = 7,
        [contract(Windows.Foundation.UniversalApiContract, 8.0)]
        MagNearestMinNearestMipLinear  = 8,
        [contract(Windows.Foundation.UniversalApiContract, 8.0)]
        MagNearestMinNearestMipNearest = 9,
    };

    [
        contract(Windows.Foundation.UniversalApiContract, 2.0)
    ]
    enum CompositionBorderMode
    {
        Inherit = 0,
        Soft    = 1,
        Hard    = 2,
    };

    [
        contract(Windows.Foundation.UniversalApiContract, 2.0)
    ]
    enum CompositionColorSpace
    {
        Auto      = 0,
        Hsl       = 1,
        Rgb       = 2,
        [contract(Windows.Foundation.UniversalApiContract, 5.0)]
        HslLinear = 3,
        [contract(Windows.Foundation.UniversalApiContract, 5.0)]
        RgbLinear = 4,
    };

    [
        contract(Windows.Foundation.UniversalApiContract, 2.0)
    ]
    enum CompositionCompositeMode
    {
        Inherit           = 0,
        SourceOver        = 1,
        DestinationInvert = 2,
        [contract(Windows.Foundation.UniversalApiContract, 3.0)]
        MinBlend          = 3,
    };

    [
        contract(Windows.Foundation.UniversalApiContract, 2.0)
    ]
    enum CompositionStretch
    {
        None          = 0,
        Fill          = 1,
        Uniform       = 2,
        UniformToFill = 3,
    };

    [
        contract(Windows.Foundation.UniversalApiContract, 2.0),
        exclusiveto(Windows.UI.Composition.ColorKeyFrameAnimation),
        uuid(93adb5e9-8e05-4593-84a3-dca152781e56)
    ]
    interface IColorKeyFrameAnimation : IInspectable
    {
        [propget] HRESULT InterpolationColorSpace([out, retval] Windows.UI.Composition.CompositionColorSpace *value);
        [propput] HRESULT InterpolationColorSpace([in] Windows.UI.Composition.CompositionColorSpace value);
        [overload("InsertKeyFrame")] HRESULT InsertKeyFrame([in] FLOAT key, [in] Windows.UI.Color value);
        [overload("InsertKeyFrame")] HRESULT InsertKeyFrameWithEasingFunction(
            [in] FLOAT key, [in] Windows.UI.Color value,
            [in] Windows.UI.Composition.CompositionEasingFunction *function
        );
    }

    [
        contract(Windows.Foundation.UniversalApiContract, 2.0),
        exclusiveto(Windows.UI.Composition.CompositionBrush),
        uuid(ab0d7608-30c0-40e9-b568-b60a6bd1fb46)
    ]
    interface ICompositionBrush : IInspectable
    {
    }

    [
        contract(Windows.Foundation.UniversalApiContract, 2.0),
        exclusiveto(Windows.UI.Composition.CompositionBrush),
        uuid(da53fb4c-4650-47c4-ad76-765379607ed6)
    ]
    interface ICompositionBrushFactory : IInspectable
    {
    }

    [
        contract(Windows.Foundation.UniversalApiContract, 2.0),
        exclusiveto(Windows.UI.Composition.CompositionClip),
        uuid(1ccd2a52-cfc7-4ace-9983-146bb8eb6a3c)
    ]
    interface ICompositionClip : IInspectable
    {
    }

    [
        contract(Windows.Foundation.UniversalApiContract, 2.0),
        exclusiveto(Windows.UI.Composition.CompositionClip),
        uuid(b9484caf-20c7-4aed-ac4a-9c78ba1302cf)
    ]
    interface ICompositionClipFactory : IInspectable
    {
    }

    [
        contract(Windows.Foundation.UniversalApiContract, 2.0),
        exclusiveto(Windows.UI.Composition.CompositionEasingFunction),
        uuid(5145e356-bf79-4ea8-8cc2-6b5b472e6c9a)
    ]
    interface ICompositionEasingFunction : IInspectable
    {
    }

    [
        contract(Windows.Foundation.UniversalApiContract, 2.0),
        exclusiveto(Windows.UI.Composition.CompositionEasingFunction),
        uuid(60840774-3da0-4949-8200-7206c00190a0)
    ]
    interface ICompositionEasingFunctionFactory : IInspectable
    {
    }

    [
        contract(Windows.Foundation.UniversalApiContract, 2.0),
        uuid(1527540d-42c7-47a6-a408-668f79a90dfb)
    ]
    interface ICompositionSurface : IInspectable
    {
    }

    [
        contract(Windows.Foundation.UniversalApiContract, 2.0),
        exclusiveto(Windows.UI.Composition.CompositionSurfaceBrush),
        uuid(ad016d79-1e4c-4c0d-9c29-83338c87c162)
    ]
    interface ICompositionSurfaceBrush : IInspectable
    {
        [propget] HRESULT BitmapInterpolationMode([out, retval] Windows.UI.Composition.CompositionBitmapInterpolationMode *value);
        [propput] HRESULT BitmapInterpolationMode([in] Windows.UI.Composition.CompositionBitmapInterpolationMode value);
        [propget] HRESULT HorizontalAlignmentRatio([out, retval] FLOAT *value);
        [propput] HRESULT HorizontalAlignmentRatio([in] FLOAT value);
        [propget] HRESULT Stretch([out, retval] Windows.UI.Composition.CompositionStretch *value);
        [propput] HRESULT Stretch([in] Windows.UI.Composition.CompositionStretch value);
        [propget] HRESULT Surface([out, retval] Windows.UI.Composition.ICompositionSurface **value);
        [propput] HRESULT Surface([in] Windows.UI.Composition.ICompositionSurface *value);
        [propget] HRESULT VerticalAlignmentRatio([out, retval] FLOAT *value);
        [propput] HRESULT VerticalAlignmentRatio([in] FLOAT value);
    }

    [
        contract(Windows.Foundation.UniversalApiContract, 2.0),
        exclusiveto(Windows.UI.Composition.ContainerVisual),
        uuid(02f6bc74-ed20-4773-afe6-d49b4a93db32)
    ]
    interface IContainerVisual : IInspectable
    {
        [propget] HRESULT Children([out, retval] Windows.UI.Composition.VisualCollection **value);
    }

    [
        contract(Windows.Foundation.UniversalApiContract, 2.0),
        exclusiveto(Windows.UI.Composition.ContainerVisual),
        uuid(0363a65b-c7da-4d9a-95f4-69b5c8df670b)
    ]
    interface IContainerVisualFactory : IInspectable
    {
    }

    [
        contract(Windows.Foundation.UniversalApiContract, 2.0),
        exclusiveto(Windows.UI.Composition.SpriteVisual),
        uuid(08e05581-1ad1-4f97-9757-402d76e4233b)
    ]
    interface ISpriteVisual : IInspectable
    {
        [propget] HRESULT Brush([out, retval] Windows.UI.Composition.CompositionBrush **value);
        [propput] HRESULT Brush([in] Windows.UI.Composition.CompositionBrush *value);
    }

    [
        contract(Windows.Foundation.UniversalApiContract, 2.0),
        exclusiveto(Windows.UI.Composition.Visual),
        uuid(117e202d-a859-4c89-873b-c2aa566788e3)
    ]
    interface IVisual : IInspectable
    {
        [propget] HRESULT AnchorPoint([out, retval] Windows.Foundation.Numerics.Vector2 *value);
        [propput] HRESULT AnchorPoint([in] Windows.Foundation.Numerics.Vector2 value);
        [propget] HRESULT BackfaceVisibility([out, retval] Windows.UI.Composition.CompositionBackfaceVisibility *value);
        [propput] HRESULT BackfaceVisibility([in] Windows.UI.Composition.CompositionBackfaceVisibility value);
        [propget] HRESULT BorderMode([out, retval] Windows.UI.Composition.CompositionBorderMode *value);
        [propput] HRESULT BorderMode([in] Windows.UI.Composition.CompositionBorderMode value);
        [propget] HRESULT CenterPoint([out, retval] Windows.Foundation.Numerics.Vector3 *value);
        [propput] HRESULT CenterPoint([in] Windows.Foundation.Numerics.Vector3 value);
        [propget] HRESULT Clip([out, retval] Windows.UI.Composition.CompositionClip **value);
        [propput] HRESULT Clip([in] Windows.UI.Composition.CompositionClip *value);
        [propget] HRESULT CompositeMode([out, retval] Windows.UI.Composition.CompositionCompositeMode *value);
        [propput] HRESULT CompositeMode([in] Windows.UI.Composition.CompositionCompositeMode value);
        [propget] HRESULT IsVisible([out, retval] boolean *value);
        [propput] HRESULT IsVisible([in] boolean value);
        [propget] HRESULT Offset([out, retval] Windows.Foundation.Numerics.Vector3 *value);
        [propput] HRESULT Offset([in] Windows.Foundation.Numerics.Vector3 value);
        [propget] HRESULT Opacity([out, retval] FLOAT *value);
        [propput] HRESULT Opacity([in] FLOAT value);
        [propget] HRESULT Orientation([out, retval] Windows.Foundation.Numerics.Quaternion *value);
        [propput] HRESULT Orientation([in] Windows.Foundation.Numerics.Quaternion value);
        [propget] HRESULT Parent([out, retval] Windows.UI.Composition.ContainerVisual **value);
        [propget] HRESULT RotationAngle([out, retval] FLOAT *value);
        [propput] HRESULT RotationAngle([in] FLOAT value);
        [propget] HRESULT RotationAngleInDegrees([out, retval] FLOAT *value);
        [propput] HRESULT RotationAngleInDegrees([in] FLOAT value);
        [propget] HRESULT RotationAxis([out, retval] Windows.Foundation.Numerics.Vector3 *value);
        [propput] HRESULT RotationAxis([in] Windows.Foundation.Numerics.Vector3 value);
        [propget] HRESULT Scale([out, retval] Windows.Foundation.Numerics.Vector3 *value);
        [propput] HRESULT Scale([in] Windows.Foundation.Numerics.Vector3 value);
        [propget] HRESULT Size([out, retval] Windows.Foundation.Numerics.Vector2 *value);
        [propput] HRESULT Size([in] Windows.Foundation.Numerics.Vector2 value);
        [propget] HRESULT TransformMatrix([out, retval] Windows.Foundation.Numerics.Matrix4x4 *value);
        [propput] HRESULT TransformMatrix([in] Windows.Foundation.Numerics.Matrix4x4 value);
    }

    [
        contract(Windows.Foundation.UniversalApiContract, 2.0),
        exclusiveto(Windows.UI.Composition.Visual),
        uuid(ad0ff93e-b502-4eb5-87b4-9a38a71d0137)
    ]
    interface IVisualFactory : IInspectable
    {
    }

    [
        contract(Windows.Foundation.UniversalApiContract, 2.0),
        exclusiveto(Windows.UI.Composition.VisualCollection),
        uuid(8b745505-fd3e-4a98-84a8-e949468c6bcb)
    ]
    interface IVisualCollection : IInspectable
    {
        [propget] HRESULT Count([out, retval] INT32 *value);
        HRESULT InsertAbove([in] Windows.UI.Composition.Visual *child, [in] Windows.UI.Composition.Visual *sibling);
        HRESULT InsertAtBottom([in] Windows.UI.Composition.Visual *child);
        HRESULT InsertAtTop([in] Windows.UI.Composition.Visual *child);
        HRESULT InsertBelow([in] Windows.UI.Composition.Visual *child, [in] Windows.UI.Composition.Visual *sibling);
        HRESULT Remove([in] Windows.UI.Composition.Visual *child);
        HRESULT RemoveAll();
    }

    [
        contract(Windows.Foundation.UniversalApiContract, 2.0),
        marshaling_behavior(agile),
        threading(both)
    ]
    runtimeclass ColorKeyFrameAnimation : Windows.UI.Composition.KeyFrameAnimation
    {
        [default] interface Windows.UI.Composition.IColorKeyFrameAnimation;
    }

    [
        composable(Windows.UI.Composition.ICompositionBrushFactory, public, Windows.Foundation.UniversalApiContract, 2.0),
        contract(Windows.Foundation.UniversalApiContract, 2.0),
        marshaling_behavior(agile),
        threading(both)
    ]
    runtimeclass CompositionBrush : Windows.UI.Composition.CompositionObject
    {
        [default] interface Windows.UI.Composition.ICompositionBrush;
    }

    [
        composable(Windows.UI.Composition.ICompositionClipFactory, public, Windows.Foundation.UniversalApiContract, 2.0),
        contract(Windows.Foundation.UniversalApiContract, 2.0),
        marshaling_behavior(agile),
        threading(both)
    ]
    runtimeclass CompositionClip : Windows.UI.Composition.CompositionObject
    {
        [default] interface Windows.UI.Composition.ICompositionClip;
        [contract(Windows.Foundation.UniversalApiContract, 3.0)] interface Windows.UI.Composition.ICompositionClip2;
    }

    [
        composable(Windows.UI.Composition.ICompositionEasingFunctionFactory, public, Windows.Foundation.UniversalApiContract, 2.0),
        contract(Windows.Foundation.UniversalApiContract, 2.0),
        marshaling_behavior(agile),
        static(Windows.UI.Composition.ICompositionEasingFunctionStatics, Windows.Foundation.UniversalApiContract, 12.0),
        threading(both)
    ]
    runtimeclass CompositionEasingFunction : Windows.UI.Composition.CompositionObject
    {
        [default] interface Windows.UI.Composition.ICompositionEasingFunction;
    }

    [
        contract(Windows.Foundation.UniversalApiContract, 2.0),
        marshaling_behavior(agile),
        threading(both)
    ]
    runtimeclass CompositionSurfaceBrush : Windows.UI.Composition.CompositionBrush
    {
        [default] interface Windows.UI.Composition.ICompositionSurfaceBrush;
        [contract(Windows.Foundation.UniversalApiContract, 3.0)] interface Windows.UI.Composition.ICompositionSurfaceBrush2;
        [contract(Windows.Foundation.UniversalApiContract, 8.0)] interface Windows.UI.Composition.ICompositionSurfaceBrush3;
    }

    [
        composable(Windows.UI.Composition.IContainerVisualFactory, public, Windows.Foundation.UniversalApiContract, 2.0),
        contract(Windows.Foundation.UniversalApiContract, 2.0),
        marshaling_behavior(agile),
        threading(both)
    ]
    runtimeclass ContainerVisual : Windows.UI.Composition.Visual
    {
        [default] interface Windows.UI.Composition.IContainerVisual;
    }

    [
        contract(Windows.Foundation.UniversalApiContract, 2.0),
        marshaling_behavior(agile),
        threading(both)
    ]
    runtimeclass SpriteVisual : Windows.UI.Composition.ContainerVisual
    {
        [default] interface Windows.UI.Composition.ISpriteVisual;
        [contract(Windows.Foundation.UniversalApiContract, 3.0)] interface Windows.UI.Composition.ISpriteVisual2;
    }

    [
        composable(Windows.UI.Composition.IVisualFactory, public, Windows.Foundation.UniversalApiContract, 2.0),
        contract(Windows.Foundation.UniversalApiContract, 2.0),
        marshaling_behavior(agile),
        threading(both)
    ]
    runtimeclass Visual : Windows.UI.Composition.CompositionObject
    {
        [default] interface Windows.UI.Composition.IVisual;
        [contract(Windows.Foundation.UniversalApiContract, 4.0)] interface Windows.UI.Composition.IVisual2;
        [contract(Windows.Foundation.UniversalApiContract, 11.0)] interface Windows.UI.Composition.IVisual3;
        [contract(Windows.Foundation.UniversalApiContract, 12.0)] interface Windows.UI.Composition.IVisual4;
    }

    [
        contract(Windows.Foundation.UniversalApiContract, 2.0),
        marshaling_behavior(agile),
        threading(both)
    ]
    runtimeclass VisualCollection : Windows.UI.Composition.CompositionObject
    {
        [default] interface Windows.UI.Composition.IVisualCollection;
        interface Windows.Foundation.Collections.IIterable<Windows.UI.Composition.Visual *>;
    }
}