Modifier and Type	Class and Description
public static class	ETC1.ETC1Data Class for storing ETC1 compressed image data.

Modifier and Type	Field and Description
public static int	ETC1_RGB8_OES
public static int	PKM_HEADER_SIZE The PKM header size in bytes

Access	Constructor and Description
public	ETC1()

Method Summary

Modifier and Type	Method and Description
public static Pixmap	Returns: the Pixmap decodeImage(ETC1.ETC1Data the `ETC1Data` instance etc1Data, Pixmap.Format either `Format#RGB565` or `Format#RGB888` format) Takes ETC1 compressed image data and converts it to a `Format#RGB565` or `Format#RGB888` `Pixmap`.
private static native void	decodeImage(ByteBuffer the compressed image data in a direct native order `ByteBuffer` compressedData, int the offset in bytes to the image data from the start of the buffer offset, ByteBuffer the decoded data in a direct native order ByteBuffer, must hold width * height * pixelSize bytes. decodedData, int the offset in bytes to the decoded image data. offsetDec, int the width in pixels width, int the height in pixels height, int the pixel size, either 2 (RBG565) or 3 (RGB888) pixelSize) Decodes the compressed image data to RGB565 or RGB888 pixel data.
public static ETC1.ETC1Data	Returns: the `ETC1Data` encodeImage(Pixmap the `Pixmap` pixmap) Encodes the image via the ETC1 compression scheme.
private static native ByteBuffer	Returns: a new direct native order ByteBuffer containing the compressed image data encodeImage(ByteBuffer the image data in a direct native order `ByteBuffer` imageData, int the offset in bytes to the image data from the start of the buffer offset, int the width in pixels width, int the height in pixels height, int the pixel size, either 2 (RGB565) or 3 (RGB888) pixelSize) Encodes the image data given as RGB565 or RGB888.
public static ETC1.ETC1Data	Returns: the `ETC1Data` encodeImagePKM(Pixmap the `Pixmap` pixmap) Encodes the image via the ETC1 compression scheme.
private static native ByteBuffer	Returns: a new direct native order ByteBuffer containing the compressed image data encodeImagePKM(ByteBuffer the image data in a direct native order `ByteBuffer` imageData, int the offset in bytes to the image data from the start of the buffer offset, int the width in pixels width, int the height in pixels height, int the pixel size, either 2 (RGB565) or 3 (RGB888) pixelSize) Encodes the image data given as RGB565 or RGB888.
public static native void	formatHeader(ByteBuffer the direct native order `ByteBuffer` header, int the offset to the header in bytes offset, int the width in pixels width, int the height in pixels height) Writes a PKM header to the `ByteBuffer`.
public static native int	getCompressedDataSize(int the width in pixels width, int the height in pixels height) Returns: the number of bytes needed to store the compressed data
pack-priv static native int	getHeightPKM(ByteBuffer direct native order `ByteBuffer` holding the PKM header header, int the offset in bytes to the PKM header from the ByteBuffer's start offset) Returns: the height stored in the PKM header
private static int	getPixelSize(Pixmap.Format format)
pack-priv static native int	getWidthPKM(ByteBuffer direct native order `ByteBuffer` holding the PKM header header, int the offset in bytes to the PKM header from the ByteBuffer's start offset) Returns: the width stored in the PKM header
pack-priv static native boolean	isValidPKM(ByteBuffer direct native order `ByteBuffer` holding the PKM header header, int the offset in bytes to the PKM header from the ByteBuffer's start offset) Returns: the width stored in the PKM header

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

ETC1_RGB8_OES	back to summary
public static int ETC1_RGB8_OES

PKM_HEADER_SIZE	back to summary
public static int PKM_HEADER_SIZE The PKM header size in bytes

Constructor Detail

ETC1	back to summary
public ETC1()

Method Detail

decodeImage back to summary

decodeImage	back to summary
public static Pixmap decodeImage(ETC1.ETC1Data etc1Data, Pixmap.Format format) Takes ETC1 compressed image data and converts it to a `Format#RGB565` or `Format#RGB888` `Pixmap`. Does not modify the ByteBuffer's position or limit. Parameters etc1Data:ETC1.ETC1Data the `ETC1Data` instance format:Pixmap.Format either `Format#RGB565` or `Format#RGB888` Returns:Pixmap the Pixmap

public static Pixmap decodeImage(ETC1.ETC1Data etc1Data, Pixmap.Format format)

Takes ETC1 compressed image data and converts it to a Format#RGB565 or Format#RGB888 Pixmap. Does not modify the ByteBuffer's position or limit.

Parameters

etc1Data:ETC1.ETC1Data: the ETC1Data instance
format:Pixmap.Format: either Format#RGB565 or Format#RGB888

Returns:Pixmap

the Pixmap

decodeImage back to summary

decodeImage	back to summary
private static native void decodeImage(ByteBuffer compressedData, int offset, ByteBuffer decodedData, int offsetDec, int width, int height, int pixelSize) Decodes the compressed image data to RGB565 or RGB888 pixel data. Does not modify the position or limit of the `ByteBuffer` instances. Parameters compressedData:ByteBuffer the compressed image data in a direct native order `ByteBuffer` offset:int the offset in bytes to the image data from the start of the buffer decodedData:ByteBuffer the decoded data in a direct native order ByteBuffer, must hold width * height * pixelSize bytes. offsetDec:int the offset in bytes to the decoded image data. width:int the width in pixels height:int the height in pixels pixelSize:int the pixel size, either 2 (RBG565) or 3 (RGB888)

private static native void decodeImage(ByteBuffer compressedData, int offset, ByteBuffer decodedData, int offsetDec, int width, int height, int pixelSize)

Decodes the compressed image data to RGB565 or RGB888 pixel data. Does not modify the position or limit of the ByteBuffer instances.

Parameters

compressedData:ByteBuffer: the compressed image data in a direct native order ByteBuffer
offset:int: the offset in bytes to the image data from the start of the buffer
decodedData:ByteBuffer: the decoded data in a direct native order ByteBuffer, must hold width * height * pixelSize bytes.
offsetDec:int: the offset in bytes to the decoded image data.
width:int: the width in pixels
height:int: the height in pixels
pixelSize:int: the pixel size, either 2 (RBG565) or 3 (RGB888)

encodeImage back to summary

encodeImage	back to summary
public static ETC1.ETC1Data encodeImage(Pixmap pixmap) Encodes the image via the ETC1 compression scheme. Only `Format#RGB565` and `Format#RGB888` are supported. Parameters pixmap:Pixmap the `Pixmap` Returns:ETC1.ETC1Data the `ETC1Data`

public static ETC1.ETC1Data encodeImage(Pixmap pixmap)

Encodes the image via the ETC1 compression scheme. Only Format#RGB565 and Format#RGB888 are supported.

Parameters

pixmap:Pixmap: the Pixmap

Returns:ETC1.ETC1Data

the ETC1Data

encodeImage back to summary

encodeImage	back to summary
private static native ByteBuffer encodeImage(ByteBuffer imageData, int offset, int width, int height, int pixelSize) Encodes the image data given as RGB565 or RGB888. Does not modify the position or limit of the `ByteBuffer`. Parameters imageData:ByteBuffer the image data in a direct native order `ByteBuffer` offset:int the offset in bytes to the image data from the start of the buffer width:int the width in pixels height:int the height in pixels pixelSize:int the pixel size, either 2 (RGB565) or 3 (RGB888) Returns:ByteBuffer a new direct native order ByteBuffer containing the compressed image data

private static native ByteBuffer encodeImage(ByteBuffer imageData, int offset, int width, int height, int pixelSize)

Encodes the image data given as RGB565 or RGB888. Does not modify the position or limit of the ByteBuffer.

Parameters

imageData:ByteBuffer: the image data in a direct native order ByteBuffer
offset:int: the offset in bytes to the image data from the start of the buffer
width:int: the width in pixels
height:int: the height in pixels
pixelSize:int: the pixel size, either 2 (RGB565) or 3 (RGB888)

Returns:ByteBuffer

a new direct native order ByteBuffer containing the compressed image data

encodeImagePKM back to summary

encodeImagePKM	back to summary
public static ETC1.ETC1Data encodeImagePKM(Pixmap pixmap) Encodes the image via the ETC1 compression scheme. Only `Format#RGB565` and `Format#RGB888` are supported. Adds a PKM header in front of the compressed image data. Parameters pixmap:Pixmap the `Pixmap` Returns:ETC1.ETC1Data the `ETC1Data`

public static ETC1.ETC1Data encodeImagePKM(Pixmap pixmap)

Encodes the image via the ETC1 compression scheme. Only Format#RGB565 and Format#RGB888 are supported. Adds a PKM header in front of the compressed image data.

Parameters

pixmap:Pixmap: the Pixmap

Returns:ETC1.ETC1Data

the ETC1Data

encodeImagePKM back to summary

encodeImagePKM	back to summary
private static native ByteBuffer encodeImagePKM(ByteBuffer imageData, int offset, int width, int height, int pixelSize) Encodes the image data given as RGB565 or RGB888. Does not modify the position or limit of the `ByteBuffer`. Parameters imageData:ByteBuffer the image data in a direct native order `ByteBuffer` offset:int the offset in bytes to the image data from the start of the buffer width:int the width in pixels height:int the height in pixels pixelSize:int the pixel size, either 2 (RGB565) or 3 (RGB888) Returns:ByteBuffer a new direct native order ByteBuffer containing the compressed image data

private static native ByteBuffer encodeImagePKM(ByteBuffer imageData, int offset, int width, int height, int pixelSize)

Encodes the image data given as RGB565 or RGB888. Does not modify the position or limit of the ByteBuffer.

Parameters

imageData:ByteBuffer: the image data in a direct native order ByteBuffer
offset:int: the offset in bytes to the image data from the start of the buffer
width:int: the width in pixels
height:int: the height in pixels
pixelSize:int: the pixel size, either 2 (RGB565) or 3 (RGB888)

Returns:ByteBuffer

a new direct native order ByteBuffer containing the compressed image data

formatHeader back to summary

formatHeader	back to summary
public static native void formatHeader(ByteBuffer header, int offset, int width, int height) Writes a PKM header to the `ByteBuffer`. Does not modify the position or limit of the ByteBuffer. Parameters header:ByteBuffer the direct native order `ByteBuffer` offset:int the offset to the header in bytes width:int the width in pixels height:int the height in pixels

public static native void formatHeader(ByteBuffer header, int offset, int width, int height)

Writes a PKM header to the ByteBuffer. Does not modify the position or limit of the ByteBuffer.

Parameters

header:ByteBuffer: the direct native order ByteBuffer
offset:int: the offset to the header in bytes
width:int: the width in pixels
height:int: the height in pixels

getCompressedDataSize	back to summary
public static native int getCompressedDataSize(int width, int height) Parameters width:int the width in pixels height:int the height in pixels Returns:int the number of bytes needed to store the compressed data

getHeightPKM	back to summary
pack-priv static native int getHeightPKM(ByteBuffer header, int offset) Parameters header:ByteBuffer direct native order `ByteBuffer` holding the PKM header offset:int the offset in bytes to the PKM header from the ByteBuffer's start Returns:int the height stored in the PKM header

getPixelSize	back to summary
private static int getPixelSize(Pixmap.Format format)

getWidthPKM	back to summary
pack-priv static native int getWidthPKM(ByteBuffer header, int offset) Parameters header:ByteBuffer direct native order `ByteBuffer` holding the PKM header offset:int the offset in bytes to the PKM header from the ByteBuffer's start Returns:int the width stored in the PKM header

isValidPKM	back to summary
pack-priv static native boolean isValidPKM(ByteBuffer header, int offset) Parameters header:ByteBuffer direct native order `ByteBuffer` holding the PKM header offset:int the offset in bytes to the PKM header from the ByteBuffer's start Returns:boolean the width stored in the PKM header

com.badlogic.gdx.graphics.glutils back to summary

public final Class ETC1.ETC1Data

Class Inheritance

extends Object
implements Disposable

java.lang.Object
com.badlogic.gdx.graphics.glutils.ETC1.ETC1Data

All Implemented Interfaces

com.badlogic.gdx.utils.Disposable

Class for storing ETC1 compressed image data.

Author: mzechner

Field Summary

Modifier and Type	Field and Description
public final ByteBuffer	compressedData the optional PKM header and compressed image data
public final int	dataOffset the offset in bytes to the actual compressed data.
public final int	height the height in pixels
public final int	width the width in pixels

Constructor Summary

Access	Constructor and Description
public	ETC1Data(int width, int height, ByteBuffer compressedData, int dataOffset)
public	ETC1Data(FileHandle pkmFile)

Method Summary

Modifier and Type	Method and Description
private void	checkNPOT()
public void	dispose() Implements com.badlogic.gdx.utils.Disposable.dispose. Releases the native resources of the ETC1Data instance.
public boolean	hasPKMHeader() Returns: whether this ETC1Data has a PKM header
public String	toString() Overrides java.lang.Object.toString. Returns a string representation of the object.
public void	write(FileHandle the file. file) Writes the ETC1Data with a PKM header to the given file.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll wait wait wait

Field Detail

compressedData	back to summary
public final ByteBuffer compressedData the optional PKM header and compressed image data

dataOffset	back to summary
public final int dataOffset the offset in bytes to the actual compressed data. Might be 16 if this contains a PKM header, 0 otherwise

height	back to summary
public final int height the height in pixels

width	back to summary
public final int width the width in pixels

Constructor Detail

ETC1Data	back to summary
public ETC1Data(int width, int height, ByteBuffer compressedData, int dataOffset)

ETC1Data	back to summary
public ETC1Data(FileHandle pkmFile)

Method Detail

checkNPOT	back to summary
private void checkNPOT()

dispose	back to summary
public void dispose() Implements com.badlogic.gdx.utils.Disposable.dispose. Releases the native resources of the ETC1Data instance.

dispose

back to summary

public void dispose()

Implements com.badlogic.gdx.utils.Disposable.dispose.

Releases the native resources of the ETC1Data instance.

hasPKMHeader	back to summary
public boolean hasPKMHeader() Returns:boolean whether this ETC1Data has a PKM header

toString back to summary

toString	back to summary
public String toString() Overrides java.lang.Object.toString. Doc from java.lang.Object.toString. Returns a string representation of the object. Satisfying this method's contract implies a non-`null` result must be returned.

public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object. Satisfying this method's contract implies a non-null result must be returned.

write	back to summary
public void write(FileHandle file) Writes the ETC1Data with a PKM header to the given file. Parameters file:FileHandle the file.

write

back to summary

public void write(FileHandle file)

Writes the ETC1Data with a PKM header to the given file.

Parameters

file:FileHandle: the file.

public Class ETC1

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public final Class ETC1.ETC1Data

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail