JPEGEncGetSurfaceInfo

Syntax

#include <cafe/jpeg.h>

JPEGStatus JPEGEncGetSurfaceInfo (u32 *pDestHeapSize,
				  const JPEGImageDim *pImageDim);

Parameters

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

Return Values

JPEG_STATUS_OK Function completed successfully.
Any other value Abnormal exit.

Description

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

Given surface buffer dimension pImageDim will not be modified.

Do Not Call From

Multiple threads This function is not thread-safe.

See Also

JPEGEncEncodeSurface
JPEGImageDim

Revision History

2013/06/03 Changed argument order of API and Added notion about constant argument.
2013/05/08 Automated cleanup pass.
2013/02/19 Replaced words 'texture' with 'surface'.
2012/03/07 Initial version.


CONFIDENTIAL