libGDX 1.14.2 · com.badlogic.gdx.graphics.g2d.Sprite

Modifier and Type	Field and Description
private Rectangle	bounds
private final Color	color
private boolean	dirty
pack-priv float	height
private float	originX
private float	originY
private float	packedColor
private float	rotation
private float	scaleX
private float	scaleY
pack-priv static final int	SPRITE_SIZE
pack-priv static final int	VERTEX_SIZE
pack-priv final float[]	vertices
pack-priv float	width
private float	x
private float	y

Constructor Summary

Access	Constructor and Description
public	Sprite() Creates an uninitialized sprite.
public	Sprite(Texture texture) Creates a sprite with width, height, and texture region equal to the size of the texture.
public	Sprite(Texture texture, int The width of the texture region. May be negative to flip the sprite when drawn. srcWidth, int The height of the texture region. May be negative to flip the sprite when drawn. srcHeight) Creates a sprite with width, height, and texture region equal to the specified size.
public	Sprite(Texture texture, int srcX, int srcY, int The width of the texture region. May be negative to flip the sprite when drawn. srcWidth, int The height of the texture region. May be negative to flip the sprite when drawn. srcHeight) Creates a sprite with width, height, and texture region equal to the specified size.
public	Sprite(TextureRegion region) Creates a sprite based on a specific TextureRegion, the new sprite's region is a copy of the parameter region - altering one does not affect the other
public	Sprite(TextureRegion region, int srcX, int srcY, int The width of the texture region. May be negative to flip the sprite when drawn. srcWidth, int The height of the texture region. May be negative to flip the sprite when drawn. srcHeight) Creates a sprite with width, height, and texture region equal to the specified size, relative to specified sprite's texture region.
public	Sprite(Sprite sprite) Creates a sprite that is a copy in every way of the specified sprite.

Method Summary

Modifier and Type	Method and Description
public void	draw(Batch batch)
public void	draw(Batch batch, float alphaModulation)
public void	flip(boolean perform horizontal flip x, boolean perform vertical flip y) Overrides com.badlogic.gdx.graphics.g2d.TextureRegion.flip. boolean parameters x,y are not setting a state, but performing a flip
public Rectangle	Returns: the bounding Rectangle getBoundingRectangle() Returns the bounding axis aligned `Rectangle` that bounds this sprite.
public Color	getColor() Returns the color of this sprite.
public float	getHeight() Returns: the height of the sprite, not accounting for scale.
public float	getOriginX() The origin influences `setPosition(float, float)`, `setRotation(float)` and the expansion direction of scaling `setScale(float, float)`
public float	getOriginY() The origin influences `setPosition(float, float)`, `setRotation(float)` and the expansion direction of scaling `setScale(float, float)`
public float	getPackedColor() Returns the packed color of this sprite.
public float	getRotation() Returns: the rotation of the sprite in degrees
public float	getScaleX() X scale of the sprite, independent of size set by `setSize(float, float)`
public float	getScaleY() Y scale of the sprite, independent of size set by `setSize(float, float)`
public float[]	getVertices() Returns the packed vertices, colors, and texture coordinates for this sprite.
public float	getWidth() Returns: the width of the sprite, not accounting for scale.
public float	getX()
public float	getY()
public void	rotate(float degrees) Sets the sprite's rotation in degrees relative to the current rotation.
public void	rotate90(boolean clockwise) Rotates this sprite 90 degrees in-place by rotating the texture coordinates.
public void	scale(float amount) Sets the sprite's scale relative to the current scale.
public void	scroll(float xAmount, float yAmount) Overrides com.badlogic.gdx.graphics.g2d.TextureRegion.scroll. Offsets the region relative to the current region.
public void	set(Sprite sprite) Make this sprite a copy in every way of the specified sprite
public void	setAlpha(float a) Sets the alpha portion of the color used to tint this sprite.
public void	setBounds(float x, float y, float width, float height) Sets the position and size of the sprite when drawn, before scaling and rotation are applied.
public void	setCenter(float x, float y) Sets the position so that the sprite is centered on (x, y)
public void	setCenterX(float x) Sets the x position so that it is centered on the given x parameter
public void	setCenterY(float y) Sets the y position so that it is centered on the given y parameter
public void	setColor(Color tint) Sets the color used to tint this sprite.
public void	setColor(float r, float g, float b, float a)
public void	setFlip(boolean the desired horizontal flip state x, boolean the desired vertical flip state y) Set the sprite's flip state regardless of current condition
public void	setOrigin(float originX, float originY) Sets the origin in relation to the sprite's position for scaling and rotation.
public void	setOriginBasedPosition(float x, float y) Sets the position where the sprite will be drawn, relative to its current origin.
public void	setOriginCenter() Place origin in the center of the sprite
public void	setPackedColor(float packedColor) Sets the packed color used to tint this sprite.
public void	setPosition(float x, float y) Sets the position where the sprite will be drawn.
public void	setRegion(float u, float v, float u2, float v2) Overrides com.badlogic.gdx.graphics.g2d.TextureRegion.setRegion.
public void	setRotation(float degrees) Sets the rotation of the sprite in degrees.
public void	setScale(float scaleXY) Sets the sprite's scale for both X and Y uniformly.
public void	setScale(float scaleX, float scaleY) Sets the sprite's scale for both X and Y.
public void	setSize(float width, float height) Sets the size of the sprite when drawn, before scaling and rotation are applied.
public void	setU(float u) Overrides com.badlogic.gdx.graphics.g2d.TextureRegion.setU.
public void	setU2(float u2) Overrides com.badlogic.gdx.graphics.g2d.TextureRegion.setU2.
public void	setV(float v) Overrides com.badlogic.gdx.graphics.g2d.TextureRegion.setV.
public void	setV2(float v2) Overrides com.badlogic.gdx.graphics.g2d.TextureRegion.setV2.
public void	setX(float x) Sets the x position where the sprite will be drawn.
public void	setY(float y) Sets the y position where the sprite will be drawn.
public void	translate(float xAmount, float yAmount) Sets the position relative to the current position where the sprite will be drawn.
public void	translateX(float xAmount) Sets the x position relative to the current position where the sprite will be drawn.
public void	translateY(float yAmount) Sets the y position relative to the current position where the sprite will be drawn.

