Symbian^3 Product Developer Library >

CVisualFrame Class Reference

class CVisualFrame : public CBase
CVisualFrame IclExtJpegApi.lib
Since
3.2

Inherits from

Nested Classes and Structures

Public Member Functions
~CVisualFrame()
IMPORT_C const RChunk &DataChunkL()
IMPORT_C TDataContainerDataContainer()
IMPORT_C TIntDataOffset()
IMPORT_C TPtr8DataPtrL()
IMPORT_C TSizeDimension()
IMPORT_C TIntFrameFormat()
IMPORT_C const TFrameLayout &FrameLayout()
IMPORT_C CImageFrame *GetImageFrameL()
IMPORT_C TIntMaxSize()
IMPORT_C CVisualFrame *NewL(TDes8 &, const TSize &, TInt)
IMPORT_C CVisualFrame *NewL(RChunk &, TInt, TInt, TInt, const TSize &, TInt)
IMPORT_C CVisualFrame *NewL(TDes8 &, const TSize &, TInt, const TFrameLayout &)
IMPORT_C CVisualFrame *NewL(RChunk &, TInt, TInt, const TSize &, TInt, const TFrameLayout &)
IMPORT_C CVisualFrame *NewL(const CImageFrame *)
IMPORT_C voidSetSizeL(TInt)
IMPORT_C TIntSize()
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
enumTDataContainer { EInChunk, EInDescriptor }
enumTDataFormat {
EFormatMonochrome = 0x0001, EFormat16bitRGB444 = 0x0002, EFormat16BitRGB565 = 0x0004, EFormat32BitRGB888 = 0x0008, EFormatJpeg = 0x0010, EFormatExif = 0x0020, EFormatFbsBitmapColor4K = 0x0040, EFormatFbsBitmapColor64K = 0x0080, EFormatFbsBitmapColor16M = 0x0100, EFormatUserDefined = 0x0200, EFormatYUV420Interleaved = 0x0400, EFormatYUV420Planar = 0x0800, EFormatYUV422 = 0x1000, EFormatYUV422Reversed = 0x2000, EFormatYUV444 = 0x4000, EFormatYUV420SemiPlanar = 0x8000, EFormatExtYUV422Interleaved = 0x00100000, EFormatExtYUV422Planar = 0x00200000, EFormatExtYUV444Planar = 0x00400000, EFormatExtDctCoeff = 0x00800000
}
Private Attributes
CVisualFrameImpl *iVisualFrameImpl

Constructor & Destructor Documentation

~CVisualFrame()

IMPORT_C~CVisualFrame()[virtual]

Destructor

Member Functions Documentation

DataChunkL()

IMPORT_C const RChunk &DataChunkL()const
Returns a constant reference to the chunk containing the image data, if exists.
Since
3.2

DataContainer()

IMPORT_C TDataContainerDataContainer()const
Returns the storage type of the image data.
Since
3.2

DataOffset()

IMPORT_C TIntDataOffset()const
Returns the offset of the image data for non-planar, single-component or compressed images.
Since
3.2

DataPtrL()

IMPORT_C TPtr8DataPtrL()const
Returns a descriptor pointer to the image data location, if exists
Since
3.2

Dimension()

IMPORT_C TSizeDimension()const
Returns the dimensions of the image.
Since
3.2

FrameFormat()

IMPORT_C TIntFrameFormat()const
Return the image data format.
Since
3.2

FrameLayout()

IMPORT_C const TFrameLayout &FrameLayout()const
Returns the layout of the image data for planar compressed images.
Since
3.2

GetImageFrameL()

IMPORT_C CImageFrame *GetImageFrameL()
Get image frame
Since
3.2

MaxSize()

IMPORT_C TIntMaxSize()const
Returns the maximum size of the memory space reserved for image data
Since
3.2

NewL(TDes8 &, const TSize &, TInt)

IMPORT_C CVisualFrame *NewL(TDes8 &aBuffer,
const TSize &aDimension,
TIntaFrameFormat
)[static]
Symbian C++ Two-phased constructor.
Since
3.2

Parameters

TDes8 & aBufferA descriptor reference to buffer containing the image data.
const TSize & aDimensionThe dimensions of the corresponding image data.
TInt aFrameFormatThe frame format of the corresponding image data.

NewL(RChunk &, TInt, TInt, TInt, const TSize &, TInt)

IMPORT_C CVisualFrame *NewL(RChunk &aChunk,
TIntaSize,
TIntaMaxSize,
TIntaDataOffset,
const TSize &aDimension,
TIntaFrameFormat
)[static]
Symbian C++ Two-phased constructor.
Since
3.2

Parameters

RChunk & aChunkAn RChunk reference to buffer containing the image data.
TInt aSizeThe amount of image data in bytes.
TInt aMaxSize
TInt aDataOffsetThe offset value specifying the location of the image data in the chunk.
const TSize & aDimensionThe dimensions of the corresponding image data.
TInt aFrameFormatThe frame format of the corresponding image data.

