<!--
{
  "availability" : [
    "iOS: 26.4.0 -",
    "iPadOS: 26.4.0 -",
    "macCatalyst: 26.4.0 -",
    "macOS: 26.0.0 -",
    "visionOS: 26.0.0 -"
  ],
  "documentType" : "symbol",
  "framework" : "ImmersiveMediaSupport",
  "identifier" : "/documentation/ImmersiveMediaSupport/ImmersiveVideoMask",
  "metadataVersion" : "0.1.0",
  "role" : "Structure",
  "symbol" : {
    "kind" : "Structure",
    "modules" : [
      "Immersive Media Support"
    ],
    "preciseIdentifier" : "s:21ImmersiveMediaSupport0A9VideoMaskV"
  },
  "title" : "ImmersiveVideoMask"
}
-->

# ImmersiveVideoMask

A video mask to use during video rendering to smooth the edges of the mesh.

```
struct ImmersiveVideoMask
```

## Overview

This type holds the generated video mask texture and its relevant information.

## Topics

### Initializers

### Instance Properties

[`var layout: ImmersiveVideoMask.Layout`](/documentation/ImmersiveMediaSupport/ImmersiveVideoMask/layout-swift.property)

The layout of this mask, see [`ImmersiveVideoMask.Layout`](/documentation/ImmersiveMediaSupport/ImmersiveVideoMask/Layout-swift.enum) for more details.

[`var texture: any MTLTexture`](/documentation/ImmersiveMediaSupport/ImmersiveVideoMask/texture)

The mask texture ready for rendering.

### Enumerations

[`enum Layout`](/documentation/ImmersiveMediaSupport/ImmersiveVideoMask/Layout-swift.enum)

A value that represents the layout of the video mask.

### Operators

[`static func == (ImmersiveVideoMask, ImmersiveVideoMask) -> Bool`](/documentation/ImmersiveMediaSupport/ImmersiveVideoMask/==(_:_:))

Compares two masks.

### Initializers

[`init(layout: ImmersiveVideoMask.Layout, isInEquirectangularProjection: Bool, texture: any MTLTexture)`](/documentation/ImmersiveMediaSupport/ImmersiveVideoMask/init(layout:isInEquirectangularProjection:texture:))

Creates an immersive video mask object.

### Instance Properties

[`var isInEquirectangularProjection: Bool`](/documentation/ImmersiveMediaSupport/ImmersiveVideoMask/isInEquirectangularProjection)

A Boolean value that indicates whether the generated mask texture is in equirectangular projection space.
If `true`, the app renderer needs to transform vertices of the mesh to equirectangular projection space to generate UVs to access the mask texture.

## Relationships

### Conforms To

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

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

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

---

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)