SpriteLayer

addSprite void addSprite(ABitmap s, int n, Coordinate c, ushort paletteSel, int scaleHoriz, int scaleVert): Undocumented in source. Be warned that the author may not have intended to support it.
addSprite void addSprite(ABitmap s, int n, int x, int y, ushort paletteSel, int scaleHoriz, int scaleVert): Undocumented in source. Be warned that the author may not have intended to support it.
editSpriteAttribute void editSpriteAttribute(int n, T value): Undocumented in source. Be warned that the author may not have intended to support it.
getPaletteID ushort getPaletteID(int n): Returns the selected paletteID of the sprite.
getSlice Coordinate getSlice(int n): Returns the displayed portion of the sprite.
getSpriteCoordinate Coordinate getSpriteCoordinate(int n): Undocumented in source. Be warned that the author may not have intended to support it.
moveSprite void moveSprite(int n, int x, int y): Undocumented in source. Be warned that the author may not have intended to support it.
readSpriteAttribute T readSpriteAttribute(int n): Reads a sprite attribute
relMoveSprite void relMoveSprite(int n, int x, int y): Undocumented in source. Be warned that the author may not have intended to support it.
removeSprite void removeSprite(int n): Undocumented in source. Be warned that the author may not have intended to support it.
replaceSprite void replaceSprite(ABitmap s, int n): Undocumented in source. Be warned that the author may not have intended to support it.
replaceSprite void replaceSprite(ABitmap s, int n, int x, int y): Undocumented in source. Be warned that the author may not have intended to support it.
replaceSprite void replaceSprite(ABitmap s, int n, Coordinate c): Undocumented in source. Be warned that the author may not have intended to support it.
replaceSpriteAttribute void replaceSpriteAttribute(int n, BitmapAttrib attr): Undocumented in source. Be warned that the author may not have intended to support it.
scaleSpriteHoriz int scaleSpriteHoriz(int n, int hScl): Scales sprite horizontally. Returns the new size, or -1 if the scaling value is invalid, or -2 if spriteID not found.
scaleSpriteVert int scaleSpriteVert(int n, int vScl): Scales sprite vertically. Returns the new size, or -1 if the scaling value is invalid, or -2 if spriteID not found.
setPaletteID ushort setPaletteID(int n, ushort paletteID): Sets the paletteID of the sprite. Returns the new ID, which is truncated to the possible values with a simple binary and operation Palette must exist in the parent Raster, otherwise AccessError might happen
setRasterizer void setRasterizer(int rX, int rY): Undocumented in source. Be warned that the author may not have intended to support it.
setSlice Coordinate setSlice(int n, Coordinate slice): Writes the displayed portion of the sprite. Returns the new slice, if invalid (greater than the bitmap, etc.) returns the old one.
updateRaster void updateRaster(void* workpad, int pitch, Color* palette): Undocumented in source. Be warned that the author may not have intended to support it.

Structs

DisplayListItem struct DisplayListItem: Helps to determine the displaying properties and order of sprites.

Variables

displayList DisplayListItem[] displayList;: Stores the display data
src Color[1024] src;: Undocumented in source.

Inherited Members

From Layer

mainRenderingFunction void function(uint* src, uint* dest, size_t length) mainRenderingFunction;: Used to get around some readability issues. (void* src, void* dest, int length)
mainColorLookupFunction void function(ushort* src, uint* dest, uint* palette, size_t length) mainColorLookupFunction;: Undocumented in source.
main8BitColorLookupFunction void function(ubyte* src, uint* dest, uint* palette, size_t length) main8BitColorLookupFunction;: Undocumented in source.
main4BitColorLookupFunction void function(ubyte* src, uint* dest, uint* palette, size_t length, int offset) main4BitColorLookupFunction;: Undocumented in source.
renderMode LayerRenderingMode renderMode;: Undocumented in source.
sX int sX;
sY int sY;
rasterX int rasterX;
rasterY int rasterY;: Undocumented in source.
setRasterizer void setRasterizer(int rX, int rY): Sets the main rasterizer
setRenderingMode void setRenderingMode(LayerRenderingMode mode): Sets the rendering mode
scroll void scroll(int x, int y): Absolute scrolling.
relScroll void relScroll(int x, int y): Relative scrolling. Positive values scrolls the layer left and up, negative values scrolls the layer down and right.
getSX int getSX(): Getter for the X scroll position.
getSY int getSY(): Getter for the Y scroll position.
updateRaster void updateRaster(void* workpad, int pitch, Color* palette): Override this to enable output to the raster
flipHorizontal void flipHorizontal(uint* src, int length): Standard algorithm for horizontal mirroring Will be deprecated in later versions and instead external functions will be used.

From ISpriteLayer

removeSprite void removeSprite(int n): Removes the sprite with the given ID.
moveSprite void moveSprite(int n, int x, int y): Moves the sprite to the given location.
relMoveSprite void relMoveSprite(int n, int x, int y): Relatively moves the sprite by the given values.
getSpriteCoordinate Coordinate getSpriteCoordinate(int n): Gets the coordinate of the sprite.
addSprite void addSprite(ABitmap s, int n, Coordinate c, ushort paletteSel, int scaleHoriz, int scaleVert): Adds a sprite to the layer.
addSprite void addSprite(ABitmap s, int n, int x, int y, ushort paletteSel, int scaleHoriz, int scaleVert): Adds a sprite to the layer.
replaceSprite void replaceSprite(ABitmap s, int n): Replaces the sprite. If the new sprite has a different dimension, the old sprite's upper-left corner will be used.
replaceSprite void replaceSprite(ABitmap s, int n, int x, int y): Replaces the sprite and moves to the given position.
replaceSprite void replaceSprite(ABitmap s, int n, Coordinate c): Replaces the sprite and moves to the given position.
editSpriteAttribute void editSpriteAttribute(int n, T value): Edits a sprite attribute.
readSpriteAttribute T readSpriteAttribute(int n): Reads a sprite attribute
replaceSpriteAttribute void replaceSpriteAttribute(int n, BitmapAttrib attr): Replaces a sprite attribute. DEPRECATED
getSlice Coordinate getSlice(int n): Returns the displayed portion of the sprite.
setSlice Coordinate setSlice(int n, Coordinate slice): Writes the displayed portion of the sprite. Returns the new slice, if invalid (greater than the bitmap, etc.) returns the old one.
getPaletteID ushort getPaletteID(int n): Returns the selected paletteID of the sprite.
setPaletteID ushort setPaletteID(int n, ushort paletteID): Sets the paletteID of the sprite. Returns the new ID, which is truncated to the possible values with a simple binary and operation Palette must exist in the parent Raster, otherwise AccessError might happen
scaleSpriteHoriz int scaleSpriteHoriz(int n, int hScl): Scales bitmap horizontally
scaleSpriteVert int scaleSpriteVert(int n, int vScl): Scales bitmap vertically

SpriteLayer

Constructors

Members

Functions

Structs

Variables

Inherited Members

From Layer

From ISpriteLayer

Meta

Source