RealityFoundation · IOS API REFERENCE

HoverEffectComponent.SpotlightHoverEffectStyle

struct · iOS 18.0+ · SDK 27.1

struct SpotlightHoverEffectStyle

A type that configures the visual aspects of a spotlight hover effect for an entity.

Members (5)

get · iOS 18.0+

opacityFunction

TypeScript

get opacityFunction(): HoverEffectComponent_OpacityFunction

Swift declaration

var opacityFunction: HoverEffectComponent.OpacityFunction

The blending technique the hover effect applies to the entity's base material. The property's default value is ``HoverEffectComponent/OpacityFunction/full``.

set · iOS 18.0+

opacityFunction

TypeScript

set opacityFunction(value: HoverEffectComponent_OpacityFunction)

Swift declaration

var opacityFunction: HoverEffectComponent.OpacityFunction

The blending technique the hover effect applies to the entity's base material. The property's default value is ``HoverEffectComponent/OpacityFunction/full``.

get · iOS 18.0+

default

TypeScript

static get default(): HoverEffectComponent_SpotlightHoverEffectStyle

Swift declaration

static let `default`: HoverEffectComponent.SpotlightHoverEffectStyle

The default style applies a white spotlight glow at the hover location.

get · iOS 18.0+

strength

TypeScript

get strength(): number

Swift declaration

var strength: Float

A floating-point value that represents the intensity of the effect. The `strength` has a default value of `1.0`. Higher values increase the intensity of the effect, making it more prominent, while lower values decrease it. Set this value to `0.0` to stop the effect from displaying.

set · iOS 18.0+

strength

TypeScript

set strength(value: number)

Swift declaration

var strength: Float

Skipped declarations

No declarations were skipped in this snapshot.

All RealityFoundation types →