《Metal》官方文档翻译006--函数和库
函数和库
本章介绍如何创建一个MTLFunction对象作为Metal着色器或计算函数的参考,以及如何组织和访问具有MTLLibrary对象的函数。
MTLFunction表示着色器或计算功能
一个MTLFunction对象表示一个单独的功能,它以Metal着色语言编写,并在GPU上作为图形或计算流水线的一部分执行。有关Metal着色语言的详细信息,请参阅“ Metal着色语言指南”。
要在Metal运行时间和以Metal着色语言编写的图形或计算函数之间传递数据或状态,请为纹理,缓冲区和采样器分配参数索引。参数索引标识由Metal运行时和Metal着色代码引用的纹理,缓冲区或采样器。
对于渲染遍,您可以在MTLFunction对象中指定一个用作顶点或片段着色器的MTLRenderPipelineDescriptor对象,如创建渲染管道状态中所述。对于计算过程,您可以MTLFunction在MTLComputePipelineState为目标设备创建对象时指定对象,如“ 为计算命令编码器指定计算状态和资源”所述。
一个Library就是一个函数库
一个MTLLibrary对象表示的一个或多个储存库MTLFunction对象。单个MTLFunction对象表示使用着色语言编写的一个Metal函数。在Metal着色语言源代码,使用一个Metal函数限定符任何功能(vertex,fragment,或kernel)可以通过一个代表MTLFunction在一个库中的对象。没有这些函数限定符之一的Metal函数不能由MTLFunction对象直接表示,尽管它可以由着色器中的另一个函数调用。
MTLFunction可以从以下任一来源创建库中的对象:
-
Metal着色语言代码,在应用程序构建过程中被编译成二进制库格式。
-
包含由运行时应用程序编译的Metal着色语言源代码的文本字符串。
从编译代码创建库
为了获得最佳性能,请在您的应用程序的Xcode构建过程中将Metal着色语言源代码编译成库文件,从而避免在应用程序运行时编译函数源的费用。要从MTLLibrary库二进制创建对象,请调用以下方法之一MTLDevice:
-
newDefaultLibrary 检索为主包构建的库,其中包含应用程序的Xcode项目中的所有着色器和计算函数。
-
newLibraryWithFile:error:将路径传递给库文件,并返回一个MTLLibrary包含存储在该库文件中的所有函数的对象。
-
newLibraryWithData:error:使用二进制blob包含库中函数的代码并返回一个MTLLibrary对象。
有关在构建过程中编译Metal着色语言源代码的更多信息,请参阅
在应用程序构建过程中创建库。
从源代码创建库
要从MTLLibrary可能包含多个函数的Metal着色语言源代码字符串创建一个,请调用以下方法之一MTLDevice。这些方法在创建库时编译源代码。要指定要使用的编译器选项,请设置MTLCompileOptions对象中的属性。
-
newLibraryWithSource:options:error:从输入字符串同步编译源代码以创建MTLFunction对象,然后返回MTLLibrary包含它们的对象。
-
newLibraryWithSource:options:completionHandler:从输入字符串异步编译源代码以创建MTLFunction对象,然后返回MTLLibrary包含它们的对象。completionHandler是在对象创建完成时调用的代码块。
从Library获取功能
返回具有请求名称的对象的newFunctionWithName:方法。如果在库中找不到使用Metal着色语言功能限定符的函数的名称,则返回。MTLLibraryMTLFunctionnewFunctionWithName:nil
清单4-1使用通过其完整路径名定位库文件的newLibraryWithFile:error:方法,MTLDevice并使用其内容创建MTLLibrary具有一个或多个MTLFunction对象的对象。加载文件时出现任何错误error。然后创建一个表示在源代码中调用的函数的对象的newFunctionWithName:方法。返回的函数对象现在可以在应用程序中使用。MTLLibraryMTLFunctionmy_funcmyFunc
清单4-1 从库访问函数
NSError *errors;
id <MTLLibrary> library = [device newLibraryWithFile:@"myarchive.metallib"
error:&errors];
id <MTLFunction> myFunc = [library newFunctionWithName:@"my_func"];
在运行时确定功能详细信息
由于MTLFunction对象的实际内容由MTLFunction创建对象之前可以编译的图形着色器或计算函数定义,因此其源代码可能无法直接用于该应用程序。您可以MTLFunction在运行时查询以下属性:
-
name一个带有该函数名称的字符串。
-
functionType,它指示函数是否被声明为顶点,片段或计算函数。
-
vertexAttributes,一组MTLVertexAttribute对象,描述如何将顶点属性数据组织在内存中,以及如何映射到顶点函数参数。有关更多详细信息,请参阅数据组织的顶点描述符。
MTLFunction不提供对函数参数的访问。在创建流水线状态期间,可以获得反映物体(MTLRenderPipelineReflection或MTLComputePipelineReflection根据命令编码器的类型)来显示着色器或计算函数参数的细节。有关创建管道状态和反射对象的详细信息,请参阅创建渲染管道状态或创建计算管道状态。如果不使用反射数据,请避免使用。
反射对象包含MTLArgument命令编码器支持的每种类型功能的对象数组。因为MTLComputeCommandEncoder,属性中MTLComputePipelineReflection有一个对应于其计算函数的参数的MTLArgument对象数组arguments。为MTLRenderCommandEncoder,MTLRenderPipelineReflection具有两个属性,vertexArguments并且fragmentArguments,这是分别对应于顶点函数参数和片段函数参数,阵列。
不是函数的所有参数都存在于反射对象中。反射对象仅包含具有关联资源的参数,但不包含使用[[ stage_in ]]限定符或内置[[ vertex_id ]]或[[ attribute_id ]]限定符声明的参数。
清单4-2显示了如何获取反射对象(在本示例中MTLComputePipelineReflection),然后遍历MTLArgument其arguments属性中的对象。
清单4-2 通过函数参数进行迭代
MTLComputePipelineReflection* reflection;
id <MTLComputePipelineState> computePS = [device
newComputePipelineStateWithFunction:func
options:MTLPipelineOptionArgumentInfo
reflection:&reflection error:&error];
for (MTLArgument *arg in reflection.arguments) {
// process each MTLArgument
}
该MTLArgument特性揭示参数传递给着色语言功能的细节。
- 该name属性仅仅是参数的名称。
- active 是一个布尔值,指示参数是否可以被忽略。
- index是在其对应的参数表中的基于零的位置。例如,for [[ buffer(2) ]],index是2。
- access描述任何访问限制,例如读取或写入访问限定符。
- type由着色语言限定符指示的,例如,[[ buffer(n) ]],[[ texture(n) ]],[[ sampler(n) ]],或[[ threadgroup(n) ]]。
type确定哪些其他MTLArgument属性是相关的。
-
如果type是MTLArgumentTypeTexture,则该textureType属性指示整体纹理类型(如texture1d_array,texture2d_ms以及texturecube在着色语言类型),并且textureDataType属性指示组件的数据类型(如half,float,int,或uint)。
-
如果type是MTLArgumentTypeThreadgroupMemory,则threadgroupMemoryAlignment和threadgroupMemoryDataSize性质有关。
-
如果type是MTLArgumentTypeBuffer,则bufferAlignment,bufferDataSize,bufferDataType,和bufferStructType属性相关。
如果缓冲区参数是一个结构(即,bufferDataType是MTLDataTypeStruct),则bufferStructType属性包含MTLStructType表示该结构,和bufferDataSize包含该结构的大小,以字节为单位。如果缓冲区参数是数组(或指向数组的指针),则bufferDataType表示元素的数据类型,并bufferDataSize包含一个数组元素的大小(以字节为单位)。
清单4-3向下钻取一个MTLStructType对象,以检查结构体成员的细节,每个由MTLStructMember对象表示。结构体成员可以是简单类型,数组或嵌套结构体。如果该成员是一个嵌套的结构体,那么调用structType方法MTLStructMember来获取一个MTLStructType代表结构体的对象,然后递归深入分析它。如果该成员是一个数组,请使用该arrayType方法MTLStructMember获取MTLArrayType表示该数组的方法。然后检查它的elementType属性MTLArrayType。如果elementType是MTLDataTypeStruct,请调用该elementStructType方法来获取结构,并继续深入其成员。如果elementType是MTLDataTypeArray,请调用elementArrayType方法获取子阵列并进一步分析。
清单4-3 处理结构参数
MTLStructType *structObj = [arg.bufferStructType];
for (MTLStructMember *member in structObj.members) {
// process each MTLStructMember
if (member.dataType == MTLDataTypeStruct) {
MTLStructType *nestedStruct = member.structType;
// recursively drill down into the nested struct
}
else if (member.dataType == MTLDataTypeArray) {
MTLStructType *memberArray = member.arrayType;
// examine the elementType and drill down, if necessary
}
else {
// member is neither struct nor array
// analyze it; no need to drill down further
}
}