com.badlogic.gdx.graphics.g2d

Class LibgdxTextureAtlasWrapper

java.lang.Object

com.badlogic.gdx.graphics.g2d.LibgdxTextureAtlasWrapper

All Implemented Interfaces:

com.badlogic.gdx.utils.Disposable

public class LibgdxTextureAtlasWrapper
extends java.lang.Object
implements com.badlogic.gdx.utils.Disposable

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	LibgdxTextureAtlasWrapper.AtlasRegion Describes the region of a packed image and provides information about the original image before it was packed.
static class	LibgdxTextureAtlasWrapper.AtlasSprite A sprite that, if whitespace was stripped from the region when it was packed, is automatically positioned as if whitespace had not been stripped.
static class	LibgdxTextureAtlasWrapper.TextureAtlasData

Constructor Summary

Constructors

Constructor and Description
LibgdxTextureAtlasWrapper() Creates an empty atlas to which regions can be added.
LibgdxTextureAtlasWrapper(com.badlogic.gdx.files.FileHandle packFile) Loads the specified pack file, using the parent directory of the pack file to find the page images.
LibgdxTextureAtlasWrapper(com.badlogic.gdx.files.FileHandle packFile, boolean flip)
LibgdxTextureAtlasWrapper(com.badlogic.gdx.files.FileHandle packFile, com.badlogic.gdx.files.FileHandle imagesDir)
LibgdxTextureAtlasWrapper(com.badlogic.gdx.files.FileHandle packFile, com.badlogic.gdx.files.FileHandle imagesDir, boolean flip)
LibgdxTextureAtlasWrapper(LibgdxTextureAtlasWrapper.TextureAtlasData data)
LibgdxTextureAtlasWrapper(java.lang.String internalPackFile) Loads the specified pack file using Files.FileType#Internal, using the parent directory of the pack file to find the page images.

Method Summary

Modifier and Type	Method and Description
LibgdxTextureAtlasWrapper.AtlasRegion	addRegion(java.lang.String name, LibgdxTexture texture, int x, int y, int width, int height) Adds a region to the atlas.
LibgdxTextureAtlasWrapper.AtlasRegion	addRegion(java.lang.String name, LibgdxTextureRegionWrapper textureRegion) Adds a region to the atlas.
void	dispose() Releases all resources associated with this TextureAtlas instance.
LibgdxTextureAtlasWrapper.AtlasRegion	findRegion(java.lang.String name) Returns the first region found with the specified name.
LibgdxTextureAtlasWrapper.AtlasRegion	findRegion(java.lang.String name, int index) Returns the first region found with the specified name and index.
com.badlogic.gdx.utils.Array<LibgdxTextureAtlasWrapper.AtlasRegion>	findRegions(java.lang.String name) Returns all regions with the specified name, ordered by smallest to largest index.
com.badlogic.gdx.utils.Array<LibgdxTextureAtlasWrapper.AtlasRegion>	getRegions() Returns all regions in the atlas.
com.badlogic.gdx.utils.ObjectSet<LibgdxTexture>	getTextures()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

LibgdxTextureAtlasWrapper

public LibgdxTextureAtlasWrapper()

Creates an empty atlas to which regions can be added.

LibgdxTextureAtlasWrapper

public LibgdxTextureAtlasWrapper(java.lang.String internalPackFile)

Loads the specified pack file using Files.FileType#Internal, using the parent directory of the pack file to find the page images.

LibgdxTextureAtlasWrapper

public LibgdxTextureAtlasWrapper(com.badlogic.gdx.files.FileHandle packFile)

Loads the specified pack file, using the parent directory of the pack file to find the page images.

LibgdxTextureAtlasWrapper

public LibgdxTextureAtlasWrapper(com.badlogic.gdx.files.FileHandle packFile,
                                 boolean flip)

Parameters:

flip - If true, all regions loaded will be flipped for use with a perspective where 0,0 is the upper left corner.

See Also:

LibgdxTextureAtlasWrapper(FileHandle)

LibgdxTextureAtlasWrapper

public LibgdxTextureAtlasWrapper(com.badlogic.gdx.files.FileHandle packFile,
                                 com.badlogic.gdx.files.FileHandle imagesDir)

LibgdxTextureAtlasWrapper

public LibgdxTextureAtlasWrapper(com.badlogic.gdx.files.FileHandle packFile,
                                 com.badlogic.gdx.files.FileHandle imagesDir,
                                 boolean flip)

Parameters:

flip - If true, all regions loaded will be flipped for use with a perspective where 0,0 is the upper left corner.

LibgdxTextureAtlasWrapper

public LibgdxTextureAtlasWrapper(LibgdxTextureAtlasWrapper.TextureAtlasData data)

Parameters:

data - May be null.

Method Detail

addRegion

public LibgdxTextureAtlasWrapper.AtlasRegion addRegion(java.lang.String name,
                                                       LibgdxTexture texture,
                                                       int x,
                                                       int y,
                                                       int width,
                                                       int height)

Adds a region to the atlas. The specified texture will be disposed when the atlas is disposed.

addRegion

public LibgdxTextureAtlasWrapper.AtlasRegion addRegion(java.lang.String name,
                                                       LibgdxTextureRegionWrapper textureRegion)

Adds a region to the atlas. The texture for the specified region will be disposed when the atlas is disposed.

getRegions

public com.badlogic.gdx.utils.Array<LibgdxTextureAtlasWrapper.AtlasRegion> getRegions()

Returns all regions in the atlas.

findRegion

public LibgdxTextureAtlasWrapper.AtlasRegion findRegion(java.lang.String name)

Returns the first region found with the specified name. This method uses string comparison to find the region, so the result should be cached rather than calling this method multiple times.

Returns:

The region, or null.

findRegion

public LibgdxTextureAtlasWrapper.AtlasRegion findRegion(java.lang.String name,
                                                        int index)

Returns the first region found with the specified name and index. This method uses string comparison to find the region, so the result should be cached rather than calling this method multiple times.

Returns:

The region, or null.

findRegions

public com.badlogic.gdx.utils.Array<LibgdxTextureAtlasWrapper.AtlasRegion> findRegions(java.lang.String name)

Returns all regions with the specified name, ordered by smallest to largest index. This method uses string comparison to find the regions, so the result should be cached rather than calling this method multiple times.

getTextures

public com.badlogic.gdx.utils.ObjectSet<LibgdxTexture> getTextures()

Returns:

the textures of the pages, unordered

dispose

public void dispose()

Releases all resources associated with this TextureAtlas instance. This releases all the textures backing all TextureRegions and Sprites, which should no longer be used after calling dispose.

Specified by:

dispose in interface com.badlogic.gdx.utils.Disposable