RealityFoundation · IOS API REFERENCE

PhysicallyBasedDecalComponent

struct · iOS 27.0+ · SDK 27.1

struct PhysicallyBasedDecalComponent

A component that specifies a decal to be applied on the scene. A decal is essentially a projective texture applied to any mesh on the scene. The transform of the decal is inherited from the entity's transform. The decal is projected along the local space negative z onto the meshes within its volume. All decal textures expect 2D texture resources. Decal textures do not support custom sampler, UV index, or swizzle options from ``PhysicallyBasedMaterial`` parameter types. All textures are sampled using bilinear filtering, projected UVs from the decal volume, and fixed channel mapping. Decals are available on devices with Apple6 GPU family feature support.

Members (24)

get · iOS 27.0+

receiverEntities

TypeScript

get receiverEntities(): Array<Entity>

Swift declaration

var receiverEntities: Set<Entity>

An optional set of receiver entities that are not part of any layers. The limit on the number of receiver entities is 8, extra entities are ignored.

set · iOS 27.0+

receiverEntities

TypeScript

set receiverEntities(value: Array<Entity>)

Swift declaration

var receiverEntities: Set<Entity>

An optional set of receiver entities that are not part of any layers. The limit on the number of receiver entities is 8, extra entities are ignored.

get · iOS 27.0+

bounds

TypeScript

get bounds(): SDKHandle

Swift declaration

var bounds: SIMD3<Float>

The bounds of the decal volume defined in entity local space.

set · iOS 27.0+

bounds

TypeScript

set bounds(value: SDKHandle)

Swift declaration

var bounds: SIMD3<Float>

The bounds of the decal volume defined in entity local space.

get · iOS 27.0+

layers

TypeScript

get layers(): RenderLayer_Set

Swift declaration

var layers: RenderLayer.Set

The layers this decal affects. Only entities whose ``RenderLayerComponent/layers`` intersect with these layers will be affected.

set · iOS 27.0+

layers

TypeScript

set layers(value: RenderLayer_Set)

Swift declaration

var layers: RenderLayer.Set

The layers this decal affects. Only entities whose ``RenderLayerComponent/layers`` intersect with these layers will be affected.

get · iOS 27.0+

normal

TypeScript

get normal(): (PhysicallyBasedMaterial_Normal) | null

Swift declaration

var normal: PhysicallyBasedMaterial.Normal?

An optional normal texture for the decal.

set · iOS 27.0+

normal

TypeScript

set normal(value: (PhysicallyBasedMaterial_Normal) | null)

Swift declaration

var normal: PhysicallyBasedMaterial.Normal?

An optional normal texture for the decal.

get · iOS 27.0+

opacity

TypeScript

get opacity(): (PhysicallyBasedMaterial_Opacity) | null

Swift declaration

var opacity: PhysicallyBasedMaterial.Opacity?

An optional opacity texture for the decal.

set · iOS 27.0+

opacity

TypeScript

set opacity(value: (PhysicallyBasedMaterial_Opacity) | null)

Swift declaration

var opacity: PhysicallyBasedMaterial.Opacity?

An optional opacity texture for the decal.

get · iOS 27.0+

emissive

TypeScript

get emissive(): (PhysicallyBasedMaterial_EmissiveColor) | null

Swift declaration

var emissive: PhysicallyBasedMaterial.EmissiveColor?

An optional emissive texture for the decal.

set · iOS 27.0+

emissive

TypeScript

set emissive(value: (PhysicallyBasedMaterial_EmissiveColor) | null)

Swift declaration

var emissive: PhysicallyBasedMaterial.EmissiveColor?

An optional emissive texture for the decal.

get · iOS 27.0+

metallic

TypeScript

get metallic(): (PhysicallyBasedMaterial_Metallic) | null

Swift declaration

var metallic: PhysicallyBasedMaterial.Metallic?

An optional metallic texture for the decal.

set · iOS 27.0+

metallic

TypeScript

set metallic(value: (PhysicallyBasedMaterial_Metallic) | null)

Swift declaration

var metallic: PhysicallyBasedMaterial.Metallic?

An optional metallic texture for the decal.

get · iOS 27.0+

specular

TypeScript

get specular(): (PhysicallyBasedMaterial_Specular) | null

Swift declaration

var specular: PhysicallyBasedMaterial.Specular?

An optional specular texture for the decal.

set · iOS 27.0+

specular

TypeScript

set specular(value: (PhysicallyBasedMaterial_Specular) | null)

Swift declaration

var specular: PhysicallyBasedMaterial.Specular?

An optional specular texture for the decal.

get · iOS 27.0+

baseColor

TypeScript

get baseColor(): (PhysicallyBasedMaterial_BaseColor) | null

Swift declaration

var baseColor: PhysicallyBasedMaterial.BaseColor?

The optional base color texture for the decal. Expects pre-multiplied alpha texture.

set · iOS 27.0+

baseColor

TypeScript

set baseColor(value: (PhysicallyBasedMaterial_BaseColor) | null)

Swift declaration

var baseColor: PhysicallyBasedMaterial.BaseColor?

The optional base color texture for the decal. Expects pre-multiplied alpha texture.

init · iOS 27.0+

init

TypeScript

static initBaseColor(baseColor: PhysicallyBasedMaterial_BaseColor): PhysicallyBasedDecalComponent

Swift declaration

init(baseColor: PhysicallyBasedMaterial.BaseColor)

Creates a new instance with ``PhysicallyBasedMaterial/BaseColor``. The tint color is multiplied with the baseColor. If base color texture is not specified, the tint color is applied as a solid color.

get · iOS 27.0+

roughness

TypeScript

get roughness(): (PhysicallyBasedMaterial_Roughness) | null

Swift declaration

var roughness: PhysicallyBasedMaterial.Roughness?

An optional roughness texture for the decal.

set · iOS 27.0+

roughness

TypeScript

set roughness(value: (PhysicallyBasedMaterial_Roughness) | null)

Swift declaration

var roughness: PhysicallyBasedMaterial.Roughness?

An optional roughness texture for the decal.

get · iOS 27.0+

sortOrder

TypeScript

get sortOrder(): number

Swift declaration

var sortOrder: Int32

The sort layer for the decal. Higher layers show up on top of lower layers.

set · iOS 27.0+

sortOrder

TypeScript

set sortOrder(value: number)

Swift declaration

var sortOrder: Int32

The sort layer for the decal. Higher layers show up on top of lower layers.

init · iOS 27.0+

init

TypeScript

static init(): PhysicallyBasedDecalComponent

Swift declaration

init()

Creates a new instance without a base color.

Skipped declarations

No declarations were skipped in this snapshot.

All RealityFoundation types →