ComputeGraph · IOS API REFERENCE

ComputeGraphSimulation.AdvanceParams

struct · iOS 27.0+ · SDK 27.1

struct AdvanceParams

Parameters for advancing a compute graph simulation by one time step.

Members (18)

get · iOS 27.0+

localToWorld

TypeScript

get localToWorld(): SDKHandle

Swift declaration

var localToWorld: simd_float4x4

The transform from the system's local space to world space. How this matrix is applied depends on the graph's coordinateSpace.

set · iOS 27.0+

localToWorld

TypeScript

set localToWorld(value: SDKHandle)

Swift declaration

var localToWorld: simd_float4x4

The transform from the system's local space to world space. How this matrix is applied depends on the graph's coordinateSpace.

get · iOS 27.0+

viewPosition

TypeScript

get viewPosition(): (SDKHandle) | null

Swift declaration

var viewPosition: SIMD3<Float>?

The position of the viewer in world space. When provided, this value can be used for billboarding or read within the graph for viewer-relative effects.

set · iOS 27.0+

viewPosition

TypeScript

set viewPosition(value: (SDKHandle) | null)

Swift declaration

var viewPosition: SIMD3<Float>?

The position of the viewer in world space. When provided, this value can be used for billboarding or read within the graph for viewer-relative effects.

get · iOS 27.0+

worldToLocal

TypeScript

get worldToLocal(): SDKHandle

Swift declaration

var worldToLocal: simd_float4x4

The transform from world space to the system's local space. How this matrix is applied depends on the graph's coordinateSpace.

set · iOS 27.0+

worldToLocal

TypeScript

set worldToLocal(value: SDKHandle)

Swift declaration

var worldToLocal: simd_float4x4

The transform from world space to the system's local space. How this matrix is applied depends on the graph's coordinateSpace.

get · iOS 27.0+

commandBuffer

TypeScript

get commandBuffer(): SDKHandle

Swift declaration

var commandBuffer: any MTLCommandBuffer

The command buffer to encode simulation commands into.

set · iOS 27.0+

commandBuffer

TypeScript

set commandBuffer(value: SDKHandle)

Swift declaration

var commandBuffer: any MTLCommandBuffer

The command buffer to encode simulation commands into.

get · iOS 27.0+

viewDirection

TypeScript

get viewDirection(): (SDKHandle) | null

Swift declaration

var viewDirection: SIMD3<Float>?

The forward direction of the viewer in world space. When provided, this value can be used for billboarding or read within the graph for viewer-relative effects.

set · iOS 27.0+

viewDirection

TypeScript

set viewDirection(value: (SDKHandle) | null)

Swift declaration

var viewDirection: SIMD3<Float>?

The forward direction of the viewer in world space. When provided, this value can be used for billboarding or read within the graph for viewer-relative effects.

get · iOS 27.0+

computeEncoder

TypeScript

get computeEncoder(): SDKHandle

Swift declaration

var computeEncoder: any MTLComputeCommandEncoder

The compute command encoder to encode simulation dispatches with.

set · iOS 27.0+

computeEncoder

TypeScript

set computeEncoder(value: SDKHandle)

Swift declaration

var computeEncoder: any MTLComputeCommandEncoder

The compute command encoder to encode simulation dispatches with.

get · iOS 27.0+

maxSteps

TypeScript

get maxSteps(): number

Swift declaration

var maxSteps: Int

The maximum number of fixed-size steps per advance. This value is only used when ``SimulationRate/mode`` is ``SimulationRate/Mode-swift.enum/fixedFrequency`` or ``SimulationRate/Mode-swift.enum/fixedTime``.

set · iOS 27.0+

maxSteps

TypeScript

set maxSteps(value: number)

Swift declaration

var maxSteps: Int

init · iOS 27.0+

init

TypeScript

static initDeltaTimeCommandBufferComputeEncoderLocalToWorldWorldToLocalViewPositionViewDirection(deltaTime: number, commandBuffer: SDKHandle, computeEncoder: SDKHandle, localToWorld: SDKHandle, worldToLocal: SDKHandle, viewPosition?: (SDKHandle) | null, viewDirection?: (SDKHandle) | null): ComputeGraphSimulation_AdvanceParams

Swift declaration

init(deltaTime: Float, commandBuffer: any MTLCommandBuffer, computeEncoder: any MTLComputeCommandEncoder, localToWorld: simd_float4x4, worldToLocal: simd_float4x4, viewPosition: SIMD3<Float>? = nil, viewDirection: SIMD3<Float>? = nil)

init · iOS 27.0+

init

TypeScript

static initDeltaTimeCommandBufferComputeEncoder(deltaTime: number, commandBuffer: SDKHandle, computeEncoder: SDKHandle): ComputeGraphSimulation_AdvanceParams

Swift declaration

init(deltaTime: Float, commandBuffer: any MTLCommandBuffer, computeEncoder: any MTLComputeCommandEncoder)

Creates advance parameters with the required Metal objects. - Parameters: - deltaTime: The time interval, in seconds, to advance the simulation. - commandBuffer: The command buffer to encode simulation commands into. - computeEncoder: The compute command encoder to use.

get · iOS 27.0+

deltaTime

TypeScript

get deltaTime(): number

Swift declaration

var deltaTime: Float

The time interval, in seconds, to advance the simulation. When ``SimulationRate/mode`` is ``SimulationRate/Mode-swift.enum/fixedFrequency`` or ``SimulationRate/Mode-swift.enum/fixedTime``, the simulation takes between zero and ``maxSteps`` fixed-size steps to consume this interval. Any remaining time is accumulated and carried into the next advance.

set · iOS 27.0+

deltaTime

TypeScript

set deltaTime(value: number)

Swift declaration

var deltaTime: Float

Skipped declarations

No declarations were skipped in this snapshot.

All ComputeGraph types →