Metal macOS 10.13 Beta 1 to Beta 2 API Differences

MTLArgument.h
Removed MTLDataTypeIndirectArgument
Removed MTLArgumentTypeIndirectConstant
Removed MTLStructMember.dataTypeDescription
Removed MTLStructMember.indirectArgumentIndex
Removed MTLArrayType.elementTypeDescription
Removed MTLPointerType.elementTypeDescription
Removed MTLPointerType.elementIsIndirectArgumentBuffer
Removed MTLArgument.dataTypeDescription
Added -[MTLStructMember textureReferenceType]
Added -[MTLStructMember pointerType]
Added MTLStructMember.argumentIndex
Added MTLArrayType.argumentIndexStride
Added -[MTLArrayType elementTextureReferenceType]
Added -[MTLArrayType elementPointerType]
Added MTLPointerType.elementIsArgumentBuffer
Added -[MTLPointerType elementStructType]
Added -[MTLPointerType elementArrayType]
MTLArgumentEncoder.h
Added MTLArgumentEncoder
Added MTLArgumentEncoder.device
Added MTLArgumentEncoder.label
Added MTLArgumentEncoder.encodedLength
Added MTLArgumentEncoder.alignment
Added -[MTLArgumentEncoder setArgumentBuffer:offset:]
Added -[MTLArgumentEncoder setArgumentBuffer:startOffset:arrayElement:]
Added -[MTLArgumentEncoder setBuffer:offset:atIndex:]
Added -[MTLArgumentEncoder setBuffers:offsets:withRange:]
Added -[MTLArgumentEncoder setTexture:atIndex:]
Added -[MTLArgumentEncoder setTextures:withRange:]
Added -[MTLArgumentEncoder setSamplerState:atIndex:]
Added -[MTLArgumentEncoder setSamplerStates:withRange:]
Added -[MTLArgumentEncoder constantDataAtIndex:]
Added -[MTLArgumentEncoder newArgumentEncoderForBufferAtIndex:]
MTLBuffer.h
Modified -[MTLBuffer newTextureWithDescriptor:offset:bytesPerRow:]
Declaration
From- (nonnull id<MTLTexture>)newTextureWithDescriptor:(nonnull MTLTextureDescriptor *)descriptor offset:(NSUInteger)offset bytesPerRow:(NSUInteger)bytesPerRow
To- (nullable id<MTLTexture>)newTextureWithDescriptor:(nonnull MTLTextureDescriptor *)descriptor offset:(NSUInteger)offset bytesPerRow:(NSUInteger)bytesPerRow

MTLCommandBuffer.h
Modified -[MTLCommandBuffer blitCommandEncoder]
Declaration
From- (nonnull id<MTLBlitCommandEncoder>)blitCommandEncoder
To- (nullable id<MTLBlitCommandEncoder>)blitCommandEncoder

Modified -[MTLCommandBuffer renderCommandEncoderWithDescriptor:]
Declaration
From- (nonnull id<MTLRenderCommandEncoder>)renderCommandEncoderWithDescriptor:(nonnull MTLRenderPassDescriptor *)renderPassDescriptor
To- (nullable id<MTLRenderCommandEncoder>)renderCommandEncoderWithDescriptor:(nonnull MTLRenderPassDescriptor *)renderPassDescriptor

Modified -[MTLCommandBuffer computeCommandEncoder]
Declaration
From- (nonnull id<MTLComputeCommandEncoder>)computeCommandEncoder
To- (nullable id<MTLComputeCommandEncoder>)computeCommandEncoder

Modified -[MTLCommandBuffer parallelRenderCommandEncoderWithDescriptor:]
Declaration
From- (nonnull id<MTLParallelRenderCommandEncoder>)parallelRenderCommandEncoderWithDescriptor:(nonnull MTLRenderPassDescriptor *)renderPassDescriptor
To- (nullable id<MTLParallelRenderCommandEncoder>)parallelRenderCommandEncoderWithDescriptor:(nonnull MTLRenderPassDescriptor *)renderPassDescriptor

