LowLevelBuffer

init

static init(descriptor: LowLevelBuffer_Descriptor): LowLevelBuffer

init(descriptor: LowLevelBuffer.Descriptor) throws

descriptor

get descriptor(): LowLevelBuffer_Descriptor

final let descriptor: LowLevelBuffer.Descriptor

withUnsafeBytes

withUnsafeBytes(callback: ((arg0: ArrayBuffer) => void)): void

final func withUnsafeBytes(_ callback: (UnsafeRawBufferPointer) -> Void)

Read the buffer synchronously on the CPU. The buffer provided is only valid for the lifetime of the callback.

withUnsafeMutableBytes

withUnsafeMutableBytes(callback: ((arg0: ArrayBuffer) => void)): void

final func withUnsafeMutableBytes(_ callback: (UnsafeMutableRawBufferPointer) -> Void)

Update the buffer's contents synchronously on the CPU. The buffer provided is only valid for the lifetime of the callback.

replaceUnsafeMutableBytes

replaceUnsafeMutableBytes(callback: ((arg0: ArrayBuffer) => void)): void

final func replaceUnsafeMutableBytes(_ callback: (UnsafeMutableRawBufferPointer) -> Void)

Replace the buffer's contents synchronously on the CPU. The buffer's contents are unspecified, and it is the caller's responsibility to populate the buffer with valid data. The buffer provided is only valid for the lifetime of the callback.

read

read(commandBuffer: SDKHandle): SDKHandle

final func read(using commandBuffer: any MTLCommandBuffer) -> any MTLBuffer

Retrieve the current contents of the buffer, for GPU reading.

replace

replace(commandBuffer: SDKHandle): SDKHandle

final func replace(using commandBuffer: any MTLCommandBuffer) -> any MTLBuffer

Retrieve an MTLBuffer that can be used to replace the contents of the buffer on GPU using Metal. The buffer's contents are in an uninitialized state. The caller supplies the MTLCommandBuffer that they intend to use for buffer modifications. RealityKit will wait for the MTLCommandBuffer to complete before utilizing the buffer for rendering.

bytesUsed

get bytesUsed(): number

final var bytesUsed: Int { get set }

bytesUsed

set bytesUsed(value: number)

final var bytesUsed: Int { get set }