MPSMatrixBinaryKernel(3)

NAME
MPSMatrixBinaryKernel

SYNOPSIS

#import <MPSMatrixTypes.h>

Inherits MPSKernel.

Inherited by MPSMatrixBatchNormalizationGradient, MPSMatrixFullyConnected, MPSMatrixFullyConnectedGradient, MPSMatrixNeuronGradient, MPSMatrixSoftMaxGradient, MPSMatrixSolveCholesky, MPSMatrixSolveLU, MPSMatrixSolveTriangular, and MPSMatrixVectorMultiplication.

  Properties
MTLOrigin primarySourceMatrixOrigin
MTLOrigin secondarySourceMatrixOrigin
MTLOrigin resultMatrixOrigin
NSUInteger batchStart
NSUInteger batchSize

  Additional Inherited Members

Detailed Description

This depends on Metal.framework A MPSMatrixBinaryKernel consumes two MPSMatrix objects and produces one MPSMatrix object.

Property Documentation

  - batchSize [read], [write], [nonatomic], [assign]
The number of matrices in the batch to process. This property is modifiable and by default allows all matrices available at encoding time to be processed. If a single matrix should be processed set this value to 1.

  - batchStart [read], [write], [nonatomic], [assign]
The index of the first matrix in the batch. This property is modifiable and defaults to 0 at initialization time. If batch processing should begin at a different matrix this value should be modified prior to encoding the kernel.

  - primarySourceMatrixOrigin [read], [write], [nonatomic], [assign]
The origin, relative to [0, 0] in the primary source matrix, at which to start reading values. This property is modifiable and defaults to [0, 0] at initialization time. If a different origin is desired then this should be modified prior to encoding the kernel. The z value must be 0.

  - resultMatrixOrigin [read], [write], [nonatomic], [assign]
The origin, relative to [0, 0] in the result matrix, at which to start writing results. This property is modifiable and defaults to [0, 0] at initialization time. If a different origin is desired then this should be modified prior to encoding the kernel. The z value must be 0.

  - secondarySourceMatrixOrigin [read], [write], [nonatomic], [assign]
The origin, relative to [0, 0] in the secondary source matrix, at which to start reading values. This property is modifiable and defaults to [0, 0] at initialization time. If a different origin is desired then this should be modified prior to encoding the kernel. The z value must be 0.

Author

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