GF4J 0.9.4 Beta
A B C D E F G I K L M N O P Q R S T U V W

A

add(BitmapEffect) - Method in class gameframe.graphics.EffectGroup
Adds the given effect to this group of effects.
add(int) - Method in class gameframe.util.Counter
Adds the given number to the counter.
addColourMapping(ColorMapping) - Method in class gameframe.graphics.ColorReplacementEffect
Adds a colour mapping to the list of colour mappings to be applied.
addColourMapping(int, int) - Method in class gameframe.graphics.ColorReplacementEffect
Adds a colour to be replaced by another colour.
addImmediately(int) - Method in class gameframe.util.Counter
Adds the given number to the counter immediately.
advanceFrames(float) - Method in class gameframe.graphics.AnimBitmap
Advances the animation the number of frames given to the direction it is configured to go.
advanceFrames(int) - Method in class gameframe.graphics.AnimBitmap
Deprecated. Use advanceFrames( float ) instead of the advanceFrames( int ) version.
ALL_COLOURDEPTHS - Static variable in interface gameframe.graphics.GraphicsEngine
All supported colour depths.
AnimBitmap - class gameframe.graphics.AnimBitmap.
Implementation of an animated bitmap.
AnimBitmap(Bitmap[]) - Constructor for class gameframe.graphics.AnimBitmap
Constructs an animated bitmap from the series of Bitmap objects given.
AnimBitmap(Bitmap, int, int) - Constructor for class gameframe.graphics.AnimBitmap
Constructs an animated bitmap from the given Bitmap that contains the animation cells.
AppletGameFrame - class gameframe.AppletGameFrame.
The GameFrame librarys main entry point class.
AppletGameFrame(Applet) - Constructor for class gameframe.AppletGameFrame
Constructs the GameFrame using default settings.
AppletGameFrame(Applet, GameFrameSettings) - Constructor for class gameframe.AppletGameFrame
Constructs the GameFrame using the given settings.
ApplicationAppletBase - class gameframe.ApplicationAppletBase.
Base class for a game that can act both as application and as an applet.
ApplicationAppletBase() - Constructor for class gameframe.ApplicationAppletBase
Constructs the example Applet.
ApplicationAppletBase(String[]) - Constructor for class gameframe.ApplicationAppletBase
Constructs the example application and stores the command line arguments given.

B

BIAS - Static variable in class gameframe.sound.ULawEncoder
Bias for linear code.
BigEndianDataInputStream - class gameframe.util.BigEndianDataInputStream.
Output stream filter that filters all input values to big endian format that is used e.g. by Intel processor equipped computers.
BigEndianDataInputStream(InputStream) - Constructor for class gameframe.util.BigEndianDataInputStream
Constructs an big endian input filter.
BigEndianDataOutputStream - class gameframe.util.BigEndianDataOutputStream.
Output stream filter that filters all output values to big endian format that is used e.g. by Intel processor equipped computers.
BigEndianDataOutputStream(OutputStream) - Constructor for class gameframe.util.BigEndianDataOutputStream
Constructs an big endian output filter.
Bitmap - interface gameframe.graphics.Bitmap.
Defines an interface to a bitmap image that can blit (draw) or strecth (scale) itself in the graphics engine's backbuffer or into drawable bitmap.
BitmapData - class gameframe.graphics.BitmapData.
Represents the bitmap data loaded from a bitmap file.
BitmapData(int[], int, int, int) - Constructor for class gameframe.graphics.BitmapData
Constructs a bitmap data object that has the given parameters.
BitmapData(int[], int, int, int, int[]) - Constructor for class gameframe.graphics.BitmapData
Constructs a bitmap data object that has the given parameters.
BitmapData(int[], int, int, int, int, int, int) - Constructor for class gameframe.graphics.BitmapData
Constructs a bitmap data object that has the given parameters.
BitmapData(int[], int, int, int, int, int, int, int[]) - Constructor for class gameframe.graphics.BitmapData
Constructs a bitmap data object that has the given parameters.
BitmapEffect - class gameframe.graphics.BitmapEffect.
Baseclass for all bitmap effect classes that process bitmaps.
BitmapEffect() - Constructor for class gameframe.graphics.BitmapEffect
 
BitmapFile - class gameframe.graphics.BitmapFile.
Represents Windows Bitmap (BMP) file and has utility methods for loading a Windows Bitmap file and returning its bitmap data.
BitmapFile() - Constructor for class gameframe.graphics.BitmapFile
 
blitTo(DrawableBitmap, int, int) - Method in interface gameframe.graphics.DrawableBitmap
Draws the bitmap to the given drawable bitmap at the given location.
blitTo(DrawableBitmap, int, int) - Method in interface gameframe.graphics.Bitmap
Draws the bitmap to the given drawable bitmap at the given location.
blitTo(DrawableBitmap, int, int) - Method in class gameframe.graphics.AnimBitmap
Draws the currently shown bitmap to the given drawable bitmap at the given location.
blitTo(int, int) - Method in interface gameframe.graphics.DrawableBitmap
Draws the bitmap to the graphics engine that loaded it at the given location.
blitTo(int, int) - Method in interface gameframe.graphics.Bitmap
Draws the bitmap to the graphics engine that loaded it at the given location.
blitTo(int, int) - Method in class gameframe.graphics.AnimBitmap
Draws the currently shown bitmap to the graphics engine that loaded it at the given location.
BUILD_NUMBER - Static variable in class gameframe.GameFrame
The build number of this library.

C

