Symbian
Symbian OS Library

SYMBIAN OS V9.3

[Index] [Spacer] [Previous] [Next]



Location: GDI.H
Link against: gdi.lib

Class TDisplayModeUtils

class TDisplayModeUtils;

Description

A set of static utility functions to get information about a display mode.

Members

Defined in TDisplayModeUtils:
IsDisplayModeColor(), IsDisplayModeValid(), NumDisplayModeBitsPerPixel(), NumDisplayModeColors()


Member functions


IsDisplayModeColor()

static IMPORT_C TBool IsDisplayModeColor(TDisplayMode aDispMode);

Description

Tests whether the display mode specified is colour or greyscale.

Parameters

TDisplayMode aDispMode

The display mode.

Return value

TBool

ETrue if colour; EFalse if greyscale or monochrome.


IsDisplayModeValid()

static IMPORT_C TBool IsDisplayModeValid(TDisplayMode aDispMode);

Description

Tests whether the display mode specified is one of the valid values.

Parameters

TDisplayMode aDispMode

The display mode to be tested.

Return value

TBool

ETrue if aDispMode is valid; EFalse if not valid.


NumDisplayModeColors()

static IMPORT_C TInt NumDisplayModeColors(TDisplayMode aDispMode);

Description

Gets the number of colours or shades of grey supported by the specified display mode.

For instance, a display mode of EGray4 returns 4, EColor4K returns 4096.

Parameters

TDisplayMode aDispMode

The display mode.

Return value

TInt

The number of colours/grey shades supported by the display mode.


NumDisplayModeBitsPerPixel()

static IMPORT_C TInt NumDisplayModeBitsPerPixel(TDisplayMode aDispMode);

Description

Gets the number of bits required by each pixel when displayed in the specified display mode.

Parameters

TDisplayMode aDispMode

The display mode.

Return value

TInt

The number of bits required by each pixel.