One Logo Pool Ball
RealityFoundation · IOS API REFERENCE

PhysicallyBasedMaterial.Clearcoat

struct · iOS 15.0+ · SDK 27.1

struct Clearcoat

An object that defines the intensity of an entity’s clear, shiny coating. A clearcoat is a separate layer of transparent specular highlights used to simulate a clear coating, like on a car or the surface of lacquered objects.

Members (8)

init · iOS 15.0+

init

TypeScript
static initFloatLiteral(value: number): PhysicallyBasedMaterial_Clearcoat
Swift declaration
init(floatLiteral value: Float)

Creates a clearcoat object using a single value. A clearcoat is a separate layer of transparent specular highlights used to simulate a clear transparent coating, like the paint on a car, or the surface of lacquered objects. Use this initializer to create an object to specify the amount of clearcoat for a material using a single value that applies to the entire material. - Parameters: - value: The clearcoat value to use for the entity.

get · iOS 15.0+

textureSemantic

TypeScript
static get textureSemantic(): TextureResource_Semantic
Swift declaration
static let textureSemantic: TextureResource.Semantic

The intended use of the object’s texture property.

init · iOS 15.0+

init

TypeScript
static initScaleTexture(scale?: number, texture?: (MaterialParameters_Texture) | null): PhysicallyBasedMaterial_Clearcoat
Swift declaration
init(scale: Float = 1.0, texture: PhysicallyBasedMaterial.Texture? = nil)

Creates a clearcoat object using a single value or a texture. A clearcoat is a separate layer of transparent specular highlights used to simulate a clear transparent coating, like the paint on a car, or the surface of lacquered objects. Use this initializer to create an object to specify the amount of clearcoat for a material using a single value for the entire material, a UV-mapped image to specify different values for different parts of the entity, or both. If you specify `texture`, RealityKit calculates the clearcoat intensity for the entity by UV-mapping `texture` onto the entity and multiplying the value of each mapped pixel by `scale`. If you don’t specify `texture`, then RealityKit uses `scale` as the entire entity’s clearcoat intensity value. If you provide a color image for `texture` rather than a grayscale image, RealityKit only uses the intensity of the image’s red channel. - Parameters: - scale: The clearcoat value for the entire material. - texture: The clearcoat values as the texture of a UV-mapped image.

get · iOS 15.0+

scale

TypeScript
get scale(): number
Swift declaration
var scale: Float

The clearcoat intensity specified as a single value.

set · iOS 15.0+

scale

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

The clearcoat intensity specified as a single value.

get · iOS 15.0+

texture

TypeScript
get texture(): (MaterialParameters_Texture) | null
Swift declaration
var texture: PhysicallyBasedMaterial.Texture?

The clearcoat intensity specified using a UV-mapped image.

set · iOS 15.0+

texture

TypeScript
set texture(value: (MaterialParameters_Texture) | null)
Swift declaration
var texture: PhysicallyBasedMaterial.Texture?

The clearcoat intensity specified using a UV-mapped image.

init · iOS 15.0+

init

TypeScript
static init(value: CustomMaterial_Clearcoat): PhysicallyBasedMaterial_Clearcoat
Swift declaration
init(_ value: CustomMaterial.Clearcoat)

Creates a clearcoat object from a custom material’s clearcoat property. - Parameters: - value: The custom material’s clearcoat property.

Skipped declarations

No declarations were skipped in this snapshot.

All RealityFoundation types →