Content-type: text/html Man page of mlib_ImageTestFlags

mlib_ImageTestFlags

Section: mediaLib Library Functions (3MLIB)
Updated: 2 Mar 2007
Index Return to Main Contents
 

NAME

mlib_ImageTestFlags - test flags  

SYNOPSIS

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

int mlib_ImageTestFlags(const mlib_image *img, mlib_s32 flags);

 

DESCRIPTION

The mlib_ImageTestFlags() function tests the flags for a combination of the following predefined characteristics. Note that the result of zero means the conditions are satisfied.

MLIB_IMAGE_ALIGNED64     /* data address is 64-byte aligned */
MLIB_IMAGE_ALIGNED8      /* data address is 8-byte aligned */
MLIB_IMAGE_ALIGNED4      /* data address is 4-byte aligned */
MLIB_IMAGE_ALIGNED2      /* data address is 2-byte aligned */
MLIB_IMAGE_WIDTH8X       /* width is multiple of 8 */
MLIB_IMAGE_WIDTH4X       /* width is multiple of 4 */
MLIB_IMAGE_WIDTH2X       /* width is multiple of 2 */
MLIB_IMAGE_HEIGHT8X      /* height is multiple of 8 */
MLIB_IMAGE_HEIGHT4X      /* height is multiple of 4 */
MLIB_IMAGE_HEIGHT2X      /* height is multiple of 2 */
MLIB_IMAGE_STRIDE8X      /* stride is multiple of 8 */
MLIB_IMAGE_ONEVECTOR     /* stride is equal to width in bytes */
MLIB_IMAGE_USERALLOCATED /* data space has been allocated by user */
MLIB_IMAGE_ATTRIBUTESET  /* image attribute flags have been set */

 

PARAMETERS

The function takes the following arguments:

img

Pointer to a mediaLib image structure.

flags

Combination of a set of characteristics to be tested. It is formed by logically Oring one or more individual predefined characteristics.

 

RETURN VALUES

The function returns an integer value containing results of test. Condition = 0 if satisfied; otherwise, Condition != 0.  

ATTRIBUTES

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

ATTRIBUTE TYPEATTRIBUTE VALUE

Interface StabilityCommitted

MT-Level

 

SEE ALSO

mlib_ImageGetFlags(3MLIB), attributes(5)


 

Index

NAME
SYNOPSIS
DESCRIPTION
PARAMETERS
RETURN VALUES
ATTRIBUTES
SEE ALSO

This document was created by man2html, using the manual pages.
Time: 02:38:26 GMT, October 02, 2010