Top Description Inners Fields Constructors Methods

com.jogamp.opengl.util.texture.spi

public Class TGAImage

Class Inheritance

extends Object

java.lang.Object
com.jogamp.opengl.util.texture.spi.TGAImage

Imports

java.io.*, java.nio.*, java.nio.channels.*, com.jogamp.opengl.*, com.jogamp.common.util.IOUtil

Targa image reader and writer adapted from sources of the Jimi image I/O class library.

Image decoder for image data stored in TGA file format. Currently only the original TGA file format is supported. This is because the new TGA format has data at the end of the file, getting to the end of a file in an InputStream orient environment presents several difficulties which are avoided at the moment.

This is a simple decoder and is only setup to load a single image from the input stream

Authors: Robin Luiten, Kenneth Russell
Version: $Revision: 1768 $

Nested and Inner Type Summary

Modifier and Type	Class and Description
public static class	TGAImage.Header This class reads in all of the TGA image header in addition it also reads in the imageID field as it is convenient to handle that here.

Field Summary

Modifier and Type	Field and Description
private int	bpp
private ByteBuffer	data
private int	format
private final TGAImage.Header	header

Constructor Summary

Access	Constructor and Description
private	TGAImage(final TGAImage.Header header)

Method Summary

Modifier and Type	Method and Description
public static TGAImage	createFromData(final int width, final int height, final boolean hasAlpha, final boolean topToBottom, final ByteBuffer data) Creates a TGAImage from data supplied by the end user.
private void	decodeImage(final GLProfile glp, final LEDataInputStream dIn) Identifies the image type of the tga image data and loads it into the JimiImage structure.
private void	decodeRGBImageRLE24_32(final GLProfile glp, final LEDataInputStream dIn) This assumes that the body is for a 24 bit or 32 bit for a RGB or ARGB image respectively.
private void	decodeRGBImageU24_32(final GLProfile glp, final LEDataInputStream dIn) This assumes that the body is for a 24 bit or 32 bit for a RGB or ARGB image respectively.
public int	getBytesPerPixel() Returns the bytes per pixel
public ByteBuffer	getData() Returns the raw data for this texture in the correct (bottom-to-top) order for calls to glTexImage2D.
public int	getGLFormat() Returns the OpenGL format for this texture; e.g. GL.GL_BGR or GL.GL_BGRA.
public int	getHeight() Returns the height of the image.
public int	getWidth() Returns the width of the image.
public static TGAImage	read(final GLProfile glp, final String filename) Reads a Targa image from the specified file.
public static TGAImage	read(final GLProfile glp, final InputStream in) Reads a Targa image from the specified InputStream.
private void	setupImage24_32(final GLProfile glp)
private static void	swapBGR(final byte[] data, final int bWidth, final int height, final int bpp)
public void	write(final String filename) Writes the image in Targa format to the specified file name.
public void	write(final File file) Writes the image in Targa format to the specified file.

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

Field Detail

bpp	back to summary
private int bpp

data	back to summary
private ByteBuffer data

format	back to summary
private int format

header	back to summary
private final TGAImage.Header header

Constructor Detail

TGAImage	back to summary
private TGAImage(final TGAImage.Header header)

Method Detail

createFromData	back to summary
public static TGAImage createFromData(final int width, final int height, final boolean hasAlpha, final boolean topToBottom, final ByteBuffer data) Creates a TGAImage from data supplied by the end user. Shares data with the passed ByteBuffer. Assumes the data is already in the correct byte order for writing to disk, i.e., BGR or BGRA.

decodeImage	back to summary
private void decodeImage(final GLProfile glp, final LEDataInputStream dIn) throws IOException Identifies the image type of the tga image data and loads it into the JimiImage structure. This was taken from the prototype and modified for the new Jimi structure

decodeRGBImageRLE24_32	back to summary
private void decodeRGBImageRLE24_32(final GLProfile glp, final LEDataInputStream dIn) throws IOException This assumes that the body is for a 24 bit or 32 bit for a RGB or ARGB image respectively.

decodeRGBImageU24_32	back to summary
private void decodeRGBImageU24_32(final GLProfile glp, final LEDataInputStream dIn) throws IOException This assumes that the body is for a 24 bit or 32 bit for a RGB or ARGB image respectively.

getBytesPerPixel	back to summary
public int getBytesPerPixel() Returns the bytes per pixel

getData	back to summary
public ByteBuffer getData() Returns the raw data for this texture in the correct (bottom-to-top) order for calls to glTexImage2D.

getGLFormat	back to summary
public int getGLFormat() Returns the OpenGL format for this texture; e.g. GL.GL_BGR or GL.GL_BGRA.

getHeight	back to summary
public int getHeight() Returns the height of the image.

getWidth	back to summary
public int getWidth() Returns the width of the image.

read	back to summary
public static TGAImage read(final GLProfile glp, final String filename) throws IOException Reads a Targa image from the specified file.

read	back to summary
public static TGAImage read(final GLProfile glp, final InputStream in) throws IOException Reads a Targa image from the specified InputStream.

setupImage24_32	back to summary
private void setupImage24_32(final GLProfile glp)

swapBGR	back to summary
private static void swapBGR(final byte[] data, final int bWidth, final int height, final int bpp)

write	back to summary
public void write(final String filename) throws IOException Writes the image in Targa format to the specified file name.

write	back to summary
public void write(final File file) throws IOException Writes the image in Targa format to the specified file.

com.jogamp.opengl.util.texture.spi back to summary

public Class TGAImage.Header

Class Inheritance

extends Object

java.lang.Object
com.jogamp.opengl.util.texture.spi.TGAImage.Header

This class reads in all of the TGA image header in addition it also reads in the imageID field as it is convenient to handle that here.

Author: Robin Luiten
Version: 1.1

Field Summary

Modifier and Type	Field and Description
public static final int	BLACKWHITE
private byte	colorMapEntrySize
private int	colorMapLength
public static final int	COLORMAPPED
private int	colorMapType
private int	firstEntryIndex TGA image colour map fields
private int	height
public static final int	I_FOURWAY
public static final int	I_NOTINTERLEAVED Field image descriptor / interleave values
public static final int	I_TWOWAY
public static final int	ID_ATTRIBPERPIXEL Field image descriptor bitfield values definitions
public static final int	ID_INTERLEAVE
public static final int	ID_RIGHTTOLEFT
public static final int	ID_TOPTOBOTTOM
private int	idLength initial TGA image data fields
private byte	imageDescriptor
private String	imageID
private byte[]	imageIDbuf
private int	imageType
public static final int	NO_IMAGE Set of possible image types in TGA file
private byte	pixelDepth
private final int	tgaType Type of this TGA file format
public static final int	TRUECOLOR
public static final int	TYPE_NEW Set of possible file format TGA types
public static final int	TYPE_OLD
public static final int	TYPE_UNK
public static final int	UBLACKWHITE
public static final int	UCOLORMAPPED
public static final int	UTRUECOLOR
private int	width
private int	xOrigin TGA image specification fields
private int	yOrigin

Constructor Summary

Access	Constructor and Description
pack-priv	Header()
pack-priv	Header(final LEDataInputStream in)

Method Summary

Modifier and Type	Method and Description
public byte	attribPerPixel() bitfields in imageDescriptor
public byte	colorMapEntrySize()
public int	colorMapLength()
public int	colorMapType()
public int	firstEntryIndex() TGA image colour map fields
public int	height()
public int	idLength() initial TGA image data fields
public byte	imageDescriptor()
public String	imageID()
public byte[]	imageIDbuf()
public int	imageType()
public byte	interleave()
public byte	pixelDepth()
public boolean	rightToLeft()
public int	size()
public int	tgaType()
public boolean	topToBottom()
public String	toString() Overrides java.lang.Object.toString. Returns a string representation of the object.
public int	width()
private void	write(final ByteBuffer buf)
public int	xOrigin() TGA image specification fields
public int	yOrigin()

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

Field Detail

BLACKWHITE	back to summary
public static final int BLACKWHITE

colorMapEntrySize	back to summary
private byte colorMapEntrySize

colorMapEntrySize

back to summary

private byte colorMapEntrySize

colorMapLength	back to summary
private int colorMapLength

COLORMAPPED	back to summary
public static final int COLORMAPPED

colorMapType	back to summary
private int colorMapType

firstEntryIndex	back to summary
private int firstEntryIndex TGA image colour map fields

firstEntryIndex

back to summary

private int firstEntryIndex

TGA image colour map fields

height	back to summary
private int height

I_FOURWAY	back to summary
public static final int I_FOURWAY

I_NOTINTERLEAVED	back to summary
public static final int I_NOTINTERLEAVED Field image descriptor / interleave values

I_TWOWAY	back to summary
public static final int I_TWOWAY

ID_ATTRIBPERPIXEL	back to summary
public static final int ID_ATTRIBPERPIXEL Field image descriptor bitfield values definitions

ID_INTERLEAVE	back to summary
public static final int ID_INTERLEAVE

ID_RIGHTTOLEFT	back to summary
public static final int ID_RIGHTTOLEFT

ID_TOPTOBOTTOM	back to summary
public static final int ID_TOPTOBOTTOM

idLength	back to summary
private int idLength initial TGA image data fields

imageDescriptor	back to summary
private byte imageDescriptor

imageID	back to summary
private String imageID

imageIDbuf	back to summary
private byte[] imageIDbuf

imageType	back to summary
private int imageType

NO_IMAGE	back to summary
public static final int NO_IMAGE Set of possible image types in TGA file

pixelDepth	back to summary
private byte pixelDepth

tgaType	back to summary
private final int tgaType Type of this TGA file format

TRUECOLOR	back to summary
public static final int TRUECOLOR

Constructor Detail

Header

back to summary

pack-priv Header(final LEDataInputStream in) throws IOException

Method Detail

colorMapEntrySize

back to summary

public byte colorMapEntrySize()

firstEntryIndex

back to summary

public int firstEntryIndex()

TGA image colour map fields

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.

Returns:String

a string representation of the object

Annotations

@Override