calculateTime() - Method in interface gameframe.util.Timer
When invoked calculates and returns the time that has elapsed since the last invokation in milliseconds (actual resolutin may vary from implementation to implementation).
clearBackbuffer() - Method in interface gameframe.graphics.GraphicsEngine
Paints the current backbuffer with the current backround color.
ColorMapping - class gameframe.graphics.ColorMapping.
Contains two colours that are related somehow.
ColorMapping() - Constructor for class gameframe.graphics.ColorMapping
Constructs a colour mapping object.
ColorMapping(int, int) - Constructor for class gameframe.graphics.ColorMapping
Constructs a colour mapping object with the given initial values.
ColorReplacementEffect - class gameframe.graphics.ColorReplacementEffect.
Replaces the colors with other colours given as colour mappings.
ColorReplacementEffect() - Constructor for class gameframe.graphics.ColorReplacementEffect
 
COLOURDEPTH_16BITS - Static variable in interface gameframe.graphics.GraphicsEngine
Constant for 16-bits colour depth.
COLOURDEPTH_24BITS - Static variable in interface gameframe.graphics.GraphicsEngine
Constant for 24-bits colour depth.
COLOURDEPTH_32BITS - Static variable in interface gameframe.graphics.GraphicsEngine
Constant for 32-bits colour depth.
Counter - class gameframe.util.Counter.
A counter that can display almost any number of digits.
Counter(int, int, int, int) - Constructor for class gameframe.util.Counter
Constructs a counter that uses the currently set font bitmap for numbers, has the given initial value, is located at the given screen coordinates and uses the given number of digits.
createTimer() - Static method in class gameframe.GameFrame
Returns a new timer instance.

D

dec(int) - Method in class gameframe.util.Counter
Decrements the given number from the counter.
decImmediately(int) - Method in class gameframe.util.Counter
Decrements the given number from the counter immediately.
DEFAULT_COLOURDEPTH - Static variable in interface gameframe.graphics.GraphicsEngine
Constant for default colour depth when none is set by the user.
DEFAULT_TITLE - Static variable in interface gameframe.graphics.GraphicsEngine
Constant that is set as the default title for all graphics engine windows.
destroy() - Method in class gameframe.ApplicationAppletBase
Closes and cleans up after applet/application.
DIR_FORWARD - Static variable in class gameframe.graphics.AnimBitmap
Enumerated direction of the animation.
DIR_REVERSE - Static variable in class gameframe.graphics.AnimBitmap
Enumerated direction of the animation.
DIR_STOPPED - Static variable in class gameframe.graphics.AnimBitmap
Enumerated direction of the animation.
DrawableBitmap - interface gameframe.graphics.DrawableBitmap.
Defines an interface to a bitmap image that can blit (draw) or strecth (scale) itself in the graphics engine's backbuffer or into drawable bitmap, but also can be blitted into.
drawTextAt(byte[], int, int) - Method in interface gameframe.graphics.GraphicsEngine
Prints the given string to the screen so that the uppermost and leftmost coordinate of the text is at the given location.
drawTextAt(String, int, int) - Method in interface gameframe.graphics.GraphicsEngine
Draws the given string to the screen so that the uppermost and leftmost coordinate of the text is at the given location.

E

EffectGroup - class gameframe.graphics.EffectGroup.
Groups a number of bitmap effects that are then applied when this effect is used in the order they were added.
EffectGroup() - Constructor for class gameframe.graphics.EffectGroup
 
encode(short[]) - Method in class gameframe.sound.ULawEncoder
Encodes the input value of linear PCM returns the results as either 8-bit u-law encoded array.
ENGINE_FACTORY_CLASS - Static variable in class gameframe.GameFrame
The engine factory class (used when finding engine factories).
ENGINE_FACTORY_GET_INSTANCE_METHOD_NAME - Static variable in class gameframe.GameFrame
The engine factory's get instance method name.
ENGINE_FACTORY_GET_INSTANCE_METHOD_PARAM_CLASSES - Static variable in class gameframe.GameFrame
The engine factory's get instance methods parameter classes.
ENGINE_FACTORY_IS_RUNNABLE_METHOD_NAME - Static variable in class gameframe.GameFrame
The engine factory's is runnable on current platform method name.
ENGINE_MAIN_PACKAGE_NAME - Static variable in class gameframe.GameFrame
The package name of the main package for engines.
ENGINE_SUBDIR_NAME - Static variable in class gameframe.GameFrame
The subdirectory name of the directory for engines.
exit(int) - Static method in class gameframe.GameFrame
Exits cleanly from application that has used GameFrame by first finalizing the whole library (that ensures all native resources are freed) and then calling carbage collector and waiting for a while and THEN exiting the application just like System.exit() method.

F

finalize() - Method in class gameframe.GameFrame
Finalizes this GameFrame instance and finalizes the whole GameFrame library.
finalize() - Method in interface gameframe.graphics.DrawableBitmap
Frees all the resources that are used by the bitmap implementation.
finalize() - Method in interface gameframe.graphics.Bitmap
Frees all the resources that are used by the bitmap implementation.
finalize() - Method in class gameframe.graphics.AnimBitmap
Frees all the resources that are used by the animated bitmap implementation.
finalize() - Method in interface gameframe.input.KeyboardDevice
Releases all resources held by the keyboard device implementation.
finalize() - Method in interface gameframe.sound.Sound
Frees all the resources that are used by the sound representation.
finalize() - Method in interface gameframe.util.Timer
Frees all the resources that are used by the timer.
flip() - Method in interface gameframe.graphics.GraphicsEngine
Switches the backbuffer and the currently displayed buffer.
FlipEffect - class gameframe.graphics.FlipEffect.
Defines a flip effect that flips the image (mirrors it around a centered horizontal line).
FlipEffect() - Constructor for class gameframe.graphics.FlipEffect
 
flush() - Method in class gameframe.util.BigEndianDataOutputStream
Flushes the used output stream.

G

