• Home
• GameBoy
• Core

PHP Class GameBoy\Core

Mostra file Open project: gabrielrcouto/php-terminal-gameboy-emulator Class Usage Examples

Public Properties

Property	Type	Description
$CPUTicks		The number of clock cycles emulated.
$DAATable
$DIVTicks		DIV Ticks Counter (Invisible lower 8-bit)
$FCarry		bit 4 - Carry
$FHalfCarry		bit 5 - Half Carry
$FSubtract		bit 6 - Sub
$FZero		bit 7 - Zero
$GBCMemory		GBC main RAM Banks
$IME		Are interrupts enabled?
$JoyPad		Joypad State (two four-bit states actually)
$LCDTicks		ScanLine Counter
$MBC1Mode		MBC1 Type (4/32, 16/8)
$MBCRAMBanksEnabled		MBC RAM Access Control.
$MBCRam		Switchable RAM (Used by games for more RAM) for the main memory range 0xA000 - 0xC000.
$RAMBanks		Used to map the RAM banks to maximum size the MBC used can do.
$ROM		The full ROM file dumped to an array.
$ROMBank1offs		Offset of the ROM bank switching.
$ROMBanks		1 Bank = 16 KBytes = 256 Kbits
$ROMImage		The game's ROM.
$RTCDayOverFlow
$RTCDays
$RTCHALT
$RTCHours
$RTCMinutes
$RTCSeconds
$RTCisLatched
$SecondaryTICKTable
$TACClocker		Timer Max Ticks
$TICKTable
$TIMAEnabled
$VRAM		Extra VRAM bank for GBC.
$audioTicks		Used to sample the audio system every x CPU instructions.
$bgEnabled
$cCamera
$cGBC		GameBoy Color detection.
$cHuC1
$cHuC3
$cMBC1		Does the cartridge use MBC1?
$cMBC2		Does the cartridge use MBC2?
$cMBC3		Does the cartridge use MBC3?
$cMBC5		Does the cartridge use MBC5?
$cMMMO1
$cRUMBLE		Does the cartridge use the RUMBLE addressing (modified MBC5)?
$cSRAM		Does the cartridge use save RAM?
$cTAMA5
$cTIMER		Added
$canvasBuffer
$cartridgeType		Cartridge Type
$colorCount
$colors		"Classic" GameBoy palette colors.
$currMBCRAMBank		MBC Currently Indexed RAM Bank
$currMBCRAMBankPosition		MBC Position Adder;
$currVRAMBank		Current VRAM bank for GBC.
$currentROMBank		The parsed current ROM bank selection.
$drawContext		LCD Context
$drewBlank		To prevent the repeating of drawing a blank screen.
$emulatorTicks		Times for how many instructions to execute before ending the loop.
$ffxxDump
$frameBuffer
$frameCount		Frame skip tracker
$fromSaveState		A boolean to see if this was loaded in as a save state.
$gameCode		Game code (Suffix for older games)
$gbColorizedPalette
$gbPalette
$gbcPalette
$gbcRamBank		Currently Switched GameBoy Color ram bank
$gbcRamBankPosition		GBC RAM offset from address start.
$gbcRamBankPositionECHO		GBC RAM (ECHO mirroring) offset from address start.
$gbcRawPalette
$gfxBackgroundX
$gfxBackgroundY
$gfxSpriteDouble
$gfxSpriteShow
$gfxWindowDisplay
$gfxWindowY
$halt		Has the CPU been suspended until the next interrupt?
$hdmaRunning		HDMA Transfer Flag - GBC only
$height
$inBootstrap		Whether we're in the GBC boot ROM.
$lastIteration		The last time we iterated the main loop.
$latchedHDays
$latchedHours
$latchedLDays
$latchedMinutes
$latchedSeconds
$lcdController		lcdControllerler object
$memory		Main Core Memory
$multiplier		GBC Speed Multiplier
$name		Name of the game
$numRAMBanks		How many RAM banks were actually allocated?
$palette		Pointer to the current palette we're using (Used for palette switches during boot or so it can be done anytime)
$pixelCount
$programCounter		Program Counter
$registerA		Accumulator (default is GB mode)
$registerB		Register B
$registerC		Register C
$registerD		Register D
$registerE		Register E
$registersHL		Registers H and L
$rgbCount
$savedStateFileName		When loaded in as a save state, this will not be empty.
$skipPCIncrement		Did we trip the DMG Halt bug?
$spritePriorityEnabled
$stackPointer		Stack Pointer
$stopEmulator		Has the emulation been paused or a frame has ended?
$tileCount		GB: 384, GBC: 384 * 2
$tileCountInvalidator
$tileData		tile data arrays
$tileReadState		true if there are any images to be invalidated
$timerTicks		Timer Ticks Count
$transparentCutoff		min "attrib" value where transparency can occur (Default is 4 (GB mode))
$untilEnable		Are the interrupts on queue to be enabled?
$weaveLookup
$width
$windowSourceLine

Public Methods

Method	Description
MBCRAMUtilized ( )
ROMLoad ( )
VRAMReadGFX ( $address, $gbcBank )
__construct ( $ROMImage, $drawContext )
arrayPad ( $length, $defaultValue )
checkPaletteType ( )
clockUpdate ( )
decodePalette ( $startIndex, $data )
disableBootROM ( )
displayShowOff ( )
drawBackgroundForLine ( $line, $windowLeft, $priority )
drawPartBgSprite ( $tileIndex, $x, $y, $sourceLine, $attribs )
drawPartCopy ( $tileIndex, $x, $y, $sourceLine, $attribs )
drawPartFgSprite ( $tileIndex, $x, $y, $sourceLine, $attribs )
drawSpritesForLine ( $line )
drawToCanvas ( )
executeIteration ( )
fromTypedArray ( $baseArray )
getTypedArray ( $length, $defaultValue, $numberType )
initBootstrap ( )
initLCD ( )
initMemory ( )
initSkipBootstrap ( )
invalidateAll ( $pal )
joyPadEvent ( $key, $down )
memoryRead ( $address )	Memory Reading:
memoryWrite ( $address, $data )	Memory Writing:
nswtuw ( $uword )
performHdma ( )
returnFromState ( $returnedFrom )
run ( )
runInterrupt ( )
saveState ( )
setCurrentMBC1ROMBank ( )
setCurrentMBC2AND3ROMBank ( )
setCurrentMBC5ROMBank ( )
setGBCPalette ( $address_, $data )
setGBCPalettePre ( $address_, $data )
setupRAM ( )
start ( )
toTypedArray ( $baseArray, $bit32, $unsigned )
unsbtub ( $ubyte )
unswtuw ( $uword )
updateCore ( )
updateImage ( $tileIndex, $attribs )
usbtsb ( $ubyte )	Helper Functions

Method Details

Property Details