ID_OpenImage function

Function that is called to begin the decoding process for an image.

Syntax

PLUGIN_API int __stdcall ID_OpenImage
(
   ID_SourceInfo* psi,
   ID_StateHdl* phs
);

Parameters

psi

Type: ID_SourceInfo*

[in] Image source data

phs

Type: ID_StateHdl*

[out] Image state handle; phs will be passed to the plug-in during subsequent function calls, and is useful for keeping track of what state the plug-in was operating in when the current image was opened.

Return Value

For a description of return values, see Return Values.

Remarks

This function begins the image decoding process for an image. It gives the plug-in the source image data, and returns a state handler via the phs member.

Requirements

Header: ID_PlugIn.h

See also: