org.bytedeco.ale

Class OSystem

java.lang.Object

org.bytedeco.javacpp.Pointer

org.bytedeco.ale.OSystem

All Implemented Interfaces:

AutoCloseable

@NoOffset
 @Properties(inherit=ale.class)
public class OSystem
extends Pointer

This class provides an interface for accessing operating system specific functions. It also comprises an overall parent object, to which all the other objects belong.

Version:

$Id: OSystem.hxx,v 1.55 2007/08/12 23:05:12 stephena Exp $

Author:

Stephen Anthony

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	OSystem.TimingInfo

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
OSystem(Pointer p) Pointer cast constructor.

Method Summary

Modifier and Type	Method and Description
void	attach(Settings settings) Adds the specified settings object to the system.
BytePointer	baseDir() Return the default directory for storing data.
BytePointer	cacheFile() This method should be called to get the full path of the gamelist cache file (used by the Launcher to show a listing of available games).
BytePointer	cheatFile() This method should be called to get the full path of the cheat file.
ColourPalette	colourPalette()
BytePointer	configFile() This method should be called to get the full path of the config file.
Console	console() Get the console of the system.
boolean	create() Create all child objects which belong to this OSystem
boolean	createConsole()
boolean	createConsole(BytePointer romfile) Creates a new game console from the specified romfile.
boolean	createConsole(String romfile)
void	deleteConsole() Deletes the currently defined console, if it exists.
int	desktopHeight()
int	desktopWidth() Get the maximum dimensions of a window for the video hardware.
Event	event() //ALE Get the event object of the system
BytePointer	features() The features which are conditionally compiled into Stella.
int	frameRate() Get the current framerate for the video system.
BytePointer	getROMInfo(BytePointer romfile) Gets all possible info about the ROM by creating a temporary Console object and querying it.
String	getROMInfo(String romfile)
int	getTicks() This method returns number of ticks in microseconds.
boolean	loadState(Deserializer in) Deserializes the OSystem state.
int	myTimePerFrame()
OSystem	myTimePerFrame(int setter)
OSystem.TimingInfo	myTimingInfo()
OSystem	myTimingInfo(OSystem.TimingInfo setter)
boolean	openROM(BytePointer rom, BytePointer md5, byte[] image, int[] size)
boolean	openROM(BytePointer rom, BytePointer md5, ByteBuffer image, IntBuffer size)
boolean	openROM(BytePointer rom, BytePointer md5, BytePointer image, IntPointer size)
boolean	openROM(BytePointer rom, BytePointer md5, PointerPointer image, IntPointer size) Open the given ROM and return an array containing its contents.
boolean	openROM(String rom, BytePointer md5, byte[] image, int[] size)
boolean	openROM(String rom, BytePointer md5, ByteBuffer image, IntBuffer size)
boolean	openROM(String rom, BytePointer md5, BytePointer image, IntPointer size)
DisplayScreen	p_display_screen()
OSystem	p_display_screen(DisplayScreen setter)
BytePointer	paletteFile() This method should be called to get the full path of the (optional) palette file.
BytePointer	propertiesFile() This method should be called to get the full path of the properties file (stella.pro).
void	quit() Issue a quit event to the OSystem.
void	resetRNGSeed() Resets the seed for our random number generator.
Random	rng() Returns the random number generator for this emulator.
BytePointer	romFile() This method should be called to get the full path of the currently loaded ROM.
boolean	saveState(Serializer out) Serializes the OSystem state.
void	setConfigPaths() Set all config file paths for the OSystem.
void	setFramerate(int framerate) Set the framerate for the video system.
Settings	settings() Get the settings object of the system
void	skipEmulation()
Sound	sound() Get the sound object of the system
ResolutionList	supportedResolutions() Get the supported fullscreen resolutions for the video hardware.

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

OSystem

public OSystem(Pointer p)

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

Method Detail

create

@Cast(value="bool")
public boolean create()

Create all child objects which belong to this OSystem

attach

public void attach(Settings settings)

Adds the specified settings object to the system.

Parameters:

settings - The settings object to add

event

public Event event()

//ALE Get the event object of the system

Returns:

The event object

sound

@ByRef
public Sound sound()

Get the sound object of the system

Returns:

The sound object

settings

@ByRef
public Settings settings()

Get the settings object of the system

Returns:

The settings object

console

@ByRef
public Console console()

Get the console of the system.

Returns:

The console object

setFramerate

public void setFramerate(@Cast(value="uInt32")
                         int framerate)

Set the framerate for the video system. It's placed in this class since the mainLoop() method is defined here.

Parameters:

framerate - The video framerate to use

setConfigPaths

public void setConfigPaths()

Set all config file paths for the OSystem.

frameRate

@Cast(value="uInt32")
public int frameRate()

Get the current framerate for the video system.

Returns:

The video framerate currently in use

desktopWidth

@Cast(value="uInt32")
public int desktopWidth()

Get the maximum dimensions of a window for the video hardware.

desktopHeight

@Cast(value="uInt32")
public int desktopHeight()

supportedResolutions

@Const
 @ByRef
public ResolutionList supportedResolutions()

Get the supported fullscreen resolutions for the video hardware.

Returns:

An array of supported resolutions

baseDir

@StdString
public BytePointer baseDir()

Return the default directory for storing data.

cacheFile

