APIdia Launch Partner
Top Description Inners Constructors Methods
com.badlogic.gdx.graphics.g2d

public Class PixmapPackerIO

extends Object
Class Inheritance
Imports
java.io.IOException, .Writer, java.util.regex.Matcher, com.badlogic.gdx.files.FileHandle, com.badlogic.gdx.graphics.PixmapIO, .Texture.TextureFilter, com.badlogic.gdx.graphics.g2d.PixmapPacker.Page

Saves PixmapPackers to files.
Author
jshapcott

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static enum
PixmapPackerIO.ImageFormat

Image formats which can be used when saving a PixmapPacker.

public static class
PixmapPackerIO.SaveParameters

Additional parameters which will be used when writing a PixmapPacker.

Constructor Summary

AccessConstructor and Description
public

Method Summary

Modifier and TypeMethod and Description
public void
save(FileHandle
the file to which the atlas descriptor will be written, images will be written as siblings
file
,
PixmapPacker
the PixmapPacker to be written
packer
)

Saves the provided PixmapPacker to the provided file.

public void
save(FileHandle
the file to which the atlas descriptor will be written, images will be written as siblings
file
,
PixmapPacker
the PixmapPacker to be written
packer
,
PixmapPackerIO.SaveParameters
the SaveParameters specifying how to save the PixmapPacker
parameters
)

Saves the provided PixmapPacker to the provided file.

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Constructor Detail

PixmapPackerIOback to summary
public PixmapPackerIO()

Method Detail

saveback to summary
public void save(FileHandle file, PixmapPacker packer) throws IOException

Saves the provided PixmapPacker to the provided file. The resulting file will use the standard TextureAtlas file format and can be loaded by TextureAtlas as if it had been created using TexturePacker. Default SaveParameters will be used.

Parameters
file:FileHandle

the file to which the atlas descriptor will be written, images will be written as siblings

packer:PixmapPacker

the PixmapPacker to be written

Exceptions
IOException:
if the atlas file can not be written
saveback to summary
public void save(FileHandle file, PixmapPacker packer, PixmapPackerIO.SaveParameters parameters) throws IOException

Saves the provided PixmapPacker to the provided file. The resulting file will use the standard TextureAtlas file format and can be loaded by TextureAtlas as if it had been created using TexturePacker.

Parameters
file:FileHandle

the file to which the atlas descriptor will be written, images will be written as siblings

packer:PixmapPacker

the PixmapPacker to be written

parameters:PixmapPackerIO.SaveParameters

the SaveParameters specifying how to save the PixmapPacker

Exceptions
IOException:
if the atlas file can not be written
com.badlogic.gdx.graphics.g2d back to summary

public final Enum PixmapPackerIO.ImageFormat

extends Enum<PixmapPackerIO.ImageFormat>
Class Inheritance

Image formats which can be used when saving a PixmapPacker.

Field Summary

Modifier and TypeField and Description
public static final PixmapPackerIO.ImageFormat
CIM

A simple compressed image format which is libgdx specific.

private final String
public static final PixmapPackerIO.ImageFormat
PNG

A standard compressed image format which is not libgdx specific.

Constructor Summary

AccessConstructor and Description
private
ImageFormat(String extension)

Method Summary

Modifier and TypeMethod and Description
public String
getExtension()

Returns the file extension for the image format.

public static PixmapPackerIO.ImageFormat
public static PixmapPackerIO.ImageFormat[]
Inherited from java.lang.Enum:
clonecompareTodescribeConstableequalsfinalizegetDeclaringClasshashCodenameordinaltoStringvalueOf

Field Detail

CIMback to summary
public static final PixmapPackerIO.ImageFormat CIM

A simple compressed image format which is libgdx specific.

extensionback to summary
private final String extension
PNGback to summary
public static final PixmapPackerIO.ImageFormat PNG

A standard compressed image format which is not libgdx specific.

Constructor Detail

ImageFormatback to summary
private ImageFormat(String extension)

Method Detail

getExtensionback to summary
public String getExtension()

Returns the file extension for the image format.

valueOfback to summary
public static PixmapPackerIO.ImageFormat valueOf(String name)
valuesback to summary
public static PixmapPackerIO.ImageFormat[] values()
com.badlogic.gdx.graphics.g2d back to summary

public Class PixmapPackerIO.SaveParameters

extends Object
Class Inheritance

Additional parameters which will be used when writing a PixmapPacker.

Field Summary

Modifier and TypeField and Description
public PixmapPackerIO.ImageFormat
public Texture.TextureFilter
public Texture.TextureFilter
public boolean

Constructor Summary

AccessConstructor and Description
public

Method Summary

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

formatback to summary
public PixmapPackerIO.ImageFormat format
magFilterback to summary
public Texture.TextureFilter magFilter
minFilterback to summary
public Texture.TextureFilter minFilter
useIndexesback to summary
public boolean useIndexes

Constructor Detail

SaveParametersback to summary
public SaveParameters()