As with tjDecompressToYUV*(), tjCompressFromYUV() also conditionally uses an intermed...

git-svn-id: svn+ssh://svn.code.sf.net/p/libjpeg-turbo/code/trunk@1170 632fc199-4ca6-4c93-a231-07263d6284db

diff --git a/doc/html/group___turbo_j_p_e_g.html b/doc/html/group___turbo_j_p_e_g.html
index 28e4926eed512c508eb424f2532996930f4d29b5..6936e5df0fc93f2e8ed51acaf1797a6e8ea5bab8 100644 (file)
--- a/doc/html/group___turbo_j_p_e_g.html
+++ b/doc/html/group___turbo_j_p_e_g.html
@@ -1067,6 +1067,7 @@ If you choose option 1, <code>*jpegSize</code> should be set to the size of your
 </div><div class="memdoc">
 
 <p>Compress a YUV planar image into a JPEG image. </p>
+<p>Note that, if the width or height of the YUV image is not an even multiple of the MCU block size (see <a class="el" href="group___turbo_j_p_e_g.html#ga9e61e7cd47a15a173283ba94e781308c" title="MCU block width (in pixels) for a given level of chrominance subsampling.">tjMCUWidth</a> and <a class="el" href="group___turbo_j_p_e_g.html#gabd247bb9fecb393eca57366feb8327bf" title="MCU block height (in pixels) for a given level of chrominance subsampling.">tjMCUHeight</a>), then an intermediate buffer copy will be performed within TurboJPEG.</p>
 <dl class="params"><dt>Parameters</dt><dd>
   <table class="params">
     <tr><td class="paramname">handle</td><td>a handle to a TurboJPEG compressor or transformer instance </td></tr>

diff --git a/turbojpeg.h b/turbojpeg.h
index a082fa36d537dc65f4ea288a41ebbde99c59278c..6c13851a80a14f4883cae685c420f55b333ed5d9 100644 (file)
--- a/turbojpeg.h
+++ b/turbojpeg.h
@@ -636,7 +636,10 @@ DLLEXPORT int DLLCALL tjCompress2(tjhandle handle, unsigned char *srcBuf,
 
 
 /**
- * Compress a YUV planar image into a JPEG image.
+ * Compress a YUV planar image into a JPEG image.  Note that, if the width or
+ * height of the YUV image is not an even multiple of the MCU block size
+ * (see #tjMCUWidth and #tjMCUHeight), then an intermediate buffer copy will be
+ * performed within TurboJPEG.
  *
  * @param handle a handle to a TurboJPEG compressor or transformer instance
  * @param srcBuf pointer to an image buffer containing a YUV planar image