opensolaris man page for mlib_signalwhitenoiseinit_f32

mlib_SignalWhiteNoiseInit_F32(3MLIB)			    mediaLib Library Functions			      mlib_SignalWhiteNoiseInit_F32(3MLIB)

NAME
       mlib_SignalWhiteNoiseInit_F32 - white noise generation

SYNOPSIS
       cc [ flag... ] file... -lmlib [ library... ]
       #include <mlib.h>

       mlib_status mlib_SignalWhiteNoiseInit_F32(void **state, mlib_f32 mag,
	    mlib_f32 seed);

DESCRIPTION
       The  mlib_SignalWhiteNoiseInit_F32() function allocates memory for an internal state structure and converts the parameters into an internal
       representation.

PARAMETERS
       The function takes the following arguments:

       state	Internal state structure.

       mag	Magnitude of white noise to be generated, in Q15 format.

       seed	Seed value for the pseudorandom number generator.

RETURN VALUES
       The function returns MLIB_SUCCESS if successful. Otherwise it returns MLIB_FAILURE.

ATTRIBUTES
       See attributes(5) for descriptions of the following attributes:

       +-----------------------------+-----------------------------+
       |      ATTRIBUTE TYPE	     |	    ATTRIBUTE VALUE	   |
       +-----------------------------+-----------------------------+
       |Interface Stability	     |Committed 		   |
       +-----------------------------+-----------------------------+
       |MT-Level		     |MT-Safe			   |
       +-----------------------------+-----------------------------+

SEE ALSO
       attributes(5)

SunOS 5.11							    2 Mar 2007				      mlib_SignalWhiteNoiseInit_F32(3MLIB)