Interface MaskReferenceImage

A mask reference image.

This encapsulates either a mask image provided by the user and configs for the user provided mask, or only config parameters for the model to generate a mask.

A mask image is an image whose non-zero values indicate where to edit the base image. If the user provides a mask image, the mask must be in the same dimensions as the raw image.

interface MaskReferenceImage {
    config?: MaskReferenceConfig;
    referenceId?: number;
    referenceImage?: Image;
    referenceType?: string;
}

Properties

config? referenceId? referenceImage? referenceType?

Properties

Optionalconfig

config?: MaskReferenceConfig

Configuration for the mask reference image.

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.

Settings

On This Page

Properties
MMNEPVFCICPMFPCPTTAAATR