One Logo Pool Ball
RealityFoundation · IOS API REFERENCE

HoverEffectComponent.HighlightHoverEffectStyle

struct · iOS 18.0+ · SDK 27.1

struct HighlightHoverEffectStyle

A type that configures the visual aspects of a highlight 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_HighlightHoverEffectStyle
Swift declaration
static let `default`: HoverEffectComponent.HighlightHoverEffectStyle

The default style applies a white uniform glow to the affect entity as well as 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. Defaults to 1.0. Higher values increase the intensity of the effect and make it more prominent while lower values decrease it. Setting this to 0.0 stops the effect from displaying.

set · iOS 18.0+

strength

TypeScript
set strength(value: number)
Swift declaration
var strength: Float

A floating-point value that represents the intensity of the effect. Defaults to 1.0. Higher values increase the intensity of the effect and make it more prominent while lower values decrease it. Setting this to 0.0 stops the effect from displaying.

Skipped declarations

No declarations were skipped in this snapshot.

All RealityFoundation types →