@StdString
public BytePointer cacheFile()

This method should be called to get the full path of the gamelist cache file (used by the Launcher to show a listing of available games).

Returns:

String representing the full path of the gamelist cache file.

cheatFile

@StdString
public BytePointer cheatFile()

This method should be called to get the full path of the cheat file.

Returns:

String representing the full path of the cheat filename.

configFile

@StdString
public BytePointer configFile()

This method should be called to get the full path of the config file.

Returns:

String representing the full path of the config filename.

paletteFile

@StdString
public BytePointer paletteFile()

This method should be called to get the full path of the (optional) palette file.

Returns:

String representing the full path of the properties filename.

propertiesFile

@StdString
public BytePointer propertiesFile()

This method should be called to get the full path of the properties file (stella.pro).

Returns:

String representing the full path of the properties filename.

romFile

@StdString
public BytePointer romFile()

This method should be called to get the full path of the currently loaded ROM.

Returns:

String representing the full path of the ROM file.

createConsole

@Cast(value="bool")
public boolean createConsole(@StdString
                                                  BytePointer romfile)

Creates a new game console from the specified romfile.

Parameters:

romfile - The full pathname of the ROM to use

Returns:

True on successful creation, otherwise false

createConsole

@Cast(value="bool")
public boolean createConsole()

createConsole

@Cast(value="bool")
public boolean createConsole(@StdString
                                                  String romfile)

deleteConsole

public void deleteConsole()

Deletes the currently defined console, if it exists. Also prints some statistics (fps, total frames, etc).

getROMInfo

@StdString
public BytePointer getROMInfo(@StdString
                                          BytePointer romfile)

Gets all possible info about the ROM by creating a temporary Console object and querying it.

Parameters:

romfile - The full pathname of the ROM to use

Returns:

Some information about this ROM

getROMInfo

@StdString
public String getROMInfo(@StdString
                                     String romfile)

features

@StdString
public BytePointer features()

The features which are conditionally compiled into Stella.

Returns:

The supported features

openROM

@Cast(value="bool")
public boolean openROM(@StdString
                                            BytePointer rom,
                                            @StdString @ByRef
                                            BytePointer md5,
                                            @Cast(value="uInt8**")
                                            PointerPointer image,
                                            IntPointer size)

Open the given ROM and return an array containing its contents.

Parameters:

rom - The absolute pathname of the ROM file

md5 - The md5 calculated from the ROM file

image - A pointer to store the ROM data Note, the calling method is responsible for deleting this

size - The amount of data read into the image array

Returns:

False on any errors, else true

openROM

@Cast(value="bool")
public boolean openROM(@StdString
                                            BytePointer rom,
                                            @StdString @ByRef
                                            BytePointer md5,
                                            @Cast(value="uInt8**") @ByPtrPtr
                                            BytePointer image,
                                            IntPointer size)

openROM

@Cast(value="bool")
public boolean openROM(@StdString
                                            String rom,
                                            @StdString @ByRef
                                            BytePointer md5,
                                            @Cast(value="uInt8**") @ByPtrPtr
                                            ByteBuffer image,
                                            IntBuffer size)

openROM

@Cast(value="bool")
public boolean openROM(@StdString
                                            BytePointer rom,
                                            @StdString @ByRef
                                            BytePointer md5,
                                            @Cast(value="uInt8**") @ByPtrPtr
                                            byte[] image,
                                            int[] size)

openROM

@Cast(value="bool")
public boolean openROM(@StdString
                                            String rom,
                                            @StdString @ByRef
                                            BytePointer md5,
                                            @Cast(value="uInt8**") @ByPtrPtr
                                            BytePointer image,
                                            IntPointer size)

openROM

@Cast(value="bool")
public boolean openROM(@StdString
                                            BytePointer rom,
                                            @StdString @ByRef
                                            BytePointer md5,
                                            @Cast(value="uInt8**") @ByPtrPtr
                                            ByteBuffer image,
                                            IntBuffer size)

openROM

@Cast(value="bool")
public boolean openROM(@StdString
                                            String rom,
                                            @StdString @ByRef
                                            BytePointer md5,
                                            @Cast(value="uInt8**") @ByPtrPtr
                                            byte[] image,
                                            int[] size)

quit

public void quit()

Issue a quit event to the OSystem.

skipEmulation

public void skipEmulation()

rng

@ByRef
public Random rng()

Returns the random number generator for this emulator.

resetRNGSeed

public void resetRNGSeed()

Resets the seed for our random number generator.

saveState

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

Serializes the OSystem state.

loadState

@Cast(value="bool")
public boolean loadState(@ByRef
                                              Deserializer in)

Deserializes the OSystem state.

getTicks

@Cast(value="uInt32")
public int getTicks()

This method returns number of ticks in microseconds.

Returns:

Current time in microseconds.

myTimePerFrame

@Cast(value="uInt32")
public int myTimePerFrame()

myTimePerFrame

public OSystem myTimePerFrame(int setter)

myTimingInfo

@ByRef
public OSystem.TimingInfo myTimingInfo()

myTimingInfo

public OSystem myTimingInfo(OSystem.TimingInfo setter)

colourPalette

@ByRef
public ColourPalette colourPalette()

p_display_screen

public DisplayScreen p_display_screen()

p_display_screen

public OSystem p_display_screen(DisplayScreen setter)