Skip to content

Commit 4ff2df5

Browse files
committed
gpujpeg_encoder_encode doxy clarifications
- mark image_compressed/image_compressed size as output (only) - mention that the output buffer is allocated in host memory (GH-97)
1 parent 2629579 commit 4ff2df5

File tree

1 file changed

+4
-4
lines changed

1 file changed

+4
-4
lines changed

libgpujpeg/gpujpeg_encoder.h

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -164,10 +164,10 @@ gpujpeg_encoder_allocate(struct gpujpeg_encoder* encoder, const struct gpujpeg_p
164164
* @param param Parameters for coder
165165
* @param param_image Parameters for image data
166166
* @param image Source image data
167-
* @param image_compressed Pointer to variable where compressed image data buffer will be placed.
168-
* Buffer is owned by encoder and must not be freed by caller. Buffer
169-
* is valid until next gpujpeg_encoder_encode() call.
170-
* @param image_compressed_size Pointer to variable where compressed image size will be placed.
167+
* @param[out] image_compressed Pointer to variable where compressed image data buffer will be placed.
168+
* Returned host buffer is owned by encoder and must not be freed by the caller.
169+
* Buffer is valid until next gpujpeg_encoder_encode() call.
170+
* @param[out] image_compressed_size Pointer to variable where compressed image size will be placed.
171171
* @return 0 if succeeds, otherwise nonzero
172172
*/
173173
GPUJPEG_API int

0 commit comments

Comments
 (0)