TFrameLayout Class Reference

#include <imageframe.h>

class TFrameLayout : public TFrameLayoutBase

Inherits from

TFrameLayout
- TFrameLayoutBase

Public Member Functions
	TFrameLayout(TInt)
IMPORT_C TInt	CurrentLength(TInt)
virtual IMPORT_C TFrameLayoutBase *	DuplicateL()
IMPORT_C TInt	Length(TInt)
IMPORT_C TInt	Planes()
IMPORT_C TInt	ScanLength(TInt)
IMPORT_C void	SetCurrentLength(TInt, TInt)
IMPORT_C void	SetLength(TInt, TInt)
IMPORT_C void	SetScanLength(TInt, TInt)
IMPORT_C void	SetStart(TInt, TInt)
IMPORT_C TInt	Start(TInt)

Inherited Functions
	TFrameLayoutBase::TFrameLayoutBase(TUid)
	TFrameLayoutBase::Type()const

Detailed Description

Class TFrameLayout is a concrete implementation of TFrameLayoutBase class. It serves as a container for parameters that describe the memory organisation of the data encapsulated by a specific CImageFrame object. Image data is stored in planes. Each plane is characterised by the byte offset from the start of the image frame memory, and its maximum size, current length and scanlength.

Constructor & Destructor Documentation

TFrameLayout ( TInt )

IMPORT_C

TFrameLayout

(

TInt

aPlanes

)

[explicit]

Constructor for the TFrameLayout class.

Parameters
aPlanes	The number of planes into which the image data is organised. It should be a positive integer less than or equal to KMaxPlanesInFrame (defined in imageframeconst.h).

Panic Codes
EInvalidValue	if the value of aPlanes is negative or greater than KMaxPlanesInFrame.

Member Function Documentation

CurrentLength ( TInt )

IMPORT_C TInt

CurrentLength

(

TInt

aIndex

)

const

Returns the current length in bytes of a specific plane.

Parameters
aIndex	The index of the plane. The value is non negative and must be less than the value returned by TFrameLayout::Planes().

Return Value: The current length of the plane in bytes.

Panic Codes
EInvalidIndex	if the index is not in the allowed range.

DuplicateL ( )

IMPORT_C TFrameLayoutBase *

DuplicateL

(

)

const [virtual]

Reimplemented from TFrameLayoutBase::DuplicateL()const

Creates an identical object to itself and places it on the heap.

Return Value: The pointer to the newly created object base class.

Leave Codes
KErrNoMemory.

Length ( TInt )

IMPORT_C TInt

Length

(

TInt

aIndex

)

const

Returns the maximum length in bytes of a specific plane.

Parameters
aIndex	The index of the plane. The value is non negative and must be less than the value returned by TFrameLayout::Planes().

Return Value: The maximum length of the plane in bytes.

Panic Codes
EInvalidIndex	if the index is not in the allowed range.

Planes ( )

IMPORT_C TInt

Planes

(

)

const

Returns the number of planes in the current layout.

Return Value: The number of planes.

ScanLength ( TInt )

IMPORT_C TInt

ScanLength

(

TInt

aIndex

)

const

Returns the scan length in bytes of a specific plane.

Parameters
aIndex	The index of the plane. The value is non negative and must be less than the value returned by TFrameLayout::Planes().

Return Value: The scan length of the plane in bytes.

Panic Codes
EInvalidIndex	if the index is not in the allowed range.

SetCurrentLength ( TInt, TInt )

IMPORT_C void	SetCurrentLength	(	TInt	aIndex,
			TInt	aCurrentLength
		)

Sets the current length for a specific plane in the current layout.

Parameters
aIndex	The index of the plane. The value is non negative and must be less than the value returned by TFrameLayout::Planes().
aCurrentLength	The new value for current length in bytes

Panic Codes
EInvalidIndex	if the index is not in the allowed range.
EInvalidValue	if the value of aCurrentLength is negative.

SetLength ( TInt, TInt )

IMPORT_C void	SetLength	(	TInt	aIndex,
			TInt	aLength
		)

Sets the maximum length of a specific plane in the current layout.

Parameters
aIndex	The index of the plane. The value is non negative and must be less than the value returned by TFrameLayout::Planes().
aLength	The new length in bytes.

Panic Codes
EInvalidIndex	if the index is not in the allowed range.
EInvalidValue	if the value of aLength is negative.

SetScanLength ( TInt, TInt )

IMPORT_C void	SetScanLength	(	TInt	aIndex,
			TInt	aScanLength
		)

Set a new value for the scan length for a specific plane in the current layout.

Parameters
aIndex	The index of the plane. The value is non negative and must be less than the value returned by TFrameLayout::Planes().
aScanLength	The new value for the scan length of the plane in bytes.

Panic Codes
EInvalidIndex	if the index is not in the allowed range.
EInvalidValue	if the value of aScanLength is negative.

SetStart ( TInt, TInt )

IMPORT_C void	SetStart	(	TInt	aIndex,
			TInt	aStart
		)

Sets the start offset for a specific plane in the current layout.

Parameters
aIndex	The index of the plane. The value is non negative and must be less than the value returned by TFrameLayout::Planes().
aStart	The new start offset position in bytes.

Panic Codes
EInvalidIndex	if the index is not in the allowed range.
EInvalidValue	if the value of aStart is negative.

Start ( TInt )

IMPORT_C TInt

Start

(

TInt

aIndex

)

const

Returns the start of a plane identified by its index. The value is the byte offset from the start of the CImageFrame object memory.

Parameters
aIndex	The index of the plane. The value is non negative and must be less than the value returned by TFrameLayout::Planes().

Return Value: The start position of the plane as a byte offset.

Panic Codes
EInvalidIndex	if the index is not in the allowed range.