MPSVector(3)						 MetalPerformanceShaders.framework					      MPSVector(3)

NAME

       MPSVector

SYNOPSIS

       #import <MPSMatrixTypes.h>

       Inherits NSObject.

       Inherited by MPSTemporaryVector.

   Instance Methods
       (nonnull instancetype) - initWithBuffer:descriptor:
       (nonnull instancetype) - initWithDevice:descriptor:
       (nonnull instancetype) - init
       (void) - synchronizeOnCommandBuffer:
       (NSUInteger) - resourceSize

   Properties
       id< MTLDevice > device
       NSUInteger length
       NSUInteger vectors
       MPSDataType dataType
       NSUInteger vectorBytes
       id< MTLBuffer > data

Detailed Description
       This depends on Metal.framework

       A MPSVector object describes a 1-dimensional array of data and provides storage for its values. Some MPSMatrixKernel objects operate on
       MPSVector objects for convenience.

Method Documentation
   - (nonnull instancetype) init
   - (nonnull instancetype) initWithBuffer: (nonnull id< MTLBuffer >) buffer(nonnull MPSVectorDescriptor *) descriptor
       Initialize a MPSVector object with a MTLBuffer.

       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.

       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.

       Reimplemented in MPSTemporaryVector.

   - (nonnull instancetype) initWithDevice: (nonnull id< MTLDevice >) device(MPSVectorDescriptor *__nonnull) descriptor
       Initialize a lazily backed MPSVector object with a descriptor

       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  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.

   - (NSUInteger) resourceSize
       Get the number of bytes used to allocate underyling MTLResources  This is the size of the backing store of underlying MTLResources. It does
       not include all storage used by the object, for example the storage used to hold the MPSVector instantiation and MTLBuffer is not included.
       It only measures the size of the allocation used to hold the vector data in the buffer. This value is subject to change between different
       devices and operating systems.

       Except when -initWithBuffer:descriptor: is used, most MPSVectors are allocated without a backing store. The backing store is allocated
       lazily when it is needed, typically when the .texture property is called. Consequently, in most cases, it should be inexpensive to make a
       MPSMatrix to see how much memory it will need, and release it if it is too large.

       This method may fail in certain circumstances, such as when the MPSMatrix is created with -initWithBuffer:descriptor:. In such cases, 0
       will be returned.

   - (void) synchronizeOnCommandBuffer: (__nonnull id< MTLCommandBuffer >) commandBuffer
       Flush the underlying MTLBuffer from the device's caches, and invalidate any CPU caches if needed.  This will call [id <MTLBlitEncoder>
       synchronizeResource: ] on the vector's MTLBuffer, if any. This is necessary for all MTLStorageModeManaged resources. For other resources,
       including temporary resources (these are all MTLStorageModePrivate), and buffers that have not yet been allocated, nothing is done. It is
       more efficient to use this method than to attempt to do this yourself with the data property.

       Parameters:
	   commandBuffer The commandbuffer on which to synchronize

Property Documentation
   - data [read],  [nonatomic],  [assign]
       An MTLBuffer to store the data.

   - dataType [read],  [nonatomic],  [assign]
       The type of the MPSVector data.

   - device [read],  [nonatomic],  [retain]
       The device on which the MPSVector will be used.

   - length [read],  [nonatomic],  [assign]
       The number of elements in the vector.

   - vectorBytes [read],  [nonatomic],	[assign]
       The stride, in bytes, between corresponding elements of consecutive vectors.

   - vectors [read],  [nonatomic],  [assign]
       The number of vectors in the MPSVector.

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

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