Class RawReferenceImage

A raw reference image.

A raw reference image represents the base image to edit, provided by the user. It can optionally be provided in addition to a mask reference image or a style reference image.

Constructors

constructor

Properties

referenceId? referenceImage? referenceType?

Methods

toReferenceImageAPI

Constructors

constructor

Properties

OptionalreferenceId

referenceId?: number

The id of the reference image.

OptionalreferenceImage

referenceImage?: Image

The reference image for the editing operation.

OptionalreferenceType

referenceType?: string

The type of the reference image. Only set by the SDK.

Methods

toReferenceImageAPI

  • toReferenceImageAPI(): ReferenceImageAPIInternal

    Internal method to convert to ReferenceImageAPIInternal.

    Returns ReferenceImageAPIInternal

Settings

On This Page

Constructors
Properties
Methods