GAME_FRAME_PACKAGE_NAME - Static variable in class gameframe.GameFrame
The package name of the main package for engines.
gameframe - package gameframe
The base classeses for user applications, library entry point and common exception classes.
GameFrame - class gameframe.GameFrame.
The GameFrame librarys main entry point class.
gameframe.graphics - package gameframe.graphics
Graphics related interfaces and classes.
gameframe.input - package gameframe.input
User input related interfaces and classes.
gameframe.sound - package gameframe.sound
Music and sample related interfaces and classes.
gameframe.util - package gameframe.util
Common utility interfaces and classes (timers, big endian I/O streams etc.).
GameFrame() - Constructor for class gameframe.GameFrame
Constructs the GameFrame using default settings.
GameFrame(GameFrameSettings) - Constructor for class gameframe.GameFrame
Constructs the GameFrame using the given settings.
GameFrameException - exception gameframe.GameFrameException.
Base class for all GameFrame exceptions.
GameFrameException(String) - Constructor for class gameframe.GameFrameException
 
GameFrameSettings - class gameframe.GameFrameSettings.
This class offers the methods for a game developer to define what kind of features he wants to be enabled (fullscreen or non-fullscreen graphics modes, proprietary engines or plain Java engines etc.) the resolution of the created graphics engine.

Default values are:
Fullscreen modes allowed. Microsoft Java allowed. Java Media Framework 1.1 allowed. Native libraries allowed. Required resolution "640x480". 16 bits per pixel. No preferred refresh rate.
GameFrameSettings() - Constructor for class gameframe.GameFrameSettings
 
