Graphisoft®

GX ModuleVersion: 16

ConvertToPixMap

Converts an image to a pixmap.

GSErrCode ConvertToPixMap (
        GSHandle               imageHandle,
        GSPixMapHandle*                pixHdl,
        const FTM::TypeID      inputFormat,
        GSPixelType            outputFormat
);

Parameters

imageHandle
The image to be converted.
pixHdl
The address of the destination pixmap.
inputFormat
The suggested format of the image.
outputFormat
The desired pixel type of the destination pixmap.

Return Values

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

Remarks

The destination pixmap handle; should be NULL-initialized.

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

There are some image formats which has no identifier sign (eg. TGA) in the image data. For these you have to supply the format information.

If you supply the format info, this function won't try other formats.

Requirements

Version:
GX
Header:
GXImageBase.hpp
Import Library:
GXImageBase.lib
Module:
GXImageBase.dll [WIN], GXImageBase.framework [MAC]

See Also

GXImageBase