|
MID Profile | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--javax.microedition.lcdui.Displayable | +--javax.microedition.lcdui.Canvas | +--javax.microedition.lcdui.game.GameCanvas
The GameCanvas class provides the basis for a game user interface. In addition to the features inherited from Canvas (commands, input events, etc.) it also provides game-specific capabilities such as an off-screen graphics buffer and the ability to query key status.
A dedicated buffer is created for each GameCanvas instance. Since a unique buffer is provided for each GameCanvas instance, it is preferable to re-use a single GameCanvas instance in the interests of minimizing heap usage. The developer can assume that the contents of this buffer are modified only by calls to the Graphics object(s) obtained from the GameCanvas instance; the contents are not modified by external sources such as other MIDlets or system-level notifications. The buffer is initially filled with white pixels.
The buffer's size is set to the maximum dimensions of the GameCanvas.
However, the area that may be flushed is limited by the current
dimensions of the GameCanvas (as influenced by the presence of a Ticker,
Commands, etc.) when the flush is requested. The current dimensions of
the GameCanvas may be obtained by calling
getWidth
and
getHeight
.
A game may provide its own thread to run the game loop. A typical loop
will check for input, implement the game logic, and then render the updated
user interface. The following code illustrates the structure of a typcial
game loop:
// Get the Graphics object for the off-screen buffer
Graphics g = getGraphics();
while (true) {
// Check user input and update positions if necessary
int keyState = getKeyStates();
if ((keyState & LEFT_PRESSED) != 0) {
sprite.move(-1, 0);
}
else if ((keyState & RIGHT_PRESSED) != 0) {
sprite.move(1, 0);
}
// Clear the background to white
g.setColor(0xFFFFFF);
g.fillRect(0,0,getWidth(), getHeight());
// Draw the Sprite
sprite.paint(g);
// Flush the off-screen buffer
flushGraphics();
}
Field Summary | |
static int |
DOWN_PRESSED
The bit representing the DOWN key. |
static int |
FIRE_PRESSED
The bit representing the FIRE key. |
static int |
GAME_A_PRESSED
The bit representing the GAME_A key (may not be supported on all devices). |
static int |
GAME_B_PRESSED
The bit representing the GAME_B key (may not be supported on all devices). |
static int |
GAME_C_PRESSED
The bit representing the GAME_C key (may not be supported on all devices). |
static int |
GAME_D_PRESSED
The bit representing the GAME_D key (may not be supported on all devices). |
static int |
LEFT_PRESSED
The bit representing the LEFT key. |
static int |
RIGHT_PRESSED
The bit representing the RIGHT key. |
static int |
UP_PRESSED
The bit representing the UP key. |
Fields inherited from class javax.microedition.lcdui.Canvas |
DOWN, FIRE, GAME_A, GAME_B, GAME_C, GAME_D, KEY_NUM0, KEY_NUM1, KEY_NUM2, KEY_NUM3, KEY_NUM4, KEY_NUM5, KEY_NUM6, KEY_NUM7, KEY_NUM8, KEY_NUM9, KEY_POUND, KEY_STAR, LEFT, RIGHT, UP |
Constructor Summary | |
protected |
GameCanvas(boolean suppressKeyEvents)
Creates a new instance of a GameCanvas. |
Method Summary | |
void |
flushGraphics()
Flushes the off-screen buffer to the display. |
void |
flushGraphics(int x,
int y,
int width,
int height)
Flushes the specified region of the off-screen buffer to the display. |
protected Graphics |
getGraphics()
Obtains the Graphics object for rendering a GameCanvas. |
int |
getKeyStates()
Gets the states of the physical game keys. |
void |
paint(Graphics g)
Paints this GameCanvas. |
Methods inherited from class javax.microedition.lcdui.Canvas |
getGameAction, getKeyCode, getKeyName, hasPointerEvents, hasPointerMotionEvents, hasRepeatEvents, hideNotify, isDoubleBuffered, keyPressed, keyReleased, keyRepeated, pointerDragged, pointerPressed, pointerReleased, repaint, repaint, serviceRepaints, setFullScreenMode, showNotify, sizeChanged |
Methods inherited from class javax.microedition.lcdui.Displayable |
addCommand, getHeight, getTicker, getTitle, getWidth, isShown, removeCommand, setCommandListener, setTicker, setTitle |
Methods inherited from class java.lang.Object |
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
public static final int UP_PRESSED
0x0002
(1 << Canvas.UP).public static final int DOWN_PRESSED
0x0040
(1 << Canvas.DOWN).public static final int LEFT_PRESSED
0x0004
(1 << Canvas.LEFT).public static final int RIGHT_PRESSED
0x0020
(1 << Canvas.RIGHT).public static final int FIRE_PRESSED
0x0100
(1 << Canvas.FIRE).public static final int GAME_A_PRESSED
0x0200
(1 << Canvas.GAME_A).public static final int GAME_B_PRESSED
0x0400
(1 << Canvas.GAME_B).public static final int GAME_C_PRESSED
0x0800
(1 << Canvas.GAME_C).public static final int GAME_D_PRESSED
0x1000
(1 << Canvas.GAME_D).Constructor Detail |
protected GameCanvas(boolean suppressKeyEvents)
If the developer only needs to query key status using the getKeyStates method, the regular key event mechanism can be suppressed for game keys while this GameCanvas is shown. If not needed by the application, the suppression of key events may improve performance by eliminating unnecessary system calls to keyPressed, keyRepeated and keyReleased methods.
If requested, key event suppression for a given GameCanvas is started when it is shown (i.e. when showNotify is called) and stopped when it is hidden (i.e. when hideNotify is called). Since the showing and hiding of screens is serialized with the event queue, this arrangement ensures that the suppression effects only those key events intended for the corresponding GameCanvas. Thus, if key events are being generated while another screen is still shown, those key events will continue to be queued and dispatched until that screen is hidden and the GameCanvas has replaced it.
Note that key events can be suppressed only for the defined game keys (UP, DOWN, FIRE, etc.); key events are always generated for all other keys.
suppressKeyEvents
- true
to suppress the regular
key event mechanism for game keys, otherwise false
.Method Detail |
protected Graphics getGraphics()
Rendering operations do not appear on the display until flushGraphics() is called; flushing the buffer does not change its contents (the pixels are not cleared as a result of the flushing operation).
A new Graphics object is created and returned each time this method is called; therefore, the needed Graphics object(s) should be obtained before the game starts then re-used while the game is running. For each GameCanvas instance, all of the provided graphics objects will render to the same off-screen buffer.
The newly created Graphics object has the following properties:
Font.getDefaultFont()
;
SOLID
; and
flushGraphics()
,
flushGraphics(int, int, int, int)
public int getKeyStates()
For example:
// Get the key state and store it
int keyState = getKeyStates();
if ((keyState & LEFT_KEY) != 0) {
positionX--;
}
else if ((keyState & RIGHT_KEY) != 0) {
positionX++;
}
Calling this method has the side effect of clearing any latched state. Another call to getKeyStates immediately after a prior call will therefore report the system's best idea of the current state of the keys, the latched bits having been cleared by the first call.
Some devices may not be able to query the keypad hardware directly and therefore, this method may be implemented by monitoring key press and release events instead. Thus the state reported by getKeyStates might lag the actual state of the physical keys since the timeliness of the key information is be subject to the capabilities of each device. Also, some devices may be incapable of detecting simultaneous presses of multiple keys.
This method returns 0 unless the GameCanvas is currently visible as
reported by Displayable.isShown()
.
Upon becoming visible, a GameCanvas will initially indicate that
all keys are unpressed (0); if a key is held down while the GameCanvas
is being shown, the key must be first released and then pressed in
order for the key press to be reported by the GameCanvas.
UP_PRESSED
,
DOWN_PRESSED
,
LEFT_PRESSED
,
RIGHT_PRESSED
,
FIRE_PRESSED
,
GAME_A_PRESSED
,
GAME_B_PRESSED
,
GAME_C_PRESSED
,
GAME_D_PRESSED
public void paint(Graphics g)
paint
in class Canvas
g
- the Graphics object with which to render the screen.NullPointerException
- if g
is null
public void flushGraphics(int x, int y, int width, int height)
If the specified region extends beyond the current bounds of the GameCanvas, only the intersecting region is flushed. No pixels are flushed if the specified width or height is less than 1.
This method does nothing and returns immediately if the GameCanvas is not currently shown or the flush request cannot be honored because the system is busy.
x
- the left edge of the region to be flushedy
- the top edge of the region to be flushedwidth
- the width of the region to be flushedheight
- the height of the region to be flushedflushGraphics()
public void flushGraphics()
This method does nothing and returns immediately if the GameCanvas is not currently shown or the flush request cannot be honored because the system is busy.
flushGraphics(int,int,int,int)
|
MID Profile | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |