JPEGEncGetInfo DEPRECATED

Syntax

#include <cafe/jpeg.h>

JPEGStatus
JPEGEncGetInfo (
            JPEGImageDim *pImageDim,
            u32          *pDestHeapSize);

Parameters

pImageDim The address of the JPEGImageDim object that includes the width, height, and number of colors of the surface image to be encoded.
pDestHeapSize The address at which to store the size of the temporary buffer required to encode the given surface.

Return Values

JPEG_STATUS_OK Function completed successfully.
Any other value Abnormal exit.

Description

This function is deprecated. Use JPEGEncGetSurfaceInfo instead.

Calculates the size of the temporary buffer required by the JPEGEncEncode function to encode surface image based on image information given in the pImageDim argument. The calculated value is stored in pDestHeapSize.

Do Not Call From

Deprecated Do not call this function in new code.
Multiple threads This function is not thread-safe.

See Also

JPEGEncEncode
JPEGImageDim

Revision History

2013/06/04 This API is now deprecated.
2013/05/08 Automated cleanup pass.
2013/02/19 Replaced words 'texture' with 'surface'.
2012/03/07 Initial version.


CONFIDENTIAL