NAME

ilWriteImage() − write a pipe image to a client or internal image

SYNOPSIS

ilBool
ilWriteImage (

ilPipe pipe,

ilObject image);

DESCRIPTION

ilWriteImage() writes a pipe image to a client or internal image.  image must be the same width and height as the pipe image.  The pipe image is otherwise converted as necessary to the image descriptor (and format if the target is a client image) associated with the target image.  The image is compressed if the image has been defined as a compressed image. 

pipe identifies a pipe created by ilCreatePipe(). 

image identifies an ilClientImage or ilInternalImage. 

RETURN VALUE

Upon successful completion, ilWriteImage() returns TRUE. 

ERRORS

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

EXAMPLE

The following example creates a target image that does not require conversion and can thereby complete a pipe that is in the state IL_PIPE_FORMING:

ilPipe pipe;    /* partly formed pipe */

unsigned long width, height;

ilImageDes des;
.
.
.

ilQueryPipe (pipe, &width, &height, &des);

if (image = ilCreateInternalImage

(pipe->context, width, height, des, 0))

ilWriteImage (pipe, image);

AUTHOR

ilWriteImage() was developed by HP. 

SEE ALSO

ilListFileImages(3X). 

Using the Image Developer’s Kit.

Hewlett-Packard Company  —  Image Library: February, 1995