AREnvironmentProbeAnchor

Inherits: RefCounted < Object

An anchor that captures environment lighting for realistic reflections.

Description

Represents a captured environment texture probe at a specific location and extent. Generated automatically when environmentTexturing is set to AUTOMATIC on the configuration. iOS only. On visionOS and macOS, this type exists for API consistency but is never populated with real data.

Properties

Vector3

extent

Vector3(0, 0, 0)

bool

has_environment_texture

false

String

identifier

""

int

texture_height

0

int

texture_width

0

Transform3D

transform

Transform3D(1, 0, 0, 0, 1, 0, 0, 0, 1, 0, 0, 0)

Property Descriptions

Vector3 extent = Vector3(0, 0, 0) 🔗

  • void set_extent(value: Vector3)

  • Vector3 get_extent()

The size of the region covered by this environment probe.

bool has_environment_texture = false 🔗

  • void set_has_environment_texture(value: bool)

  • bool get_has_environment_texture()

Whether the probe currently contains a captured environment texture.

String identifier = "" 🔗

  • void set_identifier(value: String)

  • String get_identifier()

A unique identifier for this environment probe anchor.

int texture_height = 0 🔗

  • void set_texture_height(value: int)

  • int get_texture_height()

The height of the captured environment texture in pixels.

int texture_width = 0 🔗

  • void set_texture_width(value: int)

  • int get_texture_width()

The width of the captured environment texture in pixels.

Transform3D transform = Transform3D(1, 0, 0, 0, 1, 0, 0, 0, 1, 0, 0, 0) 🔗

  • void set_transform(value: Transform3D)

  • Transform3D get_transform()

The probe transform in world space.