Collapse all Symbian^3 Product Developer Library

TFrameFormat Class Reference

class TFrameFormat : public TFrameFormatBase

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.

Inherits from

TFrameFormat
- TFrameFormatBase

Public Member Functions
	TFrameFormat(TUid)
IMPORT_C TUid	ColourSpace()
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

Private Attributes
TUid	iColourSpace
TUid	iFormatCode
TUid	iSampling

Constructor & Destructor Documentation

TFrameFormat(TUid)

IMPORT_C

TFrameFormat

(

TUid

aFormatCode

)

[explicit]

Constructor for the TFrameFormat class.

imageframeformats.hrh

Note:

If the format code is not recognised, the format code, colour space and sampling are initialised as KNullUid.

Parameters

TUid aFormatCode

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

Member Functions 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.

imageframeconst.h

DuplicateL()

IMPORT_C TFrameFormatBase *

DuplicateL

(

)

const [virtual]

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

leave: KErrNoMemory.

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.

imageframeconst.h

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.

imageframeconst.h

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.

imageframeconst.h

Parameters

TUid aColourSpace

The UID of the new colour space.

Member Data Documentation

TUid iColourSpace

TUid

iColourSpace

[private]

TUid iFormatCode

TUid

iFormatCode

[private]

TUid iSampling

TUid

iSampling

[private]