NAME

ilCreateInternalImage − create an empty internal image

SYNOPSIS

ilInternalImage
ilCreateInternalImage (

ilContext context,

long width,

long height,

ilImageDes *pImageDes,

unsigned long mustBeZero);

DESCRIPTION

ilCreateInternalImage() creates an empty internal image and returns it as an ilInternalImage structure.  The values of the image pixels are undefined until the application executes a pipe containing an ilWriteImage() element.  To free the image use ilDestroyObject(), or use ilDestroyContext() on the associated context. 

context identifies a context created by IL_CREATE_CONTEXT(). 

width identifies the width of the image. 

height identifies the height of the image. 

*pImageDes identifies an ilImageDes structure which defines the image type and other attributes of the image to be created. 

mustBeZero identifies a value that must be zero; this parameter is reserved for future use. 

RETURN VALUE

Upon successful completion, ilCreateInternalImage() returns an empty ilInternalImage structure. 

ERRORS

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

EXAMPLE

The following example allocates an internal image that is width x height, 1 byte per pixel, gray-scale. 

ilContext context;

ilInternalImage pImage;

int width, height;
.
.
.

if (!(pImage = ilCreateInternalImage (context,

width, height, IL_DES_GRAY, 0)))

return(context->error);

AUTHOR

ilCreateInternalImage() was developed by HP. 

SEE ALSO

ilWriteImage(3X), ilDestroyObject(3X), ilDestroyContext(3X). 

Using the Image Developer’s Kit.

Hewlett-Packard Company  —  Image Library: February, 1995