Field Detail

bounds	back to summary
private Rectangle bounds

color	back to summary
private final Color color

dirty	back to summary
private boolean dirty

height	back to summary
pack-priv float height

originX	back to summary
private float originX

originY	back to summary
private float originY

packedColor	back to summary
private float packedColor

rotation	back to summary
private float rotation

scaleX	back to summary
private float scaleX

scaleY	back to summary
private float scaleY

SPRITE_SIZE	back to summary
pack-priv static final int SPRITE_SIZE

VERTEX_SIZE	back to summary
pack-priv static final int VERTEX_SIZE

vertices	back to summary
pack-priv final float[] vertices

width	back to summary
pack-priv float width

x	back to summary
private float x

y	back to summary
private float y

Constructor Detail

Sprite	back to summary
public Sprite() Creates an uninitialized sprite. The sprite will need a texture region and bounds set before it can be drawn.

Sprite	back to summary
public Sprite(Texture texture) Creates a sprite with width, height, and texture region equal to the size of the texture.

Sprite	back to summary
public Sprite(Texture texture, int srcWidth, int srcHeight) Creates a sprite with width, height, and texture region equal to the specified size. The texture region's upper left corner will be 0,0. Parameters srcWidth:int The width of the texture region. May be negative to flip the sprite when drawn. srcHeight:int The height of the texture region. May be negative to flip the sprite when drawn.

Sprite

back to summary

public Sprite(Texture texture, int srcWidth, int srcHeight)

Creates a sprite with width, height, and texture region equal to the specified size. The texture region's upper left corner will be 0,0.

Parameters

srcWidth:int: The width of the texture region. May be negative to flip the sprite when drawn.
srcHeight:int: The height of the texture region. May be negative to flip the sprite when drawn.

Sprite	back to summary
public Sprite(Texture texture, int srcX, int srcY, int srcWidth, int srcHeight) Creates a sprite with width, height, and texture region equal to the specified size. Parameters srcWidth:int The width of the texture region. May be negative to flip the sprite when drawn. srcHeight:int The height of the texture region. May be negative to flip the sprite when drawn.

Sprite

back to summary

public Sprite(Texture texture, int srcX, int srcY, int srcWidth, int srcHeight)

Creates a sprite with width, height, and texture region equal to the specified size.

Parameters

srcWidth:int: The width of the texture region. May be negative to flip the sprite when drawn.
srcHeight:int: The height of the texture region. May be negative to flip the sprite when drawn.

Sprite	back to summary
public Sprite(TextureRegion region) Creates a sprite based on a specific TextureRegion, the new sprite's region is a copy of the parameter region - altering one does not affect the other

Sprite	back to summary
public Sprite(TextureRegion region, int srcX, int srcY, int srcWidth, int srcHeight) Creates a sprite with width, height, and texture region equal to the specified size, relative to specified sprite's texture region. Parameters srcWidth:int The width of the texture region. May be negative to flip the sprite when drawn. srcHeight:int The height of the texture region. May be negative to flip the sprite when drawn.

