ImFusion Web SDK

AlgorithmStatusConstant

ts
type AlgorithmStatusConstant =
  | 'Unknown'
  | 'Success'
  | 'Error'
  | 'InvalidInput'
  | 'IncompleteInput'
  | 'OutOfMemoryHost'
  | 'OutOfMemoryGPU'
  | 'UnsupportedGPU'
  | 'UnknownAction'
  | 'AbortedByUser';

Algorithm Status

  • Unknown: Returned before compute has been called or when algorithm does not implement status interface.
  • Success: Computation was successful
  • Error: Generic catch all error status
  • InvalidInput: Some input arguments do not meet the requirements
  • IncompleteInput: Not all required input has been set
  • OutOfMemoryHost: Insufficient main memory, e.g. a std::bad_alloc
  • OutOfMemoryGPU: Insufficient memory on the GPU
  • UnsupportedGPU: This should be returned when for instance the OpenGL version is not high enough or CUDA/OpenCL is not available
  • UnknownAction: This is returned by runAction if an action with the requested id does not exist
  • AbortedByUser: User canceled execution