CCamera::CCameraOverlay::TOverlayParameters Class Reference

class CCamera::CCameraOverlay::TOverlayParameters

Overlay parameters characterizing a particular overlay.

Constructor & Destructor Documentation

TOverlayParameters()

IMPORT_CTOverlayParameters()[explicit]

Member Functions Documentation

Size()

IMPORT_C TUintSize()const

Version()

IMPORT_C TUintVersion()const

Member Data Documentation

TInt iAlphaValue

TInt iAlphaValue

This is the alpha value to be applied when iCurrentTypes contains type CCamera::CCameraOverlay::TOverlayType::EPerPlane. The alpha value for red, green and blue is packed into this TInt. The layout of this TInt is such that the most significant byte (from left side) is not used at all and the remaining three bytes (after the most significant byte) contains the alpha value for red, green and blue. Otherwise, if iCurrentTypes only contains type CCamera::CCameraOverlay::TOverlayType::EPerPixel, then iAlphaValue will not be used.

TUint iCurrentModes

TUint iCurrentModes

The camera modes in which this image overlay can be used. The modes are held as a bitwise logical OR of the relevant individual modes defined in CCamera::CCameraOverlay::TOverlayCameraMode.

TUint iCurrentTypes

TUint iCurrentTypes

The camera types in which this image overlay can be used. The types are held as a bitwise logical OR of the relevant individual types defined in CCamera::CCameraOverlay::TOverlayType.

TPoint iPosition

TPoint iPosition

Top left corner within the original image, where the overlay image is to be blended.

TInt iReserved2

TInt iReserved2[private]

TInt iReserved3

TInt iReserved3[private]

TInt iReserved4

TInt iReserved4[private]

TInt iReserved5

TInt iReserved5[private]

TInt iViewFinderHandle

TInt iViewFinderHandle

The handle for the viewfinder on which the overlay is supposed to be applied. Only one viewfinder handle can be passed. If KECamOverlayNoSpecificViewFinderHandle is provided by the client, then the overlay is supposed to be applied for every viewfinder handle of type as given by iCurrentModes. If KECamOverlayInvalidViewFinderHandle, then the default implementation is being used where TOverlayParameters::iCurrentModes will not be neglected and overlay will be applied for every viewfinder alongwith other camera modes.

TUint iZOrder

TUint iZOrder

The z-order of the overlay to indicate relative depth when several overlays are applied. Values are in the range 0 to 100. The overlay with iZOrder of 0 is the deepest.