Class PixelRotationRequest

Request for rotating pixel-art viewpoint/direction.

Inheritance
object
UnifiedApiRequestBase<PixelRotationRequest, Generated<IImageAsset>, IPixelArtRotationOptions>
GenerativeRequest<PixelRotationRequest, ImagePrompt, IImageAsset, IPixelArtRotationOptions>
PixelArtRequest<PixelRotationRequest, ImagePrompt, IPixelArtRotationOptions>
PixelRotationRequest
Implements
Inherited Members
Namespace: Glitch9.AIDevKit.PixelArt
Assembly: Glitch9.AIDevKit.PixelArt.dll
Syntax
public sealed class PixelRotationRequest : PixelArtRequest<PixelRotationRequest, ImagePrompt, IPixelArtRotationOptions>, IGenerativeRequest

Constructors

| Edit this page View Source

PixelRotationRequest(ImagePrompt)

Creates a pixel-art rotation request.

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

Properties

| Edit this page View Source

DirectionChange

Optional. How many degrees to rotate the subject Min: -180, Max: 180

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

FallbackModel

Declaration
protected override string FallbackModel { get; }
Property Value
Type Description
string
Overrides
| Edit this page View Source

FromDirection

Optional. Source direction.

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

FromView

Optional. Source camera view.

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

ImageGuidanceScale

Optional. How closely to follow the reference image Min: 1, Max: 20, Default: 3

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

InitialImage

Optional. A base64 encoded image.

Declaration
public File<Texture2D> InitialImage { get; set; }
Property Value
Type Description
File<Texture2D>
| Edit this page View Source

ObliqueProjection

Optional. Generate in oblique projection

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

RequestType

The endpoint type for this

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

ToDirection

Optional. Target direction.

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

ToView

Optional. Target camera view.

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

ViewChange

Optional. How many degrees to tilt the subject Min: -90, Max: 90

Declaration
public int? ViewChange { get; set; }
Property Value
Type Description
int?

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
| Edit this page View Source

SetDescription(string)

Sets description text for rotation guidance.

Declaration
public PixelRotationRequest SetDescription(string description)
Parameters
Type Name Description
string description
Returns
Type Description
PixelRotationRequest
| Edit this page View Source

SetDirectionChange(int)

Sets direction change angle.

Declaration
public PixelRotationRequest SetDirectionChange(int directionChange)
Parameters
Type Name Description
int directionChange
Returns
Type Description
PixelRotationRequest
| Edit this page View Source

SetDirectionRange(SpriteDirection?, SpriteDirection?)

Sets source and target direction values.

Declaration
public PixelRotationRequest SetDirectionRange(SpriteDirection? fromDirection, SpriteDirection? toDirection)
Parameters
Type Name Description
SpriteDirection? fromDirection
SpriteDirection? toDirection
Returns
Type Description
PixelRotationRequest
| Edit this page View Source

SetImageGuidanceScale(float)

Sets image guidance scale.

Declaration
public PixelRotationRequest SetImageGuidanceScale(float imageGuidanceScale)
Parameters
Type Name Description
float imageGuidanceScale
Returns
Type Description
PixelRotationRequest
| Edit this page View Source

SetInitialImage(Texture2D)

Sets initial image.

Declaration
public PixelRotationRequest SetInitialImage(Texture2D initialImage)
Parameters
Type Name Description
Texture2D initialImage
Returns
Type Description
PixelRotationRequest
| Edit this page View Source

SetObliqueProjection(bool)

Sets oblique projection mode.

Declaration
public PixelRotationRequest SetObliqueProjection(bool obliqueProjection)
Parameters
Type Name Description
bool obliqueProjection
Returns
Type Description
PixelRotationRequest
| Edit this page View Source

SetView(SpriteCameraView?, SpriteCameraView?)

Sets source and target view values.

Declaration
public PixelRotationRequest SetView(SpriteCameraView? fromView, SpriteCameraView? toView)
Parameters
Type Name Description
SpriteCameraView? fromView
SpriteCameraView? toView
Returns
Type Description
PixelRotationRequest
| Edit this page View Source

SetViewChange(int)

Sets view change angle.

Declaration
public PixelRotationRequest SetViewChange(int viewChange)
Parameters
Type Name Description
int viewChange
Returns
Type Description
PixelRotationRequest

Implements

Extension Methods