Package apple.metal.protocol

Interface MTLLibrary

public interface MTLLibrary

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	MTLLibrary.Block_newFunctionWithDescriptorCompletionHandler
static interface	MTLLibrary.Block_newFunctionWithNameConstantValuesCompletionHandler
static interface	MTLLibrary.Block_newIntersectionFunctionWithDescriptorCompletionHandler

Method Summary

Modifier and Type	Method	Description
MTLDevice	device()	[@property] device The device this resource was created against.
NSArray<java.lang.String>	functionNames()	[@property] functionNames The array contains NSString objects, with the name of each function in library.
java.lang.String	installName()	[@property] installName The installName provided when this MTLLibrary was created.
java.lang.String	label()	[@property] label A string to help identify this object.
void	newFunctionWithDescriptorCompletionHandler(MTLFunctionDescriptor descriptor, MTLLibrary.Block_newFunctionWithDescriptorCompletionHandler completionHandler)	newFunctionWithDescriptor:completionHandler: Create a new MTLFunction object asynchronously.
MTLFunction	newFunctionWithDescriptorError(MTLFunctionDescriptor descriptor, org.moe.natj.general.ptr.Ptr<NSError> error)	newFunctionWithDescriptor:error: Create a new MTLFunction object synchronously.
MTLFunction	newFunctionWithName(java.lang.String functionName)	newFunctionWithName Returns a pointer to a function object, return nil if the function is not found in the library.
void	newFunctionWithNameConstantValuesCompletionHandler(java.lang.String name, MTLFunctionConstantValues constantValues, MTLLibrary.Block_newFunctionWithNameConstantValuesCompletionHandler completionHandler)	newFunctionWithName:constantValues:completionHandler: Returns a pointer to a function object obtained by applying the constant values to the named function.
MTLFunction	newFunctionWithNameConstantValuesError(java.lang.String name, MTLFunctionConstantValues constantValues, org.moe.natj.general.ptr.Ptr<NSError> error)	newFunctionWithName:constantValues:error: Returns a pointer to a function object obtained by applying the constant values to the named function.
void	newIntersectionFunctionWithDescriptorCompletionHandler(MTLIntersectionFunctionDescriptor descriptor, MTLLibrary.Block_newIntersectionFunctionWithDescriptorCompletionHandler completionHandler)	newIntersectionFunctionWithDescriptor:completionHandler: Create a new MTLFunction object asynchronously.
MTLFunction	newIntersectionFunctionWithDescriptorError(MTLIntersectionFunctionDescriptor descriptor, org.moe.natj.general.ptr.Ptr<NSError> error)	newIntersectionFunctionWithDescriptor:error: Create a new MTLFunction object synchronously.
void	setLabel(java.lang.String value)	[@property] label A string to help identify this object.
long	type()	[@property] type The library type provided when this MTLLibrary was created.

Method Detail

device

MTLDevice device()

[@property] device The device this resource was created against. This resource can only be used with this device.

functionNames

NSArray<java.lang.String> functionNames()

[@property] functionNames The array contains NSString objects, with the name of each function in library.

label

java.lang.String label()

[@property] label A string to help identify this object.

newFunctionWithName

MTLFunction newFunctionWithName(java.lang.String functionName)

newFunctionWithName Returns a pointer to a function object, return nil if the function is not found in the library.

newFunctionWithNameConstantValuesCompletionHandler

void newFunctionWithNameConstantValuesCompletionHandler(java.lang.String name,
                                                        MTLFunctionConstantValues constantValues,
                                                        MTLLibrary.Block_newFunctionWithNameConstantValuesCompletionHandler completionHandler)

newFunctionWithName:constantValues:completionHandler: Returns a pointer to a function object obtained by applying the constant values to the named function. This method is asynchronous since it is will call the compiler.

newFunctionWithNameConstantValuesError

MTLFunction newFunctionWithNameConstantValuesError(java.lang.String name,
                                                   MTLFunctionConstantValues constantValues,
                                                   org.moe.natj.general.ptr.Ptr<NSError> error)

newFunctionWithName:constantValues:error: Returns a pointer to a function object obtained by applying the constant values to the named function. This method will call the compiler. Use newFunctionWithName:constantValues:completionHandler: to avoid waiting on the compiler.

setLabel

void setLabel(java.lang.String value)

[@property] label A string to help identify this object.

installName

java.lang.String installName()

[@property] installName The installName provided when this MTLLibrary was created. Always nil if the type of the library is not MTLLibraryTypeDynamic.

See Also:

MTLCompileOptions

newFunctionWithDescriptorCompletionHandler

void newFunctionWithDescriptorCompletionHandler(MTLFunctionDescriptor descriptor,
                                                MTLLibrary.Block_newFunctionWithDescriptorCompletionHandler completionHandler)

newFunctionWithDescriptor:completionHandler: Create a new MTLFunction object asynchronously.

newFunctionWithDescriptorError

MTLFunction newFunctionWithDescriptorError(MTLFunctionDescriptor descriptor,
                                           org.moe.natj.general.ptr.Ptr<NSError> error)

newFunctionWithDescriptor:error: Create a new MTLFunction object synchronously.

newIntersectionFunctionWithDescriptorCompletionHandler

void newIntersectionFunctionWithDescriptorCompletionHandler(MTLIntersectionFunctionDescriptor descriptor,
                                                            MTLLibrary.Block_newIntersectionFunctionWithDescriptorCompletionHandler completionHandler)

newIntersectionFunctionWithDescriptor:completionHandler: Create a new MTLFunction object asynchronously.

newIntersectionFunctionWithDescriptorError

MTLFunction newIntersectionFunctionWithDescriptorError(MTLIntersectionFunctionDescriptor descriptor,
                                                       org.moe.natj.general.ptr.Ptr<NSError> error)

newIntersectionFunctionWithDescriptor:error: Create a new MTLFunction object synchronously.

type

long type()

[@property] type The library type provided when this MTLLibrary was created. Libraries with MTLLibraryTypeExecutable can be used to obtain MTLFunction from. Libraries with MTLLibraryTypeDynamic can be used to resolve external references in other MTLLibrary from.

See Also:

MTLCompileOptions