Package apple.metalperformanceshaders

Class MPSTemporaryMatrix

  • All Implemented Interfaces:
    NSObject
    public class MPSTemporaryMatrix
extends MPSMatrix
    A MPSMatrix allocated on GPU private memory. It may alias one or more other MPSTemporaryMatrices. Undesired data destruction due to aliasing is avoided using the readCount property.

    • Constructor Detail

      • MPSTemporaryMatrix

        protected MPSTemporaryMatrix​(org.moe.natj.general.Pointer peer)

    • Method Detail

      • accessInstanceVariablesDirectly

        public static boolean accessInstanceVariablesDirectly()

      • allocWithZone

        public static java.lang.Object allocWithZone​(org.moe.natj.general.ptr.VoidPtr zone)

      • automaticallyNotifiesObserversForKey

        public static boolean automaticallyNotifiesObserversForKey​(java.lang.String key)

      • cancelPreviousPerformRequestsWithTarget

        public static void cancelPreviousPerformRequestsWithTarget​(java.lang.Object aTarget)

      • cancelPreviousPerformRequestsWithTargetSelectorObject

        public static void cancelPreviousPerformRequestsWithTargetSelectorObject​(java.lang.Object aTarget,
                                                                         org.moe.natj.objc.SEL aSelector,
                                                                         java.lang.Object anArgument)

      • classFallbacksForKeyedArchiver

        public static NSArray<java.lang.String> classFallbacksForKeyedArchiver()

      • classForKeyedUnarchiver

        public static org.moe.natj.objc.Class classForKeyedUnarchiver()

      • debugDescription_static

        public static java.lang.String debugDescription_static()

      • description_static

        public static java.lang.String description_static()

      • hash_static

        public static long hash_static()

      • initWithBufferDescriptor

        public MPSTemporaryMatrix initWithBufferDescriptor​(MTLBuffer buffer,
                                                   MPSMatrixDescriptor descriptor)
        Description copied from class: MPSMatrix
        Initialize a MPSMatrix object with a MTLBuffer. This function returns a MPSMatrix object which uses the supplied MTLBuffer. The dimensions and stride of the matrix are specified by the MPSMatrixDescriptor object. The provided MTLBuffer must have enough storage to hold (descriptor.matrices-1) * descriptor.matrixBytes + (descriptor.rows-1) * descriptor.rowBytes + descriptor.columns * (element size) bytes.
        Overrides:
        initWithBufferDescriptor in class MPSMatrix
        Parameters:
        buffer - The MTLBuffer object which contains the data to use for the MPSMatrix. May not be NULL.
        descriptor - The MPSMatrixDescriptor. May not be NULL.
        Returns:
        A valid MPSMatrix object or nil, if failure.

      • instanceMethodSignatureForSelector

        public static NSMethodSignature instanceMethodSignatureForSelector​(org.moe.natj.objc.SEL aSelector)

      • instancesRespondToSelector

        public static boolean instancesRespondToSelector​(org.moe.natj.objc.SEL aSelector)

      • isSubclassOfClass

        public static boolean isSubclassOfClass​(org.moe.natj.objc.Class aClass)

      • keyPathsForValuesAffectingValueForKey

        public static NSSet<java.lang.String> keyPathsForValuesAffectingValueForKey​(java.lang.String key)

      • new_objc

        public static java.lang.Object new_objc()

      • prefetchStorageWithCommandBufferMatrixDescriptorList

        public static void prefetchStorageWithCommandBufferMatrixDescriptorList​(MTLCommandBuffer commandBuffer,
                                                                        NSArray<? extends MPSMatrixDescriptor> descriptorList)
        Help MPS decide which allocations to make ahead of time The buffer cache that underlies the MPSTemporaryMatrix can automatically allocate new storage as needed as you create new temporary matrices. However, sometimes a more global view of what you plan to make is useful for maximizing memory reuse to get the most efficient operation. This class method hints to the cache what the list of matrices will be. It is never necessary to call this method. It is purely a performance and memory optimization.
        Parameters:
        commandBuffer - The command buffer on which the MPSTemporaryMatrix will be used
        descriptorList - A NSArray of MPSMatrixDescriptor, indicating matrices that will be created

      • readCount

        public long readCount()
        The number of times a temporary matrix may be read by a MPSMatrix... kernel before its contents become undefined. MPSTemporaryMatrices must release their underlying buffers for reuse immediately after last use. So as to facilitate *prompt* convenient memory recycling, each time a MPSTemporaryMatrix is read by a MPSMatrix... -encode... method, its readCount is automatically decremented. When the readCount reaches 0, the underlying buffer is automatically made available for reuse to MPS for its own needs and for other MPSTemporaryMatrices prior to return from the -encode.. function. The contents of the buffer become undefined at this time. By default, the readCount is initialized to 1, indicating a matrix that may be overwritten any number of times, but read only once. You may change the readCount as desired to allow MPSMatrixKernels to read the MPSTemporaryMatrix additional times. However, it is an error to change the readCount once it is zero. It is an error to read or write to a MPSTemporaryMatrix with a zero readCount. You may set the readCount to 0 yourself to cause the underlying buffer to be returned to MPS. Writing to a MPSTemporaryMatrix does not adjust the readCount. The Metal API Validation layer will assert if a MPSTemporaryMatrix is deallocated with non-zero readCount to help identify cases when resources are not returned promptly.

      • resolveClassMethod

        public static boolean resolveClassMethod​(org.moe.natj.objc.SEL sel)

      • resolveInstanceMethod

        public static boolean resolveInstanceMethod​(org.moe.natj.objc.SEL sel)

      • setReadCount

        public void setReadCount​(long value)
        The number of times a temporary matrix may be read by a MPSMatrix... kernel before its contents become undefined. MPSTemporaryMatrices must release their underlying buffers for reuse immediately after last use. So as to facilitate *prompt* convenient memory recycling, each time a MPSTemporaryMatrix is read by a MPSMatrix... -encode... method, its readCount is automatically decremented. When the readCount reaches 0, the underlying buffer is automatically made available for reuse to MPS for its own needs and for other MPSTemporaryMatrices prior to return from the -encode.. function. The contents of the buffer become undefined at this time. By default, the readCount is initialized to 1, indicating a matrix that may be overwritten any number of times, but read only once. You may change the readCount as desired to allow MPSMatrixKernels to read the MPSTemporaryMatrix additional times. However, it is an error to change the readCount once it is zero. It is an error to read or write to a MPSTemporaryMatrix with a zero readCount. You may set the readCount to 0 yourself to cause the underlying buffer to be returned to MPS. Writing to a MPSTemporaryMatrix does not adjust the readCount. The Metal API Validation layer will assert if a MPSTemporaryMatrix is deallocated with non-zero readCount to help identify cases when resources are not returned promptly.

      • setVersion_static

        public static void setVersion_static​(long aVersion)

      • superclass_static

        public static org.moe.natj.objc.Class superclass_static()

      • temporaryMatrixWithCommandBufferMatrixDescriptor

        public static MPSTemporaryMatrix temporaryMatrixWithCommandBufferMatrixDescriptor​(MTLCommandBuffer commandBuffer,
                                                                                  MPSMatrixDescriptor matrixDescriptor)
        Initialize a MPSTemporaryMatrix for use on a MTLCommandBuffer
        Parameters:
        commandBuffer - The MTLCommandBuffer on which the MPSTemporaryMatrix will be exclusively used
        matrixDescriptor - A valid MPSMatrixDescriptor describing the MPSMatrix format to create
        Returns:
        A valid MPSTemporaryMatrix. The object is not managed by a NSAutoreleasePool. The object will be released when the command buffer is committed. The underlying buffer will become invalid before this time due to the action of the readCount property. Please read and understand the use of the readCount property before using this object.

      • version_static

        public static long version_static()

      • initWithBufferOffsetDescriptor

        public MPSTemporaryMatrix initWithBufferOffsetDescriptor​(MTLBuffer buffer,
                                                         long offset,
                                                         MPSMatrixDescriptor descriptor)
        Description copied from class: MPSMatrix
        Initialize a MPSMatrix object with a MTLBuffer at a given offset.
        Overrides:
        initWithBufferOffsetDescriptor in class MPSMatrix
        Parameters:
        buffer - The MTLBuffer object which contains the data to use for the MPSMatrix. May not be NULL.
        offset - The offset, in bytes, into the buffer at which the data begins.
        descriptor - The MPSMatrixDescriptor describing the shape of the matrix.

      • initWithDeviceDescriptor

        public MPSTemporaryMatrix initWithDeviceDescriptor​(MTLDevice device,
                                                   MPSMatrixDescriptor descriptor)
        Description copied from class: MPSMatrix
        Initialize a MPSMatrix object with a descriptor. Allocate the buffer. The matrix object will be created, but the storage to hold the matrix data will only be allocated when it is needed, typically when the data property is invoked. In conjunction with -resourceSize, this will allow you to estimate storage needs without actually creating the backing store for the matrix.
        Overrides:
        initWithDeviceDescriptor in class MPSMatrix
        Parameters:
        device - The device with which it will be used
        descriptor - The shape and style of the matrix
        Returns:
        A valid MPSMatrix object or nil