MTLCommandQueue.h
Modified -[MTLCommandQueue commandBuffer]
Declaration
From- (nonnull id<MTLCommandBuffer>)commandBuffer
To- (nullable id<MTLCommandBuffer>)commandBuffer

Modified -[MTLCommandQueue commandBufferWithUnretainedReferences]
Declaration
From- (nonnull id<MTLCommandBuffer>)commandBufferWithUnretainedReferences
To- (nullable id<MTLCommandBuffer>)commandBufferWithUnretainedReferences

MTLComputeCommandEncoder.h
Modified -[MTLComputeCommandEncoder useResources:count:usage:]
Declaration
From- (void)useResources:(nullable id<MTLResource> _Nullable const [])resources count:(NSUInteger)count usage:(MTLResourceUsage)usage
To- (void)useResources:(nonnull id<MTLResource> _Nonnull const [])resources count:(NSUInteger)count usage:(MTLResourceUsage)usage

Modified -[MTLComputeCommandEncoder useHeaps:count:]
Declaration
From- (void)useHeaps:(nullable id<MTLHeap> _Nullable const [])heaps count:(NSUInteger)count
To- (void)useHeaps:(nonnull id<MTLHeap> _Nonnull const [])heaps count:(NSUInteger)count

MTLComputePipeline.h
Modified MTLComputePipelineState.staticThreadgroupMemoryLength
Optional
FromOptional
ToRequired

MTLDevice.h
Removed MTLIndirectArgumentBuffersTier
Removed MTLIndirectArgumentBuffersTier1
Removed MTLIndirectArgumentBuffersTier2
Removed MTLIndirectArgumentDescriptor
Removed +[MTLIndirectArgumentDescriptor indirectArgumentDescriptor]
Removed MTLIndirectArgumentDescriptor.dataType
Removed MTLIndirectArgumentDescriptor.index
Removed MTLIndirectArgumentDescriptor.arrayLength
Removed MTLIndirectArgumentDescriptor.access
Removed MTLIndirectArgumentDescriptor.textureType
Removed MTLDevice.indirectArgumentBuffersSupport
Removed -[MTLDevice newIndirectArgumentEncoderWithArguments:]
Added MTLReadWriteTextureTierNone
Added MTLArgumentBuffersTier
Added MTLArgumentBuffersTier1
Added MTLArgumentBuffersTier2
Added MTLArgumentDescriptor
Added +[MTLArgumentDescriptor argumentDescriptor]
Added MTLArgumentDescriptor.dataType
Added MTLArgumentDescriptor.index
Added MTLArgumentDescriptor.arrayLength
Added MTLArgumentDescriptor.access
Added MTLArgumentDescriptor.textureType
Added MTLArgumentDescriptor.constantBlockAlignment
Added MTLDevice.registryID
Added MTLDevice.argumentBuffersSupport
Added MTLDevice.currentAllocatedSize
Added -[MTLDevice newArgumentEncoderWithArguments:]
Modified MTLCopyAllDevicesWithObserver()
Declaration
FromNSArray<id<MTLDevice>> * _Nonnull MTLCopyAllDevicesWithObserver(id<NSObject> _Nonnull * _Nonnull observer, MTLDeviceNotificationHandler _Nonnull handler)
ToNSArray<id<MTLDevice>> * _Nonnull MTLCopyAllDevicesWithObserver(id<NSObject> _Nullable * _Nonnull observer, MTLDeviceNotificationHandler _Nonnull handler)

Modified MTLDevice.name
Declaration
From@property (readonly, nullable) NSString *name
To@property (readonly, nonnull) NSString *name

Modified -[MTLDevice newCommandQueue]
Declaration
From- (nonnull id<MTLCommandQueue>)newCommandQueue
To- (nullable id<MTLCommandQueue>)newCommandQueue

