Documentation Archive Developer
Search

Metal Changes for Objective-C

Metal

MTLArgument.h

Modified MTLStructType.members
Declaration
From
@property(readonly) NSArray *members
To
@property(readonly, nonnull) NSArray<MTLStructMember *> *members

MTLBlitCommandEncoder.h

Added -[MTLBlitCommandEncoder copyFromBuffer:sourceOffset:sourceBytesPerRow:sourceBytesPerImage:sourceSize:toTexture:destinationSlice:destinationLevel:destinationOrigin:options:]
Added -[MTLBlitCommandEncoder copyFromTexture:sourceSlice:sourceLevel:sourceOrigin:sourceSize:toBuffer:destinationOffset:destinationBytesPerRow:destinationBytesPerImage:options:]
Added MTLBlitOption
Added MTLBlitOptionDepthFromDepthStencil
Added MTLBlitOptionNone
Added MTLBlitOptionRowLinearPVRTC
Added MTLBlitOptionStencilFromDepthStencil

MTLComputeCommandEncoder.h

Added -[MTLComputeCommandEncoder dispatchThreadgroupsWithIndirectBuffer:indirectBufferOffset:threadsPerThreadgroup:]
Added MTLDispatchThreadgroupsIndirectArguments
Modified -[MTLComputeCommandEncoder setBuffers:offsets:withRange:]
Declaration
From
- (void)setBuffers:(const id<MTLBuffer> [])buffers offsets:(const NSUInteger [])offsets withRange:(NSRange)range
To
- (void)setBuffers:(id<MTLBuffer>  _Nullable const [])buffers offsets:(const NSUInteger [])offsets withRange:(NSRange)range

Modified -[MTLComputeCommandEncoder setSamplerStates:lodMinClamps:lodMaxClamps:withRange:]
Declaration
From
- (void)setSamplerStates:(const id<MTLSamplerState> [])samplers lodMinClamps:(const float [])lodMinClamps lodMaxClamps:(const float [])lodMaxClamps withRange:(NSRange)range
To
- (void)setSamplerStates:(id<MTLSamplerState>  _Nullable const [])samplers lodMinClamps:(const float [])lodMinClamps lodMaxClamps:(const float [])lodMaxClamps withRange:(NSRange)range

Modified -[MTLComputeCommandEncoder setSamplerStates:withRange:]
Declaration
From
- (void)setSamplerStates:(const id<MTLSamplerState> [])samplers withRange:(NSRange)range
To
- (void)setSamplerStates:(id<MTLSamplerState>  _Nullable const [])samplers withRange:(NSRange)range

Modified -[MTLComputeCommandEncoder setTextures:withRange:]
Declaration
From
- (void)setTextures:(const id<MTLTexture> [])textures withRange:(NSRange)range
To
- (void)setTextures:(id<MTLTexture>  _Nullable const [])textures withRange:(NSRange)range

MTLComputePipeline.h

Added MTLComputePipelineDescriptor
Added MTLComputePipelineDescriptor.computeFunction
Added MTLComputePipelineDescriptor.label
Added -[MTLComputePipelineDescriptor reset]
Added MTLComputePipelineDescriptor.threadGroupSizeIsMultipleOfThreadExecutionWidth
Modified MTLComputePipelineReflection.arguments
Declaration
From
@property(readonly) NSArray *arguments
To
@property(readonly, nonnull) NSArray<MTLArgument *> *arguments

MTLDevice.h

