[cogl/wip/rib/cogl-1.12: 76/101] Add a note about [0, 0, 0] and cogl_vector3_normalize()

[Robert Bragg <rbragg src gnome org>]

commit 13918c38923e5aa161629c4732a40a9eb4f8647b
Author: Damien Lespiau <damien lespiau intel com>
Date:   Wed May 30 14:40:09 2012 +0100

    Add a note about [0, 0, 0] and cogl_vector3_normalize()
    
    When having the [0, 0, 0] vector, normalize() won't try to divide by 0
    and thus it's always safe to use that funtion.
    
    Reviewed-by: Neil Roberts <neil linux intel com>
    
    (cherry picked from commit 64370e7ddd32f25556a1792c00d14adc48a81d45)

 cogl/cogl-vector.h |    4 ++++
 1 files changed, 4 insertions(+), 0 deletions(-)
---
diff --git a/cogl/cogl-vector.h b/cogl/cogl-vector.h
index 01c6006..eaeba56 100644
--- a/cogl/cogl-vector.h
+++ b/cogl/cogl-vector.h
@@ -233,6 +233,10 @@ cogl_vector3_divide_scalar (float *vector,
  * Updates the vector so it is a "unit vector" such that the
  * @vector<!-- -->s magnitude or length is equal to 1.
  *
+ * <note>It's safe to use this function with the [0, 0, 0] vector, it will not
+ * try to divide components by 0 (its norm) and will leave the vector
+ * untouched.</note>
+ *
  * Since: 1.4
  * Stability: Unstable
  */