ilGetPrivateType(3X)

NAME

ilGetPrivateType() − return an image type for use with a private-typed image

SYNOPSIS

unsigned int
ilGetPrivateType (

ilContext context);

DESCRIPTION

ilGetPrivateType() returns an image type that can be used by ilCreateClientImage() in creating a private-typed image. The returned image type is a code that is unique within the context named. Private-typed images can be processed only by application-defined filters and by filters that make no assumptions about the meaning of the pixels.

Private-typed images do not work with the following functions: ilWriteFileImage(), ilWriteInternalImage(), ilCreateInternalImage(), ilWriteXDrawable(), or ilConvert().

context identifies a context created by IL_CREATE_CONTEXT().

RETURN VALUE

If successful, ilGetPrivateType() returns an image type that can be used in creating a private-typed image.

ERRORS

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

EXAMPLE

The following example sets variable typeNumber to a unique identifier to be used for private images. This identifier is then used to create a private type client image.

unsigned int typeNumber

ilContext Context

ilImageInfo infoBlock;

ilClientImage pImage;
.
.
.

typeNumber = ilGetPrivateType(context);
.
.
.

infoBlock.pDes->type = typeNumber;

if (!(pImage = ilCreateClientImage (context, infoBlock, 0)))

return(context->error);

AUTHOR

ilGetPrivateType() was developed by HP.

Museum