MityDSP Documentation Index

MityDSP::tcDspQvga16 Class Reference

The tcDspQvga16 class provides access to a 16-bit color QVGA (320x240 pixel) display device. More...

#include <core/DspQvga16.h>

Inheritance diagram for MityDSP::tcDspQvga16:
MityDSP::tcDspDisplayDriver

List of all members.

Public Member Functions

 tcDspQvga16 (void *apAddress, tcDspFpgaDma *apDma, int anDmaChannel, bool abPortrait=false)
 This constructor is used to open a tcDspQvga16 16-bit Quarter VGA display interface.
virtual ~tcDspQvga16 ()
 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 QVGA backlighting to the specified level.
virtual float GetBacklight (void)
 This method retrieves the current QVGA backlighting level.
virtual bool FlipDisplay (bool abFlip)
 This method is used to flip (or un-flip) the QVGA display presentation.
virtual bool IsFlipped (void)
 This method indicates whether or not the display is currently flipped.

Protected Attributes

volatile unsigned int * mpBaseAddr
 TouchScreen base address.
float mnBacklightDutyPercent
 Current backlight duty cycle (percent).
unsigned int mnBacklightDutyCounts
 Current backlight duty cycle (counts).
bool mbDisplayFlipped
 True if display is flipped.

Static Protected Attributes

static const int gnBacklightMinValue = 0
 minimum backlight duty cycle value
static const int gnBacklightMaxValue = 256
 maximum backlight duty cycle value
static const int gnStartStopDelayMsec = 200
 startup/shutdown delay (msec)
static unsigned int mnTicksPerMsec = CLK_countspms() / CLK_getprd()
 Number of clocks per millisecond.

Detailed Description

The tcDspQvga16 class provides access to a 16-bit color QVGA (320x240 pixel) 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. An instance of the tcDspFpgaDma class must be provided to exchange data with the device. 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.

See also:
tcDspQvga16 Page

Constructor & Destructor Documentation

tcDspQvga16::tcDspQvga16 ( void *  apAddress,
tcDspFpgaDma apDma,
int  anDmaChannel,
bool  abPortrait = false 
)

This constructor is used to open a tcDspQvga16 16-bit Quarter VGA display interface.

This constructor registers the required FPGA DMA interface with the base class.

Parameters:
[in] apAddress Base Address of the 16-bit QVGA core
[in] apDma Pointer to an instance of tcDspFpgaDma to use to provide access to the frame buffer.
[in] anDmaChannel The DMA channel in apDma to use.
[in] abPortrait True if the display is scanned in portrait mode, false if in landscape (default: false).
Returns:
None.
See also:
DspQvga16.h
DspDisplayDriver.h
tcDspQvga16::~tcDspQvga16 (  )  [virtual]

Default destructor.

Returns:
None.

Member Function Documentation

bool tcDspQvga16::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.
Returns:
True if DMA scheduled (or disabled), false otherwise.
See also:
DspQvga16.h
DspDisplayDriver.h

Reimplemented from MityDSP::tcDspDisplayDriver.

void tcDspQvga16::SetBacklight ( float  anPercent  )  [virtual]

This method sets the QVGA backlighting to the specified level.

The level is given as a percentage, where 0% is off, and 100% is full brightness.

Parameters:
[in] anPercent LCD backlight brightness percentage.
Returns:
None.
See also:
DspQvga16.h
float tcDspQvga16::GetBacklight ( void   )  [virtual]

This method retrieves the current QVGA backlighting level.

Returns:
Current LCD backlight brightness percentage..
See also:
DspQvga16.h
bool tcDspQvga16::FlipDisplay ( bool  abFlip  )  [virtual]

This method is used to flip (or un-flip) the QVGA display presentation.

Note:
Flipping is done both horizontally and vertically. Individual control of horizontal or vertical flip is not available.
Parameters:
[in] abFlip Set to true to flip display, false to restore.
Returns:
New setting.
See also:
DspQvga16.h
bool tcDspQvga16::IsFlipped ( void   )  [virtual]

This method indicates whether or not the display is currently flipped.

Returns:
True if display is flipped.
See also:
DspQvga16.h

Member Data Documentation

const int MityDSP::tcDspQvga16::gnBacklightMinValue = 0 [static, protected]

minimum backlight duty cycle value

const int MityDSP::tcDspQvga16::gnBacklightMaxValue = 256 [static, protected]

maximum backlight duty cycle value

const int MityDSP::tcDspQvga16::gnStartStopDelayMsec = 200 [static, protected]

startup/shutdown delay (msec)

unsigned int tcDspQvga16::mnTicksPerMsec = CLK_countspms() / CLK_getprd() [static, protected]

Number of clocks per millisecond.

volatile unsigned int* MityDSP::tcDspQvga16::mpBaseAddr [protected]

TouchScreen base address.

Current backlight duty cycle (percent).

Current backlight duty cycle (counts).

True if display is flipped.


  
Generated on Fri Sep 23 16:33:53 2011 for MityDSP Core by  Doxygen Version 1.6.1
Copyright © 2009, Critical Link LLC, All rights reserved.