random_seed: more elaborate doxy.
authorMichael Niedermayer <michaelni@gmx.at>
Tue, 28 Jun 2011 02:23:20 +0000 (04:23 +0200)
committerMichael Niedermayer <michaelni@gmx.at>
Tue, 28 Jun 2011 02:29:44 +0000 (04:29 +0200)
Signed-off-by: Michael Niedermayer <michaelni@gmx.at>
libavutil/random_seed.h

index 7f75063..bb95787 100644 (file)
 
 /**
  * Get a seed to use in conjunction with random functions.
+ * This function tries to provide a good seed at a best effort bases.
+ * Its possible to call this function multiple times if more bits are needed.
+ * It can be quite slow, which is why it should only be used as seed for a faster
+ * PRNG. The quality of the seed depends on the platform.
  */
 uint32_t av_get_random_seed(void);