getAllKeyboardDevices() - Method in interface gameframe.input.InputEngine
Returns all keyboard type of devices found on the system as polled devices (whenever the program that wants to know about the state of the device it must ask it from the device).
getAllPointerDevices() - Method in interface gameframe.input.InputEngine
Returns all pointer type of devices found on the system as polled devices (whenever the program that wants to know about the state of the device it must ask it from the device).
getApplet() - Method in class gameframe.AppletGameFrame
Returns the Applet that is using GF4J.
getAsBitmap(byte[]) - Method in interface gameframe.graphics.GraphicsEngine
Returns the given one line of text as an bitmap that is painted using the current font.
getAsBitmap(String) - Method in interface gameframe.graphics.GraphicsEngine
Returns the given one line of text as an bitmap that is painted using the current font.
getBitmapClones() - Method in class gameframe.graphics.AnimBitmap
Returns a copy of the used bitmaps in the animation.
getBuild() - Static method in class gameframe.GameFrame
Returns the build number of the GameFrame library.
getButtonDownCount(int) - Method in interface gameframe.input.PointerDevice
Returns the number of times the button has been stroken since last reading (after last call made to wasButtonDown or getButtonDownCount methods with the same button id number).
getClone(BitmapEffect) - Method in interface gameframe.graphics.Bitmap
Returns an effect processed copy of this bitmap.
getClone(BitmapEffect) - Method in class gameframe.graphics.AnimBitmap
Returns an effect processed copy of the currently shown bitmap.
getCopy() - Method in class gameframe.GameFrameSettings
Returns a copy of the settings.
getCopy() - Method in class gameframe.graphics.BitmapData
Returns a copy of the bitmap data.
getCopy() - Method in interface gameframe.sound.Sample
Returns a copy of this sound object that is independent from the original sound object.
getCount() - Method in class gameframe.util.Counter
Returns the current (real) counter value.
getDataDirectory() - Method in interface gameframe.graphics.GraphicsEngine
Returns the data directory wherefrom the bitmaps are loaded.
getDataDirectory() - Method in interface gameframe.sound.SoundEngine
Returns the data directory wherefrom the sounds are loaded.
getDefaultFontBitmapFilename() - Method in class gameframe.GameFrame
Filename that can be used to load the default font bitmap.
getDefaultFontBitmapFilename() - Method in class gameframe.AppletGameFrame
Filename that can be used to load the default font bitmap.
getDefaultIcon() - Method in class gameframe.GameFrame
Returns the Image that is set as the default image icon for all graphics engine windows.
getDefaultIcon() - Method in class gameframe.AppletGameFrame
Returns the Image that is set as the default image icon for all graphics engine windows.
getDefaultKeyboardDevice() - Method in interface gameframe.input.InputEngine
Returns the default keyboard type of device in the system as polled device (whenever the program that wants to know about the state of the device it must ask it from the device).
getDefaultPointerDevice() - Method in interface gameframe.input.InputEngine
Returns the default pointer type of device in the system as an polled device (whenever the program that wants to know about the state of the device it must ask it from the device).
getDescription() - Static method in class gameframe.GameFrame
Returns the (possibly multiline) description of the currently used implementation.
getDescription() - Method in interface gameframe.graphics.GraphicsEngine
Returns the (possibly multiline) description of the implementation.
getDescription() - Method in interface gameframe.input.InputEngine
Returns the (possibly multiline) description of the implementation.
getDescription() - Method in interface gameframe.sound.SoundEngine
Returns the (possibly multiline) description of the implementation.
getDirection() - Method in class gameframe.graphics.AnimBitmap
Returns the animation direction of this animated bitmap.
getDrawableBitmap(int, int) - Method in interface gameframe.graphics.GraphicsEngine
Creates a non-transparent bitmap (the color is set to the current background color) that can be drawn into with other bitmaps.
getFontHeight() - Method in interface gameframe.graphics.GraphicsEngine
Returns the current font height.
getFontWidth() - Method in interface gameframe.graphics.GraphicsEngine
Returns the current font width.
getGameFramePath() - Method in class gameframe.GameFrame
Returns the absolute path to the main directory of the library that contains the GameFrame public classes.
getGameFramePath() - Method in class gameframe.AppletGameFrame
Returns the absolute path to the main directory of the library that contains the GameFrame entry point.
getGraphicsEngine() - Static method in class gameframe.GameFrame
Returns the recommended graphics engine for the current platform or null if graphics engine was for some reason not created.
getHeight() - Method in interface gameframe.graphics.DrawableBitmap
Returns the height of the bitmap.
getHeight() - Method in class gameframe.graphics.BitmapData
Returns the height of the bitmap.
getHeight() - Method in interface gameframe.graphics.Bitmap
Returns the height of the bitmap.
getHeight() - Method in class gameframe.graphics.AnimBitmap
Returns the height of the currently shown bitmap.
getHeight() - Method in class gameframe.util.Counter
Returns the height of this counter.
getInputEngine() - Static method in class gameframe.GameFrame
Returns the recommended input engine for the current platform or null if input engine was for some reason not created.
getInstance() - Static method in class gameframe.GameFrame
Returns the singleton instance of the GameFrame class.
getKeyColorBlue() - Method in class gameframe.graphics.BitmapData
Returns the red component of the keycolor.
getKeyColorGreen() - Method in class gameframe.graphics.BitmapData
Returns the red component of the keycolor.
getKeyColorRed() - Method in class gameframe.graphics.BitmapData
Returns the red component of the keycolor.
getKeyDownCount(int) - Method in interface gameframe.input.KeyboardDevice
Returns the number of times the key has been stroken since last reading (after last call made to isKeyDown or getKeyDownCount methods with the same key code).
getMajorVersion() - Static method in class gameframe.GameFrame
Returns the major version of the GameFrame library.
getMinorVersion() - Static method in class gameframe.GameFrame
Returns the minor version of the GameFrame library.
getMode() - Method in class gameframe.graphics.AnimBitmap
Returns the animation mode of this animated bitmap.
getName() - Static method in class gameframe.GameFrame
Returns the short name (max 8 characters) of the currently used implementation e.g.
getName() - Method in interface gameframe.graphics.GraphicsEngine
Returns the short name (max 8 characters) of the implementation e.g.
getName() - Method in interface gameframe.input.InputEngine
Returns the short name (max 8 characters) of the implementation e.g.
getName() - Method in interface gameframe.sound.SoundEngine
Returns the short name (max 8 characters) of the implementation e.g.
getNumBlueBits() - Method in class gameframe.graphics.BitmapData
Returns the number of bits used for the red component in a pixel.
getNumGreenBits() - Method in class gameframe.graphics.BitmapData
Returns the number of bits used for the red component in a pixel.
getNumRedBits() - Method in class gameframe.graphics.BitmapData
Returns the number of bits used for the red component in a pixel.
getPalette() - Method in class gameframe.graphics.BitmapData
Returns the palette array in the default color format.
getPan() - Method in interface gameframe.sound.Sample
Returns the pan of the sound.
getPcmData() - Method in class gameframe.sound.RiffWavFile
Returns the raw linear PCM sample data in 16-bit mono format.
getPitch() - Method in class gameframe.graphics.BitmapData
Returns the number of pixels that needs to be travelled in the pixel array in order to step one pixel down in the bitmap.
getPixels() - Method in class gameframe.graphics.BitmapData
Returns the pixel data array in the default color format.
getRequiredBitdepth() - Method in class gameframe.GameFrameSettings
Returns the bits per pixel value that is required from the graphics engine implementation.
getRequiredRefreshRate() - Method in class gameframe.GameFrameSettings
Returns the refresh rate that is required from the graphics engine implementation.
getRequiredResolution() - Method in class gameframe.GameFrameSettings
Returns the resolution that is required from the graphics engine implementation.
getRequiredResolutionHeight() - Method in class gameframe.GameFrameSettings
Returns the required height of the resolution.
getRequiredResolutionWidth() - Method in class gameframe.GameFrameSettings
Returns the required width of the resolution.
getRotationDegrees() - Method in class gameframe.graphics.RotationEffect
Returns the amount of rotation applied to the image in degrees.
getRotationRadians() - Method in class gameframe.graphics.RotationEffect
Returns the amount of rotation applied to the image in radians.
getScale() - Method in class gameframe.graphics.ScaleEffect
Returns the amount of scaling applied to the image.
getScreenMode() - Method in class gameframe.GameFrameSettings
Returns the flag that indicates if fullscreen modes are allowed.
getSize() - Method in interface gameframe.graphics.GraphicsEngine
Returns the size of the display area that this engine uses.
getSoundEngine() - Static method in class gameframe.GameFrame
Returns the recommended sound engine for the current platform or null if sound engine was for some reason not created.
getSubBitmap(int, int, int, int) - Method in interface gameframe.graphics.Bitmap
Returns a bitmap that represents a part of this bitmap by using a new control object, but using the old bitmap data.
getSubBitmap(int, int, int, int) - Method in class gameframe.graphics.AnimBitmap
Returns the subbitmap of the current animation frame.
getSubBitmapClone(int, int, int, int) - Method in interface gameframe.graphics.Bitmap
Returns a bitmap that represents a part of this bitmap by copying the actual part of the bitmap representation to different memory location.
getSubBitmapClone(int, int, int, int) - Method in class gameframe.graphics.AnimBitmap
Returns the subbitmap clone of the current animation frame.
getSuitabilityForPlatform() - Static method in class gameframe.GameFrame
Returns the suitability of the currently used implementation for the current platform as one of the enumerated EngineFactory.SUITABILITY_xxx values.
getSupportedResolutions() - Static method in class gameframe.GameFrame
Returns all the fullscreen graphics modes supported by recommended graphics engine.
getTextWidth(byte[]) - Method in interface gameframe.graphics.GraphicsEngine
Returns the given one line of text's width when we are using the current font bitmap.
getTextWidth(String) - Method in interface gameframe.graphics.GraphicsEngine
Returns the given one line of text's width when we are using the current font bitmap.
getTitle() - Method in class gameframe.GameFrameSettings
Reutnrs the title that is shown when possible for the graphics engine.
getTypedAlphanumericKey() - Method in interface gameframe.input.KeyboardDevice
Returns any typed alphanumeric keys (including space and dot) as int values that correspond to that keys char value or -1 if no such keys were pressed after last invokation of this method.
getWidth() - Method in interface gameframe.graphics.DrawableBitmap
Returns the width of the bitmap.
getWidth() - Method in class gameframe.graphics.BitmapData
Returns the width of the bitmap.
getWidth() - Method in interface gameframe.graphics.Bitmap
Returns the width of the bitmap.
getWidth() - Method in class gameframe.graphics.AnimBitmap
Returns the width of the currently shown bitmap.
getWidth() - Method in class gameframe.util.Counter
Returns the width of this counter.
getVolume() - Method in interface gameframe.sound.Sample
Returns the volume of the sound.
getX() - Method in interface gameframe.input.PointerDevice
Returns the X-coordinate of the pointer devices current location.
getX() - Method in class gameframe.util.Counter
Returns the base x-coordinate of the counter based upon the number of digits it needs to display.
getY() - Method in interface gameframe.input.PointerDevice
Returns the Y-coordinate of the pointer devices current location.
getY() - Method in class gameframe.util.Counter
Returns the base y-coordinate.
GraphicsEngine - interface gameframe.graphics.GraphicsEngine.
Defines an interface to a graphics engine that can be thought to be a "display device".

