GetInfo

Gives general image information about an image data.

GSErrCode GSCALL GetInfo (
        GSHandle               imageHandle,
        Int32*                 hSize,
        Int32*                 vSize,
        Int32*                 hRes,
        Int32*                 vRes,
        Int32*                 pixelBitNum,
        const FTM::TypeID&     inputFormat
);

Parameters

imageHandle

The image data.

hSize

The width of the image in the data.

vSize

The height of the image in the data.

hRes

The horizontal resolution of the image in the data.

vRes

The vertical resolution of the image in the data.

pixelBitNum

The bit depth of the pixels of the image in the data.

inputFormat

The suggested format of the image. The default value is FTM::UnknownType.

Return values

If the function succeeds, the return value is NoError. If the function fails, the return value is the error code.

Remarks

This function is used to get information about an image. If some information you don't need, you can give NULL for that parameter.

This function works if you do not supply the format of the image, but considerably slower.

Requirements

Version:

GX

Header:

GXImageBase.hpp

Import Library:

GXImageBase.lib

Module:

GXImageBase.dll [WIN], GXImageBase.framework [MAC]

See Also

GXImageBase