TFrameFormat Class Reference

#include <imageframe.h>

class TFrameFormat : public TFrameFormatBase

Inherits from

TFrameFormat
- TFrameFormatBase

Public Member Functions
	TFrameFormat(TUid)
IMPORT_C TUid	ColourSpace()
virtual IMPORT_C TFrameFormatBase *	DuplicateL()
IMPORT_C TUid	FormatCode()
IMPORT_C TUid	Sampling()
IMPORT_C void	SetColourSpace(TUid)

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

Detailed Description

This class is a specific implementation of TFrameFormatBase. An object of this class provides colour space and sampling information based on a specific image format code.

Constructor & Destructor Documentation

TFrameFormat ( TUid )

IMPORT_C

TFrameFormat

(

TUid

aFormatCode

)

[explicit]

Constructor for the TFrameFormat class.

Parameter	Description
aFormatCode	Unique UID specifying an image format code. The list of recognised formats is stored in file imageframeformats.hrh.

Member Function Documentation

ColourSpace ( )

IMPORT_C TUid

ColourSpace

(

)

const

Returns the colour space for the TFrameFormat object.

Note:

File imageframeconst.h contains the recognised colour space codes. These are named KUidColourSpaceXXX.

See also: imageframeconst.h

Returns: The UID of the colour space.

DuplicateL ( )

IMPORT_C TFrameFormatBase *

DuplicateL

(

)

const [virtual]

Reimplemented from TFrameFormatBase::DuplicateL()const

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

leave: KErrNoMemory.

Returns: The pointer to the newly created object cast as its base class TFrameFormatBase.

FormatCode ( )

IMPORT_C TUid

FormatCode

(

)

const

Returns the format code which uniquely identifies the TFrameFormat object.

Note:

File imageframeconst.h contains the recognised format codes. These are named KUidFormatXXX.

See also: imageframeconst.h

Returns: The UID of the format code.

Sampling ( )

IMPORT_C TUid

Sampling

(

)

const

Returns the sampling format for the TFrameFormat object.

Note:

File imageframeconst.h contains the recognised sampling codes. These are named KUidSamplingColorXXX.

See also: imageframeconst.h

Returns: The UID of the sampling format.

SetColourSpace ( TUid )

IMPORT_C void

SetColourSpace

(

TUid

aColourSpace

)

Sets a new colour space.

Note:

File imageframeconst.h contains the recognised colour space codes. These are named KUidColourSpaceXXX.

See also: imageframeconst.h

Parameter	Description
aColourSpace	The UID of the new colour space.