org.mini2Dx.core.graphics

Interface SpriteCache

All Known Implementing Classes:

LibgdxSpriteCache

public interface SpriteCache

Method Summary

Modifier and Type	Method and Description
int	add(Sprite sprite) Adds a Sprite to the cache.
int	add(Texture texture, float x, float y) Adds a Texture to the cache
int	add(Texture texture, float x, float y, int srcX, int srcY, int srcWidth, int srcHeight) Adds a region of a Texture to the cache
int	add(Texture texture, float x, float y, int srcX, int srcY, int srcWidth, int srcHeight, boolean flipX, boolean flipY) Adds a region of a Texture to the cache
int	add(Texture texture, float x, float y, int srcX, int srcY, int srcWidth, int srcHeight, float scaleX, float scaleY, boolean flipX, boolean flipY) Adds a transformed region of a Texture to the cache
int	add(Texture texture, float x, float y, int srcX, int srcY, int srcWidth, int srcHeight, float scaleX, float scaleY, float originX, float originY, float rotation, boolean flipX, boolean flipY) Adds a transformed region of a Texture to the cache
int	add(TextureRegion region, float x, float y) Adds a TextureRegion to the cache
int	add(TextureRegion region, float x, float y, float scaleX, float scaleY) Adds a scaled TextureRegion to the cache
int	add(TextureRegion region, float x, float y, float scaleX, float scaleY, float originX, float originY, float rotation) Adds a scaled TextureRegion to the cache
int	add(TextureRegion region, float x, float y, float scaleX, float scaleY, float originX, float originY, float rotation, boolean flipX, boolean flipY) Adds a scaled TextureRegion to the cache
void	beginCache() Starts the definition of a new cache
void	beginCache(int cacheID) Starts the redefinition of an existing cache
void	clear() Invalidates all the caches and resets the SpriteCache.
void	dispose() Releases all the resources held by this SpriteCache.
void	draw(Graphics g, int cacheID) Draws all the images defined in a SpriteCache to the screen.
void	draw(Graphics g, int cacheID, int offset, int length) Draws a subset of the images defined in a SpriteCache to the screen.
int	endCache() Ends the definition of the current cache
Color	getColor() Indicates the Color currently used to tint images when they are added to the SpriteCache
Shader	getCustomShader() Indicates the custom Shader used to draw images to the cache
boolean	isDrawing() Indicates if beginCache() has been called
void	setColor(Color tint) Sets the Color used to tint images when they are added to the SpriteCache
void	setColor(float r, float g, float b, float a) Sets the Color used to tint images when they are added to the SpriteCache
void	setCustomShader(Shader shader) Sets the custom Shader used to draw images to the cache

Method Detail

add

int add(Sprite sprite)

Adds a Sprite to the cache.

Parameters:

sprite - The Sprite to be added.

Returns:

The index of the added sprite

add

int add(Texture texture,
        float x,
        float y)

Adds a Texture to the cache

Parameters:

texture - The texture to be added

x - x position of the texture

y - y position of the texture

Returns:

The index of the added texture

add

int add(Texture texture,
        float x,
        float y,
        int srcX,
        int srcY,
        int srcWidth,
        int srcHeight)

Adds a region of a Texture to the cache

Parameters:

texture - the texture to be added

x - x position of the texture

y - y position of the texture

srcX - x point in the texture

srcY - y point in the texture

srcWidth - width of the region to be drawn

srcHeight - height of the region to be drawn

Returns:

The index of the added texture

add

int add(Texture texture,
        float x,
        float y,
        int srcX,
        int srcY,
        int srcWidth,
        int srcHeight,
        boolean flipX,
        boolean flipY)

Adds a region of a Texture to the cache

Parameters:

texture - the texture to be added

x - x position of the texture

y - y position of the texture

srcX - x point in the texture

srcY - y point in the texture

srcWidth - width of the region to be drawn

srcHeight - height of the region to be drawn

flipX - indication of whether the region should be drawn x-flipped

flipY - indication of whether the region should be drawn y-flipped

Returns:

The index of the added texture

add

int add(Texture texture,
        float x,
        float y,
        int srcX,
        int srcY,
        int srcWidth,
        int srcHeight,
        float scaleX,
        float scaleY,
        boolean flipX,
        boolean flipY)

Adds a transformed region of a Texture to the cache

Parameters:

texture - the texture to be added

x - x position of the texture

y - y position of the texture

srcX - x point in the texture

srcY - y point in the texture

srcWidth - width of the region to be drawn

srcHeight - height of the region to be drawn

scaleX - scale of the texture in the x direction

scaleY - scale of the texture in the y direction

flipX - indication of whether the region should be drawn x-flipped

flipY - indication of whether the region should be drawn y-flipped

Returns:

The index of the added texture

add

