Improve doc of opj_codec_set_threads()
authorEven Rouault <even.rouault@spatialys.com>
Wed, 11 Oct 2017 23:05:04 +0000 (01:05 +0200)
committerEven Rouault <even.rouault@spatialys.com>
Wed, 11 Oct 2017 23:05:04 +0000 (01:05 +0200)
src/lib/openjp2/openjpeg.h

index f36286eb106e98fab34a69eb1840599f9f01c768..a8357c930dc0dcdda749695bba5288d939e012de 100644 (file)
@@ -1313,6 +1313,9 @@ OPJ_API OPJ_BOOL OPJ_CALLCONV opj_setup_decoder(opj_codec_t *p_codec,
  * number, or "ALL_CPUS". If OPJ_NUM_THREADS is set and this function is called,
  * this function will override the behaviour of the environment variable.
  *
+ * Currently this function must be called after opj_setup_decoder() and
+ * before opj_read_header().
+ *
  * Note: currently only has effect on the decompressor.
  *
  * @param p_codec       decompressor handler