opensolaris man page for mlib_volumefindmax_u8

mlib_VolumeFindMax_U8(3MLIB)				    mediaLib Library Functions				      mlib_VolumeFindMax_U8(3MLIB)

NAME
       mlib_VolumeFindMax_U8, mlib_VolumeFindMax_S16 - maximum intensity searching

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

       mlib_status mlib_VolumeFindMax_U8(mlib_u8 *max,
	    const mlib_rays *rays);

       mlib_status mlib_VolumeFindMax_S16(mlib_s16 *max,
	    const mlib_rays *rays);

DESCRIPTION
       Each function performs maximum intensity searching.

       It uses the following equation:

	 max[i] = MAX{ rays->results[j][i]
		       j = 0, 1, ..., rays->nsteps[i] }

       where i = 0, 1, ..., rays->nrays - 1.

PARAMETERS
       The function takes the following arguments:

       max     Pointer to an array of rays->nrays maximum values of the samples in each ray.

       rays    Pointer to an mlib_rays structure. The data rays->results are organized with ray number (rather than ray step) varying fastest. Ray
	       number and ray step are the output of the ray casting functions. The data might have values beyond the maximum step on a  ray.  For
	       example, rays->results[rays->nsteps[i]][i] on ray i might not equal 0.

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
       mlib_VolumeFindMaxBMask_U8(3MLIB), mlib_VolumeFindMaxCMask_U8(3MLIB), attributes(5)

SunOS 5.11							    2 Mar 2007					      mlib_VolumeFindMax_U8(3MLIB)