ImmersiveMediaSupport · IOS API REFERENCE

ImmersiveDynamicMask

struct · iOS 26.4+ · SDK 27.1

struct ImmersiveDynamicMask

A type that holds all the information needed to dynamically generate immersive media mask during load time. Interpolation of a set of control points or sample points on the surface of a unit sphere generates the dynamic mask.

Members (15)

get · iOS 26.4+

edgeTreatment

TypeScript

get edgeTreatment(): ImmersiveDynamicMask_EdgeTreatment

Swift declaration

var edgeTreatment: ImmersiveDynamicMask.EdgeTreatment

The edge treatment type used for the immersive media mask.

set · iOS 26.4+

edgeTreatment

TypeScript

set edgeTreatment(value: ImmersiveDynamicMask_EdgeTreatment)

Swift declaration

var edgeTreatment: ImmersiveDynamicMask.EdgeTreatment

The edge treatment type used for the immersive media mask.

get · iOS 26.4+

stereoRelation

TypeScript

get stereoRelation(): ImmersiveDynamicMask_StereoRelation

Swift declaration

var stereoRelation: ImmersiveDynamicMask.StereoRelation

Represents how the left eye mask relates to the right eye mask.

set · iOS 26.4+

stereoRelation

TypeScript

set stereoRelation(value: ImmersiveDynamicMask_StereoRelation)

Swift declaration

var stereoRelation: ImmersiveDynamicMask.StereoRelation

Represents how the left eye mask relates to the right eye mask.

get · iOS 26.4+

leftControlPoints

TypeScript

get leftControlPoints(): Array<_Spatial_Point3DFloat>

Swift declaration

var leftControlPoints: [Point3DFloat]

The left eye control points.

set · iOS 26.4+

leftControlPoints

TypeScript

set leftControlPoints(value: Array<_Spatial_Point3DFloat>)

Swift declaration

var leftControlPoints: [Point3DFloat]

The left eye control points.

get · iOS 26.4+

edgeWidthInDegrees

TypeScript

get edgeWidthInDegrees(): number

Swift declaration

var edgeWidthInDegrees: Float

The edge width in degrees used for the dynamic mask generation.

set · iOS 26.4+

edgeWidthInDegrees

TypeScript

set edgeWidthInDegrees(value: number)

Swift declaration

var edgeWidthInDegrees: Float

The edge width in degrees used for the dynamic mask generation.

get · iOS 26.4+

rightControlPoints

TypeScript

get rightControlPoints(): Array<_Spatial_Point3DFloat>

Swift declaration

var rightControlPoints: [Point3DFloat]

The right eye control points.

set · iOS 26.4+

rightControlPoints

TypeScript

set rightControlPoints(value: Array<_Spatial_Point3DFloat>)

Swift declaration

var rightControlPoints: [Point3DFloat]

The right eye control points.

get · iOS 26.4+

controlPointInterpolation

TypeScript

get controlPointInterpolation(): ImmersiveDynamicMask_ControlPointInterpolation

Swift declaration

var controlPointInterpolation: ImmersiveDynamicMask.ControlPointInterpolation

Type of the interpolation method used while processing control points.

set · iOS 26.4+

controlPointInterpolation

TypeScript

set controlPointInterpolation(value: ImmersiveDynamicMask_ControlPointInterpolation)

Swift declaration

var controlPointInterpolation: ImmersiveDynamicMask.ControlPointInterpolation

Type of the interpolation method used while processing control points.

init · iOS 26.4+

init

TypeScript

static init(name: string, stereoRelation: ImmersiveDynamicMask_StereoRelation, edgeTreatment: ImmersiveDynamicMask_EdgeTreatment, controlPointInterpolation: ImmersiveDynamicMask_ControlPointInterpolation, leftControlPoints: Array<_Spatial_Point3DFloat>, rightControlPoints: Array<_Spatial_Point3DFloat>, edgeWidthInDegrees: number): ImmersiveDynamicMask

Swift declaration

init(name: String, stereoRelation: ImmersiveDynamicMask.StereoRelation, edgeTreatment: ImmersiveDynamicMask.EdgeTreatment, controlPointInterpolation: ImmersiveDynamicMask.ControlPointInterpolation, leftControlPoints: [Point3DFloat], rightControlPoints: [Point3DFloat], edgeWidthInDegrees: Float)

get · iOS 26.4+

name

TypeScript

get name(): string

Swift declaration

var name: String

A unique name string of the dynamic mask.

set · iOS 26.4+

name

TypeScript

set name(value: string)

Swift declaration

var name: String

A unique name string of the dynamic mask.

Skipped declarations

No declarations were skipped in this snapshot.

All ImmersiveMediaSupport types →