ImmersiveMediaSupport · IOS API REFERENCE

ImmersiveVideoMask

struct · iOS 26.4+ · SDK 27.1

struct ImmersiveVideoMask

A video mask to smooth the edges of the mesh during video rendering. This type holds the generated video mask texture and its relevant information.

Members (4)

get · iOS 26.4+

isInEquirectangularProjection

TypeScript

get isInEquirectangularProjection(): boolean

Swift declaration

var isInEquirectangularProjection: Bool { get }

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.

init · iOS 26.4+

init

TypeScript

static init(layout: ImmersiveVideoMask_Layout, isInEquirectangularProjection: boolean, texture: SDKHandle): ImmersiveVideoMask

Swift declaration

init(layout: ImmersiveVideoMask.Layout, isInEquirectangularProjection: Bool, texture: any MTLTexture)

Creates an immersive video mask object. - Parameters: - layout: The layout of the mask within the texture. See ``Layout`` for valid options. - isInEquirectangularProjection: A Boolean value that indicates whether the generated mask texture is in equirectangular projection space. - texture: The MTLTexture containing the mask ready for rendering.

get · iOS 26.4+

layout

TypeScript

get layout(): ImmersiveVideoMask_Layout

Swift declaration

var layout: ImmersiveVideoMask.Layout { get }

The layout of this mask, see ``Layout-swift.enum`` for more details.

get · iOS 26.4+

texture

TypeScript

get texture(): SDKHandle

Swift declaration

var texture: any MTLTexture { get }

The mask texture ready for rendering.

Skipped declarations

No declarations were skipped in this snapshot.

All ImmersiveMediaSupport types →