Class TFrameInfo

class TFrameInfo;

Description

General frame info provided by all plugins.

Members

Defined in TFrameInfo:
CurrentDataOffset(), CurrentFrameState(), EAlphaChannel, ECanDither, EColor, EConstantAspectRatio, EFrameInfoProcessingComplete, EFrameInfoProcessingFrame, EFrameInfoProcessingFrameHeader, EFrameInfoUninitialised, EFullyScaleable, ELeaveInPlace, EMngMoreFramesToDecode, EPartialDecodeInvalid, ERestoreToBackground, ERestoreToPrevious, ETransparencyPossible, EUsesFrameSizeInPixels, FrameDataOffset(), SetCurrentDataOffset(), SetCurrentFrameState(), SetFrameDataOffset(), TFrameInfoFlags, TFrameInfoState, iBackgroundColor, iBitsPerPixel, iDelay, iFlags, iFrameCoordsInPixels, iFrameDisplayMode, iFrameSizeInPixels, iFrameSizeInTwips, iOverallSizeInPixels

IMPORT_C TFrameInfoState CurrentFrameState() const;

Description

Returns the current frame state.

Return value

TFrameInfoState The frame state.

IMPORT_C void SetCurrentFrameState(TFrameInfoState aFrameInfoState);

Description

Sets the current frame state to the supplied value.

Parameters

TFrameInfoState aFrameInfoState The frame state.

IMPORT_C TInt CurrentDataOffset() const;

Description

Returns the current data offset.

Return value

TInt The data offset.

IMPORT_C void SetCurrentDataOffset(TInt aOffset);

Description

Sets the current data offset to the supplied value.

Parameters

TInt aOffset The data offset.

IMPORT_C TInt FrameDataOffset() const;

Description

Returns the frame data offset.

Return value

TInt The frame data offset.

IMPORT_C void SetFrameDataOffset(TInt aOffset);

Description

Sets the frame data offset to the supplied value.

Parameters

TInt aOffset The frame data offset.

TFrameInfoFlags

Description

Flags that define the attributes of a frame. These can be combined using an OR operation.

EColor Indicates whether or not the frame is colour. ETransparencyPossible Indicates if any part of the frame is transparent. EFullyScaleable Indicates whether or not the frame can be scaled. EConstantAspectRatio Indicates whether or not the frame's aspect ratio must be maintained during scaling. If not set, the frame can be stretched. ECanDither Indicates if the frame can be decoded and drawn dithered. If this is not set, the bitmap must use the recommended display mode. EAlphaChannel Indicates if the frame contains alpha-blending information. This setting is only valid if ETransparencyPossible is set. ELeaveInPlace Mutually exclusive image disposal method 1, no disposal specified. Image is not disposed of and graphic is left in place. ERestoreToBackground Mutually exclusive image disposal method 2, restore to background colour. The area used by the graphic must be restored to the background colour. ERestoreToPrevious Mutually exclusive image disposal method 3, restore to previous. The decoder is required to restore the area overwritten by the graphic with what was there prior to rendering the graphic. EPartialDecodeInvalid If this flag is set and an image convert operation returns KErrUnderFlow, the partially decoded bitmap is not suitable for display. EMngMoreFramesToDecode This flag is used by Mng decoder to indicate that there are more frames to decode EUsesFrameSizeInPixels This flag is used to indicate that the code sets iFrameSizeInPixels

TFrameInfoState

Description

Indicates the current status of frame processing.

EFrameInfoUninitialised The frame information has not been initialised. EFrameInfoProcessingFrameHeader The frame header is being processed. EFrameInfoProcessingFrame The frame is being processed. EFrameInfoProcessingComplete The frame has been processed.

TRect iFrameCoordsInPixels;

Description

The coordinates of the frame within the screen in pixels.

TSize iFrameSizeInTwips;

Description

The size of the frame in twips.

TInt iBitsPerPixel;

Description

The number of bits per pixel for the frame.

TTimeIntervalMicroSeconds iDelay;

Description

The delay in microseconds before displaying the next frame.

TUint32 iFlags;

Description

Frame information flags. A combination of the values contained in the TFrameInfoFlags enum.

TSize iOverallSizeInPixels;

Description

The size of the frame. A frame can occupy a rectangle within the overall image. In this case, the frame size is less than the overall image size. For a GIF image, the following applies: For the first frame of the image, iOverallSizeInPixels will be the greater of the logical screen size and the size of the first frame. The logical screen size is defined in the logical screen descriptor block of the GIF image. If the GIF is animated it will contain a set of frames. The first frame will be full size but subsequent frames are sub-frames and iOverallSizeInPixels may differ for each sub-frame.

TDisplayMode iFrameDisplayMode;

Description

The display mode for the frame.

TRgb iBackgroundColor;

Description

The background color for the frame.

TSize iFrameSizeInPixels;

Description

The size of frame in pixels