Search Results for

    Show / Hide Table of Contents

    Class PixelAnimationRequest

    Request for generating animated pixel-art frames.

    Inheritance
    object
    UnifiedApiRequestBase<PixelAnimationRequest, Generated<IImageAsset>, IPixelArtAnimationOptions>
    GenerativeRequest<PixelAnimationRequest, ImagePrompt, IImageAsset, IPixelArtAnimationOptions>
    PixelArtRequest<PixelAnimationRequest, ImagePrompt, IPixelArtAnimationOptions>
    PixelAnimationRequest
    Implements
    IGenerativeRequest
    Inherited Members
    PixelArtRequest<PixelAnimationRequest, ImagePrompt, IPixelArtAnimationOptions>.ModelType
    PixelArtRequest<PixelAnimationRequest, ImagePrompt, IPixelArtAnimationOptions>.Size
    PixelArtRequest<PixelAnimationRequest, ImagePrompt, IPixelArtAnimationOptions>.NegativePrompt
    PixelArtRequest<PixelAnimationRequest, ImagePrompt, IPixelArtAnimationOptions>.NoBackground
    PixelArtRequest<PixelAnimationRequest, ImagePrompt, IPixelArtAnimationOptions>.PaletteImage
    PixelArtRequest<PixelAnimationRequest, ImagePrompt, IPixelArtAnimationOptions>.SetSize(MediaSize)
    PixelArtRequest<PixelAnimationRequest, ImagePrompt, IPixelArtAnimationOptions>.SetSize(SpriteSize)
    PixelArtRequest<PixelAnimationRequest, ImagePrompt, IPixelArtAnimationOptions>.SetNegativePrompt(string)
    PixelArtRequest<PixelAnimationRequest, ImagePrompt, IPixelArtAnimationOptions>.SetNoBackground(bool)
    PixelArtRequest<PixelAnimationRequest, ImagePrompt, IPixelArtAnimationOptions>.SetPaletteImage(Texture2D)
    GenerativeRequest<PixelAnimationRequest, ImagePrompt, IImageAsset, IPixelArtAnimationOptions>.ModelType
    GenerativeRequest<PixelAnimationRequest, ImagePrompt, IImageAsset, IPixelArtAnimationOptions>.Api
    GenerativeRequest<PixelAnimationRequest, ImagePrompt, IImageAsset, IPixelArtAnimationOptions>.Prompt
    GenerativeRequest<PixelAnimationRequest, ImagePrompt, IImageAsset, IPixelArtAnimationOptions>.Model
    GenerativeRequest<PixelAnimationRequest, ImagePrompt, IImageAsset, IPixelArtAnimationOptions>.N
    GenerativeRequest<PixelAnimationRequest, ImagePrompt, IImageAsset, IPixelArtAnimationOptions>.Seed
    GenerativeRequest<PixelAnimationRequest, ImagePrompt, IImageAsset, IPixelArtAnimationOptions>.MeasureLatency
    GenerativeRequest<PixelAnimationRequest, ImagePrompt, IImageAsset, IPixelArtAnimationOptions>.OnLatencyMeasured
    GenerativeRequest<PixelAnimationRequest, ImagePrompt, IImageAsset, IPixelArtAnimationOptions>.RequestedAt
    GenerativeRequest<PixelAnimationRequest, ImagePrompt, IImageAsset, IPixelArtAnimationOptions>.RecordOptions
    GenerativeRequest<PixelAnimationRequest, ImagePrompt, IImageAsset, IPixelArtAnimationOptions>.RecordedContext
    GenerativeRequest<PixelAnimationRequest, ImagePrompt, IImageAsset, IPixelArtAnimationOptions>.SetModel(Api, string)
    GenerativeRequest<PixelAnimationRequest, ImagePrompt, IImageAsset, IPixelArtAnimationOptions>.SetModel(ModelBase)
    GenerativeRequest<PixelAnimationRequest, ImagePrompt, IImageAsset, IPixelArtAnimationOptions>.SetCount(int)
    GenerativeRequest<PixelAnimationRequest, ImagePrompt, IImageAsset, IPixelArtAnimationOptions>.SetN(int)
    GenerativeRequest<PixelAnimationRequest, ImagePrompt, IImageAsset, IPixelArtAnimationOptions>.SetSeed(long)
    GenerativeRequest<PixelAnimationRequest, ImagePrompt, IImageAsset, IPixelArtAnimationOptions>.SetRecordOptions(bool?, bool?, string, string, GenerationRecord, RecordMerger, Action<GenerationRecord>)
    GenerativeRequest<PixelAnimationRequest, ImagePrompt, IImageAsset, IPixelArtAnimationOptions>.SetRecordOptions(GenerationRecordOptions)
    GenerativeRequest<PixelAnimationRequest, ImagePrompt, IImageAsset, IPixelArtAnimationOptions>.SetMeasureLatency(Action<double>)
    GenerativeRequest<PixelAnimationRequest, ImagePrompt, IImageAsset, IPixelArtAnimationOptions>.SetMeasureLatency(bool, Action<double>)
    GenerativeRequest<PixelAnimationRequest, ImagePrompt, IImageAsset, IPixelArtAnimationOptions>.SetPlaygroundSettings(string, string, string, bool, Action<double>, Action<GenerationRecord>)
    GenerativeRequest<PixelAnimationRequest, ImagePrompt, IImageAsset, IPixelArtAnimationOptions>.ExecuteAsync(CancellationToken)
    GenerativeRequest<PixelAnimationRequest, ImagePrompt, IImageAsset, IPixelArtAnimationOptions>.ExecuteAsyncT<T>(CancellationToken)
    GenerativeRequest<PixelAnimationRequest, ImagePrompt, IImageAsset, IPixelArtAnimationOptions>.ProcessPostRequestTasks<T>(Generated<T>)
    GenerativeRequest<PixelAnimationRequest, ImagePrompt, IImageAsset, IPixelArtAnimationOptions>.ProcessPostRequestTasks(IResult)
    GenerativeRequest<PixelAnimationRequest, ImagePrompt, IImageAsset, IPixelArtAnimationOptions>.GetPrompt()
    GenerativeRequest<PixelAnimationRequest, ImagePrompt, IImageAsset, IPixelArtAnimationOptions>.GetPromptStringToRecord()
    UnifiedApiRequestBase<PixelAnimationRequest, Generated<IImageAsset>, IPixelArtAnimationOptions>.Api
    UnifiedApiRequestBase<PixelAnimationRequest, Generated<IImageAsset>, IPixelArtAnimationOptions>.RequestType
    UnifiedApiRequestBase<PixelAnimationRequest, Generated<IImageAsset>, IPixelArtAnimationOptions>.HttpOptions
    UnifiedApiRequestBase<PixelAnimationRequest, Generated<IImageAsset>, IPixelArtAnimationOptions>.DownloadOptions
    UnifiedApiRequestBase<PixelAnimationRequest, Generated<IImageAsset>, IPixelArtAnimationOptions>.Sender
    UnifiedApiRequestBase<PixelAnimationRequest, Generated<IImageAsset>, IPixelArtAnimationOptions>.LogOptions
    UnifiedApiRequestBase<PixelAnimationRequest, Generated<IImageAsset>, IPixelArtAnimationOptions>.ContentType
    UnifiedApiRequestBase<PixelAnimationRequest, Generated<IImageAsset>, IPixelArtAnimationOptions>.ResponseType
    UnifiedApiRequestBase<PixelAnimationRequest, Generated<IImageAsset>, IPixelArtAnimationOptions>.IsCanceled
    UnifiedApiRequestBase<PixelAnimationRequest, Generated<IImageAsset>, IPixelArtAnimationOptions>.Stream
    UnifiedApiRequestBase<PixelAnimationRequest, Generated<IImageAsset>, IPixelArtAnimationOptions>.SafetyIdentifier
    UnifiedApiRequestBase<PixelAnimationRequest, Generated<IImageAsset>, IPixelArtAnimationOptions>.ServiceTier
    UnifiedApiRequestBase<PixelAnimationRequest, Generated<IImageAsset>, IPixelArtAnimationOptions>.Metadata
    UnifiedApiRequestBase<PixelAnimationRequest, Generated<IImageAsset>, IPixelArtAnimationOptions>.ProviderOptions
    UnifiedApiRequestBase<PixelAnimationRequest, Generated<IImageAsset>, IPixelArtAnimationOptions>.Options
    UnifiedApiRequestBase<PixelAnimationRequest, Generated<IImageAsset>, IPixelArtAnimationOptions>.SetSender(string)
    UnifiedApiRequestBase<PixelAnimationRequest, Generated<IImageAsset>, IPixelArtAnimationOptions>.SetLogOptions(CurlLogOptions)
    UnifiedApiRequestBase<PixelAnimationRequest, Generated<IImageAsset>, IPixelArtAnimationOptions>.SetOutputPath(string)
    UnifiedApiRequestBase<PixelAnimationRequest, Generated<IImageAsset>, IPixelArtAnimationOptions>.SetOutputPath(string, string)
    UnifiedApiRequestBase<PixelAnimationRequest, Generated<IImageAsset>, IPixelArtAnimationOptions>.SetOutputDirectory(string)
    UnifiedApiRequestBase<PixelAnimationRequest, Generated<IImageAsset>, IPixelArtAnimationOptions>.SetDownloadOptions(DownloadOptions)
    UnifiedApiRequestBase<PixelAnimationRequest, Generated<IImageAsset>, IPixelArtAnimationOptions>.SetRequestMimeType(MimeType)
    UnifiedApiRequestBase<PixelAnimationRequest, Generated<IImageAsset>, IPixelArtAnimationOptions>.SetResponseMimeType(MimeType)
    UnifiedApiRequestBase<PixelAnimationRequest, Generated<IImageAsset>, IPixelArtAnimationOptions>.SetStream(bool)
    UnifiedApiRequestBase<PixelAnimationRequest, Generated<IImageAsset>, IPixelArtAnimationOptions>.SetMetadata(ServerDictionary)
    UnifiedApiRequestBase<PixelAnimationRequest, Generated<IImageAsset>, IPixelArtAnimationOptions>.SetSafetyIdentifier(string)
    UnifiedApiRequestBase<PixelAnimationRequest, Generated<IImageAsset>, IPixelArtAnimationOptions>.SetProviderOptions(IPixelArtAnimationOptions)
    UnifiedApiRequestBase<PixelAnimationRequest, Generated<IImageAsset>, IPixelArtAnimationOptions>.SetSpecificOptions(IPixelArtAnimationOptions)
    UnifiedApiRequestBase<PixelAnimationRequest, Generated<IImageAsset>, IPixelArtAnimationOptions>.GetConfig<T>()
    UnifiedApiRequestBase<PixelAnimationRequest, Generated<IImageAsset>, IPixelArtAnimationOptions>.ExecuteAsync(CancellationToken)
    UnifiedApiRequestBase<PixelAnimationRequest, Generated<IImageAsset>, IPixelArtAnimationOptions>.Cancel()
    object.Equals(object)
    object.Equals(object, object)
    object.GetHashCode()
    object.GetType()
    object.ReferenceEquals(object, object)
    object.ToString()
    Namespace: Glitch9.AIDevKit.PixelArt
    Assembly: Glitch9.AIDevKit.PixelArt.dll
    Syntax
    public sealed class PixelAnimationRequest : PixelArtRequest<PixelAnimationRequest, ImagePrompt, IPixelArtAnimationOptions>, IGenerativeRequest

    Constructors

    | Edit this page View Source

    PixelAnimationRequest(ImagePrompt)

    Creates a pixel-art animation request.

    Declaration
    public PixelAnimationRequest(ImagePrompt prompt)
    Parameters
    Type Name Description
    ImagePrompt prompt

    Properties

    | Edit this page View Source

    FallbackModel

    Declaration
    protected override string FallbackModel { get; }
    Property Value
    Type Description
    string
    Overrides
    GenerativeRequest<PixelAnimationRequest, ImagePrompt, IImageAsset, IPixelArtAnimationOptions>.FallbackModel
    | Edit this page View Source

    ReferenceImage

    Required. Reference image to animate

    Declaration
    public Texture2D ReferenceImage { get; set; }
    Property Value
    Type Description
    Texture2D
    | Edit this page View Source

    RequestType

    The endpoint type for this

    Declaration
    public override RequestType RequestType { get; }
    Property Value
    Type Description
    RequestType
    Overrides
    UnifiedApiRequestBase<PixelAnimationRequest, Generated<IImageAsset>, IPixelArtAnimationOptions>.RequestType

    Methods

    | Edit this page View Source

    ExecuteAsyncInternal()

    Executes the actual task logic. Must be implemented in derived classes.

    Declaration
    protected override UniTask<Generated<IImageAsset>> ExecuteAsyncInternal()
    Returns
    Type Description
    UniTask<Generated<IImageAsset>>
    Overrides
    UnifiedApiRequestBase<PixelAnimationRequest, Generated<IImageAsset>, IPixelArtAnimationOptions>.ExecuteAsyncInternal()
    | Edit this page View Source

    SetReferenceImage(Texture2D)

    Sets reference image.

    Declaration
    public PixelAnimationRequest SetReferenceImage(Texture2D referenceImage)
    Parameters
    Type Name Description
    Texture2D referenceImage
    Returns
    Type Description
    PixelAnimationRequest

    Implements

    IGenerativeRequest

    Extension Methods

    ArrayExtensions.ToArrayOrEmpty<T>(T)
    ArrayExtensions.ToArrayOrNull<T>(T)
    EventExtensions.ToDelta<T>(T, string, int, string, bool)
    EventExtensions.ToDone<T>(T, string, int, string)
    EventExtensions.ToEvent<T>(T)
    EventExtensions.UpcastDelta<T1, T2>(T1, string, int, string, bool)
    FallbackExtensions.IsOr<TParent, TChild>(TParent, TChild)
    ResponseCastingExtensions.GetResult<T>(T)
    SystemExtensions.GetName(object)
    • Edit this page
    • View Source
    In this article
    Back to top AI DevKit Documentation