ImageProviderExtensions.AsAnimationFrame Method

Article
09/16/2015

Returns an AnimationFrame with the specified IImageProvider as its source and the specified frame duration.

Namespace: Lumia.Imaging
Assembly: Lumia.Imaging.Managed (in Lumia.Imaging.Managed.dll) Version: 0.0.0.0

Syntax

public static AnimationFrame AsAnimationFrame(
    this IImageProvider imageProvider,
    int duration = 0,
    Point position = null,
    AnimationFrameDithering dithering = AnimationFrameDithering.UseRendererSetting
)

'Declaration
<ExtensionAttribute>
Public Shared Function AsAnimationFrame ( 
    imageProvider As IImageProvider,
    Optional duration As Integer = 0,
    Optional position As Point = Nothing,
    Optional dithering As AnimationFrameDithering = AnimationFrameDithering.UseRendererSetting
) As AnimationFrame

public:
[ExtensionAttribute]
static AnimationFrame^ AsAnimationFrame(
    IImageProvider^ imageProvider, 
    int duration = 0, 
    Point position = nullptr, 
    AnimationFrameDithering dithering = AnimationFrameDithering::UseRendererSetting
)

Lumia.Imaging.ImageProviderExtensions.AsAnimationFrame = function(imageProvider, duration, position, dithering);

Parameters

imageProvider
Type: Lumia.Imaging.IImageProvider
The provider of the image for the animation frame.

duration (Optional)
Type: System.Int32
Specifies the duration that this frame should be displayed, in milliseconds. The actual precision may not be in single milliseconds.

position (Optional)
Type: Windows.Foundation.Point
Optional, specifies the position of the frame. The position is relative to the top-left corner of the first animation frame.

dithering (Optional)
Type: Lumia.Imaging.AnimationFrameDithering
Optional, specifies if the frame should be dithered.

Return Value

Type: AnimationFrame
An AnimationFrame. Note that if imageProvider is already an AnimationFrame, the same object will be returned with updated property values.

Usage Note

In Visual Basic and C#, you can call this method as an instance method on any object of type IImageProvider. When you use instance method syntax to call this method, omit the first parameter. For more information, see Extension Methods (Visual Basic) or Extension Methods (C# Programming Guide).

Version Information

Lumia Imaging SDK

Supported in: 3.0, 2.0

Share via