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. 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-Thu2Jul 13 2017     MPSMatrixCopyDescriptor(3)


Mac OS X 10.12.6 - Generated Mon Oct 30 19:05:42 CDT 2017