One Logo Pool Ball
RealityFoundation · IOS API REFERENCE

ClippingComponent.FeatheredEdge

struct · iOS 27.0+ · SDK 27.1

struct FeatheredEdge

Configuration for feathering the clipping boundaries. Feathering is defined separately for positive and negative edges of each axis, providing fine-grained control over how content fades out near the clipping bounds.

Members (8)

get · iOS 27.0+

negativeEdgeInset

TypeScript
get negativeEdgeInset(): SDKHandle
Swift declaration
var negativeEdgeInset: SIMD3<Float>

The distance from each negative edge (-X, -Y, -Z) of the clip bounds over which opacity fades to 0, expressed in local coordinate space units. Values range from `0.0` to the half-extent of the bounding box on each axis. For example: - `0.0` means no feathering on that edge. - An inset distance value of `2.0` on X axis creates a 2-unit feather zone inward from the -X edge.

set · iOS 27.0+

negativeEdgeInset

TypeScript
set negativeEdgeInset(value: SDKHandle)
Swift declaration
var negativeEdgeInset: SIMD3<Float>

The distance from each negative edge (-X, -Y, -Z) of the clip bounds over which opacity fades to 0, expressed in local coordinate space units. Values range from `0.0` to the half-extent of the bounding box on each axis. For example: - `0.0` means no feathering on that edge. - An inset distance value of `2.0` on X axis creates a 2-unit feather zone inward from the -X edge.

get · iOS 27.0+

positiveEdgeInset

TypeScript
get positiveEdgeInset(): SDKHandle
Swift declaration
var positiveEdgeInset: SIMD3<Float>

The distance from each positive edge (+X, +Y, +Z) of the clip bounds over which opacity fades to 0, expressed in local coordinate space units. Values range from `0.0` to the half-extent of the bounding box on each axis. For example: - `0.0` means no feathering on that edge. - An inset distance value of `2.0`on X axis creates a 2-unit feather zone inward from the +X edge.

set · iOS 27.0+

positiveEdgeInset

TypeScript
set positiveEdgeInset(value: SDKHandle)
Swift declaration
var positiveEdgeInset: SIMD3<Float>

The distance from each positive edge (+X, +Y, +Z) of the clip bounds over which opacity fades to 0, expressed in local coordinate space units. Values range from `0.0` to the half-extent of the bounding box on each axis. For example: - `0.0` means no feathering on that edge. - An inset distance value of `2.0`on X axis creates a 2-unit feather zone inward from the +X edge.

init · iOS 27.0+

init

TypeScript
static init(symmetricEdgeInset?: SDKHandle, falloff?: ClippingComponent_FeatheredEdge_Falloff): ClippingComponent_FeatheredEdge
Swift declaration
init(symmetricEdgeInset: SIMD3<Float> = .zero, falloff: ClippingComponent.FeatheredEdge.Falloff = .linear)

Initializes both ``positiveEdgeInset`` and ``negativeEdgeInset`` with the same symmetric value.

get · iOS 27.0+

none

TypeScript
static get none(): ClippingComponent_FeatheredEdge
Swift declaration
static var none: ClippingComponent.FeatheredEdge { get }
get · iOS 27.0+

falloff

TypeScript
get falloff(): ClippingComponent_FeatheredEdge_Falloff
Swift declaration
var falloff: ClippingComponent.FeatheredEdge.Falloff

The falloff function used for the feathered edge computation.

set · iOS 27.0+

falloff

TypeScript
set falloff(value: ClippingComponent_FeatheredEdge_Falloff)
Swift declaration
var falloff: ClippingComponent.FeatheredEdge.Falloff

The falloff function used for the feathered edge computation.

Skipped declarations

No declarations were skipped in this snapshot.

All RealityFoundation types →