NAME

ilRecommendedStripHeight() − return the recommended strip height for an image

SYNOPSIS

long
ilRecommendedStripHeight (

ilImageDes *pDes,

ilImageFormat *pFormat,

long width,

long height);

DESCRIPTION

ilRecommendedStripHeight() returns the recommended strip height based on the supplied descriptor, format and size of an image. A routine that adds a producer to a pipe can use this function to determine the optimal height of strips to be fed into a pipe.  (See ilAddPipeElement(3X) or Using the Image Developer’s Kit for more information about strips.)  This function is particularly useful when writing an EFS file type handler. 

*pDes is the image descriptor for this image. 

*pFormat is the image format descriptor for this image. 

width, height are the image width and height in pixels. 

EXAMPLE

The following example sets the variable stripHeight to the recommended strip height for a YCbCr plane-oriented image that is 640 pixels wide and 512 pixels high. 

ilContext context;

long stripHeight;
.
.
.

if (!ilRecommendedStripHeight (IL_DES_YCBCR_2,

IL_FORMAT_3BYTE_PLANE,
640, 512)) return(context->error);

ERRORS

If the call fails, context->error receives a non-zero error code. 

AUTHOR

ilRecommendedStripHeight() was developed by HP. 

SEE ALSO

ilAddPipeElement(3X), ilImageFormat(3X), ilerror(3X), ilImageDes(3X). 

Using the Image Developer’s Kit.

Hewlett-Packard Company  —  Image Library: February, 1995