MityDSP::tcDspLcd Class Reference

The tcDspLcd class provides general access to an LCD 5-6-5 Display device. More...

#include <core/DspLcd.h>

Inheritance diagram for MityDSP::tcDspLcd:

Classes
struct	tsLCDConfig
	LCD timing configuration structure. More...
Public Member Functions
	tcDspLcd (void apAddress, bool abPortrait, tsLCDConfig apConfig, float anBacklightPercent=50.0)
	This constructor is used to open a tcDspLcd 16-bit display interface.
virtual	~tcDspLcd ()
	Default destructor.
virtual bool	SetFrameBuffer (void *apBuffer)
	Updates the current frame buffer, and initiates DMA transfer from the provided buffer.
virtual void	SetBacklight (float anPercent)
	This method sets the backlighting to the specified level.
virtual float	GetBacklight (void)
	This method retrieves the current QVGA backlighting level.
virtual void	SetScreenEnabled (bool apEnable)
	Enables/Disables the screen.
virtual void	GenTestPattern (int anPatternNo)
	Generate a test pattern on the current FrameBuffer.
Protected Attributes
unsigned int	mnTicksPerMsec
	Number of clocks per millisecond.
volatile unsigned int *	mpBaseAddr
	Display Base address.
float	mnBacklightDutyPercent
	Current backlight duty cycle (percent).
unsigned int	mnBacklightDutyCounts
	Current backlight duty cycle (counts).
float	mnOnBacklightDutyPercent
	backlight duty cycle (percent) for screen enables
tsLCDConfig	msConfig
Static Protected Attributes
static const int	gnBacklightMinValue = 0
	minimum backlight duty cycle value
static const int	gnBacklightMaxValue = 255
	maximum backlight duty cycle value

Detailed Description

The tcDspLcd class provides general access to an LCD 5-6-5 Display device.

It is derived from the tcDspDisplayDriver base class to provide a consistent interface to the underlying frame buffer. Additional functions to set and get the display backlighting are provided. This driver in turn may be used to setup direct access to the device's frame buffer, or may be used in conjunction with the tcDisplay class.

Note:: This Core deprecates the tcDspQvga16 class.

See also:: tcDspLcd Page

Constructor & Destructor Documentation

tcDspLcd::tcDspLcd	(	void *	apAddress,
		bool	abPortrait,
		tsLCDConfig *	apConfig,
		float	anBacklightPercent = `50.0`
	)

This constructor is used to open a tcDspLcd 16-bit display interface.

Parameters:

`[in]`	apAddress	Base Address of the 16-bit LCD core
`[in]`	abPortrait	True if the display is scanned in portrait mode, false if in landscape (default: false).
`[in]`	apConfig	User customized LCD timing/configuration, defaults to nominal Quarter VGA settings.
`[in]`	anBacklightPercent	The backlight level initially and also used when set_screen_enable(true) is called.

Returns:: None.

See also:: DspLcd.h; DspDisplayDriver.h

tcDspLcd::~tcDspLcd ( ) [virtual]

Default destructor.

Returns:: None.

Member Function Documentation

bool tcDspLcd::SetFrameBuffer ( void * apBuffer ) [virtual]

Updates the current frame buffer, and initiates DMA transfer from the provided buffer.

If NULL, DMA is disabled. In addition, if the frame buffer is transitioning from NULL, the LCD startup procedure is performed. Similarly, if transitioning to NULL, the shutdown procedure is performed.

Parameters:

[in] apBuffer Pointer to the new frame buffer.