Revision: 56763
http://sourceforge.net/p/brlcad/code/56763
Author: mohitdaga
Date: 2013-08-12 22:19:36 +0000 (Mon, 12 Aug 2013)
Log Message:
-----------
Add comments about new icv_read and icv_write. Also sanitize some comments due
to change in name of api.
Modified Paths:
--------------
brlcad/trunk/include/icv.h
Modified: brlcad/trunk/include/icv.h
===================================================================
--- brlcad/trunk/include/icv.h 2013-08-12 21:55:24 UTC (rev 56762)
+++ brlcad/trunk/include/icv.h 2013-08-12 22:19:36 UTC (rev 56763)
@@ -55,9 +55,9 @@
/** @{ */
/** @file libicv/fileformat.c
*
- * image save/read routines
+ * image read/write routines
*
- * save or read images in a variety of formats.
+ * read/write images in a variety of formats.
*
*/
@@ -181,10 +181,13 @@
ICV_EXPORT int icv_writepixel(icv_image_t *bif, int x, int y, double *data);
/**
- * Saves Image to a file of respective format
+ * Saves Image to a file or streams to stdout in respective format
+ *
+ * To stream it to stdout pass NULL pointer for filename.
+ *
* @param bif Image structure of file.
- * @param filename Filename of the file to be saved
- * @param format Specific format of the file to be saved.
+ * @param filename Filename of the file to be written.
+ * @param format Specific format of the file to be written.
* @return on success 0, on failure -1 with log messages.
*/
ICV_EXPORT extern int icv_write(icv_image_t *bif, const char*filename,
ICV_IMAGE_FORMAT format);
@@ -200,6 +203,8 @@
* square at first, then looking through a set of common sizes, finally
assuming
* 512x512.
*
+ * To read stream from stdin pass NULL pointer for filename.
+ *
* @param filename File to read
* @param hint_format Probable format of the file, typically ICV_IMAGE_AUTO
* @param hint_width Width when passed as parameter from calling program. 0
for default
This was sent by the SourceForge.net collaborative development platform, the
world's largest Open Source development site.
------------------------------------------------------------------------------
Get 100% visibility into Java/.NET code with AppDynamics Lite!
It's a free troubleshooting tool designed for production.
Get down to code-level detail for bottlenecks, with <2% overhead.
Download for free and get started troubleshooting in minutes.
http://pubads.g.doubleclick.net/gampad/clk?id=48897031&iu=/4140/ostg.clktrk
_______________________________________________
BRL-CAD Source Commits mailing list
[email protected]
https://lists.sourceforge.net/lists/listinfo/brlcad-commits