Modified -[MTLDevice newCommandQueueWithMaxCommandBufferCount:]
Declaration
From- (nonnull id<MTLCommandQueue>)newCommandQueueWithMaxCommandBufferCount:(NSUInteger)maxCommandBufferCount
To- (nullable id<MTLCommandQueue>)newCommandQueueWithMaxCommandBufferCount:(NSUInteger)maxCommandBufferCount

Modified -[MTLDevice newHeapWithDescriptor:]
Declaration
From- (nonnull id<MTLHeap>)newHeapWithDescriptor:(nonnull MTLHeapDescriptor *)descriptor
To- (nullable id<MTLHeap>)newHeapWithDescriptor:(nonnull MTLHeapDescriptor *)descriptor

Modified -[MTLDevice newBufferWithLength:options:]
Declaration
From- (nonnull id<MTLBuffer>)newBufferWithLength:(NSUInteger)length options:(MTLResourceOptions)options
To- (nullable id<MTLBuffer>)newBufferWithLength:(NSUInteger)length options:(MTLResourceOptions)options

Modified -[MTLDevice newBufferWithBytes:length:options:]
Declaration
From- (nonnull id<MTLBuffer>)newBufferWithBytes:(nonnull const void *)pointer length:(NSUInteger)length options:(MTLResourceOptions)options
To- (nullable id<MTLBuffer>)newBufferWithBytes:(nonnull const void *)pointer length:(NSUInteger)length options:(MTLResourceOptions)options

Modified -[MTLDevice newBufferWithBytesNoCopy:length:options:deallocator:]
Declaration
From- (nonnull id<MTLBuffer>)newBufferWithBytesNoCopy:(nonnull void *)pointer length:(NSUInteger)length options:(MTLResourceOptions)options deallocator:(nullable void (^)(void * _Nonnull, NSUInteger))deallocator
To- (nullable id<MTLBuffer>)newBufferWithBytesNoCopy:(nonnull void *)pointer length:(NSUInteger)length options:(MTLResourceOptions)options deallocator:(nullable void (^)(void * _Nonnull, NSUInteger))deallocator

Modified -[MTLDevice newDepthStencilStateWithDescriptor:]
Declaration
From- (nonnull id<MTLDepthStencilState>)newDepthStencilStateWithDescriptor:(nonnull MTLDepthStencilDescriptor *)descriptor
To- (nullable id<MTLDepthStencilState>)newDepthStencilStateWithDescriptor:(nonnull MTLDepthStencilDescriptor *)descriptor

Modified -[MTLDevice newTextureWithDescriptor:]
Declaration
From- (nonnull id<MTLTexture>)newTextureWithDescriptor:(nonnull MTLTextureDescriptor *)descriptor
To- (nullable id<MTLTexture>)newTextureWithDescriptor:(nonnull MTLTextureDescriptor *)descriptor

Modified -[MTLDevice newTextureWithDescriptor:iosurface:plane:]
Declaration
From- (nonnull id<MTLTexture>)newTextureWithDescriptor:(nonnull MTLTextureDescriptor *)descriptor iosurface:(nonnull IOSurfaceRef)iosurface plane:(NSUInteger)plane
To- (nullable id<MTLTexture>)newTextureWithDescriptor:(nonnull MTLTextureDescriptor *)descriptor iosurface:(nonnull IOSurfaceRef)iosurface plane:(NSUInteger)plane

Modified -[MTLDevice newSamplerStateWithDescriptor:]
Declaration
From- (nonnull id<MTLSamplerState>)newSamplerStateWithDescriptor:(nonnull MTLSamplerDescriptor *)descriptor
To- (nullable id<MTLSamplerState>)newSamplerStateWithDescriptor:(nonnull MTLSamplerDescriptor *)descriptor

Modified -[MTLDevice newFence]
Declaration
From- (nonnull id<MTLFence>)newFence
To- (nullable id<MTLFence>)newFence

