CCamera::CCameraOverlay::TOverlaySupportInfo Class Reference

class CCamera::CCameraOverlay::TOverlaySupportInfo

Overlay support information characterizing the overlay functionality as a whole.

Constructor & Destructor Documentation

TOverlaySupportInfo()

IMPORT_CTOverlaySupportInfo()[explicit]

Constructor for the TOverlaySupportInfo class.

Member Functions Documentation

Size()

IMPORT_C TUintSize()const

Returns the size of the class. Used for extensibility by deriving from this base class and adding new member variables. Intended to be used for implementation of methods where this class reference is passed as function arguments. Implementation of such methods can find out the whether the actual class passed is base or the derived one. So, if a new application is made to run on an old implementation, an error may occur once the old implementation detects this by getting the size information of the T class passed. Also, if an old application is made to run on a new implementation, this can be corrrectly handled if the derived class variables handling is done in a proper 'if-else' statement.

Note:

The size will be modified when the T-class gets updated.

Version()

IMPORT_C TUintVersion()const

Returns the version of the class. Used for extensibility specially when the class members are not added but the Reserved members get used at a later stage.

Note:

The version will be modified when the T-class gets updated.

Member Data Documentation

TBool iCanOverlap

TBool iCanOverlap

Whether overlapping overlays are supported.

TOverlayCameraMode iDesiredCameraMode

TOverlayCameraMode iDesiredCameraMode

This is an input parameter which the client needs to provide. It represents the specific camera mode for which the overlay support information is required. Default values for iDesiredCameraMode (that is, CCamera::CCameraOverlay::EModeNone) and iViewFinderHandle (that is, KECamOverlayInvalidViewFinderHandle) implies that the client is using the TOverlaySupportInfo as before and iSupportedModes will not be neglected. Refer to TOverlaySupportInfo().

TBlendingType iPerPixel

TBlendingType iPerPixel

Represents blending type for EPerPixel overlay Type.

TBlendingType iPerPlane

TBlendingType iPerPlane

Represents blending type for EPerPlane overlay Type.

TInt iReserved3

TInt iReserved3[private]

TUint iSupportedModes

TUint iSupportedModes

The camera modes that the ECam implementation supports when applying overlays. The modes are held as a bitwise logical OR of the relevant individual modes defined in CCamera::CCameraOverlay::TOverlayCameraMode.

TUint iSupportedTypes

TUint iSupportedTypes

The camera types that the ECam implementation supports when applying overlays. The types are held as a bitwise logical OR of the relevant individual types defined in CCamera::CCameraOverlay::TOverlayType.

TInt iViewFinderHandle

TInt iViewFinderHandle

This is also another input parameter which the client needs to provide. It represents the specific viewfinder handle for which the overlay support information is required. If iViewFinderHandle is KECamOverlayNoSpecificViewFinderHandle, then generic overlay support is required which will be valid for every viewfinder handle of type iDesiredCameraMode. Default values for iDesiredCameraMode (that is, CCamera::CCameraOverlay::EModeNone) and iViewFinderHandle (that is, KECamOverlayInvalidViewFinderHandle) implies that the client is using the TOverlaySupportInfo as before and iSupportedModes will not be neglected. Refer to TOverlaySupportInfo().