Added MTLDevice.maxThreadsPerThreadgroup
Added -[MTLDevice newComputePipelineStateWithDescriptor:options:completionHandler:]
Added -[MTLDevice newComputePipelineStateWithDescriptor:options:reflection:error:]
Added -[MTLDevice supportsTextureSampleCount:]
Added MTLAutoreleasedComputePipelineReflection
Added MTLAutoreleasedRenderPipelineReflection
Added MTLFeatureSet_iOS_GPUFamily1_v2
Added MTLFeatureSet_iOS_GPUFamily2_v2
Added MTLFeatureSet_iOS_GPUFamily3_v1
Added MTLNewComputePipelineStateCompletionHandler
Added MTLNewComputePipelineStateWithReflectionCompletionHandler
Added MTLNewLibraryCompletionHandler
Added MTLNewRenderPipelineStateCompletionHandler
Added MTLNewRenderPipelineStateWithReflectionCompletionHandler
Modified -[MTLDevice newComputePipelineStateWithFunction:completionHandler:]
Declaration
From
- (void)newComputePipelineStateWithFunction:(id<MTLFunction>)computeFunction completionHandler:(void (^)(id<MTLComputePipelineState> computePipelineState, NSError *error))completionHandler
To
- (void)newComputePipelineStateWithFunction:(id<MTLFunction> _Nonnull)computeFunction completionHandler:(MTLNewComputePipelineStateCompletionHandler _Nonnull)completionHandler

Modified -[MTLDevice newComputePipelineStateWithFunction:options:completionHandler:]
Declaration
From
- (void)newComputePipelineStateWithFunction:(id<MTLFunction>)computeFunction options:(MTLPipelineOption)options completionHandler:(void (^)(id<MTLComputePipelineState> computePipelineState, MTLComputePipelineReflection *reflection, NSError *error))completionHandler
To
- (void)newComputePipelineStateWithFunction:(id<MTLFunction> _Nonnull)computeFunction options:(MTLPipelineOption)options completionHandler:(MTLNewComputePipelineStateWithReflectionCompletionHandler _Nonnull)completionHandler

Modified -[MTLDevice newComputePipelineStateWithFunction:options:reflection:error:]
Declaration
From
- (id<MTLComputePipelineState>)newComputePipelineStateWithFunction:(id<MTLFunction>)computeFunction options:(MTLPipelineOption)options reflection:(MTLComputePipelineReflection **)reflection error:(NSError **)error
To
- (id<MTLComputePipelineState> _Nullable)newComputePipelineStateWithFunction:(id<MTLFunction> _Nonnull)computeFunction options:(MTLPipelineOption)options reflection:(MTLAutoreleasedComputePipelineReflection * _Nullable)reflection error:(NSError * _Nullable * _Nullable)error

Modified -[MTLDevice newLibraryWithSource:options:completionHandler:]
Declaration
From
- (void)newLibraryWithSource:(NSString *)source options:(MTLCompileOptions *)options completionHandler:(void (^)(id<MTLLibrary> library, NSError *error))completionHandler
To
- (void)newLibraryWithSource:(NSString * _Nonnull)source options:(MTLCompileOptions * _Nullable)options completionHandler:(MTLNewLibraryCompletionHandler _Nonnull)completionHandler

Modified -[MTLDevice newRenderPipelineStateWithDescriptor:completionHandler:]
Declaration
From
- (void)newRenderPipelineStateWithDescriptor:(MTLRenderPipelineDescriptor *)descriptor completionHandler:(void (^)(id<MTLRenderPipelineState> renderPipelineState, NSError *error))completionHandler
To
- (void)newRenderPipelineStateWithDescriptor:(MTLRenderPipelineDescriptor * _Nonnull)descriptor completionHandler:(MTLNewRenderPipelineStateCompletionHandler _Nonnull)completionHandler

Modified -[MTLDevice newRenderPipelineStateWithDescriptor:options:completionHandler:]
Declaration
From
- (void)newRenderPipelineStateWithDescriptor:(MTLRenderPipelineDescriptor *)descriptor options:(MTLPipelineOption)options completionHandler:(void (^)(id<MTLRenderPipelineState> renderPipelineState, MTLRenderPipelineReflection *reflection, NSError *error))completionHandler
To
- (void)newRenderPipelineStateWithDescriptor:(MTLRenderPipelineDescriptor * _Nonnull)descriptor options:(MTLPipelineOption)options completionHandler:(MTLNewRenderPipelineStateWithReflectionCompletionHandler _Nonnull)completionHandler

