ImageProcessor::TInputInfo Class Reference

#include <imageprocessor/imageprocessorinputinfo.h>

Link against: imageprocessor.lib

class ImageProcessor::TInputInfo
Public Member Functions
IMPORT_C TUint32BitsPerPixelL()
IMPORT_C TDisplayModeDisplayModeL()
IMPORT_C TAny *Extension(TUid)
IMPORT_C voidFormatL(TUid &, TUid &)
IMPORT_C TBoolHasAlphaL()
IMPORT_C TUidImageFrameFormatL()
IMPORT_C TBoolIsInterlacedL()
IMPORT_C TBoolIsProgressiveL()
IMPORT_C TUidSamplingL()
IMPORT_C TSizeSizeL()

Detailed Description

This class provides functions to read input image details. These details can be used for display in a file browser or to verify the correct capabilities. Prior to use this API, a pointer to ImageProcessor::InputInfoL() interface must be obtained from the active CImgProcessor instance.

Member Function Documentation

BitsPerPixelL ( )

IMPORT_C TUint32BitsPerPixelL()const

Gets the bits per pixel of input image.

Returns: bits per pixel of image.

DisplayModeL ( )

IMPORT_C TDisplayModeDisplayModeL()const

Gets the display mode of input image.

Returns: display mode of image.

Extension ( TUid )

IMPORT_C TAny *Extension(TUidaExtension)const

Retrieves access to a custom extension.

ParameterDescription
aExtensionThe UID of the extension to be retrieved

Returns: Extension corresponding to the UID given as a parameter.

FormatL ( TUid &, TUid & )

IMPORT_C voidFormatL(TUid &aFormat,
TUid &aSubFormat
)const

Gets the input image format

leave
KErrNotReady The effect is not active.
ParameterDescription
aFormatReturns the Uid of the format.
aSubFormatReturns the sub Uid of the format.

HasAlphaL ( )

IMPORT_C TBoolHasAlphaL()const

Gets the the image alpha information.

Returns: true if input image has alpha channel.

ImageFrameFormatL ( )

IMPORT_C TUidImageFrameFormatL()const

Gets the uid of frame format of input image. When calling TInputInfo::DisplayModeL() returns ENone, this ImageFrameFormatL() could be used to get image frame format.

Returns: uid of frame format of the image.

IsInterlacedL ( )

IMPORT_C TBoolIsInterlacedL()const

Gets the source image information and scans whether the source image is interlaced or not.

Returns: ETrue if the source image is interlaced otherwise EFlase.

IsProgressiveL ( )

IMPORT_C TBoolIsProgressiveL()const

Gets the source image information and scans whether the source image allows progressive decoding or not.

Returns: ETrue if the source image allows progressive decoding otherwise EFalse.

SamplingL ( )

IMPORT_C TUidSamplingL()const

Gets the sampling of input image.

Returns: sampling of image.

SizeL ( )

IMPORT_C TSizeSizeL()const

Gets the size of input image

Returns: size of the image