Method ilcd.Graphic.setAnimationBackgroundGraphic

static void setAnimationBackgroundGraphic(int animLoc, int startX, int startY, int graphicIndex)

Throws:

static void setAnimationBackgroundGraphic(int animLoc, int startX, int startY, String graphicNameOrFilename)

Throws:

_INSERT_METHOD_SIGNATURE_HERE_

by index:

Parameter	Range	Description
animLoc	0 ... 7	index of the animation control
startX	0 ... graphic width - 1	horizontal offset in background graphic
startY	0 ... graphic height - 1	vertical offset in background graphic
graphicIndex	0 ... max. graphic index	index of the background graphic

by name or filename:

Parameter	Range	Description
animLoc	0 ... 7	index of the animation control
startX	0 ... graphic width - 1	horizontal offset in background graphic
startY	0 ... graphic height - 1	vertical offset in background graphic
graphicNameOrFilename	ASCII chars (0x01 .. 0xFF) or DOS filename (8.3 format)	name of the graphic or name and path of the graphics file

Assigns the background graphic specified by graphicIndex or graphicNameOrFilename to the animation engine animLoc.

When a background graphic is assigned to an animation control, every frame is restored to the underlying part of the background before the next one is drawn.
If the animation was never drawn before, the whole animation area is filled with the according part of background graphic before the first frame is drawn.
When addressing by index, the graphic offset (see Extra.setGraphicOffset(int)) is taken into account.
When addressing by name, the graphic prefix (refer to Extra.setGraphicNamePrefix(String)) and suffix (refer to Extra.setGraphicNameSuffix(String)) are taken into account.
Background graphics can be larger than the animation area. In this case, offsetX and offsetY have to be set to the offset between the origin of the background graphic and the origin of the animation area.
Restoring frames to background allows an animation to run backwards (refer to Graphic.moveAnimationToFrame(int, int, int)), but slows it down a bit. Even more so if animated or background graphic have to be loaded from SD card.
The background is restored to the assigned background graphic when using the methods Graphic.eraseAnimationImageArea(int) or Graphic.eraseAnimationFrameArea(int) as well.
Find general information about animated graphics in class Graphic.

Example

Graphic.setAnimationBackgroundGraphic(1, 0, 0, 7);

Graphic.setAnimationBackgroundGraphic(2, 10, 20, "GRAPHIC");

Graphic.setAnimationBackgroundGraphic(3, 0, 0, "DIR/FILE.RII");

These commands will assign:

graphic with index #7 without offset to the animation control #1
part of the graphic with name "GRAPHIC" starting from position 10/20 to the animation control #2
graphic with filename "FILE.RII" from the SD card's "DIR" folder without offset to the animation control #3