GameContainer

java.lang.Object
- org.cell2d.celick.GameContainer

public class GameContainer
extends java.lang.Object

A generic game container that handles the game loop

Field Summary

Fields
Modifier and Type	Field and Description
`protected boolean`	`alphaSupport` Alpha background supported
`protected boolean`	`forceExit` True if we should force exit
`protected Game`	`game` The game being managed
`protected static SGL`	`GL` The renderer to use for all GL operations
`protected int`	`height` The height of the display
`protected long`	`lastFrame` The time the last frame was rendered
`protected org.lwjgl.opengl.DisplayMode`	`originalDisplayMode` The original display mode before we tampered with things
`protected boolean`	`running` True if we're currently running the game loop
`protected int`	`samples` The number of samples we'll attempt through hardware
`protected static org.lwjgl.opengl.Drawable`	`SHARED_DRAWABLE` The shared drawable if any
`protected boolean`	`supportsMultiSample` True if this context supports multisample
`protected org.lwjgl.opengl.DisplayMode`	`targetDisplayMode` The display mode we're going to try and use
`protected int`	`width` The width of the display

Constructor Summary

Constructors
Constructor and Description

GameContainer(Game game)
Create a new container wrapping a game

Constructors
Constructor and Description
`GameContainer(Game game)` Create a new container wrapping a game

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`destroy()` Destroy the app game container
`static void`	`enableSharedContext()` Enable shared OpenGL context.
`protected void`	`enterOrtho()` Enter the orthographic mode
`protected void`	`enterOrtho(int xsize, int ysize)` Enter the orthographic mode
`void`	`exit()` Cause the game to exit and shutdown cleanly
`protected void`	`gameLoop()` Strategy for overloading game loop context handling
`float`	`getAspectRatio()` Get the aspect ratio of the screen
`Font`	`getDefaultFont()` Get the default system font
`protected int`	`getDelta()` Retrieve the time taken to render the last frame, i.e.
`Graphics`	`getGraphics()` Get the graphics context used by this container.
`int`	`getHeight()` Get the height of the game canvas
`int`	`getSamples()` The number of samples we're attempting to performing using hardware multisampling
`int`	`getScreenHeight()` Get the height of the standard screen resolution
`int`	`getScreenWidth()` Get the width of the standard screen resolution
`static org.lwjgl.opengl.Drawable`	`getSharedContext()` Get the context shared by all containers
`long`	`getTime()` Get the accurate system time
`int`	`getWidth()` Get the width of the game canvas
`boolean`	`hasFocus()`
`protected void`	`initGL()` Initialise the GL context
`protected void`	`initSystem()` Initialise the system components, OpenGL and OpenAL.
`boolean`	`isMouseGrabbed()`
`protected boolean`	`running()` True if the game is running
`void`	`setAnimatedMouseCursor(java.lang.String ref, int x, int y, int width, int height, int[] cursorDelays)` Get a cursor based on a image reference on the classpath.
`void`	`setDefaultFont(Font font)` Set the default font that will be intialised in the graphics held in this container
`void`	`setDefaultMouseCursor()` Set the default mouse cursor - i.e.
`void`	`setDisplayMode(org.lwjgl.opengl.DisplayMode mode, boolean fullscreen)` Set the display mode to be used
`void`	`setForceExit(boolean forceExit)` Indicate if we should force exitting the VM at the end of the game (default = true)
`void`	`setIcon(java.lang.String ref)`
`void`	`setIcons(java.lang.String[] refs)`
`void`	`setMouseCursor(org.lwjgl.input.Cursor cursor, int hotSpotX, int hotSpotY)` Set the mouse cursor to be displayed - this is a hardware cursor and hence shouldn't have any impact on FPS.
`void`	`setMouseCursor(ImageData data, int hotSpotX, int hotSpotY)` Set the mouse cursor to be displayed - this is a hardware cursor and hence shouldn't have any impact on FPS.
`void`	`setMouseCursor(Image image, int hotSpotX, int hotSpotY)` Set the mouse cursor to be displayed - this is a hardware cursor and hence shouldn't have any impact on FPS.
`void`	`setMouseCursor(java.lang.String ref, int hotSpotX, int hotSpotY)` Set the mouse cursor to be displayed - this is a hardware cursor and hence shouldn't have any impact on FPS.
`void`	`setMouseGrabbed(boolean grabbed)`
`void`	`setMultiSample(int samples)` Indicate whether we want to try to use fullscreen multisampling.
`void`	`setTitle(java.lang.String title)` Set the title of the window
`protected void`	`setup()` Setup the environment
`void`	`setVerbose(boolean verbose)` Inidcate we want verbose logging
`void`	`start()` Start running the game
`boolean`	`supportsAlphaInBackBuffer()` Check if the display created supported alpha in the back buffer
`boolean`	`supportsMultiSample()` Check if this hardware can support multi-sampling

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - originalDisplayMode
```
protected org.lwjgl.opengl.DisplayMode originalDisplayMode
```
    The original display mode before we tampered with things
  - targetDisplayMode
```
protected org.lwjgl.opengl.DisplayMode targetDisplayMode
```
    The display mode we're going to try and use
  - alphaSupport
```
protected boolean alphaSupport
```
    Alpha background supported
  - GL
```
protected static SGL GL
```
    The renderer to use for all GL operations
  - SHARED_DRAWABLE
```
protected static org.lwjgl.opengl.Drawable SHARED_DRAWABLE
```
    The shared drawable if any
  - lastFrame
```
protected long lastFrame
```
    The time the last frame was rendered
  - running
```
protected boolean running
```
    True if we're currently running the game loop
  - width
```
protected int width
```
    The width of the display
  - height
```
protected int height
```
    The height of the display
  - game
```
protected Game game
```
    The game being managed
  - forceExit
```
protected boolean forceExit
```
    True if we should force exit
  - samples
```
protected int samples
```
    The number of samples we'll attempt through hardware
  - supportsMultiSample
```
protected boolean supportsMultiSample
```
    True if this context supports multisample
- Constructor Detail
  - GameContainer
```
public GameContainer(Game game)
              throws SlickException
```
    Create a new container wrapping a game
    
    Parameters:
    
    game - The game to be wrapped
    
    Throws:
    
    SlickException - Indicates a failure to initialise the display
- Method Detail
  - setDefaultFont
```
public void setDefaultFont(Font font)
```
    Set the default font that will be intialised in the graphics held in this container
    
    Parameters:
    
    font - The font to use as default
  - setMultiSample
```
public void setMultiSample(int samples)
```
    Indicate whether we want to try to use fullscreen multisampling. This will give antialiasing across the whole scene using a hardware feature.
    
    Parameters:
    
    samples - The number of samples to attempt (2 is safe)
  - supportsMultiSample
```
public boolean supportsMultiSample()
```
    Check if this hardware can support multi-sampling
    
    Returns:
    
    True if the hardware supports multi-sampling
  - getSamples
```
public int getSamples()
```
    The number of samples we're attempting to performing using hardware multisampling
    
    Returns:
    
    The number of samples requested
  - setForceExit
```
public void setForceExit(boolean forceExit)
```
    Indicate if we should force exitting the VM at the end of the game (default = true)
    
    Parameters:
    
    forceExit - True if we should force the VM exit
  - getAspectRatio
```
public float getAspectRatio()
```
    Get the aspect ratio of the screen
    
    Returns:
    
    The aspect ratio of the display
  - enableSharedContext
```
public static void enableSharedContext()
                                throws SlickException
```
    Enable shared OpenGL context. After calling this all containers created will shared a single parent context
    
    Throws:
    
    SlickException - Indicates a failure to create the shared drawable
  - getSharedContext
```
public static org.lwjgl.opengl.Drawable getSharedContext()
```
    Get the context shared by all containers
    
    Returns:
    
    The context shared by all the containers or null if shared context isn't enabled
  - getDefaultFont
```
public Font getDefaultFont()
```
    Get the default system font
    
    Returns:
    
    The default system font
  - getWidth
```
public int getWidth()
```
    Get the width of the game canvas
    
    Returns:
    
    The width of the game canvas
  - getHeight
```
public int getHeight()
```
    Get the height of the game canvas
    
    Returns:
    
    The height of the game canvas
  - getTime
```
public long getTime()
```
    Get the accurate system time
    
    Returns:
    
    The system time in milliseconds
  - setAnimatedMouseCursor
```
public void setAnimatedMouseCursor(java.lang.String ref,
                                   int x,
                                   int y,
                                   int width,
                                   int height,
                                   int[] cursorDelays)
                            throws SlickException
```
    Get a cursor based on a image reference on the classpath. The image is assumed to be a set/strip of cursor animation frames running from top to bottom.
    
    Parameters:
    
    ref - The reference to the image to be loaded
    
    x - The x-coordinate of the cursor hotspot (left to right)
    
    y - The y-coordinate of the cursor hotspot (bottom to top)
    
    width - The x width of the cursor
    
    height - The y height of the cursor
    
    cursorDelays - image delays between changing frames in animation
    
    Throws:
    
    SlickException - Indicates a failure to load the image or a failure to create the hardware cursor
  - getDelta
```
protected int getDelta()
```
    Retrieve the time taken to render the last frame, i.e. the change in time - delta.
    
    Returns:
    
    The time taken to render the last frame
  - initGL
```
protected void initGL()
```
    Initialise the GL context
  - initSystem
```
protected void initSystem()
                   throws SlickException
```
    Initialise the system components, OpenGL and OpenAL.
    
    Throws:
    
    SlickException - Indicates a failure to create a native handler
  - enterOrtho
```
protected void enterOrtho()
```
    Enter the orthographic mode
  - running
```
protected boolean running()
```
    True if the game is running
    
    Returns:
    
    True if the game is running
  - setVerbose
```
public void setVerbose(boolean verbose)
```
    Inidcate we want verbose logging
    
    Parameters:
    
    verbose - True if we want verbose logging (INFO and DEBUG)
  - exit
```
public void exit()
```
    Cause the game to exit and shutdown cleanly
  - getGraphics
```
public Graphics getGraphics()
```
    Get the graphics context used by this container. Note that this value may vary over the life time of the game.
    
    Returns:
    
    The graphics context used by this container
  - enterOrtho
```
protected void enterOrtho(int xsize,
                          int ysize)
```
    Enter the orthographic mode
    
    Parameters:
    
    xsize - The size of the panel being used
    
    ysize - The size of the panel being used
  - supportsAlphaInBackBuffer
```
public boolean supportsAlphaInBackBuffer()
```
    Check if the display created supported alpha in the back buffer
    
    Returns:
    
    True if the back buffer supported alpha
  - setTitle
```
public void setTitle(java.lang.String title)
```
    Set the title of the window
    
    Parameters:
    
    title - The title to set on the window
  - setDisplayMode
```
public void setDisplayMode(org.lwjgl.opengl.DisplayMode mode,
                           boolean fullscreen)
                    throws SlickException
```
    Set the display mode to be used
    
    Parameters:
    
    mode - The DisplayMode to be used
    
    fullscreen - True if we want fullscreen mode
    
    Throws:
    
    SlickException - Indicates a failure to initialise the display
  - setMouseCursor
```
public void setMouseCursor(java.lang.String ref,
                           int hotSpotX,
                           int hotSpotY)
                    throws SlickException
```
    Set the mouse cursor to be displayed - this is a hardware cursor and hence shouldn't have any impact on FPS.
    
    Parameters:
    
    ref - The location of the image to be loaded for the cursor
    
    hotSpotX - The x coordinate of the hotspot within the cursor image
    
    hotSpotY - The y coordinate of the hotspot within the cursor image
    
    Throws:
    
    SlickException - Indicates a failure to load the cursor image or create the hardware cursor
  - setMouseCursor
```
public void setMouseCursor(ImageData data,
                           int hotSpotX,
                           int hotSpotY)
                    throws SlickException
```
    Set the mouse cursor to be displayed - this is a hardware cursor and hence shouldn't have any impact on FPS.
    
    Parameters:
    
    data - The image data from which the cursor can be constructed
    
    hotSpotX - The x coordinate of the hotspot within the cursor image
    
    hotSpotY - The y coordinate of the hotspot within the cursor image
    
    Throws:
    
    SlickException - Indicates a failure to load the cursor image or create the hardware cursor
  - setMouseCursor
```
public void setMouseCursor(org.lwjgl.input.Cursor cursor,
                           int hotSpotX,
                           int hotSpotY)
                    throws SlickException
```
    Set the mouse cursor to be displayed - this is a hardware cursor and hence shouldn't have any impact on FPS.
    
    Parameters:
    
    cursor - The cursor to use
    
    hotSpotX - The x coordinate of the hotspot within the cursor image
    
    hotSpotY - The y coordinate of the hotspot within the cursor image
    
    Throws:
    
    SlickException - Indicates a failure to load the cursor image or create the hardware cursor
  - setMouseCursor
```
public void setMouseCursor(Image image,
                           int hotSpotX,
                           int hotSpotY)
                    throws SlickException
```
    Set the mouse cursor to be displayed - this is a hardware cursor and hence shouldn't have any impact on FPS.
    
    Parameters:
    
    image - The image from which the cursor can be constructed
    
    hotSpotX - The x coordinate of the hotspot within the cursor image
    
    hotSpotY - The y coordinate of the hotspot within the cursor image
    
    Throws:
    
    SlickException - Indicates a failure to load the cursor image or create the hardware cursor
  - start
```
public void start()
           throws SlickException
```
    Start running the game
    
    Throws:
    
    SlickException - Indicates a failure to initialise the system
  - setup
```
protected void setup()
              throws SlickException
```
    Setup the environment
    
    Throws:
    
    SlickException - Indicates a failure
  - gameLoop
```
protected void gameLoop()
```
    Strategy for overloading game loop context handling
  - setIcon
```
public void setIcon(java.lang.String ref)
             throws SlickException
```
    Throws:
    
    SlickException
  - setMouseGrabbed
```
public void setMouseGrabbed(boolean grabbed)
```
  - isMouseGrabbed
```
public boolean isMouseGrabbed()
```
  - hasFocus
```
public boolean hasFocus()
```
  - getScreenHeight
```
public int getScreenHeight()
```
    Get the height of the standard screen resolution
    
    Returns:
    
    The screen height
  - getScreenWidth
```
public int getScreenWidth()
```
    Get the width of the standard screen resolution
    
    Returns:
    
    The screen width
  - destroy
```
public void destroy()
```
    Destroy the app game container
  - setIcons
```
public void setIcons(java.lang.String[] refs)
              throws SlickException
```
    Throws:
    
    SlickException
  - setDefaultMouseCursor
```
public void setDefaultMouseCursor()
```
    Set the default mouse cursor - i.e. the original cursor before any native cursor was set

Class GameContainer

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

originalDisplayMode

targetDisplayMode

alphaSupport

GL

SHARED_DRAWABLE

lastFrame

running

width

height

game

forceExit

samples

supportsMultiSample

Constructor Detail

GameContainer

Method Detail

setDefaultFont

setMultiSample

supportsMultiSample

getSamples

setForceExit

getAspectRatio

enableSharedContext

getSharedContext

getDefaultFont

getWidth

getHeight

getTime

setAnimatedMouseCursor

getDelta

initGL

initSystem

enterOrtho

running

setVerbose

exit

getGraphics

enterOrtho

supportsAlphaInBackBuffer

setTitle

setDisplayMode

setMouseCursor

setMouseCursor

setMouseCursor

setMouseCursor

start

setup

gameLoop

setIcon

setMouseGrabbed

isMouseGrabbed

hasFocus

getScreenHeight

getScreenWidth

destroy

setIcons

setDefaultMouseCursor