Collapse all Symbian^3 Application Developer Library

CVtImage Class Reference

class CVtImage : public CBase

Abstract base class for VS images.

videosource.lib

Inherits from

CVtImage
- CBase

Public Member Functions
TInt	BytesPerRow ()
TUint32 *	DataAddress ()
TVtDisplayMode	DisplayMode ()
TVtDisplayMode	DisplayModeToVtDisplayMode ( TDisplayMode )
TUint32 *	LineAddress ( TInt )
TBool	NeedHeapLock ()
TSize	Size ()
IMPORT_C TVtImageType	Type ()

Protected Member Functions
	CVtImage ( TVtImageType )

Inherited Functions
	CBase::CBase()
	CBase::Delete(CBase *)
	CBase::Extension_(TUint,TAny &,TAny )
	CBase::operator new(TUint)
	CBase::operator new(TUint,TAny *)
	CBase::operator new(TUint,TLeave)
	CBase::operator new(TUint,TLeave,TUint)
	CBase::operator new(TUint,TUint)
	CBase::~CBase()

Public Member Enumerations
enum	TVtDisplayMode { EVtColorNone , EVtColor4K , EVtColor64K , EVtColor16M , EVtColor16MU , EVtColor16MA , EVtColorIYUV }
enum	TVtImageType { EVtImageBitmap , EVtImageIYUV }

Private Attributes
TVtImageType	iType

Constructor & Destructor Documentation

CVtImage(TVtImageType)

CVtImage

(

TVtImageType

aType

)

[protected]

C++ constructor.

Parameters

TVtImageType aType

Member Functions Documentation

BytesPerRow()

TInt

BytesPerRow

(

)

const [pure virtual]

Pure virtual function to get how many bytes this image has per scaline.

DataAddress()

TUint32 *

DataAddress

(

)

const [pure virtual]

Pure virtual function to get pointer to image data.

DisplayMode()

TVtDisplayMode

DisplayMode

(

)

const [pure virtual]

Pure virtual function to get displaymode from image.

DisplayModeToVtDisplayMode(TDisplayMode)

TVtDisplayMode

DisplayModeToVtDisplayMode

(

TDisplayMode

aMode

)

[static]

Converts given TDisplayMode to corresponding TVtDisplayMode.

Parameters

TDisplayMode aMode

Display mode as TDisplayMode.

LineAddress(TInt)

TUint32 *

LineAddress

(

TInt

aLine

)

const [pure virtual]

Pure virtual function to get pointer to image data at defined line. If aLine is lower than zero then line zero is returned, also if aLine is greater than height of the image minus 1 ( height - 1 ) then line number ( height - 1 ) is returned.

Parameters

TInt aLine

Number of vertical line for which pointer is wanted.

NeedHeapLock()

TBool

NeedHeapLock

(

)

const [pure virtual]

Pure virtual function to check whether bitmap heap needs to be locked for this image type.

Size()

TSize

Size

(

)

const [pure virtual]

Pure virtual function to get size of the image in pixels

Type()

IMPORT_C TVtImageType

Type

(

)

const

Method for getting image type.

Member Enumerations Documentation

Enum TVtDisplayMode

Vt display modes. Used for identifying image's data format.

Enumerators

EVtColorNone	Unsupported display mode.
EVtColor4K	4096 colour display mode (12 bpp).
EVtColor64K	2^16 colour display mode (16 bpp).
EVtColor16M	True colour display mode (24 bpp).
EVtColor16MU	True colour display mode (32 bpp).
EVtColor16MA	True colour display mode with alpha (32 bpp).
EVtColorIYUV	YUV 420 planar display mode.

Enum TVtImageType

Enumeration for supported image types.

Enumerators

EVtImageBitmap	CFbsBitmap image.
EVtImageIYUV	YUV 420 planar image where all Y samples are found first in memory as an array of unsigned char (possibly with a larger stride for memory alignment), followed immediately by all Cr (U) samples (with half the stride of the Y lines, and half the number of lines), then followed immediately by all Cb (V) samples in a similar fashion.

Member Data Documentation

TVtImageType iType

TVtImageType

iType

[private]