ImageProcessor::CImgProcessor Class Reference
#include
<imageprocessor/imageprocessor.h>
Link against: imageprocessor.lib
class ImageProcessor::CImgProcessor : public CBase |
Inherits from
- ImageProcessor::CImgProcessor
Public Member Enumerations |
---|
enum | TEvent { EEventInitializing, EEventInitializingComplete, EEventProcessing, EEventProcessingComplete, ..., EEventPreviewRenderingComplete } |
enum | TOperation { EOperationNone, EOperationRotate90, EOperationRotate180, EOperationRotate270, ..., EOperationMirrorVerticalAxisRotate90 } |
enum | TOptions { EOptionNone, EOptionSyncProcessing, EOptionExifMetadataProcessing } |
enum | TState { EUninitialized, EInitializing, EInitialized, EEffectActive, ..., EStatesCount } |
Public Member Functions |
---|
| ~CImgProcessor() |
IMPORT_C void | ApplyOperationL(CImgProcessor::TOperation) |
IMPORT_C TRgb | BackgroundColorL() |
IMPORT_C TInt | CalculatePixelBufferSizeL(TSize, TDisplayMode, TUint32) |
IMPORT_C TInt | CalculatePixelBufferSizeL(TSize, const TUid &, TUint32) |
IMPORT_C TBool | CanRedoL() |
IMPORT_C TBool | CanUndoL() |
IMPORT_C void | Cancel() |
IMPORT_C void | ConvertFileExtensionToUidL(const TDesC &, TUid &, TUid &) |
IMPORT_C void | ConvertMimeTypeToUidL(const TDesC8 &, TUid &, TUid &) |
IMPORT_C void | ConvertUidToFileExtensionL(TDes &, const TUid &, const TUid &) |
IMPORT_C void | ConvertUidToMimeTypeL(TDes8 &, const TUid &, const TUid &) |
IMPORT_C void | CreateInputL(CFbsBitmap &) |
IMPORT_C void | CreateInputL(CImageFrame &) |
IMPORT_C void | CreateInputL(const TSize &, const TRgb &) |
IMPORT_C TSize | CurrentSizeL() |
IMPORT_C TEffect * | EffectL(TUid) |
IMPORT_C TAny * | Extension(TUid) |
IMPORT_C void | InitializeL() |
IMPORT_C void | InitializeL(TUint64) |
IMPORT_C TInputInfo * | InputInfoL() |
IMPORT_C void | InputUpdatedL() |
IMPORT_C CImgProcessor * | NewL(RFs &, MImgProcessorObserver &, TUid) |
IMPORT_C TUint64 | Options() |
IMPORT_C TOutputInfo * | OutputInfoL() |
IMPORT_C TOverlay * | OverlayL() |
IMPORT_C TPreview * | PreviewL(TInt) |
IMPORT_C void | ProcessL() |
IMPORT_C void | ProcessL(const TSize &, TBool) |
IMPORT_C TProgressInfo * | ProgressInfoL() |
IMPORT_C void | RedoAllL() |
IMPORT_C void | RedoL() |
IMPORT_C void | ResetL() |
IMPORT_C void | SetBackgroundColorL(const TRgb &) |
IMPORT_C void | SetInputL(const TDesC &, const TUid &, const TUid &) |
IMPORT_C void | SetInputL(RFile &, const TUid &, const TUid &) |
IMPORT_C void | SetInputL(TMMSource &, const TUid &, const TUid &) |
IMPORT_C void | SetInputL(const TDesC8 &, const TUid &, const TUid &) |
IMPORT_C void | SetInputL(const CFbsBitmap &, const CFbsBitmap *) |
IMPORT_C void | SetInputL(const CImageFrame &) |
IMPORT_C void | SetInputL(CImagePanorama &) |
IMPORT_C void | SetInputRectL(const TRect &) |
IMPORT_C void | SetOptionsL(TUint64) |
IMPORT_C void | SetOutputL(const TDesC &, const TUid &, const TUid &) |
IMPORT_C void | SetOutputL(RFile &, const TUid &, const TUid &) |
IMPORT_C void | SetOutputL(RBuf8 &, const TUid &, const TUid &) |
IMPORT_C void | SetOutputL(CImageFrame &) |
IMPORT_C void | SetOutputL(CFbsBitmap &, CFbsBitmap *) |
IMPORT_C TState | State() |
IMPORT_C void | SupportedEffectsL(RArray< TUid > &) |
IMPORT_C void | SupportedInputDisplayModesL(RArray< TDisplayMode > &) |
IMPORT_C void | SupportedInputFormatsL(RArray< TUid > &) |
IMPORT_C void | SupportedInputImageFrameFormatsL(RArray< TUid > &) |
IMPORT_C void | SupportedInputSubFormatsL(TUid, RArray< TUid > &) |
IMPORT_C TUint | SupportedOperations() |
IMPORT_C TUint64 | SupportedOptions() |
IMPORT_C void | SupportedOutputDisplayModesL(RArray< TDisplayMode > &) |
IMPORT_C void | SupportedOutputFormatsL(RArray< TUid > &) |
IMPORT_C void | SupportedOutputImageFrameFormatsL(RArray< TUid > &) |
IMPORT_C void | SupportedOutputSubFormatsL(TUid, RArray< TUid > &) |
IMPORT_C void | UndoAllL() |
IMPORT_C void | UndoL() |
Detailed Description
This class provides functions to process images. Those operations can be divided in two groups:
effects.
geometrical operations.
Good examples of effects could be the Sepia effect applying shades of brown to an image, or the solarize effect that consists in reversing the tones of a picture and make it look like a negative. Good examples of geometrical operations could be Rotation or Flip.
The image processor will decode and render an image:
Inputs can be
compressed images (JPEG, GIF, PNG etc)
uncompressed images (CFbsBitmap and general pixel buffers e.g. YUV 4:2:0 Interleaved etc)
Outputs can be
compressed images (JPEG, GIF, PNG etc)
uncompressed images (CFbsBitmap and general pixel buffers e.g. YUV 4:2:0 Interleaved etc)
An intermediate generally low resolution uncompressed image providing a preview representation of the output of the processing is provided allowing applications to display the results of the operations applied without needing to fully render the image. Multiple previews are allowed.
Images may be overlaid onto the main source image.
The source image can be changed and the current effects and geometric oprations will be re-applied to the new image. The previews will be updated.
Member Enumeration Documentation
Enum TEvent
Events occurring during processing.
Enum TOperation
Flags to control the operations or transforms on an image.
Enum TOptions
Flags to control how the image is processed.
Enum TState
Possible states for the image processor.
Constructor & Destructor Documentation
~CImgProcessor ( )
Member Function Documentation
ApplyOperationL ( CImgProcessor::TOperation )
Applies a geometrical operation to the image. The image processor needs to be in an initialized state.
Parameters |
---|
aOperation | The geometrical operation to be applied. |
BackgroundColorL ( )
IMPORT_C TRgb | BackgroundColorL | ( | ) | const |
Retrieves the current background color.
- Return Value
- The current background color.
Leave Codes |
---|
KErrNotReady | The input of the image processor is not set. |
Other | A range of system wide error codes. |
CalculatePixelBufferSizeL ( TSize, TDisplayMode, TUint32 )
Calculates the required pixel buffer size in bytes for the destination image given display mode and scan line length.
Parameters |
---|
aSizeInPixels | The size in pixels of the image to calculate buffer size for. |
aDisplayMode | The display mode of the destination image to calculate buffer size for. section for details. |
aScanLineLength | Number of bytes per image row. |
- Return Value
- The calculated pixel buffer size in bytes.
Leave Codes |
---|
KErrNotReady | The image processor is not in EUninitialized state. |
Other | A range of system wide error codes. |
CalculatePixelBufferSizeL ( TSize, const TUid &, TUint32 )
IMPORT_C TInt | CalculatePixelBufferSizeL | ( | TSize | aSizeInPixels, |
| const TUid & | aFormat, |
| TUint32 | aScanLineLength = 0 |
| ) | const |
Calculates the required pixel buffer size in bytes for the destination image given destination uncompressed image format and scan line length.
Parameters |
---|
aSizeInPixels | The size in pixels of the raw image to calculate buffer size for. |
aFormat | The format of the raw image to calculate buffer size for (one of the valid CImageFrame formats). section for details. |
aScanLineLength | Number of bytes per image row. |
- Return Value
- The calculated pixel buffer size.
Leave Codes |
---|
KErrNotReady | The image processor is not in EUninitialized state. |
Other | A range of system wide error codes. |
CanRedoL ( )
IMPORT_C TBool | CanRedoL | ( | ) | const |
Determines if there are operations on the operation stack which can be re-applied.
- Return Value
- ETrue if at least one operation applied to the image can be redone; EFalse otherwise.
Leave Codes |
---|
KErrNotReady | The image processor is not initialized or input is not set. |
CanUndoL ( )
IMPORT_C TBool | CanUndoL | ( | ) | const |
Determines if there are operations on the operation stack which can be 'undone'.
- Return Value
- ETrue if at least one operation applied to the image can be undone; EFalse otherwise.
Leave Codes |
---|
KErrNotReady | The image processor is not initialized or input is not set. |
Other | A range of system wide error codes. |
Cancel ( )
Cancels any current asynchronous operation, for example preview or output rendering. Ignored if no asynchronous operation is in progress.
ConvertFileExtensionToUidL ( const TDesC &, TUid &, TUid & )
IMPORT_C void | ConvertFileExtensionToUidL | ( | const TDesC & | aFileExtension, |
| TUid & | aFormat, |
| TUid & | aSubFormat |
| ) | const |
Converts a given file extension to format and sub-format UIDs.
Parameters |
---|
aFileExtension | The file extension to convert. |
aFormat | The format UID corresponding to the given file extension. |
aSubFormat | The sub-format UID corresponding to the given file extension. |
Leave Codes |
---|
KErrNotFound | The given file extension is not found in existing formats. |
Other | A range of system wide error codes. |
ConvertMimeTypeToUidL ( const TDesC8 &, TUid &, TUid & )
IMPORT_C void | ConvertMimeTypeToUidL | ( | const TDesC8 & | aMimeType, |
| TUid & | aFormat, |
| TUid & | aSubFormat |
| ) | const |
Converts a given mime type to format and sub-format UIDs.
Parameters |
---|
aMimeType | The mime type to convert. |
aFormat | The format UID corresponding to the given mime type. |
aSubFormat | The sub-format UID corresponding to the given mime type. |
Leave Codes |
---|
KErrNotFound | The given mime type is not found in existing formats. |
Other | A range of system wide error codes. |
ConvertUidToFileExtensionL ( TDes &, const TUid &, const TUid & )
IMPORT_C void | ConvertUidToFileExtensionL | ( | TDes & | aFileExtension, |
| const TUid & | aFormat, |
| const TUid & | aSubFormat |
| ) | const |
Converts a format and sub-format UIDs to a file extension.
Parameters |
---|
aFileExtension | The file extension corresponding to the given format and sub-format UIDs. (Consider re-ordering these parameters) |
aFormat | The format UID to convert. |
aSubFormat | The sub-format UID to convert. |
Leave Codes |
---|
KErrNotFound | The given format UID is not found in existing file extensions. |
Other | A range of system wide error codes. |
ConvertUidToMimeTypeL ( TDes8 &, const TUid &, const TUid & )
IMPORT_C void | ConvertUidToMimeTypeL | ( | TDes8 & | aMimeType, |
| const TUid & | aFormat, |
| const TUid & | aSubFormat |
| ) | const |
Converts a format and sub-format UID to a mime type.
Parameters |
---|
aMimeType | Returns the mime type corresponding to the given format and sub-format UIDs. (Consider re-ordering these parameters) |
aFormat | The format UID to convert. |
aSubFormat | The sub-format UID to convert. |
Leave Codes |
---|
KErrNotFound | The given format UID is not found in existing mime types. |
Other | A range of system wide error codes. |
CreateInputL ( CFbsBitmap & )
Creates internal pixel buffer for the input and copies data from source bitmap to internal buffer
Parameters |
---|
aBitmap | The bitmap to copy. |
Leave Codes |
---|
KErrNotReady | The image processor is not initialized. |
KErrArgument | The input bitmap size is 0. |
Other | A range of system wide error codes. |
CreateInputL ( CImageFrame & )
Creates internal pixel buffer the for the source image and copies data from the image frame to the internal buffer
Parameters |
---|
aPixelBuffer | The image frame to copy. |
Leave Codes |
---|
KErrNotReady | The image processor is not initialized. |
KErrArgument | The input bitmap size is 0. |
Other | A range of system wide error codes. |
CreateInputL ( const TSize &, const TRgb & )
IMPORT_C void | CreateInputL | ( | const TSize & | aSize, |
| const TRgb & | aColor |
| ) | |
Creates internal pixel buffer for the source image using the given size and initializes source image with the given color.
Parameters |
---|
aSize | The size of the new source image. |
aColor | The color of the new source image. |
Leave Codes |
---|
KErrNotReady | The image processor is not initialized. |
KErrArgument | The input bitmap size is 0. |
Other | A range of system wide error codes. |
CurrentSizeL ( )
IMPORT_C TSize | CurrentSizeL | ( | ) | const |
Retrieves the size of the current source image.
- Return Value
- The size of the current source image.
Leave Codes |
---|
KErrNotReady | The input image source data hasn't been set. |
Other | A range of system wide error codes. |
EffectL ( TUid )
Retrieves the interface to an specific effect (e.g. Sepia effect) given an effect UID.
- Return Value
- The effect interface corresponding to the given effect UID.
Leave Codes |
---|
KErrNotReady | The image processor is not initialized or is initializing. |
KErrNotSupported | The given effect is not supported. |
KErrNoMemory | Not enough memory. |
Other | A range of system wide error codes. |
Extension ( TUid )
IMPORT_C TAny * | Extension | ( | TUid | aExtension | ) | |
Retrieves a non-standard extension on the image processor.
Parameters |
---|
aExtension | The UID of the extension to be retrieved |
- Return Value
- Extension corresponding to the UID given as a parameter.
InitializeL ( )
IMPORT_C void | InitializeL | ( | ) | |
Initializes the image processor asynchronously. After this asynchronous call completes,the image processor's state should normally be EInitialized.
Leave Codes |
---|
KErrNotReady | The image processor has already been initialized. |
Other | A range of system wide error codes. |
InitializeL ( TUint64 )
IMPORT_C void | InitializeL | ( | TUint64 | aOptions | ) | |
Initializes the image processor. After the initialization completes, the image processor's state should normally be EInitialized.
Parameters |
---|
aOptions | The options to set to this image processor with the initialization. |
Leave Codes |
---|
KErrNotReady | The image processor has already been initialized. |
KErrNotSupported | The option to set to the image processor is not supported. |
Other | A range of system wide error codes. |
InputInfoL ( )
Retrieves information about the current source image.
- Return Value
- a TInputInfo filled with all available information about the current source image.
Leave Codes |
---|
KErrNotReady | The image processor is not initialized or is initializing. |
KErrNoMemory | Not enough memory. |
Other | A range of system wide error codes. |
InputUpdatedL ( )
IMPORT_C void | InputUpdatedL | ( | ) | |
This method needs to be called when the input image source data has been updated externally.
Leave Codes |
---|
KErrNotReady | The image processor is not initialized or input image source data hasn't been set. |
Other | A range of system wide error codes. |
NewL ( RFs &, MImgProcessorObserver &, TUid )
Constructs a new image processor object.
Parameters |
---|
aFileServerSession | A file server session for the image processor to use. |
aObserver | The image processor observer to recieve callbacks. |
aImageProcessorPluginUid | The UID of the image processor plugin to load. Can be set to KUidNull which will load the highest version of the plugin. |
- Return Value
- A pointer to the new image processor object.
Leave Codes |
---|
KErrNoMemory | There is insufficient memory available. |
Options ( )
- Return Value
- A TUint containing the image processor options.
OutputInfoL ( )
Retrieves information about the output image.
- Return Value
- a TOutputInfo filled with all available information about the output image.
Leave Codes |
---|
KErrNotReady | The image processor is not initialized or is initializing. |
KErrNoMemory | Not enough memory. |
Other | A range of system wide error codes. |
OverlayL ( )
Retrieves this image processor's TOverlay object. TOverlay provides functions to overlay a border or clipart onto an image.
- Return Value
- The image processor's overlay object.
Leave Codes |
---|
KErrNotReady | The image processor is not initialized or is initializing. |
KErrNoMemory | Not enough memory. |
Other | A range of system wide error codes. |
PreviewL ( TInt )
Displays a low resolution preview of the output image with the effects and/or operations applied before rendering to a high resolution output image. Multiple previews are possible.
If the requested preview already exists, it will be returned, otherwise a new preview with id aPreviewId will be created and returned.
Parameters |
---|
aPreviewId | The unique id for preview image. It is not the index of the preview of Image Processor. Instead any value can be given here to either return an preview previously created or will create a new one with that id. |
- Return Value
- A TPreview object.
Leave Codes |
---|
KErrNotReady | The image processor is not initialized or is initializing. |
KErrNoMemory | Not enough memory. |
Other | A range of system wide error codes. |
ProcessL ( )
All operations and effects are performed on the source image which is then rendered to the output specified. The size for the output image being rendered is the same as the size for the input image. Aspect ratio is maintained.
The image processor behaves differently according to if ImageProcessor::EOptionSyncProcessing is set or not
See also: ImageProcessor::CImgProcessor::SetOptionsL. In the asynchronous case the call leaves with KErrNorReady immediately if the image processor is not initialised. If an error occurs during asynchronous processing then the error is reported back to the client via the observer ImageProcessor::MImgProcessorObserver.
In the synchronous case i.e. when ImageProcessor::EOptionSyncProcessing is set then the same errors are reported except this time by leaving with the error code directly from ProcessL. In this case no callback is made to the observer.
Leave Codes |
---|
KErrNotReady | The image processor is not initialized or input is not set or output is not set. |
Other | A range of system wide error codes. |
ProcessL ( const TSize &, TBool )
IMPORT_C void | ProcessL | ( | const TSize & | aSize, |
| TBool | aMaintainAspectRatio |
| ) | |
All operations and effects are performed on the source image which is then rendered to the output specified. The aspect ratio can be controlled.
Parameters |
---|
aSize | The proposed size for the output image being rendered. If a size of 0, 0 is passed then the rendered output size is the same as the input size. |
aMaintainAspectRatio | ETrue to maintain the aspect ratio, EFalse otherwise. Must be ETrue if aSize is passed as 0,0 |
Leave Codes |
---|
KErrNotReady | The image processor is not initialized or input is not set or output is not set. |
Other | A range of system wide error codes. |
ProgressInfoL ( )
The progress infomation of the rendering function which is executed iteratively to enable asynchronous operation. This gives the possibility to show a progress bar in the GUI when performing time consuming renderings. Rendering functions are synchronous if EOptionSyncProcessing option is set on CImgProcessor.
Retrieves the available progress information in a TProgressInfo obect.
- Return Value
- a TProgressInfo object containing all the progress information.
Leave Codes |
---|
KErrNotReady | The image processor is not initialized or is initializing. |
KErrNoMemory | Not enough memory. |
Other | A range of system wide error codes. |
RedoAllL ( )
Re-applies all re-doable operations previously undone.
Leave Codes |
---|
KErrNotReady | The image processor is not initialized or input is not set. |
Other | A range of system wide error codes. |
RedoL ( )
Re-applies the most recent redoable operation.
Leave Codes |
---|
KErrNotReady | The image processor is not initialized or input is not set. |
Other | A range of system wide error codes. |
ResetL ( )
Resets the image processor. image processor's input is reset and image processor's state is set to EInitialized.
Leave Codes |
---|
KErrNotReady | The image processor is not initialized or is initializing. |
Other | A range of system wide error codes. |
SetBackgroundColorL ( const TRgb & )
IMPORT_C void | SetBackgroundColorL | ( | const TRgb & | aColor | ) | |
Sets the background color to use for the output image. Any area of the output image which is not rendered to is set to this colour.
Parameters |
---|
aColor | The background color to set. |
Leave Codes |
---|
KErrNotReady | The image processor is not initialized or input is not set. |
Other | A range of system wide error codes. |
SetInputL ( const TDesC &, const TUid &, const TUid & )
IMPORT_C void | SetInputL | ( | const TDesC & | aFilename, |
| const TUid & | aFormat = KNullUid, |
| const TUid & | aSubFormat = KNullUid |
| ) | |
Sets or updates the source image to the specified file name.
Parameters |
---|
aFilename | The filename of the new source image to use. |
aFormat | The format of the new source image to use. If KNullUid is passed then an attempt is made to recognize its format. |
aSubFormat | The sub-format of the new source image to use. If KNullUid is passed then an attempt is made to recognize its sub-format. |
Leave Codes |
---|
KErrNotReady | The image processor is not initialized. |
Other | A range of system wide error codes. |
SetInputL ( RFile &, const TUid &, const TUid & )
IMPORT_C void | SetInputL | ( | RFile & | aFile, |
| const TUid & | aFormat = KNullUid, |
| const TUid & | aSubFormat = KNullUid |
| ) | |
The source image is set or updated to the given file.
Parameters |
---|
aFile | The file handle of the new source image to use. |
aFormat | The format of the new source image to use. |
aSubFormat | The sub-format of the new source image to use. |
Leave Codes |
---|
KErrNotReady | The image processor is not initialized. |
Other | A range of system wide error codes. |
SetInputL ( TMMSource &, const TUid &, const TUid & )
IMPORT_C void | SetInputL | ( | TMMSource & | aDrmFile, |
| const TUid & | aFormat = KNullUid, |
| const TUid & | aSubFormat = KNullUid |
| ) | |
The source image is set or updated. The source image may be DRM protected.
Parameters |
---|
aDrmFile | The DRM file of the new source image to use. |
aFormat | The format of the new source image to use. |
aSubFormat | The sub-format of the new source image to use. |
Leave Codes |
---|
KErrNotReady | The image processor is not initialized. |
Other | A range of system wide error codes. |
SetInputL ( const TDesC8 &, const TUid &, const TUid & )
IMPORT_C void | SetInputL | ( | const TDesC8 & | aBuffer, |
| const TUid & | aFormat = KNullUid, |
| const TUid & | aSubFormat = KNullUid |
| ) | |
The source image is set or updated to the content of the buffer provided.
Parameters |
---|
aBuffer | The buffer containing the new source image to use. |
aFormat | The format of the new source image to use. |
aSubFormat | The sub-format of the new source image to use. |
Leave Codes |
---|
KErrNotReady | The image processor is not initialized. |
Other | A range of system wide error codes. |
SetInputL ( const CFbsBitmap &, const CFbsBitmap * )
The source image is set or updated to the bitmap provided.
Parameters |
---|
aBitmap | The bitmap of the new source image to use. |
aMask | The bitmap mask of the new source image to use. |
Leave Codes |
---|
KErrNotReady | The image processor is not initialized. |
Other | A range of system wide error codes. |
SetInputL ( const CImageFrame & )
IMPORT_C void | SetInputL | ( | const CImageFrame & | aPixelBuffer | ) | |
The source image is set or updated to the image frame provided.
Parameters |
---|
aPixelBuffer | The image frame of the new source image to use. |
Leave Codes |
---|
KErrNotReady | The image processor is not initialized. |
Other | A range of system wide error codes. |
SetInputL ( CImagePanorama & )
The input is set or updated to the panorama object provided. Any existing options are reset.
Parameters |
---|
aPanorama | The panorama object to use. |
Leave Codes |
---|
KErrNotReady | The image processor is not initialized. |
Other | A range of system wide error codes. |
SetInputRectL ( const TRect & )
IMPORT_C void | SetInputRectL | ( | const TRect & | aRect | ) | |
Sets the area of interest of the source image to be used for processing.
Parameters |
---|
aRect | A reference to a TRect that specifies the location and size of the region to be used for the source image. |
Leave Codes |
---|
KErrNotReady | The image processor is not initialized or input image source data hasn't been set. |
KErrArgument | The area size is 0 or there is no overlap between aRect and source image. |
Other | A range of system wide error codes. |
SetOptionsL ( TUint64 )
IMPORT_C void | SetOptionsL | ( | TUint64 | aOptions | ) | |
Sets the desired options. Options can be combined using bitwise inclusive OR.
See also: CImgProcessor:TOptions
Parameters |
---|
aOptions | The new options to set to this image processor. |
SetOutputL ( const TDesC &, const TUid &, const TUid & )
Changes the output image to the image specified in the file given. Rendering is not performed.
Parameters |
---|
aFilename | The filename of the new output image to use. |
aFormat | The format of the new output image to use. |
aSubFormat | The sub-format of the new output image to use. |
Leave Codes |
---|
KErrNotReady | The image processor is not initialized. |
Other | A range of system wide error codes. |
SetOutputL ( RFile &, const TUid &, const TUid & )
Changes the output image to the image specified in the file given. Rendering is not performed.
Parameters |
---|
aFile | The file handle of the new output image to use. |
aFormat | The format of the new output image to use. |
aSubFormat | The sub-format of the new output image to use. |
Leave Codes |
---|
KErrNotReady | The image processor is not initialized. |
Other | A range of system wide error codes. |
SetOutputL ( RBuf8 &, const TUid &, const TUid & )
Changes the output image to the image specified in the buffer given. Rendering is not performed.
Parameters |
---|
aBuffer | The buffer containing the new output image to use. This may be re-allocated when rendering is performed if more memory is required. |
aFormat | The format of the new output image to use. |
aSubFormat | The sub-format of the new output image to use. |
Leave Codes |
---|
KErrNotReady | The image processor is not initialized. |
Other | A range of system wide error codes. |
SetOutputL ( CImageFrame & )
Changes the output image to the image specified in the buffer given. Rendering is not performed.
Parameters |
---|
aPixelBuffer | The image frame of the new output image to use. |
Leave Codes |
---|
KErrNotReady | The image processor is not initialized. |
KErrArgument | The buffer is empty. |
Other | A range of system wide error codes. |
SetOutputL ( CFbsBitmap &, CFbsBitmap * )
Changes the output image to the image specified in the bitmap given. Rendering is not performed.
Parameters |
---|
aBitmap | The bitmap of the new output image to use. |
aMask | The bitmap mask of the new output image to use. |
Leave Codes |
---|
KErrNotReady | The image processor is not initialized. |
KErrArgument | The bitmap is empty or given mask is empty. |
Other | A range of system wide error codes. |
State ( )
- Return Value
- The image processor's state.
SupportedEffectsL ( RArray< TUid > & )
IMPORT_C void | SupportedEffectsL | ( | RArray< TUid > & | aEffects | ) | const |
Returns a list of effect UIDs which can be applied by this image processor.
Parameters |
---|
aEffects | Array to be filled by the list of the supported effects. |
SupportedInputDisplayModesL ( RArray< TDisplayMode > & )
Returns a list of supported input display modes (e.g. EColor16M).
Parameters |
---|
aDisplayModes | Array to be filled in by the list of the supported input display modes. |
SupportedInputFormatsL ( RArray< TUid > & )
IMPORT_C void | SupportedInputFormatsL | ( | RArray< TUid > & | aFormats | ) | const |
Returns a list of compressed image formats which are supported (e.g. KImageTypeJPGUid etc).
Parameters |
---|
aFormats | Array to be filled by the list of the supported input formats. |
SupportedInputImageFrameFormatsL ( RArray< TUid > & )
IMPORT_C void | SupportedInputImageFrameFormatsL | ( | RArray< TUid > & | aFormats | ) | const |
Returns a list of supported image frame formats (e.g. KUidFormat32BitRGB888Interleaved).
Parameters |
---|
aFormats | Array to be filled in by the list of the supported input formats. |
SupportedInputSubFormatsL ( TUid, RArray< TUid > & )
IMPORT_C void | SupportedInputSubFormatsL | ( | TUid | aFormat, |
| RArray< TUid > & | aSubFormats |
| ) | const |
Returns a list of the input sub-formats supported.
Parameters |
---|
aFormat | Supported input format. |
aSubFormats | Array to be filled by the list of the supported input sub-formats. |
SupportedOperations ( )
IMPORT_C TUint | SupportedOperations | ( | ) | const |
- Return Value
- A TUint containing the supported operations.
SupportedOptions ( )
IMPORT_C TUint64 | SupportedOptions | ( | ) | const |
Returns the options supported by this image processor as a set of flags.
See also: CImgProcessor:TOptions
- Return Value
- A TUint64 containing the supported options.
SupportedOutputDisplayModesL ( RArray< TDisplayMode > & )
Returns a list of supported output display modes (e.g. EColor16M).
Parameters |
---|
aDisplayModes | Array to be filled in by the list of the supported output display modes. |
SupportedOutputFormatsL ( RArray< TUid > & )
IMPORT_C void | SupportedOutputFormatsL | ( | RArray< TUid > & | aFormats | ) | const |
Returns a list of supported compressed output image formats (e.g. KImageTypeJPGUid etc.).
Parameters |
---|
aFormats | Array to be filled in by the list of the supported output formats. |
SupportedOutputImageFrameFormatsL ( RArray< TUid > & )
IMPORT_C void | SupportedOutputImageFrameFormatsL | ( | RArray< TUid > & | aFormats | ) | const |
Returns a list of image frame formats to which the output can be rendered (e.g. KUidFormat32BitRGB888Interleaved).
Parameters |
---|
aFormats | Array to be filled in by the list of the supported output frame formats. |
SupportedOutputSubFormatsL ( TUid, RArray< TUid > & )
IMPORT_C void | SupportedOutputSubFormatsL | ( | TUid | aFormat, |
| RArray< TUid > & | aSubFormats |
| ) | const |
Returns a list of the output sub-formats supported.
Parameters |
---|
aFormat | The supported format of ImageProcessor. |
aSubFormats | Array to be filled in by the list of the supported sub formats of ImageProcessor. |
UndoAllL ( )
Reverts all operations which can be undone.
Leave Codes |
---|
KErrNotReady | The image processor is not initialized or input is not set. |
Other | A range of system wide error codes. |
UndoL ( )
Reverts the most recent operation which can be undone.
Leave Codes |
---|
KErrNotReady | The image processor is not initialized or input is not set. |
Other | A range of system wide error codes. |