Modified -[MTLDevice newRenderPipelineStateWithDescriptor:options:reflection:error:]
Declaration
From
- (id<MTLRenderPipelineState>)newRenderPipelineStateWithDescriptor:(MTLRenderPipelineDescriptor *)descriptor options:(MTLPipelineOption)options reflection:(MTLRenderPipelineReflection **)reflection error:(NSError **)error
To
- (id<MTLRenderPipelineState> _Nullable)newRenderPipelineStateWithDescriptor:(MTLRenderPipelineDescriptor * _Nonnull)descriptor options:(MTLPipelineOption)options reflection:(MTLAutoreleasedRenderPipelineReflection * _Nullable)reflection error:(NSError * _Nullable * _Nullable)error

MTLLibrary.h

Added MTLCompileOptions.languageVersion
Added MTLLanguageVersion
Added MTLLanguageVersion1_0
Added MTLLanguageVersion1_1
Modified MTLCompileOptions.preprocessorMacros
Declaration
From
@property(readwrite, copy, nonatomic) NSDictionary *preprocessorMacros
To
@property(readwrite, copy, nonatomic, nullable) NSDictionary<NSString *,NSObject *> *preprocessorMacros

Modified MTLFunction.vertexAttributes
Declaration
From
@property(readonly) NSArray *vertexAttributes
To
@property(readonly, nullable) NSArray<MTLVertexAttribute *> *vertexAttributes

Modified MTLLibrary.functionNames
Declaration
From
@property(readonly) NSArray *functionNames
To
@property(readonly, nonnull) NSArray<NSString *> *functionNames

MTLPixelFormat.h

Added MTLPixelFormatBGR5A1Unorm
Added MTLPixelFormatDepth32Float_Stencil8

MTLRenderCommandEncoder.h

Added -[MTLRenderCommandEncoder drawIndexedPrimitives:indexCount:indexType:indexBuffer:indexBufferOffset:instanceCount:baseVertex:baseInstance:]
Added -[MTLRenderCommandEncoder drawIndexedPrimitives:indexType:indexBuffer:indexBufferOffset:indirectBuffer:indirectBufferOffset:]
Added -[MTLRenderCommandEncoder drawPrimitives:indirectBuffer:indirectBufferOffset:]
Added -[MTLRenderCommandEncoder drawPrimitives:vertexStart:vertexCount:instanceCount:baseInstance:]
Added -[MTLRenderCommandEncoder setDepthClipMode:]
Added -[MTLRenderCommandEncoder setStencilFrontReferenceValue:backReferenceValue:]
Added MTLDepthClipMode
Added MTLDepthClipModeClamp
Added MTLDepthClipModeClip
Added MTLDrawIndexedPrimitivesIndirectArguments
Added MTLDrawPrimitivesIndirectArguments
Added MTLVisibilityResultModeCounting
Modified -[MTLRenderCommandEncoder setFragmentBuffers:offsets:withRange:]
Declaration
From
- (void)setFragmentBuffers:(const id<MTLBuffer> [])buffers offsets:(const NSUInteger [])offset withRange:(NSRange)range
To
- (void)setFragmentBuffers:(id<MTLBuffer>  _Nullable const [])buffers offsets:(const NSUInteger [])offset withRange:(NSRange)range

Modified -[MTLRenderCommandEncoder setFragmentSamplerStates:lodMinClamps:lodMaxClamps:withRange:]
Declaration
From
- (void)setFragmentSamplerStates:(const id<MTLSamplerState> [])samplers lodMinClamps:(const float [])lodMinClamps lodMaxClamps:(const float [])lodMaxClamps withRange:(NSRange)range
To
- (void)setFragmentSamplerStates:(id<MTLSamplerState>  _Nullable const [])samplers lodMinClamps:(const float [])lodMinClamps lodMaxClamps:(const float [])lodMaxClamps withRange:(NSRange)range

Modified -[MTLRenderCommandEncoder setFragmentSamplerStates:withRange:]
Declaration
From
- (void)setFragmentSamplerStates:(const id<MTLSamplerState> [])samplers withRange:(NSRange)range
To
- (void)setFragmentSamplerStates:(id<MTLSamplerState>  _Nullable const [])samplers withRange:(NSRange)range

