iOS - Metal - MTLDevice 文档翻译

/*!
 @brief 返回对首选系统默认Metal设备的引用。
 @discussion 在Mac OS X系统上支持自动图形切换,调用这种获得Metal器件的API将使系统切换到高功率GPU。在支持多个GPU的其他系统上,它将返回GPU与主显示相关联。*/
@available(iOS 8.0, *)
public func MTLCreateSystemDefaultDevice() -> MTLDevice?

/*!
 @brief 返回系统中的所有Metal设备。
 @discussion 这个API不会导致系统切换设备,并根据它认为合适的标准来决定使用哪个GPU来使用应用程序。
*/

@available(iOS 8.0, *)
public enum MTLFeatureSet : UInt {


@available(iOS 8.0, *)
case iOS_GPUFamily1_v1

@available(iOS 8.0, *)
case iOS_GPUFamily2_v1


@available(iOS 9.0, *)
case iOS_GPUFamily1_v2

@available(iOS 9.0, *)
case iOS_GPUFamily2_v2

@available(iOS 9.0, *)
case iOS_GPUFamily3_v1


@available(iOS 10.0, *)
case iOS_GPUFamily1_v3

@available(iOS 10.0, *)
case iOS_GPUFamily2_v3

@available(iOS 10.0, *)
case iOS_GPUFamily3_v2
}

/*!
 @enum MTLPipelineOption
 @abstract 控制管道(pipeline)的创建
 */
@available(iOS 8.0, *)
public struct MTLPipelineOption : OptionSet {

public init(rawValue: UInt)


public static var argumentInfo: MTLPipelineOption { get }

public static var bufferTypeInfo: MTLPipelineOption { get }
}

/*!
 @abstract 表示内存大小和字节对齐。
 */
public struct MTLSizeAndAlign {

public var size: Int

public var align: Int

public init()

public init(size: Int, align: Int)
}

/* Convenience typedef,它可以很容易地声明某些返回类型的存储。 */
public typealias MTLAutoreleasedRenderPipelineReflection = MTLRenderPipelineReflection
public typealias MTLAutoreleasedComputePipelineReflection = MTLComputePipelineReflection

public typealias MTLNewLibraryCompletionHandler = (MTLLibrary?, Error?) -> Swift.Void

public typealias MTLNewRenderPipelineStateCompletionHandler = (MTLRenderPipelineState?, Error?) -> Swift.Void
public typealias MTLNewRenderPipelineStateWithReflectionCompletionHandler = (MTLRenderPipelineState?, MTLRenderPipelineReflection?, Error?) -> Swift.Void

public typealias MTLNewComputePipelineStateCompletionHandler = (MTLComputePipelineState?, Error?) -> Swift.Void
public typealias MTLNewComputePipelineStateWithReflectionCompletionHandler = (MTLComputePipelineState?, MTLComputePipelineReflection?, Error?) -> Swift.Void


/*!
 @protocol MTLDevice
 @abstract MTLDevice 表示能够进行数据并行计算的处理器
 */
