ryan/mozjpeg
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

TurboJPEG: C API documentation buglet

Browse Source 
TJFLAG_NOREALLOC, tjAlloc(), and tjFree() apply to all TurboJPEG
compression functions, not just tjCompress2().
This commit is contained in:
DRC
2017-06-27 11:36:25 -05:00
parent 6a2b067428
commit d0c3aa900b
2 changed files with 14 additions and 14 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
doc/html/group___turbo_j_p_e_g.html
View File

@@ -455,7 +455,7 @@ Variables</h2></td></tr>
</div><div class="memdoc"> </div><div class="memdoc">
<p>Disable buffer (re)allocation. </p> <p>Disable buffer (re)allocation. </p>
<p>If passed to <a class="el" href="group___turbo_j_p_e_g.html#gaf38f2ed44bdc88e730e08b632fa6e88e" title="Compress an RGB, grayscale, or CMYK image into a JPEG image.">tjCompress2()</a> or <a class="el" href="group___turbo_j_p_e_g.html#gad02cd42b69f193a0623a9c801788df3a" title="Losslessly transform a JPEG image into another JPEG image.">tjTransform()</a>, this flag will cause those functions to generate an error if the JPEG image buffer is invalid or too small rather than attempting to allocate or reallocate that buffer. This reproduces the behavior of earlier versions of TurboJPEG. </p> <p>If passed to one of the JPEG compression or transform functions, this flag will cause those functions to generate an error if the JPEG image buffer is invalid or too small rather than attempting to allocate or reallocate that buffer. This reproduces the behavior of earlier versions of TurboJPEG. </p>
</div> </div>
</div> </div>
@@ -812,7 +812,7 @@ Variables</h2></td></tr>
</div><div class="memdoc"> </div><div class="memdoc">
<p>Allocate an image buffer for use with TurboJPEG. </p> <p>Allocate an image buffer for use with TurboJPEG. </p>
<p>You should always use this function to allocate the JPEG destination buffer(s) for <a class="el" href="group___turbo_j_p_e_g.html#gaf38f2ed44bdc88e730e08b632fa6e88e" title="Compress an RGB, grayscale, or CMYK image into a JPEG image.">tjCompress2()</a> and <a class="el" href="group___turbo_j_p_e_g.html#gad02cd42b69f193a0623a9c801788df3a" title="Losslessly transform a JPEG image into another JPEG image.">tjTransform()</a> unless you are disabling automatic buffer (re)allocation (by setting <a class="el" href="group___turbo_j_p_e_g.html#ga8808d403c68b62aaa58a4c1e58e98963" title="Disable buffer (re)allocation.">TJFLAG_NOREALLOC</a>.)</p> <p>You should always use this function to allocate the JPEG destination buffer(s) for the compression and transform functions unless you are disabling automatic buffer (re)allocation (by setting <a class="el" href="group___turbo_j_p_e_g.html#ga8808d403c68b62aaa58a4c1e58e98963" title="Disable buffer (re)allocation.">TJFLAG_NOREALLOC</a>.)</p>
<dl class="params"><dt>Parameters</dt><dd> <dl class="params"><dt>Parameters</dt><dd>
<table class="params"> <table class="params">
<tr><td class="paramname">bytes</td><td>the number of bytes to allocate</td></tr> <tr><td class="paramname">bytes</td><td>the number of bytes to allocate</td></tr>
@@ -1942,7 +1942,7 @@ If you choose option 1, <code>*jpegSize</code> should be set to the size of your
</div><div class="memdoc"> </div><div class="memdoc">
<p>Free an image buffer previously allocated by TurboJPEG. </p> <p>Free an image buffer previously allocated by TurboJPEG. </p>
<p>You should always use this function to free JPEG destination buffer(s) that were automatically (re)allocated by <a class="el" href="group___turbo_j_p_e_g.html#gaf38f2ed44bdc88e730e08b632fa6e88e" title="Compress an RGB, grayscale, or CMYK image into a JPEG image.">tjCompress2()</a> or <a class="el" href="group___turbo_j_p_e_g.html#gad02cd42b69f193a0623a9c801788df3a" title="Losslessly transform a JPEG image into another JPEG image.">tjTransform()</a> or that were manually allocated using <a class="el" href="group___turbo_j_p_e_g.html#ga5c9234bda6d993cdaffdd89bf81a00ff" title="Allocate an image buffer for use with TurboJPEG.">tjAlloc()</a>.</p> <p>You should always use this function to free JPEG destination buffer(s) that were automatically (re)allocated by the compression and transform functions or that were manually allocated using <a class="el" href="group___turbo_j_p_e_g.html#ga5c9234bda6d993cdaffdd89bf81a00ff" title="Allocate an image buffer for use with TurboJPEG.">tjAlloc()</a>.</p>
<dl class="params"><dt>Parameters</dt><dd> <dl class="params"><dt>Parameters</dt><dd>
<table class="params"> <table class="params">
<tr><td class="paramname">buffer</td><td>address of the buffer to free</td></tr> <tr><td class="paramname">buffer</td><td>address of the buffer to free</td></tr>

