org.bytedeco.ale

Class Cartridge

java.lang.Object

org.bytedeco.javacpp.Pointer

org.bytedeco.ale.Device

org.bytedeco.ale.Cartridge

All Implemented Interfaces:

AutoCloseable

@NoOffset
 @Properties(inherit=ale.class)
public class Cartridge
extends Device

A cartridge is a device which contains the machine code for a game and handles any bankswitching performed by the cartridge.

Version:

$Id: Cart.hxx,v 1.19 2007/06/14 13:47:50 stephena Exp $

Author:

Bradford W. Mott

Nested Class Summary

Nested classes/interfaces inherited from class org.bytedeco.javacpp.Pointer

Pointer.CustomDeallocator, Pointer.Deallocator, Pointer.NativeDeallocator, Pointer.ReferenceCounter

Field Summary

Fields inherited from class org.bytedeco.javacpp.Pointer

address, capacity, limit, position

Constructor Summary

Constructors

Constructor and Description
Cartridge(Pointer p) Pointer cast constructor.

Method Summary

Modifier and Type	Method and Description
static BytePointer	about() Query some information about this cartridge.
int	bank() Get the current bank.
void	bank(short bank) Set the specified bank.
int	bankCount() Query the number of banks supported by the cartridge.
byte[]	getImage(int[] size)
ByteBuffer	getImage(IntBuffer size)
BytePointer	getImage(IntPointer size) Access the internal ROM image for this cartridge.
void	lockBank() Lock/unlock bankswitching capability.
boolean	patch(short _address, byte value) Patch the cartridge ROM.
boolean	save(Pointer out) Save the internal (patched) ROM image.
boolean	save(Serializer out) MGB: Added to drop warning on overloaded save() method.
void	unlockBank()

Methods inherited from class org.bytedeco.ale.Device

install, load, name, peek, poke, reset, systemCyclesReset

Methods inherited from class org.bytedeco.javacpp.Pointer

address, asBuffer, asByteBuffer, availablePhysicalBytes, calloc, capacity, capacity, close, deallocate, deallocate, deallocateReferences, deallocator, deallocator, equals, fill, formatBytes, free, getPointer, getPointer, getPointer, getPointer, hashCode, isNull, isNull, limit, limit, malloc, maxBytes, maxPhysicalBytes, memchr, memcmp, memcpy, memmove, memset, offsetof, offsetof, parseBytes, physicalBytes, position, position, put, realloc, referenceCount, releaseReference, retainReference, setNull, sizeof, sizeof, toString, totalBytes, totalCount, totalPhysicalBytes, withDeallocator, zero

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

Cartridge

public Cartridge(Pointer p)

Pointer cast constructor. Invokes Pointer.Pointer(Pointer).

Method Detail

about

@StdString
public static BytePointer about()

Query some information about this cartridge.

save

@Cast(value="bool")
public boolean save(@Cast(value="std::ofstream*") @ByRef
                                         Pointer out)

Save the internal (patched) ROM image.

Parameters:

out - The output file stream to save the image

save

@Cast(value="bool")
public boolean save(@ByRef
                                         Serializer out)

MGB: Added to drop warning on overloaded save() method.

Overrides:

save in class Device

Parameters:

out - The serializer device to save to.

Returns:

The result of the save. True on success, false on failure.

lockBank

public void lockBank()

Lock/unlock bankswitching capability.

unlockBank

public void unlockBank()

bank

public void bank(@Cast(value="uInt16")
                 short bank)

Set the specified bank.

bank

public int bank()

Get the current bank.

Returns:

The current bank, or -1 if bankswitching not supported

bankCount

public int bankCount()

Query the number of banks supported by the cartridge.

patch

@Cast(value="bool")
public boolean patch(@Cast(value="uInt16")
                                          short _address,
                                          @Cast(value="uInt8")
                                          byte value)

Patch the cartridge ROM.

Parameters:

address - The ROM address to patch

value - The value to place into the address

Returns:

Success or failure of the patch operation

getImage

@Cast(value="uInt8*")
public BytePointer getImage(@ByRef
                                                   IntPointer size)

Access the internal ROM image for this cartridge.

Parameters:

size - Set to the size of the internal ROM image data

Returns:

A pointer to the internal ROM image data

getImage

@Cast(value="uInt8*")
public ByteBuffer getImage(@ByRef
                                                  IntBuffer size)

getImage

@Cast(value="uInt8*")
public byte[] getImage(@ByRef
                                              int[] size)