Search Results for

    Show / Hide Table of Contents

    Class PixelGenerationRequest

    Request for generating a pixel-art image from text prompt.

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

    Constructors

    | Edit this page View Source

    PixelGenerationRequest(Prompt)

    Creates a pixel-art generation request.

    Declaration
    public PixelGenerationRequest(Prompt prompt)
    Parameters
    Type Name Description
    Prompt prompt

    Properties

    | Edit this page View Source

    Direction

    Optional target direction metadata for consumers that place outputs into directional cells. Providers that don't support direction can ignore this at API layer.

    Declaration
    public SpriteDirection? Direction { get; set; }
    Property Value
    Type Description
    SpriteDirection?
    | Edit this page View Source

    FallbackModel

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

    RequestType

    The endpoint type for this

    Declaration
    public override RequestType RequestType { get; }
    Property Value
    Type Description
    RequestType
    Overrides
    UnifiedApiRequestBase<PixelGenerationRequest, Generated<IImageAsset>, IPixelArtGenerationOptions>.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<PixelGenerationRequest, Generated<IImageAsset>, IPixelArtGenerationOptions>.ExecuteAsyncInternal()
    | Edit this page View Source

    SetDirection(SpriteDirection?)

    Declaration
    public PixelGenerationRequest SetDirection(SpriteDirection? direction)
    Parameters
    Type Name Description
    SpriteDirection? direction
    Returns
    Type Description
    PixelGenerationRequest

    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