Class TFrameInfo

class TFrameInfo;

Description

General frame info provided by all plugins.

Members

Defined in TFrameInfo:

• CurrentDataOffset()constReturns the current data offset.
• CurrentFrameState()constReturns the current frame state.
• EAlphaChannelIndicates if the frame contains alpha-blending information. This setting is only...
• ECanDitherIndicates if the frame can be decoded and drawn dithered. If this is not set, th...
• EColorIndicates whether or not the frame is colour.
• EConstantAspectRatioIndicates whether or not the frame's aspect ratio must be maintained during scal...
• EFrameInfoProcessingCompleteThe frame has been processed.
• EFrameInfoProcessingFrameThe frame is being processed.
• EFrameInfoProcessingFrameHeaderThe frame header is being processed.
• EFrameInfoUninitialisedThe frame information has not been initialised.
• EFullyScaleableIndicates whether or not the frame can be scaled.
• ELeaveInPlaceMutually exclusive image disposal method 1, no disposal specified. Image is not ...
• EMngMoreFramesToDecodeThis flag is used by Mng decoder to indicate that there are more frames to decod...
• EPartialDecodeInvalidIf this flag is set and an image convert operation returns KErrUnderFlow, the pa...
• ERestoreToBackgroundMutually exclusive image disposal method 2, restore to background colour. The ar...
• ERestoreToPreviousMutually exclusive image disposal method 3, restore to previous. The decoder is ...
• ETransparencyPossibleIndicates if any part of the frame is transparent.
• EUsesFrameSizeInPixelsThis flag is used to indicate that the code sets iFrameSizeInPixels
• FrameDataOffset()constReturns the frame data offset.
• SetCurrentDataOffset(TInt)Sets the current data offset to the supplied value.
• SetCurrentFrameState(TFrameInfoState)Sets the current frame state to the supplied value.
• SetFrameDataOffset(TInt)Sets the frame data offset to the supplied value.
• TFrameInfoFlagsFlags that define the attributes of a frame. These can be combined using an OR o...
• TFrameInfoStateIndicates the current status of frame processing.
• iBackgroundColorThe background color for the frame.
• iBitsPerPixelThe number of bits per pixel for the frame.
• iDelayThe delay in microseconds before displaying the next frame.
• iFlagsFrame information flags. A combination of the values contained in the TFrameInfo...
• iFrameCoordsInPixelsThe coordinates of the frame within the screen in pixels.
• iFrameDisplayModeThe display mode for the frame.
• iFrameSizeInPixelsThe size of frame in pixels
• iFrameSizeInTwipsThe size of the frame in twips.
• iOverallSizeInPixelsThe size of the frame. A frame can occupy a rectangle within the overall image. ...

IMPORT_C TFrameInfoState CurrentFrameState() const;

Description

Returns the current frame state.

Return value

IMPORT_C void SetCurrentFrameState(TFrameInfoState aFrameInfoState);

Description

Sets the current frame state to the supplied value.

Parameters

IMPORT_C TInt CurrentDataOffset() const;

Description

Returns the current data offset.

Return value

IMPORT_C void SetCurrentDataOffset(TInt aOffset);

Description

Sets the current data offset to the supplied value.

Parameters

IMPORT_C TInt FrameDataOffset() const;

Description

Returns the frame data offset.

Return value

IMPORT_C void SetFrameDataOffset(TInt aOffset);

Description

Sets the frame data offset to the supplied value.

Parameters

TFrameInfoFlags

Description

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

TFrameInfoState

Description

Indicates the current status of frame processing.

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