libgui 2.01
libgui is a GUI library for the GameCube, Wii, and Wii U
 
Loading...
Searching...
No Matches
OgcVideoDriver Class Reference

GC/Wii VideoDriver: raw GX, double-buffered XFB. More...

#include <OgcVideoDriver.h>

Inheritance diagram for OgcVideoDriver:
[legend]

Public Member Functions

void init (int width, int height) override
 
void shutdown () override
 Releases the video backend. Call after every other user of the renderers has finished.
 
void render () override
 Flushes the current frame to the screen and swaps buffers.
 
void clearScreen (const PixelColor &color) override
 Clears the current frame buffer.
 
int getScreenWidth () const override
 
int getScreenHeight () const override
 
int getRefreshRate () const override
 
float getDeltaTime () const override
 
uint32_t getFrameTimer () override
 
ImageRenderer * getImageRenderer () override
 
GlyphRenderer * getGlyphRenderer () override
 
- Public Member Functions inherited from VideoDriver
virtual float getUIScale () const
 Ratio of physical render-target pixels to design-canvas pixels (the width/height passed to init()).
 

Detailed Description

GC/Wii VideoDriver: raw GX, double-buffered XFB.

Definition at line 13 of file OgcVideoDriver.h.

Constructor & Destructor Documentation

◆ OgcVideoDriver()

OgcVideoDriver::OgcVideoDriver ( )

Definition at line 21 of file OgcVideoDriver.cpp.

◆ ~OgcVideoDriver()

OgcVideoDriver::~OgcVideoDriver ( )
override

Definition at line 23 of file OgcVideoDriver.cpp.

Member Function Documentation

◆ clearScreen()

void OgcVideoDriver::clearScreen ( const PixelColor & color)
overridevirtual

Clears the current frame buffer.

Implements VideoDriver.

Definition at line 121 of file OgcVideoDriver.cpp.

◆ getDeltaTime()

float OgcVideoDriver::getDeltaTime ( ) const
inlineoverridevirtual
Returns
the nominal frame period in seconds (1/getRefreshRate()); not a measured time

Implements VideoDriver.

Definition at line 27 of file OgcVideoDriver.h.

◆ getFrameTimer()

uint32_t OgcVideoDriver::getFrameTimer ( )
inlineoverridevirtual
Returns
the number of frames rendered so far (incremented once per render())

Implements VideoDriver.

Definition at line 28 of file OgcVideoDriver.h.

◆ getGlyphRenderer()

GlyphRenderer * OgcVideoDriver::getGlyphRenderer ( )
inlineoverridevirtual
Returns
the renderer GuiTextRenderer draws glyphs through

Implements VideoDriver.

Definition at line 31 of file OgcVideoDriver.h.

◆ getImageRenderer()

ImageRenderer * OgcVideoDriver::getImageRenderer ( )
inlineoverridevirtual
Returns
the renderer GuiImage/GuiImageData draw through

Implements VideoDriver.

Definition at line 30 of file OgcVideoDriver.h.

◆ getRefreshRate()

int OgcVideoDriver::getRefreshRate ( ) const
inlineoverridevirtual
Returns
the display refresh rate in Hz (50 for PAL/576i output, otherwise 60)

Implements VideoDriver.

Definition at line 26 of file OgcVideoDriver.h.

◆ getScreenHeight()

int OgcVideoDriver::getScreenHeight ( ) const
inlineoverridevirtual
Returns
the design canvas height in pixels (as passed to init())

Implements VideoDriver.

Definition at line 25 of file OgcVideoDriver.h.

◆ getScreenWidth()

int OgcVideoDriver::getScreenWidth ( ) const
inlineoverridevirtual
Returns
the design canvas width in pixels (as passed to init())

Implements VideoDriver.

Definition at line 24 of file OgcVideoDriver.h.

◆ init()

void OgcVideoDriver::init ( int width,
int height )
overridevirtual
Parameters
widthDesign canvas width in pixels
heightDesign canvas height in pixels

Implements VideoDriver.

Definition at line 29 of file OgcVideoDriver.cpp.

◆ render()

void OgcVideoDriver::render ( )
overridevirtual

Flushes the current frame to the screen and swaps buffers.

Implements VideoDriver.

Definition at line 107 of file OgcVideoDriver.cpp.

◆ shutdown()

void OgcVideoDriver::shutdown ( )
overridevirtual

Releases the video backend. Call after every other user of the renderers has finished.

Implements VideoDriver.

Definition at line 97 of file OgcVideoDriver.cpp.


The documentation for this class was generated from the following files: