JPEGStatus

Syntax

#include <cafe/jpeg.h>

typedef enum {
    JPEG_STATUS_OK              =   0,
    JPEG_STATUS_ARGS            =  -1,
    JPEG_STATUS_UNSUPPORTED     =  -2,
    JPEG_STATUS_INVALID         =  -3,
    JPEG_STATUS_OUT_OF_MEMORY   =  -6,
    JPEG_STATUS_SHORT_OUTPUT    =  -7,
    JPEG_STATUS_HEAP_ERROR      = -18,
    JPEG_STATUS_FATAL           = -19
} JPEGStatus;

Elements

JPEG_STATUS_OK Indicates a normal exit.
JPEG_STATUS_ARGS Returned when an illegal value was given as an argument to a function.
JPEG_STATUS_UNSUPPORTED Returned when JPEG binary not supported by this library was given as an argument to the JPEGDecDecodeImage or JPEGDecGetImageInfo functions. A strict determination is not made to avoid reduced performance.
JPEG_STATUS_INVALID Returned when invalid JPEG binary was given as an argument to the JPEGDecDecodeImage or JPEGDecGetImageInfo functions.
JPEG_STATUS_OUT_OF_MEMORY Returned when the buffer given for use as work memory to the JPEGEncEncodeSurface or JPEGDecDecodeImage functions is not large enough.
JPEG_STATUS_SHORT_OUTPUT Returned when the buffer to be used to store output JPEG binary given to the JPEGEncEncodeSurface function is not large enough.
JPEG_STATUS_HEAP_ERROR Returned when a call to MEMCreateExpHeap for creating a buffer to be used as work memory by the JPEGEncEncodeSurface or JPEGDecDecodeImage functions has failed.
JPEG_STATUS_FATAL Returned in all cases other than the above.

Description

This enumerated type is used to indicate execution status after encoding surface image or decoding JPEG binary.

See Also

JPEGEncEncodeSurface
JPEGEncGetSurfaceInfo
JPEGDecDecodeImage
JPEGDecGetImageInfo

Revision History

2013/05/08 Automated cleanup pass.
2013/02/19 Replaced words 'texture' with 'surface'.
2012/03/07 Added JPEG_STATUS_SHORT_OUTPUT.
2012/02/02 Changed members so they could be unambiguously distinguished from each other.
2011/08/08 Initial version.


CONFIDENTIAL