I

imageUpdate(Image, int, int, int, int, int) - Method in class gameframe.graphics.BitmapFile
The image observer method that gets updated when an image is loading.
init() - Method in class gameframe.ApplicationAppletBase
Initializes the GameFrame for Java library.
InputEngine - interface gameframe.input.InputEngine.
Represents the interface to an input engine that is used to get to the input devices in the system.
IS_STABLE_RELEASE - Static variable in class gameframe.GameFrame
Is this release a stable release.
isButtonDown(int) - Method in interface gameframe.input.PointerDevice
Returns true if the button is currently down.
isInFullscreenMode() - Method in interface gameframe.graphics.GraphicsEngine
Returns true if the engine is in fullscreen mode, false if in windowed mode.
isInitialized() - Static method in class gameframe.GameFrame
Returns whether GF4J library is initialized at the moment or not.
isJmf11Allowed() - Method in class gameframe.GameFrameSettings
Returns the flag that indicates if Java Media Framework 1.1 specific implementations are allowed.
isKeyColourInUse() - Method in class gameframe.graphics.BitmapData
Returns whether this bitmap data uses the keycolor or not.
isKeyDown(int) - Method in interface gameframe.input.KeyboardDevice
Returns true if the key is down or if the key was briefly kept down after last reading of the keys state (after last call made to isKeyDown or getKeyDownCount methods with the same key code).
isMsJavaAllowed() - Method in class gameframe.GameFrameSettings
Returns the flag that indicates if Microsoft Java VM specific implementations are allowed.
isNativeAllowed() - Method in class gameframe.GameFrameSettings
Returns the flag that indicates if native code implementations are allowed.
isPaletted() - Method in class gameframe.graphics.BitmapData
Returns whether this image data uses a palette or not.
isPlaying() - Method in interface gameframe.sound.Sound
Returns true if play() or playLooped() has been invoked on the sound and the stop() hasn't been called after that.
isStableVersion() - Static method in class gameframe.GameFrame
Returns true if this version is a stable release (not prerelease, beta or alpha or anything like that) meant for anyones use.

K

KeyboardDevice - interface gameframe.input.KeyboardDevice.
This interface is meant for input devices that are keyboard-like in their operation.
keyColor - Variable in class gameframe.graphics.ColorMapping
The key colour.

L

loadAlphaBitmap(String) - Method in interface gameframe.graphics.GraphicsEngine
Loads and returns a transparent bitmap (used bitmap format is Windows BMP 8-bit, 16-bit or 24-bit) from the given filename.
loadAlphaBitmap(String, byte, byte, byte) - Method in interface gameframe.graphics.GraphicsEngine
Loads and returns a transparent bitmap (used bitmap format is Windows BMP 8-bit, 16-bit or 24-bit) from the given filename.
loadBitmap(String) - Method in interface gameframe.graphics.GraphicsEngine
Loads and returns a non-transparent bitmap (used bitmap format is Windows BMP 8-bit, 16-bit or 24-bit) from the given filename.
loadBMP(InputStream, String, boolean) - Static method in class gameframe.graphics.BitmapFile
Handles the loading of the bitmap from the given input stream.
loadBMP(InputStream, String, byte, byte, byte) - Static method in class gameframe.graphics.BitmapFile
Handles the loading of the bitmap from the given input stream.
loadBMP(String, boolean) - Static method in class gameframe.graphics.BitmapFile
Loads the given file containing a Windows BMP formatted bitmap and returns an object containing the raw pixel data and the dimensions of the loaded bitmap.
loadBMP(String, byte, byte, byte) - Static method in class gameframe.graphics.BitmapFile
Loads the given file containing a Windows BMP formatted bitmap and returns an object containing the raw pixel data and the dimensions of the loaded bitmap.
loadBMPURL(String, boolean) - Static method in class gameframe.graphics.BitmapFile
Loads the file at the given URL containing a Windows BMP formatted bitmap and returns an object containing the raw pixel data and the dimensions of the loaded bitmap.
loadBMPURL(String, byte, byte, byte) - Static method in class gameframe.graphics.BitmapFile
Loads the file at the given URL containing a Windows BMP formatted bitmap and returns an object containing the raw pixel data and the dimensions of the loaded bitmap.
loadDefaultFontBitmap() - Method in interface gameframe.graphics.GraphicsEngine
Loads the default font bitmap that is used when printing text on the screen.
loadFontBitmap(String) - Method in interface gameframe.graphics.GraphicsEngine
Loads and sets the used font set to be loaded from the given filename using a calculated fixed size for every letter.
loadFromInputStream(String) - Method in class gameframe.sound.RiffWavFile
 
