Vision · IOS API REFERENCE

GenerateForegroundInstanceMaskRequest

struct · iOS 18.0+ · SDK 27.1

struct GenerateForegroundInstanceMaskRequest

A request that generates an instance mask of noticeable objects to separate from the background.

Members (8)

get · iOS 18.0+

descriptor

TypeScript

get descriptor(): RequestDescriptor

Swift declaration

var descriptor: RequestDescriptor { get }

An enum that identifies the request and request revision.

get · iOS 18.0+

regionOfInterest

TypeScript

get regionOfInterest(): NormalizedRect

Swift declaration

var regionOfInterest: NormalizedRect

The region of the image in which Vision will perform the request. The rectangle is normalized to the dimensions of the processed image. Its origin is specified relative to the image's lower-left corner. By default, the region of interest will be the full image.

set · iOS 18.0+

regionOfInterest

TypeScript

set regionOfInterest(value: NormalizedRect)

Swift declaration

var regionOfInterest: NormalizedRect

method · iOS 18.0+

setComputeDevice

TypeScript

setComputeDevice(computeDevice: (_CoreML_MLComputeDevice) | null, computeStage: ComputeStage): void

Swift declaration

mutating func setComputeDevice(_ computeDevice: MLComputeDevice?, for computeStage: ComputeStage)

Assigns a compute device for a compute stage. If the parameter `computeDevice` is `nil`, the framework removes any explicit compute device assignment and allows the framework to select the device. Configure any compute device for a given compute stage. When performing a request, the system makes a validity check. Use `supportedComputeStageDevices` to get valid compute devices for a request’s compute stages. - Parameters: - `computeDevice: `The compute device to assign to the compute stage. - `computeStage: `The compute stage.

get · iOS 18.0+

supportedRevisions

TypeScript

static get supportedRevisions(): Array<GenerateForegroundInstanceMaskRequest_Revision>

Swift declaration

static let supportedRevisions: [GenerateForegroundInstanceMaskRequest.Revision]

The collection of currently-supported revisions for `GenerateForegroundInstanceMaskRequest`.

get · iOS 18.0+

supportedComputeStageDevices

TypeScript

get supportedComputeStageDevices(): NativeMap<ComputeStage, Array<_CoreML_MLComputeDevice>>

Swift declaration

var supportedComputeStageDevices: [ComputeStage : [MLComputeDevice]] { get }

get · iOS 18.0+

revision

TypeScript

get revision(): GenerateForegroundInstanceMaskRequest_Revision

Swift declaration

let revision: GenerateForegroundInstanceMaskRequest.Revision

The request's configured revision.

init · iOS 18.0+

init

TypeScript

static init(revision?: (GenerateForegroundInstanceMaskRequest_Revision) | null): GenerateForegroundInstanceMaskRequest

Swift declaration

init(_ revision: GenerateForegroundInstanceMaskRequest.Revision? = nil)

- Parameters: - revision: The specific algorithm or implementation revision that is to be used to perform the request.

Skipped declarations

No declarations were skipped in this snapshot.

All Vision types →