The Pedigree Project  0.1
Public Member Functions | List of all members
MaltaVga Class Reference

#include <Vga.h>

+ Inheritance diagram for MaltaVga:
+ Collaboration diagram for MaltaVga:

Public Member Functions

virtual bool setMode (size_t nCols, size_t nRows, bool bIsText, size_t nBpp=0)
 
virtual bool setLargestTextMode ()
 
virtual bool isMode (size_t nCols, size_t nRows, bool bIsText, size_t nBpp=0)
 
virtual bool isLargestTextMode ()
 
virtual size_t getNumCols ()
 
virtual size_t getNumRows ()
 
virtual void rememberMode ()
 
virtual void restoreMode ()
 
virtual void pokeBuffer (uint8_t *pBuffer, size_t nBufLen)
 
virtual void peekBuffer (uint8_t *pBuffer, size_t nBufLen)
 
virtual void moveCursor (size_t nX, size_t nY)
 
 operator uint16_t * () const
 
- Public Member Functions inherited from Vga
virtual void setControl (VgaControl which)=0
 
virtual void clearControl (VgaControl which)=0
 
virtual bool setMode (int mode)=0
 

Additional Inherited Members

- Public Types inherited from Vga
enum  VgaControl { LineGraphics = 2, Blink = 3 }
 

Detailed Description

Vga device abstraction.

Definition at line 29 of file kernel/machine/malta/Vga.h.

Member Function Documentation

virtual size_t MaltaVga::getNumCols ( )
inlinevirtual
Returns
The number of columns in the current mode.

Implements Vga.

Definition at line 80 of file kernel/machine/malta/Vga.h.

virtual size_t MaltaVga::getNumRows ( )
inlinevirtual
Returns
The number of rows in the current mode.

Implements Vga.

Definition at line 88 of file kernel/machine/malta/Vga.h.

virtual bool MaltaVga::isLargestTextMode ( )
inlinevirtual

Tests if the current video mode is the largest text mode.

Returns
True if the current video mode is equal to the largest text mode.

Implements Vga.

Definition at line 72 of file kernel/machine/malta/Vga.h.

virtual bool MaltaVga::isMode ( size_t  nCols,
size_t  nRows,
bool  bIsText,
size_t  nBpp = 0 
)
inlinevirtual

Tests the current video mode.

Returns
True if the current mode matches the given arguments.

Implements Vga.

Definition at line 63 of file kernel/machine/malta/Vga.h.

virtual void MaltaVga::moveCursor ( size_t  nX,
size_t  nY 
)
inlinevirtual

Moves the cursor to the position specified by the parameters.

Parameters
nXThe column to move to.
nYThe row to move to.

Implements Vga.

Definition at line 138 of file kernel/machine/malta/Vga.h.

virtual void MaltaVga::peekBuffer ( uint8_t *  pBuffer,
size_t  nBufLen 
)
inlinevirtual

Copies the current framebuffer into the given buffer.

The buffer is assumed to be in the correct format for directly copying from video memory. This will obviously depend on the current mode (text/graphical) as well as resolution and bits per pixel (graphics mode only).

Parameters
Apointer to the buffer.
Thelength of pBuffer.

Implements Vga.

Definition at line 129 of file kernel/machine/malta/Vga.h.

virtual void MaltaVga::pokeBuffer ( uint8_t *  pBuffer,
size_t  nBufLen 
)
inlinevirtual

Copies the given buffer into video memory, replacing the current framebuffer.

The buffer is assumed to be in the correct format for directly copying into video memory. This will obviously depend on the current mode (text/graphical) as well as resolution and bits per pixel (graphics mode only).

Parameters
Apointer to the buffer to swap into video memory.
Thelength of pBuffer.

Implements Vga.

Definition at line 117 of file kernel/machine/malta/Vga.h.

virtual void MaltaVga::rememberMode ( )
inlinevirtual

Stores the current video mode.

Implements Vga.

Definition at line 96 of file kernel/machine/malta/Vga.h.

virtual void MaltaVga::restoreMode ( )
inlinevirtual

Restores the saved video mode from a rememberMode() call.

Implements Vga.

Definition at line 103 of file kernel/machine/malta/Vga.h.

virtual bool MaltaVga::setLargestTextMode ( )
inlinevirtual

Sets the largest possible text mode.

Returns
True on success, false on failure.

Implements Vga.

Definition at line 53 of file kernel/machine/malta/Vga.h.

virtual bool MaltaVga::setMode ( size_t  nCols,
size_t  nRows,
bool  bIsText,
size_t  nBpp = 0 
)
inlinevirtual

Changes the mode the VGA device is in.

Parameters
nColsThe number of columns required.
nRowsThe number of rows required.
bIsTextTrue if the caller requires a text mode, false if graphical.
nBppOnly applicable for graphics modes - the number of bits per pixel.
Returns
True on success, false on failure.

Definition at line 44 of file kernel/machine/malta/Vga.h.


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