RealityFoundation · IOS API REFERENCE

EnvironmentResource.CreateOptions

struct · iOS 18.0+ · SDK 27.1

struct CreateOptions

A type that controls compression, sampling quality, and cubemap dimensions when creating an environment resource. The options provide control for balancing memory usage, quality, and processing power when creating an environment's lighting data.

Members (10)

init · iOS 27.0+

init

TypeScript

static initSkyboxModeSamplingQualitySpecularCubeDimensionCompression(skyboxMode: EnvironmentResource_SkyboxMode, samplingQuality?: EnvironmentResource_CreateOptions_SamplingQuality, specularCubeDimension?: (number) | null, compression?: TextureResource_Compression): Promise<EnvironmentResource_CreateOptions>

Swift declaration

init(skyboxMode: EnvironmentResource.SkyboxMode, samplingQuality: EnvironmentResource.CreateOptions.SamplingQuality = .fast, specularCubeDimension: Int? = nil, compression: EnvironmentResource.Compression = .default)

Creates an environment creation options structure. - Parameters: - samplingQuality: The skybox sampling quality for lighting textures. - specularCubeDimension: The dimension of the computed specular cubemap for material reflections. - compression: The compression to apply to environment textures. - skyboxMode: Skybox's preservation in the environment resource. - Note: The skybox is not needed for image based lighting with `VirtualEnvironmentProbeComponent` and `ImageBasedLightComponent`.

get · iOS 27.0+

skyboxMode

TypeScript

get skyboxMode(): Promise<EnvironmentResource_SkyboxMode>

Swift declaration

var skyboxMode: EnvironmentResource.SkyboxMode { get set }

Skybox's preservation in the environment resource.

set · iOS 27.0+

skyboxMode

TypeScript

setSkyboxMode(value: EnvironmentResource_SkyboxMode): Promise<void>

Swift declaration

var skyboxMode: EnvironmentResource.SkyboxMode { get set }

Skybox's preservation in the environment resource.

get · iOS 18.0+

compression

TypeScript

get compression(): Promise<TextureResource_Compression>

Swift declaration

var compression: EnvironmentResource.Compression

The compression to apply to environment textures.

set · iOS 18.0+

compression

TypeScript

setCompression(value: TextureResource_Compression): Promise<void>

Swift declaration

var compression: EnvironmentResource.Compression

The compression to apply to environment textures.

init · iOS 18.0+

init

TypeScript

static initSamplingQualitySpecularCubeDimensionCompression(samplingQuality?: EnvironmentResource_CreateOptions_SamplingQuality, specularCubeDimension?: (number) | null, compression?: TextureResource_Compression): Promise<EnvironmentResource_CreateOptions>

Swift declaration

init(samplingQuality: EnvironmentResource.CreateOptions.SamplingQuality = .fast, specularCubeDimension: Int? = nil, compression: EnvironmentResource.Compression = .default)

get · iOS 18.0+

samplingQuality

TypeScript

get samplingQuality(): Promise<EnvironmentResource_CreateOptions_SamplingQuality>

Swift declaration

var samplingQuality: EnvironmentResource.CreateOptions.SamplingQuality

The skybox sampling quality for lighting textures.

set · iOS 18.0+

samplingQuality

TypeScript

setSamplingQuality(value: EnvironmentResource_CreateOptions_SamplingQuality): Promise<void>

Swift declaration

var samplingQuality: EnvironmentResource.CreateOptions.SamplingQuality

The skybox sampling quality for lighting textures.

get · iOS 18.0+

specularCubeDimension

TypeScript

get specularCubeDimension(): Promise<(number) | null>

Swift declaration

var specularCubeDimension: Int?

The dimension of the computed specular cubemap for material reflections. If `nil`, the environment resource uses the source cubemap's dimensions. A value lower than that of the cubemap helps to reduce the memory footprint in scenes where you view skybox details through specular reflections. - Note: The specular cube dimension clamps to the source cubemap's dimensions if it exceeds them.

set · iOS 18.0+

specularCubeDimension

TypeScript

setSpecularCubeDimension(value?: (number) | null): Promise<void>

Swift declaration

var specularCubeDimension: Int?

Skipped declarations

No declarations were skipped in this snapshot.

All RealityFoundation types →