MPSState.h(3)						 MetalPerformanceShaders.framework					     MPSState.h(3)

NAME

       MPSState.h

SYNOPSIS

       #import <MPSCore/MPSCoreTypes.h>

   Classes
       class MPSStateResourceList
       struct MPSStateTextureInfo
       class MPSState

   Typedefs
       typedef struct MPSStateTextureInfo MPSStateTextureInfo
       typedef enum MPSStateResourceType MPSStateResourceType
       typedef NSArray< MPSState * > MPSStateBatch

   Enumerations
       enum MPSStateResourceType { MPSStateResourceTypeNone, MPSStateResourceTypeBuffer, MPSStateResourceTypeTexture }

   Functions
       NSUInteger MPSStateBatchIncrementReadCount (MPSStateBatch *__nullable batch, NSInteger amount) ''
       NSUInteger void MPSStateBatchSynchronize (MPSStateBatch *__nonnull batch, __nonnull id< MTLCommandBuffer > cmdBuf) ''

Typedef Documentation
   typedef NSArray<MPSState*> MPSStateBatch
   typedef enum MPSStateResourceType
	    MPSStateResourceType"

   typedef struct MPSStateTextureInfo MPSStateTextureInfo
Enumeration Type Documentation
   enum MPSStateResourceType
       Enumerator

       MPSStateResourceTypeNone

       MPSStateResourceTypeBuffer

       MPSStateResourceTypeTexture

Function Documentation
   NSUInteger MPSStateBatchIncrementReadCount (MPSStateBatch *__nullable batch, NSInteger amount)
       raise or lower the readcount of a batch by a set amount	In some circumstances, a MPSState may appear in a MPSStateBatch multiple times.
       This is particularly common when the MPSState serves as an accumulator across the entire batch, such as when accumulating gradients for
       convolution weight update or batch statistics for batch normalization. A naive function would then end up incrementing the state multiple
       times, probably leading to an error.

       MPSStateBatchIncrementReadCount() will efficiently increment the readCounts of each object in the batch only once, avoiding this problem.

       Parameters:
	   batch The MPSStateBatch to increment
	   amount The value to add to the read count for each unique state in the batch

       Returns:
	   The number of different objects in the batch

   NSUInteger void MPSStateBatchSynchronize (MPSStateBatch *__nonnull batch, __nonnull id< MTLCommandBuffer > cmdBuf)
       Call [MTLBlitEncoder synchronizeResource:] on unique resources

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

Version MetalPerformanceShaders-100				  Thu Feb 8 2018						     MPSState.h(3)