Login or Register to Ask a Question and Join Our Community

Linux and UNIX Man Pages

Linux & Unix Commands - Search Man Pages

mpsmatrixcopydescriptor(3) [mojave man page]

MPSMatrixCopyDescriptor(3)				 MetalPerformanceShaders.framework				MPSMatrixCopyDescriptor(3)

NAME

       MPSMatrixCopyDescriptor

SYNOPSIS

       #import <MPSMatrixCombination.h>

       Inherits NSObject.

   Instance Methods
       (nonnull instancetype) - initWithDevice:count:
       (void) - setCopyOperationAtIndex:sourceMatrix:destinationMatrix:offsets:
       (nonnull instancetype) - initWithSourceMatrices:destinationMatrices:offsetVector:offset:
       (nonnull instancetype) - init

   Class Methods
       (nonnull instancetype) + descriptorWithSourceMatrix:destinationMatrix:offsets:

Method Documentation
   + (nonnull instancetype) descriptorWithSourceMatrix: (MPSMatrix *__nonnull) sourceMatrix(MPSMatrix *__nonnull)
       destinationMatrix(MPSMatrixCopyOffsets) offsets
       convenience allocator for single copies

   - (nonnull instancetype) init
   - (nonnull instancetype) initWithDevice: (nonnull id< MTLDevice >) device(NSUInteger) count
       initialize a MPSMatrixCopyDescriptor with default values.  Use -setCopyOperationAtIndex:sourceMatrix:destinationMatrix:copyOffsets to
       initialize. All indices must be initialized before use.

       Parameters:
	   device The device on which the copy will be performed
	   count The number of copy operations the object will encode

       Returns:
	   A MPSMatrixCopyDescriptor. It still needs to be initialized with -setCopyOperationAtIndex:sourceMatrix:destinationMatrix:copyOffsets

   - (nonnull instancetype) initWithSourceMatrices: (NSArray< MPSMatrix * > *__nonnull) sourceMatrices(NSArray< MPSMatrix * > *__nonnull)
       destinationMatrices(MPSVector *__nullable) offsets(NSUInteger) byteOffset
       Initialize a MPSMatrixCopyDescriptor using offsets generated on the GPU	Use this method when the offsets needed are coming from GPU based
       computation.

       Parameters:
	   sourceMatrices A list of matrices from which the matrix data is read
	   destinationMatrices A list of matrices to which to write the data. The count must match the number of source matrices.
	   offsets A MPSVector of type MPSDataTypeUInt32 containing the list of offsets, stored as a packed array of MPSMatrixCopyOffsets.
	   byteOffset A byte offset into the offsets vector where the data starts in 'offsets'. This value must be a multiple of 16.

       Returns:
	   A valid MPSMatrixCopyDescriptor to represent the list of copy operations

   - (void) setCopyOperationAtIndex: (NSUInteger) index(MPSMatrix *__nonnull) sourceMatrix(MPSMatrix *__nonnull)
       destinationMatrix(MPSMatrixCopyOffsets) offsets
       Initialize a MPSMatrixCopyDescriptor using offsets generated on the CPU	This is for one at a time intialization of the copy operations

       Parameters:
	   index The index of the copy operation
	   sourceMatrix The source matrix for this copy operation
	   destinationMatrix The destination matrix for this copy operation
	   offsets The offsets to use for the copy operation

Author
       Generated automatically by Doxygen for MetalPerformanceShaders.framework from the source code.

Version MetalPerformanceShaders-100				  Thu Feb 8 2018					MPSMatrixCopyDescriptor(3)

Check Out this Related Man Page

MPSKeyedUnarchiver(3)					 MetalPerformanceShaders.framework				     MPSKeyedUnarchiver(3)

NAME

       MPSKeyedUnarchiver

SYNOPSIS

       #import <MPSKeyedUnarchiver.h>

       Inherits NSKeyedUnarchiver, and <MPSDeviceProvider>.

   Instance Methods
       (nullable instancetype) - init
       (nullable instancetype) - initWithDevice:
       (nonnull instancetype) - initForReadingWithData:
       (nonnull instancetype) - initForReadingWithData:device:
       (__nonnull id< MTLDevice >) - mpsMTLDevice

   Class Methods
       (nullable id) + unarchiveObjectWithData:
       (nullable id) + unarchiveObjectWithData:device:
       (nullable id) + unarchiveTopLevelObjectWithData:error:
       (nullable id) + unarchiveTopLevelObjectWithData:device:error:
       (nullable id) + unarchiveObjectWithFile:
       (nullable id) + unarchiveObjectWithFile:device:

Detailed Description
       A NSKeyedArchiver that supports the MPSDeviceProvider protocol for MPSKernel decoding

Method Documentation
   - (nullable instancetype) init
   - (nonnull instancetype) initForReadingWithData: (NSData *__nonnull) data
   - (nonnull instancetype) initForReadingWithData: (NSData *__nonnull) data(__nonnull id< MTLDevice >) device
   - (nullable instancetype) initWithDevice: (__nonnull id< MTLDevice >) device
   - (__nonnull id <MTLDevice>) mpsMTLDevice
       Reports which device to use for unarchiving MPSKernels

       Reimplemented from <MPSDeviceProvider>.

   + (nullable id) unarchiveObjectWithData: (NSData *__nonnull) data
   + (nullable id) unarchiveObjectWithData: (NSData *__nonnull) data(__nonnull id< MTLDevice >) device
   + (nullable id) unarchiveObjectWithFile: (NSString *__nonnull) path
   + (nullable id) unarchiveObjectWithFile: (NSString *__nonnull) path(__nonnull id< MTLDevice >) device
   + (nullable id) unarchiveTopLevelObjectWithData: (NSData *__nonnull) data(__nonnull id< MTLDevice >) device(NSError *__nullable *__nullable)
       error
   + (nullable id) unarchiveTopLevelObjectWithData: (NSData *__nonnull) data(NSError *__nullable *__nullable) error
Author
       Generated automatically by Doxygen for MetalPerformanceShaders.framework from the source code.

Version MetalPerformanceShaders-100				  Thu Feb 8 2018					     MPSKeyedUnarchiver(3)
Man Page