A B C D E F G H I M R S U W X Y

A

Audio - interface gamingtools.Audio.

The Audio interface is a simple abstraction for playing music or a sound effect.

AudioListener - interface gamingtools.AudioListener.

A class implements this interface to receive notification that music or a sound effect has stopped playing.

AudioSource - class gamingtools.AudioSource.

The AudioSource class provides methods for loading music and sound effect files.

audioStopped() - Method in interface gamingtools.AudioListener

Invoked by an Audio object when the audio stops playing.

B

backgroundNumber - Variable in class gamingtools.FrameBuilder

Index that is incremented only if the background changes.

bufferHeight - Variable in class gamingtools.FrameBuilder

Height of the buffers.

bufferWidth - Variable in class gamingtools.FrameBuilder

Width of the buffers.

C

clearAudioListener() - Method in interface gamingtools.Audio

Unregisters the AudioListener if there is one.

clearRenderListener() - Static method in class gamingtools.GraphicsSource

Unregisters the RenderListener if there is one.

D

DEFAULT_MAX_DIRTY_REGIONS - Static variable in class gamingtools.FrameBuilder

Default maximum dirty regions stored in the history per buffer.

DEFAULT_WINDOW_LISTENER - Static variable in class gamingtools.GraphicsSource

Used when the application runs in a window instead of full-screen exclusive mode.

dispose() - Method in interface gamingtools.Audio

Releases any system resources used by this object.

drawSprite(Graphics, Image, int, int) - Method in class gamingtools.FrameBuilder

Draws an image at the specified coordinates and marks the region it occupies as dirty.

E

enterDisplayMode(int, int) - Static method in class gamingtools.GraphicsSource

Attempts to enter full-screen exclusive mode with the specified screen dimensions.

ExceptionHandler - interface gamingtools.ExceptionHandler.

A class implements this interface to receive notification that an exception has occurred.

exceptionOccurred(Throwable) - Method in interface gamingtools.ExceptionHandler

Called back an Exception or an Error happens.

exitDisplayMode() - Static method in class gamingtools.GraphicsSource

Restores the display mode back to normal and stops the animation.

F

FrameBuilder - class gamingtools.FrameBuilder.

A class that desires to generate animation frames extends this class.

FrameBuilder.FrameInfo - class gamingtools.FrameBuilder.FrameInfo.

Description of an animation frame.

FrameBuilder.FrameInfo() - Constructor for class gamingtools.FrameBuilder.FrameInfo

FrameBuilder.Region - class gamingtools.FrameBuilder.Region.

Rectangular dirty region.

FrameBuilder.Region() - Constructor for class gamingtools.FrameBuilder.Region

FrameBuilder() - Constructor for class gamingtools.FrameBuilder

Constructs this class with a dirty region history size equal to 64.

FrameBuilder(int) - Constructor for class gamingtools.FrameBuilder

Constructs this class with dirty region history size equal to the specified value.

frameInfoHistory - Variable in class gamingtools.FrameBuilder

Stored frame descriptions.

G

gamingtools - package gamingtools

getAudio(String) - Static method in class gamingtools.AudioSource

Loads an audio file with the specified name from the sounds directory.

getAudio(String, AudioListener) - Static method in class gamingtools.AudioSource

Loads an audio file with the specified name from the sounds directory and associates it with an AudioListener.

getBufferHeight() - Static method in class gamingtools.GraphicsSource

Obtains the height of the buffers.

getBufferWidth() - Static method in class gamingtools.GraphicsSource

Obtains the width of the buffers.

getExceptionHandler() - Static method in class gamingtools.GraphicsSource

Obtains the ExceptionHandler used when an exception is thrown in the animation loop thread.

getFrame() - Static method in class gamingtools.GraphicsSource

Obtains the Frame used as the full-screen window.

getImage(String) - Static method in class gamingtools.ImageSource

Loads an image with the specified name from the images directory.

getImages(String[], String) - Static method in class gamingtools.ImageSource

Loads an array of images with the specified names.

getResolution() - Method in interface gamingtools.StopWatch

The error expected in the measured elapsed time; meaning, the actual elapsed time is somewhere in the range of the measured elapsed time plus-or-minus this value.

getStopWatch() - Static method in class gamingtools.StopWatchSource

Obtains the StopWatch with the highest resolution available.

GraphicsSource - class gamingtools.GraphicsSource.

The GraphicsSource class provides methods for entering and exiting full-screen exclusive mode and for registering for animation frame rendering callbacks.

H

height - Variable in class gamingtools.FrameBuilder.Region

Height of the region.

historyIndex - Variable in class gamingtools.FrameBuilder

Alternates between 0 and 1, or remains at 0.

historySize - Variable in class gamingtools.FrameBuilder

Equal to the number of buffers.

I

IMAGES_DIR - Static variable in class gamingtools.ImageSource

Location of the image files relative to the root package.

ImageSource - class gamingtools.ImageSource.

The ImageSource class provides methods for loading images.

init() - Method in class gamingtools.FrameBuilder

This method is used to load images and sounds, and for configuration.

init(boolean, int, int) - Method in interface gamingtools.RenderListener

This method is used to load images and sounds, and for configuration.

init(boolean, int, int) - Method in class gamingtools.FrameBuilder

This method is automatically invoked by GraphicsSource.

isBackgroundSame() - Method in class gamingtools.FrameBuilder

Returns true if and only if the background has not changed.

isPageFlipping() - Static method in class gamingtools.GraphicsSource

Returns whether or not page flipping is used as the double-buffer strategy.

M

markDirtyRegion(int, int, int, int) - Method in class gamingtools.FrameBuilder

Records a dirty region.

MAX_DIRTY_REGIONS - Variable in class gamingtools.FrameBuilder

Maximum number of dirty regions stored in the history per buffer.

R

regionHistory - Variable in class gamingtools.FrameBuilder

Stored dirty regions: [history index][region index]

render(Graphics, boolean, int) - Method in interface gamingtools.RenderListener

Displays the game state to the back buffer.

render(Graphics, boolean, int) - Method in class gamingtools.FrameBuilder

This method is automatically invoked by GraphicsSource.

renderBackground(Graphics) - Method in class gamingtools.FrameBuilder

Draws the complete background.

renderBackground(Graphics, int, int, int, int) - Method in class gamingtools.FrameBuilder

Draws a rectangular sub-region of the background.

renderForeground(Graphics) - Method in class gamingtools.FrameBuilder

Draws the sprites and other foreground graphics.

RenderListener - interface gamingtools.RenderListener.

A class that is interested in generating animation frames implements this interface.

S

setAudioListener(AudioListener) - Method in interface gamingtools.Audio

Registers an AudioListener with this Audio object to receive notification of when the audio stops.

setExceptionHandler(ExceptionHandler) - Static method in class gamingtools.GraphicsSource

Sets the ExceptionHandler used when an exception is thrown in the animation loop thread.

setRenderListener(RenderListener) - Static method in class gamingtools.GraphicsSource

Sets the RenderListener used for generating animation frames.

SOUNDS_DIR - Static variable in class gamingtools.AudioSource

Location of the audio files relative to the root package.

start() - Method in interface gamingtools.StopWatch

Starts timing.

startAnimation(int) - Static method in class gamingtools.GraphicsSource

Starts the animation loop.

startAnimation(int, int) - Static method in class gamingtools.GraphicsSource

Starts the animation loop.

stop() - Method in interface gamingtools.StopWatch

Stops timing and returns the elapsed time in nanoseconds (10^-9 seconds).

stopAnimation() - Static method in class gamingtools.GraphicsSource

Stops the animation loop.

StopWatch - interface gamingtools.StopWatch.

Used for timing the execution of a code segment.

StopWatchSource - class gamingtools.StopWatchSource.

The origin of stop watches.

U

updateModel() - Method in interface gamingtools.RenderListener

This method is used to update the state of the game.

updateModel() - Method in class gamingtools.FrameBuilder

This method is automatically invoked by GraphicsSource.

updateState() - Method in class gamingtools.FrameBuilder

This method is used to update the state of the game.

W

width - Variable in class gamingtools.FrameBuilder.Region

Width of the region.

X

x - Variable in class gamingtools.FrameBuilder.Region

Horizontal position of the upper-left corner.

Y

y - Variable in class gamingtools.FrameBuilder.Region

Vertical position of the upper-left corner.

A B C D E F G H I M R S U W X Y