[Bf-blender-cvs] [b4e56dc] master: Doc: more detailed ImBuf.rect/rect_float comments
Campbell Barton
noreply at git.blender.org
Thu Jan 14 21:17:36 CET 2016
Commit: b4e56dce30cf1f2495f1222800627bd003591a3d
Author: Campbell Barton
Date: Fri Jan 15 07:08:28 2016 +1100
Branches: master
https://developer.blender.org/rBb4e56dce30cf1f2495f1222800627bd003591a3d
Doc: more detailed ImBuf.rect/rect_float comments
===================================================================
M source/blender/imbuf/IMB_imbuf_types.h
===================================================================
diff --git a/source/blender/imbuf/IMB_imbuf_types.h b/source/blender/imbuf/IMB_imbuf_types.h
index 0af203c..f4b2539 100644
--- a/source/blender/imbuf/IMB_imbuf_types.h
+++ b/source/blender/imbuf/IMB_imbuf_types.h
@@ -156,10 +156,19 @@ typedef struct ImBuf {
int mall; /* what is malloced internal, and can be freed */
/* pixels */
- unsigned int *rect; /* pixel values stored here */
- float *rect_float; /* floating point Rect equivalent
- * Linear RGB color space - may need gamma correction to
- * sRGB when generating 8bit representations */
+
+ /** Image pixel buffer (8bit representation):
+ * - color space defaults to `sRGB`.
+ * - alpha defaults to 'straight'.
+ */
+ unsigned int *rect;
+ /** Image pixel buffer (float representation):
+ * - color space defaults to 'linear' (`rec709`).
+ * - alpha defaults to 'premul'.
+ * \note May need gamma correction to `sRGB` when generating 8bit representations.
+ * \note Formats that support higher more than 8 but channels load as floats.
+ */
+ float *rect_float;
/* resolution - pixels per meter */
double ppm[2];
More information about the Bf-blender-cvs
mailing list