int add(Texture texture,
        float x,
        float y,
        int srcX,
        int srcY,
        int srcWidth,
        int srcHeight,
        float scaleX,
        float scaleY,
        float originX,
        float originY,
        float rotation,
        boolean flipX,
        boolean flipY)

Adds a transformed region of a Texture to the cache

Parameters:

texture - the texture to be added

x - x position of the texture

y - y position of the texture

srcX - x point in the texture

srcY - y point in the texture

srcWidth - width of the region to be drawn

srcHeight - height of the region to be drawn

scaleX - scale of the texture in the x direction

scaleY - scale of the texture in the y direction

originX - x position of the point around which the texture should be rotated

originY - y position of the point around which the texture should be rotated

rotation - rotation of the texture around the origin point (in degrees)

flipX - indication of whether the region should be drawn x-flipped

flipY - indication of whether the region should be drawn y-flipped

Returns:

The index of the added texture

add

int add(TextureRegion region,
        float x,
        float y)

Adds a TextureRegion to the cache

Parameters:

region - the texture region to be added

x - x position of the texture region

y - y position of the texture region

Returns:

The index of the added texture region

add

int add(TextureRegion region,
        float x,
        float y,
        float scaleX,
        float scaleY)

Adds a scaled TextureRegion to the cache

Parameters:

region - the texture region to be added

x - x position of the texture region

y - y position of the texture region

scaleX - scale of the texture region in the x direction

scaleY - scale of the texture region in the y direction

Returns:

The index of the added texture region

add

int add(TextureRegion region,
        float x,
        float y,
        float scaleX,
        float scaleY,
        float originX,
        float originY,
        float rotation)

Adds a scaled TextureRegion to the cache

Parameters:

region - the texture region to be added

x - x position of the texture region

y - y position of the texture region

scaleX - scale of the texture region in the x direction

scaleY - scale of the texture region in the y direction

originX - x position of the point around which the region should be rotated

originY - y position of the point around which the region should be rotated

rotation - rotation of the texture around the origin point (in degrees)

Returns:

The index of the added texture region

add

int add(TextureRegion region,
        float x,
        float y,
        float scaleX,
        float scaleY,
        float originX,
        float originY,
        float rotation,
        boolean flipX,
        boolean flipY)

Adds a scaled TextureRegion to the cache

Parameters:

region - the texture region to be added

x - x position of the texture region

y - y position of the texture region

scaleX - scale of the texture region in the x direction

scaleY - scale of the texture region in the y direction

originX - x position of the point around which the region should be rotated

originY - y position of the point around which the region should be rotated

rotation - rotation of the texture around the origin point (in degrees)

flipX - indication of whether the region should be drawn x-flipped

flipY - indication of whether the region should be drawn y-flipped

Returns:

The index of the added texture region

clear

void clear()

Invalidates all the caches and resets the SpriteCache.

dispose

void dispose()

Releases all the resources held by this SpriteCache.

draw

void draw(Graphics g,
          int cacheID)

Draws all the images defined in a SpriteCache to the screen.

Parameters:

g - the current Graphics context

cacheID - ID of the SpriteCache containing the images to draw.

draw

void draw(Graphics g,
          int cacheID,
          int offset,
          int length)

Draws a subset of the images defined in a SpriteCache to the screen.

Parameters:

g - the current Graphics context

cacheID - ID of the SpriteCache containing the images to draw.

offset - The index of the first image to draw

length - The number of the images to draw

beginCache

void beginCache()

Starts the definition of a new cache

beginCache

void beginCache(int cacheID)

Starts the redefinition of an existing cache

Parameters:

cacheID - ID of the cache to be redefined

endCache

int endCache()

Ends the definition of the current cache

Returns:

ID of the current cache

getColor

Color getColor()

Indicates the Color currently used to tint images when they are added to the SpriteCache

Returns:

the color currently used to tint images when they are added to the SpriteCache

setColor

void setColor(Color tint)

Sets the Color used to tint images when they are added to the SpriteCache

Parameters:

tint - the new color to be used to tint images when they are added to the SpriteCache

setColor

void setColor(float r,
              float g,
              float b,
              float a)

Sets the Color used to tint images when they are added to the SpriteCache

Parameters:

r - The red value of the new color (0.0-1.0)

g - The green value of the new color (0.0-1.0)

b - The blue value of the new color (0.0-1.0)

a - The alpha value of the new color (0.0-1.0)

getCustomShader

Shader getCustomShader()

Indicates the custom Shader used to draw images to the cache

Returns:

the custom Shader used to draw images to the cache

setCustomShader

void setCustomShader(Shader shader)

Sets the custom Shader used to draw images to the cache

Parameters:

shader - the new custom Shader used to draw images to the cache

isDrawing

boolean isDrawing()

Indicates if beginCache() has been called

Returns:

beginCache has been called