Package apple.metalperformanceshaders

Class MPSTemporaryNDArray

  • All Implemented Interfaces:
    NSObject
    public class MPSTemporaryNDArray
extends MPSNDArray
    MPSTemporaryNDArray A MPSNDArray that uses command buffer specific memory to store the array data Temporary memory is command buffer specific memory, and is useful for MPSNDArray allocations with limited lifetime within a single command buffer. Typically, most MPSNDArrays that are not read or written to by the CPU or needed in other command buffers should be MPSTemporaryNDArray. This will greatly reduce time spent allocating new memory, reduce memory usage and help improve memory locality.

    • Constructor Detail

      • MPSTemporaryNDArray

        protected MPSTemporaryNDArray​(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()

      • defaultAllocator

        public static MPSNDArrayAllocator defaultAllocator()
        Get a well known that makes temporary MTLBuffers

      • description_static

        public static java.lang.String description_static()

      • hash_static

        public static long hash_static()

      • initWithDeviceDescriptor

        public MPSTemporaryNDArray initWithDeviceDescriptor​(MTLDevice device,
                                                    MPSNDArrayDescriptor descriptor)
        Description copied from class: MPSNDArray
        Initialize an MPSNDArrayDescriptor object on a device for given dimension sizes in descriptor.
        Overrides:
        initWithDeviceDescriptor in class MPSNDArray
        Parameters:
        device - The device on which the data type will be created.
        descriptor - The MPSNDArrayDescriptor used for initializing the the NDArray
        Returns:
        A valid MPSNDArray 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()

      • readCount

        public long readCount()
        The number of times a temporary MPSNDArray may be read by a MPSNDArray... kernel before its contents become undefined. MPSTemporaryNDArrays must release their underlying buffers for reuse immediately after last use. So as to facilitate *prompt* convenient memory recycling, each time a MPSTemporaryNDArray is read by a MPSNDArray... -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 MPSTemporaryNDArrays 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 MPSNDArray that may be overwritten any number of times, but read only once. You may change the readCount as desired to allow MPSNDArrayKernels to read the MPSTemporaryNDArray 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 MPSTemporaryNDArray 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 MPSTemporaryNDArray does not adjust the readCount. The Metal API Validation layer will assert if a MPSTemporaryNDArray 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 MPSNDArray may be read by a MPSNDArray... kernel before its contents become undefined. MPSTemporaryNDArrays must release their underlying buffers for reuse immediately after last use. So as to facilitate *prompt* convenient memory recycling, each time a MPSTemporaryNDArray is read by a MPSNDArray... -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 MPSTemporaryNDArrays 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 MPSNDArray that may be overwritten any number of times, but read only once. You may change the readCount as desired to allow MPSNDArrayKernels to read the MPSTemporaryNDArray 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 MPSTemporaryNDArray 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 MPSTemporaryNDArray does not adjust the readCount. The Metal API Validation layer will assert if a MPSTemporaryNDArray 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()

      • temporaryNDArrayWithCommandBufferDescriptor

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