NewL(TDes8 &, const TSize &, TInt, const TFrameLayout &)

IMPORT_C CVisualFrame *NewL(TDes8 &aBuffer,
const TSize &aDimension,
TIntaFrameFormat,
const TFrameLayout &aFrameLayout
)[static]
Symbian C++ Two-phased constructor.
Since
3.2

Parameters

TDes8 & aBufferA descriptor reference to buffer containing the image data.
const TSize & aDimensionThe dimensions of the corresponding image data.
TInt aFrameFormat
const TFrameLayout & aFrameLayoutThe layout of the image color components.

NewL(RChunk &, TInt, TInt, const TSize &, TInt, const TFrameLayout &)

IMPORT_C CVisualFrame *NewL(RChunk &aChunk,
TIntaSize,
TIntaMaxSize,
const TSize &aDimension,
TIntaFrameFormat,
const TFrameLayout &aFrameLayout
)[static]
Symbian C++ Two-phased constructor.
Since
3.2

Parameters

RChunk & aChunkAn RChunk reference to buffer containing the image data.
TInt aSizeThe amount of image data in bytes.
TInt aMaxSizeThe maximum size of the memory reserved in the chunk for the image data.
const TSize & aDimensionThe dimensions of the corresponding image data.
TInt aFrameFormatThe frame format of the corresponding image data.
const TFrameLayout & aFrameLayoutThe layout of the image color components. TFrameLayout contains the scan line lengths and offsets for each component in planar YUV case

NewL(const CImageFrame *)

IMPORT_C CVisualFrame *NewL(const CImageFrame *aImageFrame)[static]

Symbian C++ Two-phased constructor.

Parameters

const CImageFrame * aImageFrame

SetSizeL(TInt)

IMPORT_C voidSetSizeL(TIntaSize)
Sets the amount of image data to the given value. Should be called when the image data amount is modified explicitly.
Since
3.2

Parameters

TInt aSize

Size()

IMPORT_C TIntSize()const
Returns the amount of stored image data in bytes.
Since
3.2

Member Enumerations Documentation

Enum TDataContainer

Enumerators

EInChunk
EInDescriptor

Enum TDataFormat

Enumerators

EFormatMonochrome = 0x0001

8 bit greyscale values, 0=black, 255=white.

EFormat16bitRGB444 = 0x0002

Packed RGB triplets, 4 bits per pixel with red in the least significant bits and the 4 most significant bits unused.

EFormat16BitRGB565 = 0x0004

Packed RGB triplets, 5 bits per pixel for red and blue and 6 bits for green, with red in the least significant bits.

EFormat32BitRGB888 = 0x0008

Packed RGB triplets, 8 bits per pixel with red in the least significant bits and the 8 most significant bits unused.

EFormatJpeg = 0x0010

JFIF JPEG.

EFormatExif = 0x0020

EXIF JPEG

EFormatFbsBitmapColor4K = 0x0040

CFbsBitmap object with display mode EColor4K.

EFormatFbsBitmapColor64K = 0x0080

CFbsBitmap object with display mode EColor64K.

EFormatFbsBitmapColor16M = 0x0100

CFbsBitmap object with display mode EColor16M.

EFormatUserDefined = 0x0200

Implementation dependent.

EFormatYUV420Interleaved = 0x0400

4:2:0 format, 8 bits per sample, Y00Y01Y10Y11UV.

EFormatYUV420Planar = 0x0800

4:2:0 format, 8 bits per sample, Y00Y01Y02Y03...U0...V0...

EFormatYUV422 = 0x1000

4:2:2 format, 8 bits per sample, UY0VY1.

EFormatYUV422Reversed = 0x2000

4:2:2 format, 8 bits per sample, Y1VY0U.

EFormatYUV444 = 0x4000

4:4:4 format, 8 bits per sample, Y00U00V00 Y01U01V01...

EFormatYUV420SemiPlanar = 0x8000

4:2:0 format, 8 bits per sample, Y00Y01Y02Y03...U0V0...

EFormatExtYUV422Interleaved = 0x00100000

4:2:2 format, 8 bits per sample, Y0Y1UV.

EFormatExtYUV422Planar = 0x00200000

4:2:2 format, 8 bits per sample, Y0Y1Y2...U0U1...V0V1.

EFormatExtYUV444Planar = 0x00400000

4:4:4 format, 8 bits per sample, Y0U0V0Y1U1V1.

EFormatExtDctCoeff = 0x00800000

DCT coefficients

Member Data Documentation

CVisualFrameImpl * iVisualFrameImpl

CVisualFrameImpl *iVisualFrameImpl[private]

Copyright ©2010 Nokia Corporation and/or its subsidiary(-ies).
All rights reserved. Unless otherwise stated, these materials are provided under the terms of the Eclipse Public License v1.0.