Sprite

back to summary

public Sprite(TextureRegion region, int srcX, int srcY, int srcWidth, int srcHeight)

Creates a sprite with width, height, and texture region equal to the specified size, relative to specified sprite's texture region.

Parameters

srcWidth:int: The width of the texture region. May be negative to flip the sprite when drawn.
srcHeight:int: The height of the texture region. May be negative to flip the sprite when drawn.

Sprite	back to summary
public Sprite(Sprite sprite) Creates a sprite that is a copy in every way of the specified sprite.

Method Detail

draw	back to summary
public void draw(Batch batch)

draw	back to summary
public void draw(Batch batch, float alphaModulation)

flip	back to summary
public void flip(boolean x, boolean y) Overrides com.badlogic.gdx.graphics.g2d.TextureRegion.flip. boolean parameters x,y are not setting a state, but performing a flip Parameters x:boolean perform horizontal flip y:boolean perform vertical flip

flip

back to summary

public void flip(boolean x, boolean y)

Overrides com.badlogic.gdx.graphics.g2d.TextureRegion.flip.

boolean parameters x,y are not setting a state, but performing a flip

Parameters

x:boolean: perform horizontal flip
y:boolean: perform vertical flip

getBoundingRectangle back to summary

getBoundingRectangle	back to summary
public Rectangle getBoundingRectangle() Returns the bounding axis aligned `Rectangle` that bounds this sprite. The rectangles x and y coordinates describe its bottom left corner. If you change the position or size of the sprite, you have to fetch the triangle again for it to be recomputed. Returns:Rectangle the bounding Rectangle

public Rectangle getBoundingRectangle()

Returns the bounding axis aligned Rectangle that bounds this sprite. The rectangles x and y coordinates describe its bottom left corner. If you change the position or size of the sprite, you have to fetch the triangle again for it to be recomputed.

Returns:Rectangle: the bounding Rectangle

getColor	back to summary
public Color getColor() Returns the color of this sprite. If the returned instance is manipulated, `setColor(Color)` must be called afterward.

getHeight	back to summary
public float getHeight() Returns:float the height of the sprite, not accounting for scale.

getOriginX	back to summary
public float getOriginX() The origin influences `setPosition(float, float)`, `setRotation(float)` and the expansion direction of scaling `setScale(float, float)`

getOriginY	back to summary
public float getOriginY() The origin influences `setPosition(float, float)`, `setRotation(float)` and the expansion direction of scaling `setScale(float, float)`

getPackedColor	back to summary
public float getPackedColor() Returns the packed color of this sprite.

getRotation	back to summary
public float getRotation() Returns:float the rotation of the sprite in degrees

getScaleX	back to summary
public float getScaleX() X scale of the sprite, independent of size set by `setSize(float, float)`

getScaleY	back to summary
public float getScaleY() Y scale of the sprite, independent of size set by `setSize(float, float)`

getVertices	back to summary
public float[] getVertices() Returns the packed vertices, colors, and texture coordinates for this sprite.

getWidth	back to summary
public float getWidth() Returns:float the width of the sprite, not accounting for scale.

getX	back to summary
public float getX()

getY	back to summary
public float getY()

rotate	back to summary
public void rotate(float degrees) Sets the sprite's rotation in degrees relative to the current rotation. Rotation is centered on the origin set in `setOrigin(float, float)`

rotate90	back to summary
public void rotate90(boolean clockwise) Rotates this sprite 90 degrees in-place by rotating the texture coordinates. This rotation is unaffected by `setRotation(float)` and `rotate(float)`.

scale	back to summary
public void scale(float amount) Sets the sprite's scale relative to the current scale. for example: original scale 2 -> sprite.scale(4) -> final scale 6. The sprite scales out from the origin. This will not affect the values returned by `getWidth()` and `getHeight()`

scroll	back to summary
public void scroll(float xAmount, float yAmount) Overrides com.badlogic.gdx.graphics.g2d.TextureRegion.scroll. Doc from com.badlogic.gdx.graphics.g2d.TextureRegion.scroll. Offsets the region relative to the current region. Generally the region's size should be the entire size of the texture in the direction(s) it is scrolled.

scroll

back to summary

public void scroll(float xAmount, float yAmount)

Overrides com.badlogic.gdx.graphics.g2d.TextureRegion.scroll.

Doc from com.badlogic.gdx.graphics.g2d.TextureRegion.scroll.

Offsets the region relative to the current region. Generally the region's size should be the entire size of the texture in the direction(s) it is scrolled.

