libElysianVMU 1.6.0
Full-featured, accurate, cross-platform library emulating the Dreamcast's Visual Memory Unit
Loading...
Searching...
No Matches
EvmuLcd Struct Reference

#include <evmu_lcd.h>

Inheritance diagram for EvmuLcd:
EvmuPeripheral EvmuIBehavior

Data Fields

union { 
 
   EvmuLcdClass *   pClass 
 
   EvmuPeripheral   base 
 
};  
 
size_t screenRefreshDivisor
 
uint32_t screenChanged: 1
 
uint32_t ghostingEnabled: 1
 
uint32_t filterEnabled: 1
 
uint32_t invertColors: 1
 
- Data Fields inherited from EvmuPeripheral
union { 
 
   EvmuPeripheralClass *   pClass 
 
   GblObject   base 
 
};  
 
GblFlags logLevel
 

Related Symbols

(Note that these are not member symbols.)

Configuration

Methods for querying the display configuration

GblBool EvmuLcd_screenEnabled (const EvmuLcd *pSelf)
 
GblBool EvmuLcd_refreshEnabled (const EvmuLcd *pSelf)
 
EVMU_LCD_REFRESH_RATE EvmuLcd_refreshRate (const EvmuLcd *pSelf)
 
EvmuTicks EvmuLcd_refreshRateTicks (const EvmuLcd *pSelf)
 
Configuring

Methods for setting and altering the display configuration

void EvmuLcd_setScreenEnabled (EvmuLcd *pSelf, GblBool enabled)
 
void EvmuLcd_setRefreshEnabled (EvmuLcd *pSelf, GblBool enabled)
 
void EvmuLcd_setRefreshRate (EvmuLcd *pSelf, EVMU_LCD_REFRESH_RATE rate)
 
Display Reading

Methods to retrieve display values for rendering

EVMU_LCD_ICONS EvmuLcd_icons (const EvmuLcd *pSelf)
 
GblBool EvmuLcd_pixel (const EvmuLcd *pSelf, size_t row, size_t col)
 
uint8_t EvmuLcd_decoratedPixel (const EvmuLcd *pSelf, size_t row, size_t col)
 
Display Rendering

Methods to set and modify display values

void EvmuLcd_setIcons (EvmuLcd *pSelf, EVMU_LCD_ICONS icons)
 
void EvmuLcd_setPixel (EvmuLcd *pSelf, size_t row, size_t col, GblBool enabled)
 

Detailed Description

EvmuLcd screen and framebuffer peripheral.

EvmuLcd is the instance structure providing an API around the VMU's LCD screen.

See also
EvmuLcdClass

Definition at line 114 of file evmu_lcd.h.

Friends And Related Symbol Documentation

◆ EvmuLcd_decoratedPixel()

uint8_t EvmuLcd_decoratedPixel ( const EvmuLcd * pSelf,
size_t row,
size_t col )
related

Retrieves the decorated pixel value for the given screen coordinate, with all effects enabled.

◆ EvmuLcd_icons()

EVMU_LCD_ICONS EvmuLcd_icons ( const EvmuLcd * pSelf)
related

Returns a value containing the bitmasks of all of the enabled icons OR'd together.

◆ EvmuLcd_pixel()

GblBool EvmuLcd_pixel ( const EvmuLcd * pSelf,
size_t row,
size_t col )
related

Returns the raw pixel value for the given screen coordinate, GBL_TRUE being black and GBL_FALSE being white.

◆ EvmuLcd_refreshEnabled()

GblBool EvmuLcd_refreshEnabled ( const EvmuLcd * pSelf)
related

Returns GBL_TRUE if screen refreshing is currently enabled for the display, GBL_FALSE otherwise.

◆ EvmuLcd_refreshRate()

EVMU_LCD_REFRESH_RATE EvmuLcd_refreshRate ( const EvmuLcd * pSelf)
related

Returns the refresh rate configuration for how frequently the display updates.

◆ EvmuLcd_refreshRateTicks()

EvmuTicks EvmuLcd_refreshRateTicks ( const EvmuLcd * pSelf)
related

Returns the refresh rate / update time of the LCD screen in milliseconds.

◆ EvmuLcd_screenEnabled()

GblBool EvmuLcd_screenEnabled ( const EvmuLcd * pSelf)
related

Returns GBL_TRUE if the display is enabled/powered, GBL_FALSE otherwise.

◆ EvmuLcd_setIcons()

void EvmuLcd_setIcons ( EvmuLcd * pSelf,
EVMU_LCD_ICONS icons )
related

Sets the active icons to the mask given by icons, which has individual icon masks OR'd together.

◆ EvmuLcd_setPixel()

void EvmuLcd_setPixel ( EvmuLcd * pSelf,
size_t row,
size_t col,
GblBool enabled )
related

Sets the raw pixel value for the given screen coordinate, with enabled signifying a black pixel.

◆ EvmuLcd_setRefreshEnabled()

void EvmuLcd_setRefreshEnabled ( EvmuLcd * pSelf,
GblBool enabled )
related

Enables or disables automatic screen refreshing for the display, depending on the value of enabled.

◆ EvmuLcd_setRefreshRate()

void EvmuLcd_setRefreshRate ( EvmuLcd * pSelf,
EVMU_LCD_REFRESH_RATE rate )
related

Sets the refresh rate of the LCD screen to the given rate value.

◆ EvmuLcd_setScreenEnabled()

void EvmuLcd_setScreenEnabled ( EvmuLcd * pSelf,
GblBool enabled )
related

Enables or disables the VMU's LCD display, depending on the value of enabled.

Field Documentation

◆ base

EvmuPeripheral EvmuLcd::base

Inherited base instance structure.

Definition at line 114 of file evmu_lcd.h.

◆ filterEnabled

uint32_t EvmuLcd::filterEnabled

Enable linear filtering.

Definition at line 118 of file evmu_lcd.h.

◆ ghostingEnabled

uint32_t EvmuLcd::ghostingEnabled

Emulate pixel ghosting/fade effect.

Definition at line 117 of file evmu_lcd.h.

◆ invertColors

uint32_t EvmuLcd::invertColors

Swap black and white pixel values.

Definition at line 119 of file evmu_lcd.h.

◆ pClass

EvmuLcdClass* EvmuLcd::pClass

Pointer to class/vtable structure.

Definition at line 114 of file evmu_lcd.h.

◆ screenChanged

uint32_t EvmuLcd::screenChanged

User-driven toggle for knowing when to redraw.

Definition at line 116 of file evmu_lcd.h.

◆ screenRefreshDivisor

size_t EvmuLcd::screenRefreshDivisor

How many hardware refreshes before software refresh.

Definition at line 115 of file evmu_lcd.h.


The documentation for this struct was generated from the following file: