Name

OfxMultiThreadSuiteV1::multiThreadIndex — Function which indicates the index of the current thread

Synopsis

#include "ofxMultiThread.h" 
OfxStatus(*multiThreadIndex)(unsigned int *threadIndex);
 

Arguments

  • threadIndex - pointer to an integer where the result is returned

Description

This function returns the thread index, which is the same as the threadIndex argument passed to the OfxThreadFunctionV1.

If there are no threads currently spawned, then this function will set threadIndex to 0

Returns

  • kOfxStatOK, all was OK and the maximum number of threads is in nThreads.
  • kOfxStatFailed, the function failed to return an index