ConvertFromPixMap

Creates an image in given format from a pixmap.

    GSErrCode ConvertFromPixMap (

        GSPixMapHandle         pixmapHandle,
        const FTM::TypeID&     targetFormat,
        short                  pixelDepth,
        GSHandle*              target,
        GSHandle               optionsHandle,
        DESC*                  calculatedColorTable,

        short                  quality

);

Parameters

pixmapHandle

The source pixmap.

targetFormat

The format of the target.

pixelDepth

The desired pixel depth in bits in the target. This parameter is ignored if you supply an optionsHandle.

target

The address of the target image.

optionsHandle

A data-stream given back by the SetCompressionSettings function. Default value is NULL.

calculatedColorTable

Default value is NULL.

quality

The color bitdepth of the pixmap. Default value is 0.

Return Values

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

Remarks

If you supply an optionsHandle, the pixelDepth parameter is ignored. The optionsHandle should be made for the given targetFormat.

If you give 0 for quality parameter, or leave it on default, the function will search for the color depth of the picture, but it will slow down the process.

Requirements

Version:

GX

Header:

GXImageBase.hpp

Import Library:

GXImageBase.lib

Module:

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

See Also

GXImageBase