@available(iOS 8.0, *)
public protocol MTLDevice : NSObjectProtocol {

/*!
 @property name
 @abstract 供应商设备的全名。
 */
public var name: String? { get }


/*!
 @property maxThreadsPerThreadgroup
 @abstract 每个维度上的最大线程数。
 */
@available(iOS 9.0, *)
public var maxThreadsPerThreadgroup: MTLSize { get }


/*!
 @method newCommandQueue
 @brief 创建并返回一个新的命令队列。通过此方法创建的命令队列只允许64个未完成的命令缓冲区。
 @return 新的命令队列对象
 */
public func makeCommandQueue() -> MTLCommandQueue


/*!
 @method newCommandQueueWithMaxCommandBufferCount
 @brief 创建并返回一个包含未完成的命令缓冲区的新命令队列。
 @return 新的命令队列对象
 */
public func makeCommandQueue(maxCommandBufferCount: Int) -> MTLCommandQueue


/*!
 @method heapTextureSizeAndAlignWithDescriptor:
 @abstract 当从堆中分配时,确定纹理的字节大小。
 @discussion 此方法可用于帮助确定所需的堆大小。
 */
@available(iOS 10.0, *)
public func heapTextureSizeAndAlign(descriptor desc: MTLTextureDescriptor) -> MTLSizeAndAlign


/*!
 @method heapBufferSizeAndAlignWithLength:options:
 @abstract 从堆中分配子分配时,确定缓冲区的字节大小。
 @discussion 此方法可用于帮助确定所需的堆大小。
 */
@available(iOS 10.0, *)
public func heapBufferSizeAndAlign(length: Int, options: MTLResourceOptions = []) -> MTLSizeAndAlign


/*!
 @method newHeapWithDescriptor:
 @abstract 创建带有给定描述符的新堆。
 */
@available(iOS 10.0, *)
public func makeHeap(descriptor: MTLHeapDescriptor) -> MTLHeap


/*!
 @method newBufferWithLength:options:
 @brief Create a buffer by allocating new memory.
 */
public func makeBuffer(length: Int, options: MTLResourceOptions = []) -> MTLBuffer


/*!
 @method newBufferWithBytes:length:options:
 @brief 通过分配新的内存创建缓冲区。
 */
public func makeBuffer(bytes pointer: UnsafeRawPointer, length: Int, options: MTLResourceOptions = []) -> MTLBuffer


/*!
 @method newBufferWithBytesNoCopy:length:options:deallocator:
 @brief 通过封装地址空间的现有部分来创建缓冲区。
 */
public func makeBuffer(bytesNoCopy pointer: UnsafeMutableRawPointer, length: Int, options: MTLResourceOptions = [], deallocator: ((UnsafeMutableRawPointer, Int) -> Swift.Void)? = nil) -> MTLBuffer


/*!
 @method newDepthStencilStateWithDescriptor:
 @brief 创建一个深度/模板测试状态对象。
 */
public func makeDepthStencilState(descriptor: MTLDepthStencilDescriptor) -> MTLDepthStencilState


/*!
 @method newTextureWithDescriptor:
 @abstract 使用私有存储分配新纹理。
 */
public func makeTexture(descriptor: MTLTextureDescriptor) -> MTLTexture


/*!
 @method newSamplerStateWithDescriptor:
 @abstract 创建一个新的取样器。
*/
public func makeSamplerState(descriptor: MTLSamplerDescriptor) -> MTLSamplerState


/*!
 @method newDefaultLibrary
 @abstract 返回主包的默认库。
 @discussion 使用newDefaultLibraryWithBundle:错误:得到一个NSError在失败的情况下。
 */
public func newDefaultLibrary() -> MTLLibrary?


/*
 @method newDefaultLibraryWithBundle:error:
 @abstract 返回给定bundle的默认库
 @return 一个指向库的指针,如果出现错误,则为nil。
*/
@available(iOS 10.0, *)
public func makeDefaultLibrary(bundle: Bundle) throws -> MTLLibrary


/*!
 @method newLibraryWithFile:
 @abstract 从一个Metal库文件加载一个MTLLibrary。
 */
public func makeLibrary(filepath: String) throws -> MTLLibrary


/*!
 @method newLibraryWithData:
 @abstract 从dispatch_data_t加载一个MTLLibrary
 @param data 已经以dispatch_data_t的形式加载的Metal库文件。
 @param error 如果我们没有打开Metal库数据,会出现错误。
 */
public func makeLibrary(data: __DispatchData) throws -> MTLLibrary


/*!
 @method newLibraryWithSource:options:error:
 @abstract 从源装载一个MTLLibrary。
 */
public func makeLibrary(source: String, options: MTLCompileOptions?) throws -> MTLLibrary


/*!
 @method newLibraryWithSource:options:completionHandler:
 @abstract 从源装载一个MTLLibrary。
 */
public func makeLibrary(source: String, options: MTLCompileOptions?, completionHandler: @escaping Metal.MTLNewLibraryCompletionHandler)


/*!
 @method newRenderPipelineStateWithDescriptor:error:
 @abstract 同步创建和编译一个新的mtlrender管道对象。
 */
public func makeRenderPipelineState(descriptor: MTLRenderPipelineDescriptor) throws -> MTLRenderPipelineState


/*!
 @method newRenderPipelineStateWithDescriptor:options:reflection:error:
 @abstract 创建并编译一个新的mtlrender管线对象,并返回额外的反射信息。
 */
public func makeRenderPipelineState(descriptor: MTLRenderPipelineDescriptor, options: MTLPipelineOption, reflection: AutoreleasingUnsafeMutablePointer<MTLAutoreleasedRenderPipelineReflection?>?) throws -> MTLRenderPipelineState


/*!
 @method newRenderPipelineState:completionHandler:
 @abstract 异步创建和编译一个新的mtlrender管线对象。
 */
public func makeRenderPipelineState(descriptor: MTLRenderPipelineDescriptor, completionHandler: @escaping Metal.MTLNewRenderPipelineStateCompletionHandler)


/*!
 @method newRenderPipelineState:options:completionHandler:
 @abstract 创建并编译一个新的mtlrender管线对象,并返回额外的反射信息
 */
public func makeRenderPipelineState(descriptor: MTLRenderPipelineDescriptor, options: MTLPipelineOption, completionHandler: @escaping Metal.MTLNewRenderPipelineStateWithReflectionCompletionHandler)


/*!
 @method newComputePipelineStateWithDescriptor:error:
 @abstract 同步创建和编译一个新的mtlcomputeUNK inestate对象。
 */
public func makeComputePipelineState(function computeFunction: MTLFunction) throws -> MTLComputePipelineState


/*!
 @method newComputePipelineStateWithDescriptor:options:reflection:error:
 @abstract 同步创建和编译一个新的mtlcomputeUNK inestate对象。
 */
public func makeComputePipelineState(function computeFunction: MTLFunction, options: MTLPipelineOption, reflection: AutoreleasingUnsafeMutablePointer<MTLAutoreleasedComputePipelineReflection?>?) throws -> MTLComputePipelineState


/*!
 @method newComputePipelineStateWithDescriptor:completionHandler:
 @abstract异步地创建和编译一个新的mtlcomputeUNK inestate对象。
 */
public func makeComputePipelineState(function computeFunction: MTLFunction, completionHandler: @escaping Metal.MTLNewComputePipelineStateCompletionHandler)


/*!
 @method newComputePipelineStateWithDescriptor:options:completionHandler:
 @abstract异步地创建和编译一个新的mtlcomputeUNK inestate对象。
 */
public func makeComputePipelineState(function computeFunction: MTLFunction, options: MTLPipelineOption, completionHandler: @escaping Metal.MTLNewComputePipelineStateWithReflectionCompletionHandler)


/*!
 @method newComputePipelineStateWithDescriptor:options:reflection:error:
 @abstract 同步创建和编译一个新的mtlcomputeUNK inestate对象。
 */
@available(iOS 9.0, *)
public func makeComputePipelineState(descriptor: MTLComputePipelineDescriptor, options: MTLPipelineOption, reflection: AutoreleasingUnsafeMutablePointer<MTLAutoreleasedComputePipelineReflection?>?) throws -> MTLComputePipelineState


/*!
 @method newComputePipelineStateWithDescriptor:options:completionHandler:
 @abstract异步地创建和编译一个新的mtlcomputeUNK inestate对象。
 */
@available(iOS 9.0, *)
public func makeComputePipelineState(descriptor: MTLComputePipelineDescriptor, options: MTLPipelineOption, completionHandler: @escaping Metal.MTLNewComputePipelineStateWithReflectionCompletionHandler)


/*!
 @method newFence
 @abstract 创建一个新的MTLFence对象
 */
@available(iOS 10.0, *)
public func makeFence() -> MTLFence


/*!
 @method supportsFeatureSet:
 @abstract Returns TRUE if the feature set is supported by this MTLDevice.
 */
public func supportsFeatureSet(_ featureSet: MTLFeatureSet) -> Bool


/*!
 @method supportsTextureSampleCount:
 @brief 查询设备,如果它支持给定的sampleCount的纹理。
 @return BOOL value. 如果是,设备支持给定的纹理样式。如果没有,设备不支持给定的sampleCount。
 */
@available(iOS 9.0, *)
public func supportsTextureSampleCount(_ sampleCount: Int) -> Bool

}

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 216,692评论 6 501
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 92,482评论 3 392
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 162,995评论 0 353
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 58,223评论 1 292
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 67,245评论 6 388
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 51,208评论 1 299
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 40,091评论 3 418
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 38,929评论 0 274
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 45,346评论 1 311
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 37,570评论 2 333
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 39,739评论 1 348
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 35,437评论 5 344
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 41,037评论 3 326
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 31,677评论 0 22
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,833评论 1 269
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 47,760评论 2 369
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 44,647评论 2 354

推荐阅读更多精彩内容