loadMusic(String) - Method in interface gameframe.sound.SoundEngine
First tries to load a music file as streamed Microsoft RIFF WAV file, if no such file is found from the current data directory, tries to load a music file in MIDI format.
loadSample(String) - Method in interface gameframe.sound.SoundEngine
Loads a sample in Microsoft RIFF WAV format and returns the control object for the sample.
loadWAV(String) - Method in class gameframe.sound.RiffWavFile
Loads the RIFFF WAVE file from the specified file.
loadWAVURL(String) - Method in class gameframe.sound.RiffWavFile
Loads the RIFFF WAVE file from the specified URL.

M

main(String[]) - Static method in class gameframe.ApplicationAppletBase
Starts up the example application (creates an instance and calls the init() and start() methods of the instance).
MAJOR_VERSION - Static variable in class gameframe.GameFrame
The major version number of this library.
MINOR_VERSION - Static variable in class gameframe.GameFrame
The minor version number of this library.
MirrorEffect - class gameframe.graphics.MirrorEffect.
Mirrors (mirrors around a vertical line) the image.
MirrorEffect() - Constructor for class gameframe.graphics.MirrorEffect
 
MODE_LOOP - Static variable in class gameframe.graphics.AnimBitmap
Enumerated animation mode.
MODE_ONCE - Static variable in class gameframe.graphics.AnimBitmap
Enumerated animation mode.
MODE_PING_PONG - Static variable in class gameframe.graphics.AnimBitmap
Enumerated animation mode.
Music - interface gameframe.sound.Music.
Defines the interface for a music representation.

N

nextFrame() - Method in class gameframe.graphics.AnimBitmap
Advances the animation one frame to the direction it is configured to go.
NO_PREFERRED_REFRESHRATE - Static variable in interface gameframe.graphics.GraphicsEngine
Constant for refreshrate when there is no preferred refresh rate.
NOT_USED - Static variable in class gameframe.graphics.BitmapData
The value of any key color component if it is not used.
NSEGS - Static variable in class gameframe.sound.ULawEncoder
Number of A-law segments.

O

ObjectPreserver - class gameframe.util.ObjectPreserver.
This class has methods to ensure that an object is never garbage collected.

P

paint() - Method in class gameframe.util.Counter
Paints this counter to the backbuffer.
paint(Graphics) - Method in class gameframe.ApplicationAppletBase
Overridden to display a text message when the applet has stopped execution (user presses ESC etc.)
parseCommandLineArgs(String[]) - Method in class gameframe.GameFrameSettings
Parses the given command line arguments and sets the contained settings accordingly.
playForward() - Method in class gameframe.graphics.AnimBitmap
Tells the animation to play forward (from first animation cell to the last).
playLooped() - Method in interface gameframe.sound.Sound
Plays the sound over and over again (looping).
playOnce() - Method in interface gameframe.sound.Sound
Plays the sound once and then stops.
playReverse() - Method in class gameframe.graphics.AnimBitmap
Tells the animation to play backwards (from last animation cell to the first).
PointerDevice - interface gameframe.input.PointerDevice.
This interface is meant for input devices that are pointer or mouse like in their operation.
preserveObject(Object) - Static method in class gameframe.util.ObjectPreserver
The objects passed to this method will be protected from garbage collection until they are released by the unpreserveObject method.
processData(BitmapData) - Method in class gameframe.graphics.BitmapEffect
Processes the given bitmap data in some way.
processData(BitmapData) - Method in class gameframe.graphics.EffectGroup
Processes the given bitmap data with all the effects in this group.
processData(BitmapData) - Method in class gameframe.graphics.ColorReplacementEffect
Maps the colours with the given colour maps.
processData(BitmapData) - Method in class gameframe.graphics.RotationEffect
Rotates the image around its center the given amount.
processData(BitmapData) - Method in class gameframe.graphics.ScaleEffect
Scales the image the given amount.
processData(BitmapData) - Method in class gameframe.graphics.FlipEffect
Flips (mirrors around a horizontal line) the image.
processData(BitmapData) - Method in class gameframe.graphics.MirrorEffect
Mirrors (mirrors around a vertical line) the image.

Q

QUANT_MASK - Static variable in class gameframe.sound.ULawEncoder
Quantization field mask.

R