set	back to summary
public void set(Sprite sprite) Make this sprite a copy in every way of the specified sprite

setAlpha	back to summary
public void setAlpha(float a) Sets the alpha portion of the color used to tint this sprite.

setBounds	back to summary
public void setBounds(float x, float y, float width, float height) Sets the position and size of the sprite when drawn, before scaling and rotation are applied. If origin, rotation, or scale are changed, it is slightly more efficient to set the bounds after those operations.

setCenter	back to summary
public void setCenter(float x, float y) Sets the position so that the sprite is centered on (x, y)

setCenterX	back to summary
public void setCenterX(float x) Sets the x position so that it is centered on the given x parameter

setCenterY	back to summary
public void setCenterY(float y) Sets the y position so that it is centered on the given y parameter

setColor	back to summary
public void setColor(Color tint) Sets the color used to tint this sprite. Default is `Color#WHITE`.

setColor	back to summary
public void setColor(float r, float g, float b, float a) See Also `setColor(Color)`

setFlip

back to summary

public void setFlip(boolean x, boolean y)

Set the sprite's flip state regardless of current condition

Parameters

x:boolean: the desired horizontal flip state
y:boolean: the desired vertical flip state

setOrigin	back to summary
public void setOrigin(float originX, float originY) Sets the origin in relation to the sprite's position for scaling and rotation.

setOriginBasedPosition	back to summary
public void setOriginBasedPosition(float x, float y) Sets the position where the sprite will be drawn, relative to its current origin.

setOriginCenter	back to summary
public void setOriginCenter() Place origin in the center of the sprite

setPackedColor back to summary

public void setPackedColor(float packedColor)

Sets the packed color used to tint this sprite.

See Also: setColor(Color), Color#toFloatBits()

setPosition	back to summary
public void setPosition(float x, float y) Sets the position where the sprite will be drawn. If origin, rotation, or scale are changed, it is slightly more efficient to set the position after those operations. If both position and size are to be changed, it is better to use `setBounds(float, float, float, float)`.

setRegion	back to summary
public void setRegion(float u, float v, float u2, float v2) Overrides com.badlogic.gdx.graphics.g2d.TextureRegion.setRegion.

setRotation	back to summary
public void setRotation(float degrees) Sets the rotation of the sprite in degrees. Rotation is centered on the origin set in `setOrigin(float, float)`

setScale	back to summary
public void setScale(float scaleXY) Sets the sprite's scale for both X and Y uniformly. The sprite scales out from the origin. This will not affect the values returned by `getWidth()` and `getHeight()`

setScale	back to summary
public void setScale(float scaleX, float scaleY) Sets the sprite's scale for both X and Y. The sprite scales out from the origin. This will not affect the values returned by `getWidth()` and `getHeight()`

setSize	back to summary
public void setSize(float width, float height) Sets the size of the sprite when drawn, before scaling and rotation are applied. If origin, rotation, or scale are changed, it is slightly more efficient to set the size after those operations. If both position and size are to be changed, it is better to use `setBounds(float, float, float, float)`.

setU	back to summary
public void setU(float u) Overrides com.badlogic.gdx.graphics.g2d.TextureRegion.setU.

setU2	back to summary
public void setU2(float u2) Overrides com.badlogic.gdx.graphics.g2d.TextureRegion.setU2.

setV	back to summary
public void setV(float v) Overrides com.badlogic.gdx.graphics.g2d.TextureRegion.setV.

setV2	back to summary
public void setV2(float v2) Overrides com.badlogic.gdx.graphics.g2d.TextureRegion.setV2.

setX	back to summary
public void setX(float x) Sets the x position where the sprite will be drawn. If origin, rotation, or scale are changed, it is slightly more efficient to set the position after those operations. If both position and size are to be changed, it is better to use `setBounds(float, float, float, float)`.

setY	back to summary
public void setY(float y) Sets the y position where the sprite will be drawn. If origin, rotation, or scale are changed, it is slightly more efficient to set the position after those operations. If both position and size are to be changed, it is better to use `setBounds(float, float, float, float)`.

translate	back to summary
public void translate(float xAmount, float yAmount) Sets the position relative to the current position where the sprite will be drawn. If origin, rotation, or scale are changed, it is slightly more efficient to translate after those operations.

translateX	back to summary
public void translateX(float xAmount) Sets the x position relative to the current position where the sprite will be drawn. If origin, rotation, or scale are changed, it is slightly more efficient to translate after those operations.

translateY	back to summary
public void translateY(float yAmount) Sets the y position relative to the current position where the sprite will be drawn. If origin, rotation, or scale are changed, it is slightly more efficient to translate after those operations.

public Class Sprite

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail