Package apple.metalperformanceshaders

Class MPSTemporaryVector

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

    • Constructor Detail

      • MPSTemporaryVector

        protected MPSTemporaryVector​(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 MPSTemporaryVector initWithBufferDescriptor​(MTLBuffer buffer,
                                                   MPSVectorDescriptor descriptor)
        Description copied from class: MPSVector
        Initialize a MPSVector object with a MTLBuffer. This function returns a MPSVector object which uses the supplied MTLBuffer. The length, number of vectors, and stride between vectors are specified by the MPSVectorDescriptor object. The provided MTLBuffer must have enough storage to hold (descriptor.vectors-1) * descriptor.vectorBytes + descriptor.length * (element size) bytes.
        Overrides:
        initWithBufferDescriptor in class MPSVector
        Parameters:
        buffer - The MTLBuffer object which contains the data to use for the MPSVector. May not be NULL.
        descriptor - The MPSVectorDescriptor. May not be NULL.
        Returns:
        A valid MPSVector object or nil, if failure.

      • initWithBufferOffsetDescriptor

        public MPSTemporaryVector initWithBufferOffsetDescriptor​(MTLBuffer buffer,
                                                         long offset,
                                                         MPSVectorDescriptor descriptor)
        Description copied from class: MPSVector
        Initialize a MPSVector object with a MTLBuffer and an offset.
        Overrides:
        initWithBufferOffsetDescriptor in class MPSVector
        Parameters:
        buffer - The MTLBuffer containing the data.
        offset - The offset, in bytes, into the buffer at which data begins.
        descriptor - The MPSVectorDescriptor.

      • initWithDeviceDescriptor

        public MPSTemporaryVector initWithDeviceDescriptor​(MTLDevice device,
                                                   MPSVectorDescriptor descriptor)
        Description copied from class: MPSVector
        Initialize a lazily backed MPSVector object with a descriptor The vector object will be created, but the storage to hold the vector 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 vector.
        Overrides:
        initWithDeviceDescriptor in class MPSVector
        Parameters:
        device - The device with which it will be used
        descriptor - The shape and style of the matrix
        Returns:
        A valid MPSVector object or nil

      • 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()

      • prefetchStorageWithCommandBufferDescriptorList

        public static void prefetchStorageWithCommandBufferDescriptorList​(MTLCommandBuffer commandBuffer,
                                                                  NSArray<? extends MPSVectorDescriptor> descriptorList)
        Help MPS decide which allocations to make ahead of time The buffer cache that underlies the MPSTemporaryVector can automatically allocate new storage as needed as you create new temporary vectors. 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 MPSTemporaryVector will be used
        descriptorList - A NSArray of MPSVectorDescriptor objects, indicating vectors that will be created

      • readCount

        public long readCount()
        The number of times a temporary vector may be read by a MPSMatrix... kernel before its contents become undefined. MPSTemporaryVector objects must release their underlying buffers for reuse immediately after last use. So as to facilitate *prompt* convenient memory recycling, each time a MPSTemporaryVector 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 MPSTemporaryVector objects 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 MPSMatrix kernels to read the MPSTemporaryVector 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 MPSTemporaryVector 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 MPSTemporaryVector does not adjust the readCount. The Metal API Validation layer will assert if a MPSTemporaryVector 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 vector may be read by a MPSMatrix... kernel before its contents become undefined. MPSTemporaryVector objects must release their underlying buffers for reuse immediately after last use. So as to facilitate *prompt* convenient memory recycling, each time a MPSTemporaryVector 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 MPSTemporaryVector objects 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 MPSMatrix kernels to read the MPSTemporaryVector 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 MPSTemporaryVector 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 MPSTemporaryVector does not adjust the readCount. The Metal API Validation layer will assert if a MPSTemporaryVector 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()

      • temporaryVectorWithCommandBufferDescriptor

        public static MPSTemporaryVector temporaryVectorWithCommandBufferDescriptor​(MTLCommandBuffer commandBuffer,
                                                                            MPSVectorDescriptor descriptor)
        Initialize a MPSTemporaryVector for use on a MTLCommandBuffer
        Parameters:
        commandBuffer - The MTLCommandBuffer on which the MPSTemporaryMatrix will be exclusively used
        descriptor - A valid MPSVectorDescriptor describing the MPSVector format to create
        Returns:
        A valid MPSTemporaryVector. 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()