Modified -[MTLRenderCommandEncoder setFragmentTextures:withRange:]
Declaration
From
- (void)setFragmentTextures:(const id<MTLTexture> [])textures withRange:(NSRange)range
To
- (void)setFragmentTextures:(id<MTLTexture>  _Nullable const [])textures withRange:(NSRange)range

Modified -[MTLRenderCommandEncoder setVertexBuffers:offsets:withRange:]
Declaration
From
- (void)setVertexBuffers:(const id<MTLBuffer> [])buffers offsets:(const NSUInteger [])offsets withRange:(NSRange)range
To
- (void)setVertexBuffers:(id<MTLBuffer>  _Nullable const [])buffers offsets:(const NSUInteger [])offsets withRange:(NSRange)range

Modified -[MTLRenderCommandEncoder setVertexSamplerStates:lodMinClamps:lodMaxClamps:withRange:]
Declaration
From
- (void)setVertexSamplerStates:(const id<MTLSamplerState> [])samplers lodMinClamps:(const float [])lodMinClamps lodMaxClamps:(const float [])lodMaxClamps withRange:(NSRange)range
To
- (void)setVertexSamplerStates:(id<MTLSamplerState>  _Nullable const [])samplers lodMinClamps:(const float [])lodMinClamps lodMaxClamps:(const float [])lodMaxClamps withRange:(NSRange)range

Modified -[MTLRenderCommandEncoder setVertexSamplerStates:withRange:]
Declaration
From
- (void)setVertexSamplerStates:(const id<MTLSamplerState> [])samplers withRange:(NSRange)range
To
- (void)setVertexSamplerStates:(id<MTLSamplerState>  _Nullable const [])samplers withRange:(NSRange)range

Modified -[MTLRenderCommandEncoder setVertexTextures:withRange:]
Declaration
From
- (void)setVertexTextures:(const id<MTLTexture> [])textures withRange:(NSRange)range
To
- (void)setVertexTextures:(id<MTLTexture>  _Nullable const [])textures withRange:(NSRange)range

MTLRenderPass.h

Added MTLRenderPassDepthAttachmentDescriptor.depthResolveFilter
Added MTLMultisampleDepthResolveFilter
Added MTLMultisampleDepthResolveFilterMax
Added MTLMultisampleDepthResolveFilterMin
Added MTLMultisampleDepthResolveFilterSample0

MTLRenderPipeline.h

Modified MTLRenderPipelineReflection.fragmentArguments
Declaration
From
@property(readonly) NSArray *fragmentArguments
To
@property(readonly, nullable) NSArray<MTLArgument *> *fragmentArguments

Modified MTLRenderPipelineReflection.vertexArguments
Declaration
From
@property(readonly) NSArray *vertexArguments
To
@property(readonly, nullable) NSArray<MTLArgument *> *vertexArguments

MTLResource.h

Added MTLResource.storageMode
Added MTLResourceCPUCacheModeDefaultCache
Added MTLResourceCPUCacheModeWriteCombined
Added MTLResourceStorageModePrivate
Added MTLResourceStorageModeShared
Added MTLStorageMode
Added MTLStorageModePrivate
Added MTLStorageModeShared

MTLSampler.h

Added MTLSamplerDescriptor.compareFunction
Added MTLSamplerDescriptor.lodAverage

MTLTexture.h

Added MTLTexture.buffer
Added MTLTexture.bufferBytesPerRow
Added MTLTexture.bufferOffset
Added -[MTLTexture newTextureViewWithPixelFormat:textureType:levels:slices:]
Added MTLTexture.parentRelativeLevel
Added MTLTexture.parentRelativeSlice
Added MTLTexture.parentTexture
Added MTLTexture.usage
Added MTLTextureDescriptor.cpuCacheMode
Added MTLTextureDescriptor.storageMode
Added MTLTextureDescriptor.usage
Added MTLTextureUsage
Added MTLTextureUsagePixelFormatView
Added MTLTextureUsageRenderTarget
Added MTLTextureUsageShaderRead
Added MTLTextureUsageShaderWrite
Added MTLTextureUsageUnknown