Package apple.metal.protocol

Interface MTLLibrary

public interface MTLLibrary

API-Since: 8.0

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
@NotNull MTLDevice	device()	[@property] device The device this resource was created against.
@NotNull NSArray<java.lang.String>	functionNames()	[@property] functionNames The array contains NSString objects, with the name of each function in library.
@Nullable java.lang.String	installName()	[@property] installName The installName provided when this MTLLibrary was created.
@Nullable java.lang.String	label()	[@property] label A string to help identify this object.
void	newFunctionWithDescriptorCompletionHandler(@NotNull MTLFunctionDescriptor descriptor, @NotNull MTLLibrary.Block_newFunctionWithDescriptorCompletionHandler completionHandler)	newFunctionWithDescriptor:completionHandler: Create a new MTLFunction object asynchronously.
@Nullable MTLFunction	newFunctionWithDescriptorError(@NotNull MTLFunctionDescriptor descriptor, @Nullable org.moe.natj.general.ptr.Ptr<NSError> error)	newFunctionWithDescriptor:error: Create a new MTLFunction object synchronously.
@Nullable MTLFunction	newFunctionWithName(@NotNull 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(@NotNull java.lang.String name, @NotNull MTLFunctionConstantValues constantValues, @NotNull MTLLibrary.Block_newFunctionWithNameConstantValuesCompletionHandler completionHandler)	newFunctionWithName:constantValues:completionHandler: Returns a pointer to a function object obtained by applying the constant values to the named function.
@Nullable MTLFunction	newFunctionWithNameConstantValuesError(@NotNull java.lang.String name, @NotNull MTLFunctionConstantValues constantValues, @Nullable 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(@NotNull MTLIntersectionFunctionDescriptor descriptor, @NotNull MTLLibrary.Block_newIntersectionFunctionWithDescriptorCompletionHandler completionHandler)	newIntersectionFunctionWithDescriptor:completionHandler: Create a new MTLFunction object asynchronously.
@Nullable MTLFunction	newIntersectionFunctionWithDescriptorError(@NotNull MTLIntersectionFunctionDescriptor descriptor, @Nullable org.moe.natj.general.ptr.Ptr<NSError> error)	newIntersectionFunctionWithDescriptor:error: Create a new MTLFunction object synchronously.
void	setLabel(@Nullable 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

@NotNull
@NotNull MTLDevice device()

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

functionNames

@NotNull
@NotNull NSArray<java.lang.String> functionNames()

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

label

@Nullable
@Nullable java.lang.String label()

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

newFunctionWithName

@Nullable
@Nullable MTLFunction newFunctionWithName(@NotNull
                                          @NotNull 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(@NotNull
                                                        @NotNull java.lang.String name,
                                                        @NotNull
                                                        @NotNull MTLFunctionConstantValues constantValues,
                                                        @NotNull
                                                        @NotNull 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. API-Since: 10.0

newFunctionWithNameConstantValuesError

@Nullable
@Nullable MTLFunction newFunctionWithNameConstantValuesError(@NotNull
                                                             @NotNull java.lang.String name,
                                                             @NotNull
                                                             @NotNull MTLFunctionConstantValues constantValues,
                                                             @Nullable
                                                             @Nullable 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. API-Since: 10.0

setLabel

void setLabel(@Nullable
              @Nullable java.lang.String value)

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

installName

@Nullable
@Nullable 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:

API-Since: 14.0

newFunctionWithDescriptorCompletionHandler

void newFunctionWithDescriptorCompletionHandler(@NotNull
                                                @NotNull MTLFunctionDescriptor descriptor,
                                                @NotNull
                                                @NotNull MTLLibrary.Block_newFunctionWithDescriptorCompletionHandler completionHandler)

newFunctionWithDescriptor:completionHandler: Create a new MTLFunction object asynchronously. API-Since: 14.0

newFunctionWithDescriptorError

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

newFunctionWithDescriptor:error: Create a new MTLFunction object synchronously. API-Since: 14.0

newIntersectionFunctionWithDescriptorCompletionHandler

void newIntersectionFunctionWithDescriptorCompletionHandler(@NotNull
                                                            @NotNull MTLIntersectionFunctionDescriptor descriptor,
                                                            @NotNull
                                                            @NotNull MTLLibrary.Block_newIntersectionFunctionWithDescriptorCompletionHandler completionHandler)

newIntersectionFunctionWithDescriptor:completionHandler: Create a new MTLFunction object asynchronously. API-Since: 14.0

newIntersectionFunctionWithDescriptorError

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

newIntersectionFunctionWithDescriptor:error: Create a new MTLFunction object synchronously. API-Since: 14.0

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:

API-Since: 14.0