TextureRegion (mini2Dx)

All Known Subinterfaces:

Sprite, TextureAtlasRegion

All Known Implementing Classes:

LibgdxSprite, LibgdxTextureAtlasRegion, LibgdxTextureRegion
```
public interface TextureRegion
```

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`void`	`flip(boolean x, boolean y)`
`int`	`getRegionHeight()` Returns the region's height.
`int`	`getRegionWidth()` Returns the region's width.
`int`	`getRegionX()`
`int`	`getRegionY()`
`Texture`	`getTexture()`
`float`	`getU()`
`float`	`getU2()`
`float`	`getV()`
`float`	`getV2()`
`boolean`	`isFlipX()`
`boolean`	`isFlipY()`
`void`	`scroll(float xAmount, float yAmount)` Offsets the region relative to the current region.
`void`	`setFlip(boolean flipX, boolean flipY)`
`void`	`setFlipX(boolean flipX)`
`void`	`setFlipY(boolean flipY)`
`void`	`setRegion(float u, float v, float u2, float v2)`
`void`	`setRegion(int x, int y, int width, int height)`
`void`	`setRegion(Texture texture)`
`void`	`setRegion(TextureRegion region)` Sets the texture and coordinates to the specified region.
`void`	`setRegion(TextureRegion region, int x, int y, int width, int height)` Sets the texture to that of the specified region and sets the coordinates relative to the specified region.
`void`	`setRegionHeight(int height)`
`void`	`setRegionWidth(int width)`
`void`	`setRegionX(int x)`
`void`	`setRegionY(int y)`
`void`	`setTexture(Texture texture)`
`void`	`setU(float u)`
`void`	`setU2(float u2)`
`void`	`setV(float v)`
`void`	`setV2(float v2)`
`TextureRegion[][]`	`split(int tileWidth, int tileHeight)` Helper function to create tiles out of this TextureRegion starting from the top left corner going to the right and ending at the bottom right corner.
`Pixmap`	`toPixmap()` Converts this `TextureRegion` to a `Pixmap`

- Method Detail
  - setRegion
```
void setRegion(Texture texture)
```
  - setRegion
```
void setRegion(int x,
               int y,
               int width,
               int height)
```
    Parameters:
    
    width - The width of the texture region. May be negative to flip the sprite when drawn.
    
    height - The height of the texture region. May be negative to flip the sprite when drawn.
  - setRegion
```
void setRegion(float u,
               float v,
               float u2,
               float v2)
```
  - setRegion
```
void setRegion(TextureRegion region)
```
    Sets the texture and coordinates to the specified region.
  - setRegion
```
void setRegion(TextureRegion region,
               int x,
               int y,
               int width,
               int height)
```
    Sets the texture to that of the specified region and sets the coordinates relative to the specified region.
  - getTexture
```
Texture getTexture()
```
  - setTexture
```
void setTexture(Texture texture)
```
  - getU
```
float getU()
```
  - setU
```
void setU(float u)
```
  - getV
```
float getV()
```
  - setV
```
void setV(float v)
```
  - getU2
```
float getU2()
```
  - setU2
```
void setU2(float u2)
```
  - getV2
```
float getV2()
```
  - setV2
```
void setV2(float v2)
```
  - getRegionX
```
int getRegionX()
```
  - setRegionX
```
void setRegionX(int x)
```
  - getRegionY
```
int getRegionY()
```
  - setRegionY
```
void setRegionY(int y)
```
  - getRegionWidth
```
int getRegionWidth()
```
    Returns the region's width.
  - setRegionWidth
```
void setRegionWidth(int width)
```
  - getRegionHeight
```
int getRegionHeight()
```
    Returns the region's height.
  - setRegionHeight
```
void setRegionHeight(int height)
```
  - flip
```
void flip(boolean x,
          boolean y)
```
  - setFlip
```
void setFlip(boolean flipX,
             boolean flipY)
```
  - isFlipX
```
boolean isFlipX()
```
  - setFlipX
```
void setFlipX(boolean flipX)
```
  - isFlipY
```
boolean isFlipY()
```
  - setFlipY
```
void setFlipY(boolean flipY)
```
  - scroll
```
void scroll(float xAmount,
            float yAmount)
```
    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.
    
    Parameters:
    
    xAmount - The percentage to offset horizontally.
    
    yAmount - The percentage to offset vertically. This is done in texture space, so up is negative.
  - toPixmap
```
Pixmap toPixmap()
```
    Converts this TextureRegion to a Pixmap
    
    Returns:
    
    A new Pixmap instance containing the pixel data
  - split
```
TextureRegion[][] split(int tileWidth,
                        int tileHeight)
```
    Helper function to create tiles out of this TextureRegion starting from the top left corner going to the right and ending at the bottom right corner. Only complete tiles will be returned so if the region's width or height are not a multiple of the tile width and height not all of the region will be used. This will not work on texture regions returned form a TextureAtlas that either have whitespace removed or where flipped before the region is split.
    
    Parameters:
    
    tileWidth - a tile's width in pixels
    
    tileHeight - a tile's height in pixels
    
    Returns:
    
    a 2D array of TextureRegions indexed by [row][column].

Interface TextureRegion

Method Summary

Method Detail

setRegion

setRegion

setRegion

setRegion

setRegion

getTexture

setTexture

getU

setU

getV

setV

getU2

setU2

getV2

setV2

getRegionX

setRegionX

getRegionY

setRegionY

getRegionWidth

setRegionWidth

getRegionHeight

setRegionHeight

flip

setFlip

isFlipX

setFlipX

isFlipY

setFlipY

scroll

toPixmap

split