<!--
{
  "availability" : [
    "iOS: 18.0.0 -",
    "iPadOS: 18.0.0 -",
    "macOS: 15.0.0 -",
    "tvOS: 18.0.0 -",
    "visionOS: 2.0.0 -",
    "watchOS: 27.0.0 -"
  ],
  "documentType" : "symbol",
  "framework" : "Vision",
  "identifier" : "/documentation/Vision/GenerateForegroundInstanceMaskRequest",
  "metadataVersion" : "0.1.0",
  "role" : "Structure",
  "symbol" : {
    "kind" : "Structure",
    "modules" : [
      "Vision"
    ],
    "preciseIdentifier" : "s:6Vision37GenerateForegroundInstanceMaskRequestV"
  },
  "title" : "GenerateForegroundInstanceMaskRequest"
}
-->

# GenerateForegroundInstanceMaskRequest

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

```
struct GenerateForegroundInstanceMaskRequest
```

## Overview

This request generates an [`InstanceMaskObservation`](/documentation/Vision/InstanceMaskObservation) object with instance-mask data.

## Topics

### Creating a request

[`init(_:)`](/documentation/Vision/GenerateForegroundInstanceMaskRequest/init(_:))

Creates a foreground instance-mask request.

### Performing a request

[`perform(on:orientation:)`](/documentation/Vision/ImageProcessingRequest/perform(on:orientation:)-80bya)

Performs the request on an image URL and produces observations.

[`perform(on:orientation:)`](/documentation/Vision/ImageProcessingRequest/perform(on:orientation:)-3f3f1)

Performs the request on image data and produces observations.

[`perform(on:orientation:)`](/documentation/Vision/ImageProcessingRequest/perform(on:orientation:)-qxxx)

Performs the request on a Core Graphics image and produces observations.

[`perform(on:orientation:)`](/documentation/Vision/ImageProcessingRequest/perform(on:orientation:)-xspx)

Performs the request on a pixel buffer and produces observations.

[`perform(on:orientation:)`](/documentation/Vision/ImageProcessingRequest/perform(on:orientation:)-3hddl)

Performs the request on a Core Media buffer and produces observations.

[`perform(on:orientation:)`](/documentation/Vision/ImageProcessingRequest/perform(on:orientation:)-85ex1)

Performs the request on a Core Image image and produces observations.

### Understanding the result

[`InstanceMaskObservation`](/documentation/Vision/InstanceMaskObservation)

An observation that contains an instance mask that labels instances in the mask.

### Getting the revision

[`revision`](/documentation/Vision/GenerateForegroundInstanceMaskRequest/revision-swift.property)

The algorithm or implementation the request uses.

[`supportedRevisions`](/documentation/Vision/GenerateForegroundInstanceMaskRequest/supportedRevisions)

The collection of revisions the request supports.

[`Revision`](/documentation/Vision/GenerateForegroundInstanceMaskRequest/Revision-swift.enum)

A type that describes the algorithm or implementation that the request performs.

## Relationships

### Conforms To

[`Sendable`](/documentation/Swift/Sendable)

[`SendableMetatype`](/documentation/Swift/SendableMetatype)

[`ImageProcessingRequest`](/documentation/Vision/ImageProcessingRequest)

[`CustomStringConvertible`](/documentation/Swift/CustomStringConvertible)

[`VisionRequest`](/documentation/Vision/VisionRequest)

[`Equatable`](/documentation/Swift/Equatable)

[`Hashable`](/documentation/Swift/Hashable)

---

Copyright &copy; 2026 Apple Inc. All rights reserved. | [Terms of Use](https://www.apple.com/legal/internet-services/terms/site.html) | [Privacy Policy](https://www.apple.com/privacy/privacy-policy)