Modified MTLDevice.maxThreadgroupMemoryLength
Optional
FromOptional
ToRequired

MTLHeap.h
Added MTLHeap.currentAllocatedSize
MTLIndirectArgumentEncoder.h
Removed MTLIndirectArgumentEncoder
Removed MTLIndirectArgumentEncoder.device
Removed MTLIndirectArgumentEncoder.label
Removed MTLIndirectArgumentEncoder.encodedLength
Removed -[MTLIndirectArgumentEncoder setIndirectArgumentBuffer:offset:]
Removed -[MTLIndirectArgumentEncoder setBuffer:offset:atIndex:]
Removed -[MTLIndirectArgumentEncoder setBuffers:offsets:withRange:]
Removed -[MTLIndirectArgumentEncoder setTexture:atIndex:]
Removed -[MTLIndirectArgumentEncoder setTextures:withRange:]
Removed -[MTLIndirectArgumentEncoder setSamplerState:atIndex:]
Removed -[MTLIndirectArgumentEncoder setSamplerStates:withRange:]
Removed -[MTLIndirectArgumentEncoder constantDataAtIndex:]
Removed -[MTLIndirectArgumentEncoder newIndirectArgumentEncoderForBufferAtIndex:]
MTLLibrary.h
Removed -[MTLFunction newIndirectArgumentEncoderWithBufferIndex:]
Removed -[MTLFunction newIndirectArgumentEncoderWithBufferIndex:reflection:]
Added -[MTLFunction newArgumentEncoderWithBufferIndex:]
Added -[MTLFunction newArgumentEncoderWithBufferIndex:reflection:]
MTLParallelRenderCommandEncoder.h
Modified -[MTLParallelRenderCommandEncoder renderCommandEncoder]
Declaration
From- (nonnull id<MTLRenderCommandEncoder>)renderCommandEncoder
To- (nullable id<MTLRenderCommandEncoder>)renderCommandEncoder

MTLRenderCommandEncoder.h
Modified -[MTLRenderCommandEncoder useResources:count:usage:]
Declaration
From- (void)useResources:(nullable id<MTLResource> _Nullable const [])resources count:(NSUInteger)count usage:(MTLResourceUsage)usage
To- (void)useResources:(nonnull id<MTLResource> _Nonnull const [])resources count:(NSUInteger)count usage:(MTLResourceUsage)usage

Modified -[MTLRenderCommandEncoder useHeaps:count:]
Declaration
From- (void)useHeaps:(nullable id<MTLHeap> _Nullable const [])heaps count:(NSUInteger)count
To- (void)useHeaps:(nonnull id<MTLHeap> _Nonnull const [])heaps count:(NSUInteger)count

MTLRenderPipeline.h
Added MTLRenderPipelineDescriptor.rasterSampleCount
MTLResource.h
Added MTLResource.allocatedSize
MTLSampler.h
Added MTLSamplerDescriptor.supportArgumentBuffers
MTLTexture.h
Modified -[MTLTexture newTextureViewWithPixelFormat:]
Declaration
From- (nonnull id<MTLTexture>)newTextureViewWithPixelFormat:(MTLPixelFormat)pixelFormat
To- (nullable id<MTLTexture>)newTextureViewWithPixelFormat:(MTLPixelFormat)pixelFormat

Modified -[MTLTexture newTextureViewWithPixelFormat:textureType:levels:slices:]
Declaration
From- (nonnull id<MTLTexture>)newTextureViewWithPixelFormat:(MTLPixelFormat)pixelFormat textureType:(MTLTextureType)textureType levels:(NSRange)levelRange slices:(NSRange)sliceRange
To- (nullable id<MTLTexture>)newTextureViewWithPixelFormat:(MTLPixelFormat)pixelFormat textureType:(MTLTextureType)textureType levels:(NSRange)levelRange slices:(NSRange)sliceRange