read() - Method in class gameframe.util.BigEndianDataInputStream
Reads an integer.
read(byte[]) - Method in class gameframe.util.BigEndianDataInputStream
Reads the series of bytes in big endian format.
read(byte[], int, int) - Method in class gameframe.util.BigEndianDataInputStream
Reads the series of bytes in big endian format.
readBoolean() - Method in class gameframe.util.BigEndianDataInputStream
Reads a boolean value.
readByte() - Method in class gameframe.util.BigEndianDataInputStream
Reads a byte.
readChar() - Method in class gameframe.util.BigEndianDataInputStream
Reads a Unicode character.
readDouble() - Method in class gameframe.util.BigEndianDataInputStream
Reads a double value in big endian format.
readFloat() - Method in class gameframe.util.BigEndianDataInputStream
Reads a floating point value in big endian format.
readFully(byte[]) - Method in class gameframe.util.BigEndianDataInputStream
Reads some bytes from an input stream and stores them into the buffer array aBytes.
readFully(byte[], int, int) - Method in class gameframe.util.BigEndianDataInputStream
Reads some bytes from an input stream and stores them into the buffer array aBytes.
readHeader() - Method in class gameframe.sound.RiffWavFile
Reads and parses the RIFF WAVE header.
readInt() - Method in class gameframe.util.BigEndianDataInputStream
Reads a integer value in big endian format.
readLine() - Method in class gameframe.util.BigEndianDataInputStream
Reads one line of text.
readLong() - Method in class gameframe.util.BigEndianDataInputStream
Reads a long value in big endian format.
readShort() - Method in class gameframe.util.BigEndianDataInputStream
Reads a short value in big endian format.
readUnsignedByte() - Method in class gameframe.util.BigEndianDataInputStream
Reads an unsigned byte.
readUnsignedShort() - Method in class gameframe.util.BigEndianDataInputStream
Reads an unsigned short value in big endian format.
readUTF() - Method in class gameframe.util.BigEndianDataInputStream
Does nothing.
remove(BitmapEffect) - Method in class gameframe.graphics.EffectGroup
Removes the given effect from this group of effects.
removeAll() - Method in class gameframe.graphics.EffectGroup
Removes all the effects from this group (no effects are applied).
resampleTo(int) - Method in class gameframe.sound.RiffWavFile
Sets the sampling rate of this wav data to the given sampling rate
reset() - Method in class gameframe.graphics.BitmapEffect
Resets the effects settings.
reset() - Method in class gameframe.graphics.EffectGroup
Resets all the effects in this group.
reset() - Method in class gameframe.graphics.ColorReplacementEffect
Resets the effect settings to default values (no colour mappings are applied).
reset() - Method in class gameframe.graphics.RotationEffect
Resets the effect settings to default values (no rotation is applied).
reset() - Method in class gameframe.graphics.ScaleEffect
Resets the effect settings to default values (no scaling is applied).
reset() - Method in class gameframe.graphics.FlipEffect
Does nothing in this effect.
reset() - Method in class gameframe.graphics.MirrorEffect
Does nothing in this effect.
reset() - Method in class gameframe.util.Counter
Resets this counter to its inital value.
RiffWavFile - class gameframe.sound.RiffWavFile.
Class for reading RIFF WAV audio files.
RiffWavFile() - Constructor for class gameframe.sound.RiffWavFile
Constructs a new RIFF wave file without any filename.
RotationEffect - class gameframe.graphics.RotationEffect.
Rotates the image around its center the given amount.
RotationEffect() - Constructor for class gameframe.graphics.RotationEffect
 
run() - Method in class gameframe.ApplicationAppletBase
Executes the example applet/application
run() - Method in class gameframe.util.ObjectPreserver
The threads run method that does nothing else than keeps this object alive.

S

Sample - interface gameframe.sound.Sample.
Defines the interface for a representation of a sample.
saveBMP(String, BitmapData) - Static method in class gameframe.graphics.BitmapFile
Saves the given bitmap to a Windows BMP formatted file.
ScaleEffect - class gameframe.graphics.ScaleEffect.
Scales the image the given amount.
ScaleEffect() - Constructor for class gameframe.graphics.ScaleEffect
 
