Class PixelArtRequest<TSelf, TInput, TOptions>

Base request for pixel-art image generation/editing calls.

Inheritance
object
UnifiedApiRequestBase<TSelf, Generated<IImageAsset>, TOptions>
GenerativeRequest<TSelf, TInput, IImageAsset, TOptions>
PixelArtRequest<TSelf, TInput, TOptions>
PixelAnimationRequest
PixelGenerationRequest
PixelInpaintingRequest
PixelRotationRequest
PixelTilesetRequest
Implements
Inherited Members
Namespace: Glitch9.AIDevKit.PixelArt
Assembly: Glitch9.AIDevKit.PixelArt.dll
Syntax
public abstract class PixelArtRequest<TSelf, TInput, TOptions> : GenerativeRequest<TSelf, TInput, IImageAsset, TOptions>, IGenerativeRequest where TSelf : PixelArtRequest<TSelf, TInput, TOptions> where TInput : IPrompt where TOptions : IPixelArtRequestOptions
Type Parameters
Name Description
TSelf
TInput
TOptions

Constructors

| Edit this page View Source

PixelArtRequest(TInput)

Declaration
protected PixelArtRequest(TInput prompt)
Parameters
Type Name Description
TInput prompt

Properties

| Edit this page View Source

ModelType

Declaration
public override ModelType ModelType { get; }
Property Value
Type Description
ModelType
Overrides
| Edit this page View Source

NegativePrompt

Optional. Text description of what to avoid in the generated image

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

NoBackground

Optional. Generate with transparent background

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

PaletteImage

Optional. Use this to guide output colors. Keep palette images small (below 1MB, recommended 200k characters or less).

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

Size

Required.

Declaration
public MediaSize? Size { get; set; }
Property Value
Type Description
MediaSize?

Methods

| Edit this page View Source

SetNegativePrompt(string)

Sets negative prompt text.

Declaration
public TSelf SetNegativePrompt(string negativePrompt)
Parameters
Type Name Description
string negativePrompt
Returns
Type Description
TSelf
| Edit this page View Source

SetNoBackground(bool)

Enables or disables transparent background.

Declaration
public TSelf SetNoBackground(bool noBackground)
Parameters
Type Name Description
bool noBackground
Returns
Type Description
TSelf
| Edit this page View Source

SetPaletteImage(Texture2D)

Declaration
public TSelf SetPaletteImage(Texture2D paletteImage)
Parameters
Type Name Description
Texture2D paletteImage
Returns
Type Description
TSelf
| Edit this page View Source

SetSize(MediaSize)

Sets output image size.

Declaration
public TSelf SetSize(MediaSize size)
Parameters
Type Name Description
MediaSize size
Returns
Type Description
TSelf
| Edit this page View Source

SetSize(SpriteSize)

Sets square output image size from sprite size enum.

Declaration
public TSelf SetSize(SpriteSize size)
Parameters
Type Name Description
SpriteSize size
Returns
Type Description
TSelf

Implements

Extension Methods