20
turbojpeg.h
View File

@@ -1,5 +1,5 @@
/* /*
* Copyright (C)2009-2015 D. R. Commander. All Rights Reserved. * Copyright (C)2009-2015, 2017 D. R. Commander. All Rights Reserved.
* *
* Redistribution and use in source and binary forms, with or without * Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met: * modification, are permitted provided that the following conditions are met:
@@ -358,11 +358,11 @@ enum TJCS
*/ */
#define TJFLAG_FASTUPSAMPLE 256 #define TJFLAG_FASTUPSAMPLE 256
/** /**
* Disable buffer (re)allocation. If passed to #tjCompress2() or * Disable buffer (re)allocation. If passed to one of the JPEG compression or
* #tjTransform(), this flag will cause those functions to generate an error if * transform functions, this flag will cause those functions to generate an
* the JPEG image buffer is invalid or too small rather than attempting to * error if the JPEG image buffer is invalid or too small rather than
* allocate or reallocate that buffer. This reproduces the behavior of earlier * attempting to allocate or reallocate that buffer. This reproduces the
* versions of TurboJPEG. * behavior of earlier versions of TurboJPEG.
*/ */
#define TJFLAG_NOREALLOC 1024 #define TJFLAG_NOREALLOC 1024
/** /**
@@ -1435,8 +1435,8 @@ DLLEXPORT int DLLCALL tjDestroy(tjhandle handle);
/** /**
* Allocate an image buffer for use with TurboJPEG. You should always use * Allocate an image buffer for use with TurboJPEG. You should always use
* this function to allocate the JPEG destination buffer(s) for #tjCompress2() * this function to allocate the JPEG destination buffer(s) for the compression
* and #tjTransform() unless you are disabling automatic buffer * and transform functions unless you are disabling automatic buffer
* (re)allocation (by setting #TJFLAG_NOREALLOC.) * (re)allocation (by setting #TJFLAG_NOREALLOC.)
* *
* @param bytes the number of bytes to allocate * @param bytes the number of bytes to allocate
@@ -1452,8 +1452,8 @@ DLLEXPORT unsigned char* DLLCALL tjAlloc(int bytes);
/** /**
* Free an image buffer previously allocated by TurboJPEG. You should always * Free an image buffer previously allocated by TurboJPEG. You should always
* use this function to free JPEG destination buffer(s) that were automatically * use this function to free JPEG destination buffer(s) that were automatically
* (re)allocated by #tjCompress2() or #tjTransform() or that were manually * (re)allocated by the compression and transform functions or that were
* allocated using #tjAlloc(). * manually allocated using #tjAlloc().
* *
* @param buffer address of the buffer to free * @param buffer address of the buffer to free
* *