SCREENMODE_COMPONENT - Static variable in class gameframe.GameFrameSettings
Enumerated mode for the graphics engine, means component graphics mode.
SCREENMODE_FULLSCREEN - Static variable in class gameframe.GameFrameSettings
Enumerated mode for the graphics engine, means fullscreen graphics mode.
SCREENMODE_WINDOWED - Static variable in class gameframe.GameFrameSettings
Enumerated mode for the graphics engine, means windowed graphics mode.
SEG_MASK - Static variable in class gameframe.sound.ULawEncoder
Segment field mask.
SEG_SHIFT - Static variable in class gameframe.sound.ULawEncoder
Left shift for segment number.
setAllowJmf11(boolean) - Method in class gameframe.GameFrameSettings
Sets the flag that indicates if Java Media Framework 1.1 specific implementations are allowed.
setAllowMsJava(boolean) - Method in class gameframe.GameFrameSettings
Sets the flag that indicates if Microsoft Java VM specific implementations are allowed.
setAllowNative(boolean) - Method in class gameframe.GameFrameSettings
Sets the flag that indicates if native code implementations are allowed.
setBackgroundColor(Color) - Method in interface gameframe.graphics.GraphicsEngine
Sets the currently used background color (which defaults to Color.black).
setColourBits(int, int, int) - Method in class gameframe.graphics.BitmapData
Sets the colour bits (the number of bits used for each colour).
setCount(int) - Method in class gameframe.util.Counter
Sets the count of this counter to the given number.
setDataDirectory(String) - Method in interface gameframe.graphics.GraphicsEngine
Sets the data directory wherefrom the bitmaps are loaded.
setDataDirectory(String) - Method in interface gameframe.sound.SoundEngine
Sets the data directory wherefrom the sounds are loaded.
setFromApplet(Applet) - Method in class gameframe.GameFrameSettings
Queries the given applet for parameters and sets the contained settings accordingly.
setImmediately(int) - Method in class gameframe.util.Counter
Sets the given counter value immediately without the fancy scrolling effect.
setMode(int) - Method in class gameframe.graphics.AnimBitmap
Sets the animation mode of this animated bitmap.
setPan(float) - Method in interface gameframe.sound.Sample
Sets the pan of the sound.
setRequiredResolution(String) - Method in class gameframe.GameFrameSettings
Sets the resolution that is required from the graphics engine implementation.
setRotationDegrees(float) - Method in class gameframe.graphics.RotationEffect
Sets the amount of rotation applied to the image in degrees.
setRotationRadians(float) - Method in class gameframe.graphics.RotationEffect
Sets the amount of rotation applied to the image in radians.
setScale(float) - Method in class gameframe.graphics.ScaleEffect
Sets the amount of scaling applied to the image.
setScreenMode(int) - Method in class gameframe.GameFrameSettings
Sets the required screen mode for the graphics engine.
SettingsException - exception gameframe.SettingsException.
GameFrame exception that gets thrown when GameFrame is used in a wrong way.
SettingsException(String) - Constructor for class gameframe.SettingsException
Contstructs a SettingsException with the given description.
setTitle(String) - Method in class gameframe.GameFrameSettings
Sets the title that is shown when possible for the graphics engine.
setVolume(float) - Method in interface gameframe.sound.Sample
Sets the volume of the sound.
setX(int) - Method in class gameframe.util.Counter
Sets the upper left coordinate.
setY(int) - Method in class gameframe.util.Counter
Sets the upper left coordinate.
SIGN_BIT - Static variable in class gameframe.sound.ULawEncoder
Sign bit for a A-law byte.
skipBytes(int) - Method in class gameframe.util.BigEndianDataInputStream
Skips the given number of bytes.
Sound - interface gameframe.sound.Sound.
Defines the base interface for all representations of a sound.
SoundEngine - interface gameframe.sound.SoundEngine.
Defines an interface to a sound engine that can be thought to be a "sound device".
start() - Method in class gameframe.ApplicationAppletBase
Starts the applet/application running.
stop() - Method in class gameframe.ApplicationAppletBase
Stops the applets/applications running.
stop() - Method in class gameframe.graphics.AnimBitmap
Stops the animation.
stop() - Method in interface gameframe.sound.Sound
Stops playing the sound.
stop() - Method in class gameframe.util.ObjectPreserver
Stops the garbage collector preventing thread.
strecthTo(DrawableBitmap, int, int, int, int) - Method in interface gameframe.graphics.DrawableBitmap
Draws the bitmap to the given drawable bitmap at the given location at the given size.
strecthTo(DrawableBitmap, int, int, int, int) - Method in interface gameframe.graphics.Bitmap
Draws the bitmap to the given drawable bitmap at the given location at the given size.
strecthTo(DrawableBitmap, int, int, int, int) - Method in class gameframe.graphics.AnimBitmap
Draws the currently shown bitmap to the given drawable bitmap at the given location at the given size.
strecthTo(int, int, int, int) - Method in interface gameframe.graphics.DrawableBitmap
Draws the bitmap to the graphics engine that loaded it at the given location and at the given size.
strecthTo(int, int, int, int) - Method in interface gameframe.graphics.Bitmap
Draws the bitmap to the graphics engine that loaded it at the given location and at the given size.
strecthTo(int, int, int, int) - Method in class gameframe.graphics.AnimBitmap
Draws the currently shown bitmap to the graphics engine that loaded it at the given location and at the given size.

T

tick() - Method in class gameframe.util.Counter
Calcultes the value of this counter every time called.
Timer - interface gameframe.util.Timer.
Interface for a generic timer class that times the (average or exact, depending on implementation) time between the calls made to the calculateTime() method.

U

ULawEncoder - class gameframe.sound.ULawEncoder.
u-law, A-law and linear PCM conversions.
ULawEncoder() - Constructor for class gameframe.sound.ULawEncoder
 
unpreserveObject(Object) - Static method in class gameframe.util.ObjectPreserver
The objects passed to this method will no longer be protected from garbage collection.

V

valueColor - Variable in class gameframe.graphics.ColorMapping
The value colour.

W

wasButtonDown(int) - Method in interface gameframe.input.PointerDevice
Returns true if the button was briefly kept down after last reading of the buttons state (after last call made to wasButtonDown or getButtonDownCount methods with the same button id number).
wasKeyDown(int) - Method in interface gameframe.input.KeyboardDevice
Returns true if the key was briefly kept down after last reading of the keys state (after last call made to isKeyDown or getKeyDownCount methods with the same key code).
WAVE_FORMAT_PCM - Static variable in class gameframe.sound.RiffWavFile
Format tag for Microsoft Pulse Code Modulation (PCM) format (non-proprietary).
write(byte[], int, int) - Method in class gameframe.util.BigEndianDataOutputStream
Writes the series of bytes in big endian format.
write(int) - Method in class gameframe.util.BigEndianDataOutputStream
Writes an integer to the used output stream in big endian format.
writeBoolean(boolean) - Method in class gameframe.util.BigEndianDataOutputStream
Writes the given boolean value.
writeByte(int) - Method in class gameframe.util.BigEndianDataOutputStream
Writes the given byte.
writeBytes(String) - Method in class gameframe.util.BigEndianDataOutputStream
Writes the given string as an array of bytes.
writeChar(int) - Method in class gameframe.util.BigEndianDataOutputStream
Writes the given Unicode character.
writeChars(String) - Method in class gameframe.util.BigEndianDataOutputStream
Writes the given string as an array of Unicode characters.
writeDouble(double) - Method in class gameframe.util.BigEndianDataOutputStream
Writes the given double value in big endian format.
writeFloat(float) - Method in class gameframe.util.BigEndianDataOutputStream
Writes the given floating point value in big endian format.
writeInt(int) - Method in class gameframe.util.BigEndianDataOutputStream
Writes the given integer value in big endian format.
writeLong(long) - Method in class gameframe.util.BigEndianDataOutputStream
Writes the given long value in big endian format.
writeShort(int) - Method in class gameframe.util.BigEndianDataOutputStream
Writes the given short value in big endian format.
writeUTF(String) - Method in class gameframe.util.BigEndianDataOutputStream
Does nothing.

A B C D E F G I K L M N O P Q R S T U V W
GF4J 0.9.4 Beta