Modifier and Type	Class and Description
pack-priv static class	DDSImage.Header
public static class	DDSImage.ImageInfo Simple class describing images and data; does not encapsulate image format information.

Field Summary

Modifier and Type	Field and Description
private ByteBuffer	buf
private FileChannel	chan
public static final int	D3DFMT_A8R8G8B8
public static final int	D3DFMT_DXT1
public static final int	D3DFMT_DXT2
public static final int	D3DFMT_DXT3
public static final int	D3DFMT_DXT4
public static final int	D3DFMT_DXT5
public static final int	D3DFMT_R8G8B8
public static final int	D3DFMT_UNKNOWN
public static final int	D3DFMT_X8R8G8B8
public static final int	DDPF_ALPHA
public static final int	DDPF_ALPHAPIXELS
public static final int	DDPF_COMPRESSED
public static final int	DDPF_FOURCC
public static final int	DDPF_PALETTEINDEXED1
public static final int	DDPF_PALETTEINDEXED2
public static final int	DDPF_PALETTEINDEXED4
public static final int	DDPF_PALETTEINDEXED8
public static final int	DDPF_PALETTEINDEXEDTO8
public static final int	DDPF_RGB
public static final int	DDPF_RGBTOYUV
public static final int	DDPF_YUV
public static final int	DDPF_ZBUFFER
public static final int	DDPF_ZPIXELS
public static final int	DDSCAPS2_CUBEMAP
public static final int	DDSCAPS2_CUBEMAP_NEGATIVEX
public static final int	DDSCAPS2_CUBEMAP_NEGATIVEY
public static final int	DDSCAPS2_CUBEMAP_NEGATIVEZ
public static final int	DDSCAPS2_CUBEMAP_POSITIVEX
public static final int	DDSCAPS2_CUBEMAP_POSITIVEY
public static final int	DDSCAPS2_CUBEMAP_POSITIVEZ
public static final int	DDSCAPS_COMPLEX
public static final int	DDSCAPS_MIPMAP
public static final int	DDSCAPS_TEXTURE
public static final int	DDSD_ALPHABITDEPTH
public static final int	DDSD_BACKBUFFERCOUNT
public static final int	DDSD_CAPS
public static final int	DDSD_DEPTH
public static final int	DDSD_HEIGHT
public static final int	DDSD_LINEARSIZE
public static final int	DDSD_LPSURFACE
public static final int	DDSD_MIPMAPCOUNT
public static final int	DDSD_PITCH
public static final int	DDSD_PIXELFORMAT
public static final int	DDSD_WIDTH
public static final int	DDSD_ZBUFFERBITDEPTH
private FileInputStream	fis
private DDSImage.Header	header
private static final int	MAGIC

Constructor Summary

Access	Constructor and Description
private	DDSImage()

Method Summary

Modifier and Type	Method and Description
public static ByteBuffer	allocateBlankBuffer(final int width, final int height, final int openGLInternalFormat) Allocates a temporary, empty ByteBuffer suitable for use in a call to glCompressedTexImage2D.
public void	close() Closes open files and resources associated with the open DDSImage.
private static int	computeBlockSize(final int width, final int height, final int depth, final int pixelFormat)
private static int	computeCompressedBlockSize(final int width, final int height, final int depth, final int compressionFormat)
public static DDSImage	Returns: DDS image object createFromData(final int the D3DFMT_ constant describing the data; it is assumed that it is packed tightly d3dFormat, final int the width in pixels of the topmost mipmap image width, final int the height in pixels of the topmost mipmap image height, final ByteBuffer[] the data for each mipmap level of the resulting DDSImage; either only one mipmap level should be specified, or they all must be mipmapData) Creates a new DDSImage from data supplied by the user.
public void	debugPrint()
private void	fixupHeader()
public DDSImage.ImageInfo[]	Returns: Mipmap image objects set getAllMipMaps() Returns an array of ImageInfos corresponding to all mipmap levels of this DDS file.
public DDSImage.ImageInfo[]	Returns: Mipmap image objects set getAllMipMaps(final int Cubemap side or 0 for 2D texture side) Returns an array of ImageInfos corresponding to all mipmap levels of this DDS file.
public int	getCompressionFormat() If this surface is compressed, returns the kind of compression used (DXT1..DXT5).
public static String	Returns: String format code getCompressionFormatName(int Compression format constant compressionFormat) Converts e.g. DXT1 compression format constant (see `getCompressionFormat`) into "DXT1".
public int	getDepth() Total number of bits per pixel.
public int	getHeight() Height of the texture (or the top-most mipmap if mipmaps are present)
public DDSImage.ImageInfo	Returns: Image object getMipMap(final int Mipmap index map) Gets the ith mipmap data (0..getNumMipMaps() - 1)
public DDSImage.ImageInfo	Returns: Image object getMipMap(final int Cubemap side or 0 for 2D texture side, final int Mipmap index map) Gets the ith mipmap data (0..getNumMipMaps() - 1)
public int	getNumMipMaps() Number of mip maps in the texture
public int	getPixelFormat() Gets the pixel format of this texture (D3DFMT_*) based on some heuristics.
public int	getWidth() Width of the texture (or the top-most mipmap if mipmaps are present)
private void	initFromData(final int d3dFormat, final int width, final int height, final ByteBuffer[] mipmapData)
public boolean	isCompressed() Indicates whether this texture is compressed.
public boolean	Returns: true if cubemap or false otherwise isCubemap() Indicates whether this texture is cubemap
public boolean	Returns: true if side present or false otherwise isCubemapSidePresent(final int Side to test side) Indicates whethe this cubemap side present
public static boolean	Returns: true if input stream is DDS image or false otherwise isDDSImage(InputStream Stream to check in) Deprecated rather call `ImageType#getFileSuffix(InputStream)` Determines from the magic number whether the given InputStream points to a DDS image.
public boolean	isPixelFormatFlagSet(final int flag) Test for presence/absence of pixel format flags (DDPF_*)
public boolean	Returns: true if flag present or false otherwise isSurfaceDescFlagSet(final int DDSD_* flags set to test flag) Test for presence/absence of surface description flags (DDSD_*)
private int	mipMapHeight(final int map)
private int	mipMapSizeInBytes(final int map)
private int	mipMapWidth(final int map)
private boolean	printIfRecognized(final PrintStream tty, final int flags, final int flag, final String what)
public static DDSImage	Returns: DDS image object read(final String File name filename) Reads a DirectDraw surface from the specified file name, returning the resulting DDSImage.
public static DDSImage	Returns: DDS image object read(final File File object file) Reads a DirectDraw surface from the specified file, returning the resulting DDSImage.
public static DDSImage	Returns: DDS image object read(final ByteBuffer Input data buf) Reads a DirectDraw surface from the specified ByteBuffer, returning the resulting DDSImage.
private void	readFromBuffer(final ByteBuffer buf)
private void	readFromFile(final File file)
private int	sideShiftInBytes(final int side)
private int	sideSizeInBytes()
public void	write(final String File name to write to filename) Writes this DDSImage to the specified file name.
public void	write(final File File object to write to file) Writes this DDSImage to the specified file name.

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

Field Detail

buf	back to summary
private ByteBuffer buf

chan	back to summary
private FileChannel chan

D3DFMT_A8R8G8B8	back to summary
public static final int D3DFMT_A8R8G8B8

D3DFMT_DXT1	back to summary
public static final int D3DFMT_DXT1

D3DFMT_DXT2	back to summary
public static final int D3DFMT_DXT2

D3DFMT_DXT3	back to summary
public static final int D3DFMT_DXT3

D3DFMT_DXT4	back to summary
public static final int D3DFMT_DXT4

D3DFMT_DXT5	back to summary
public static final int D3DFMT_DXT5

D3DFMT_R8G8B8	back to summary
public static final int D3DFMT_R8G8B8

D3DFMT_UNKNOWN	back to summary
public static final int D3DFMT_UNKNOWN

D3DFMT_X8R8G8B8	back to summary
public static final int D3DFMT_X8R8G8B8

DDPF_ALPHA	back to summary
public static final int DDPF_ALPHA

DDPF_ALPHAPIXELS	back to summary
public static final int DDPF_ALPHAPIXELS

DDPF_COMPRESSED	back to summary
public static final int DDPF_COMPRESSED

DDPF_FOURCC	back to summary
public static final int DDPF_FOURCC

DDPF_PALETTEINDEXED1	back to summary
public static final int DDPF_PALETTEINDEXED1

DDPF_PALETTEINDEXED2	back to summary
public static final int DDPF_PALETTEINDEXED2

DDPF_PALETTEINDEXED4	back to summary
public static final int DDPF_PALETTEINDEXED4

DDPF_PALETTEINDEXED8	back to summary
public static final int DDPF_PALETTEINDEXED8

DDPF_PALETTEINDEXEDTO8	back to summary
public static final int DDPF_PALETTEINDEXEDTO8

DDPF_RGB	back to summary
public static final int DDPF_RGB

DDPF_RGBTOYUV	back to summary
public static final int DDPF_RGBTOYUV

DDPF_YUV	back to summary
public static final int DDPF_YUV

DDPF_ZBUFFER	back to summary
public static final int DDPF_ZBUFFER

DDPF_ZPIXELS	back to summary
public static final int DDPF_ZPIXELS

DDSCAPS2_CUBEMAP	back to summary
public static final int DDSCAPS2_CUBEMAP

DDSCAPS2_CUBEMAP_NEGATIVEX	back to summary
public static final int DDSCAPS2_CUBEMAP_NEGATIVEX

DDSCAPS2_CUBEMAP_NEGATIVEY	back to summary
public static final int DDSCAPS2_CUBEMAP_NEGATIVEY

DDSCAPS2_CUBEMAP_NEGATIVEZ	back to summary
public static final int DDSCAPS2_CUBEMAP_NEGATIVEZ

DDSCAPS2_CUBEMAP_POSITIVEX	back to summary
public static final int DDSCAPS2_CUBEMAP_POSITIVEX

DDSCAPS2_CUBEMAP_POSITIVEY	back to summary
public static final int DDSCAPS2_CUBEMAP_POSITIVEY

DDSCAPS2_CUBEMAP_POSITIVEZ	back to summary
public static final int DDSCAPS2_CUBEMAP_POSITIVEZ

DDSCAPS_COMPLEX	back to summary
public static final int DDSCAPS_COMPLEX

DDSCAPS_MIPMAP	back to summary
public static final int DDSCAPS_MIPMAP

DDSCAPS_TEXTURE	back to summary
public static final int DDSCAPS_TEXTURE

DDSD_ALPHABITDEPTH	back to summary
public static final int DDSD_ALPHABITDEPTH

DDSD_BACKBUFFERCOUNT	back to summary
public static final int DDSD_BACKBUFFERCOUNT

DDSD_CAPS	back to summary
public static final int DDSD_CAPS

DDSD_DEPTH	back to summary
public static final int DDSD_DEPTH

DDSD_HEIGHT	back to summary
public static final int DDSD_HEIGHT

DDSD_LINEARSIZE	back to summary
public static final int DDSD_LINEARSIZE

DDSD_LPSURFACE	back to summary
public static final int DDSD_LPSURFACE

DDSD_MIPMAPCOUNT	back to summary
public static final int DDSD_MIPMAPCOUNT

DDSD_PITCH	back to summary
public static final int DDSD_PITCH

DDSD_PIXELFORMAT	back to summary
public static final int DDSD_PIXELFORMAT

DDSD_WIDTH	back to summary
public static final int DDSD_WIDTH

DDSD_ZBUFFERBITDEPTH	back to summary
public static final int DDSD_ZBUFFERBITDEPTH

fis	back to summary
private FileInputStream fis

MAGIC	back to summary
private static final int MAGIC

Constructor Detail

DDSImage	back to summary
private DDSImage()

Method Detail

allocateBlankBuffer

back to summary

public static ByteBuffer allocateBlankBuffer(final int width, final int height, final int openGLInternalFormat)

Allocates a temporary, empty ByteBuffer suitable for use in a call to glCompressedTexImage2D. This is used by the Texture class to expand non-power-of-two DDS compressed textures to power-of-two sizes on hardware not supporting OpenGL 2.0 and the NPOT texture extension. The specified OpenGL internal format must be one of GL_COMPRESSED_RGB_S3TC_DXT1_EXT, GL_COMPRESSED_RGBA_S3TC_DXT1_EXT, GL_COMPRESSED_RGBA_S3TC_DXT3_EXT, or GL_COMPRESSED_RGBA_S3TC_DXT5_EXT.

close	back to summary
public void close() Closes open files and resources associated with the open DDSImage. No other methods may be called on this object once this is called.

computeBlockSize	back to summary
private static int computeBlockSize(final int width, final int height, final int depth, final int pixelFormat)

computeCompressedBlockSize	back to summary
private static int computeCompressedBlockSize(final int width, final int height, final int depth, final int compressionFormat)

createFromData

back to summary

public static DDSImage createFromData(final int d3dFormat, final int width, final int height, final ByteBuffer[] mipmapData) throws IllegalArgumentException

Creates a new DDSImage from data supplied by the user. The resulting DDSImage can be written to disk using the write() method.

Parameters

d3dFormat:int: the D3DFMT_ constant describing the data; it is assumed that it is packed tightly
width:int: the width in pixels of the topmost mipmap image
height:int: the height in pixels of the topmost mipmap image
mipmapData:ByteBuffer[]: the data for each mipmap level of the resulting DDSImage; either only one mipmap level should be specified, or they all must be

Returns:DDSImage

DDS image object

Exceptions

IllegalArgumentException:: if the data does not match the specified arguments

debugPrint	back to summary
public void debugPrint()

fixupHeader	back to summary
private void fixupHeader()

getAllMipMaps

back to summary

public DDSImage.ImageInfo[] getAllMipMaps()

Returns an array of ImageInfos corresponding to all mipmap levels of this DDS file.

Returns:DDSImage.ImageInfo[]: Mipmap image objects set

getAllMipMaps

back to summary

public DDSImage.ImageInfo[] getAllMipMaps(final int side)

Returns an array of ImageInfos corresponding to all mipmap levels of this DDS file.

Parameters

side:int: Cubemap side or 0 for 2D texture

Returns:DDSImage.ImageInfo[]

Mipmap image objects set

getCompressionFormat	back to summary
public int getCompressionFormat() If this surface is compressed, returns the kind of compression used (DXT1..DXT5).

getCompressionFormatName back to summary

public static String getCompressionFormatName(int compressionFormat)

Converts e.g. DXT1 compression format constant (see getCompressionFormat) into "DXT1".

Parameters

compressionFormat:int: Compression format constant

Returns:String

String format code

getDepth	back to summary
public int getDepth() Total number of bits per pixel. Only valid if DDPF_RGB is present. For A8R8G8B8, would be 32.

getHeight	back to summary
public int getHeight() Height of the texture (or the top-most mipmap if mipmaps are present)

getMipMap

back to summary

public DDSImage.ImageInfo getMipMap(final int map)

Gets the ith mipmap data (0..getNumMipMaps() - 1)

Parameters

map:int: Mipmap index

Returns:DDSImage.ImageInfo

Image object

getMipMap

back to summary

public DDSImage.ImageInfo getMipMap(final int side, final int map)

Gets the ith mipmap data (0..getNumMipMaps() - 1)

Parameters

side:int: Cubemap side or 0 for 2D texture
map:int: Mipmap index

Returns:DDSImage.ImageInfo

Image object

getNumMipMaps	back to summary
public int getNumMipMaps() Number of mip maps in the texture

getPixelFormat	back to summary
public int getPixelFormat() Gets the pixel format of this texture (D3DFMT_*) based on some heuristics. Returns D3DFMT_UNKNOWN if could not recognize the pixel format.

getWidth	back to summary
public int getWidth() Width of the texture (or the top-most mipmap if mipmaps are present)

initFromData	back to summary
private void initFromData(final int d3dFormat, final int width, final int height, final ByteBuffer[] mipmapData) throws IllegalArgumentException

isCompressed	back to summary
public boolean isCompressed() Indicates whether this texture is compressed.

isCubemap

back to summary

public boolean isCubemap()

Indicates whether this texture is cubemap

Returns:boolean: true if cubemap or false otherwise

isCubemapSidePresent

back to summary

public boolean isCubemapSidePresent(final int side)

Indicates whethe this cubemap side present

Parameters

side:int: Side to test

Returns:boolean

true if side present or false otherwise

isDDSImage back to summary

public static boolean isDDSImage(InputStream in) throws IOException

Deprecated

rather call ImageType#getFileSuffix(InputStream)

Determines from the magic number whether the given InputStream points to a DDS image. The given InputStream must return true from markSupported() and support a minimum of four bytes of read-ahead.

Parameters

in:InputStream: Stream to check

Returns:boolean

true if input stream is DDS image or false otherwise

Annotations

@Deprecated

Exceptions

IOException:: if an I/O exception occurred

isPixelFormatFlagSet	back to summary
public boolean isPixelFormatFlagSet(final int flag) Test for presence/absence of pixel format flags (DDPF_*)

isSurfaceDescFlagSet

back to summary

public boolean isSurfaceDescFlagSet(final int flag)

Test for presence/absence of surface description flags (DDSD_*)

Parameters

flag:int: DDSD_* flags set to test

Returns:boolean

true if flag present or false otherwise

mipMapHeight	back to summary
private int mipMapHeight(final int map)

mipMapSizeInBytes	back to summary
private int mipMapSizeInBytes(final int map)

mipMapWidth	back to summary
private int mipMapWidth(final int map)

printIfRecognized	back to summary
private boolean printIfRecognized(final PrintStream tty, final int flags, final int flag, final String what)

read

back to summary

public static DDSImage read(final String filename) throws IOException

Reads a DirectDraw surface from the specified file name, returning the resulting DDSImage.

Parameters

filename:String: File name

Returns:DDSImage

DDS image object

Exceptions

IOException:: if an I/O exception occurred

read

back to summary

public static DDSImage read(final File file) throws IOException

Reads a DirectDraw surface from the specified file, returning the resulting DDSImage.

Parameters

file:File: File object

Returns:DDSImage

DDS image object

Exceptions

IOException:: if an I/O exception occurred

read

back to summary

public static DDSImage read(final ByteBuffer buf) throws IOException

Reads a DirectDraw surface from the specified ByteBuffer, returning the resulting DDSImage.

Parameters

buf:ByteBuffer: Input data

Returns:DDSImage

DDS image object

Exceptions

IOException:: if an I/O exception occurred

readFromBuffer	back to summary
private void readFromBuffer(final ByteBuffer buf) throws IOException

readFromFile	back to summary
private void readFromFile(final File file) throws IOException

sideShiftInBytes	back to summary
private int sideShiftInBytes(final int side)

sideSizeInBytes	back to summary
private int sideSizeInBytes()

write

back to summary

public void write(final String filename) throws IOException

Writes this DDSImage to the specified file name.

Parameters

filename:String: File name to write to

Exceptions

IOException:: if an I/O exception occurred

write

back to summary

public void write(final File file) throws IOException

Writes this DDSImage to the specified file name.

Parameters

file:File: File object to write to

Exceptions

IOException:: if an I/O exception occurred

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

public Class DDSImage.ImageInfo

Class Inheritance

extends Object

java.lang.Object
com.jogamp.opengl.util.texture.spi.DDSImage.ImageInfo

Simple class describing images and data; does not encapsulate image format information. User is responsible for transmitting that information in another way.

Field Summary

Modifier and Type	Field and Description
private final int	compressionFormat
private final ByteBuffer	data
private final int	height
private final boolean	isCompressed
private final int	width

Constructor Summary

Access	Constructor and Description
public	ImageInfo(final ByteBuffer data, final int width, final int height, final boolean compressed, final int compressionFormat)

Method Summary

Modifier and Type	Method and Description
public int	getCompressionFormat()
public ByteBuffer	getData()
public int	getHeight()
public int	getWidth()
public boolean	isCompressed()

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

Field Detail

compressionFormat	back to summary
private final int compressionFormat

data	back to summary
private final ByteBuffer data

height	back to summary
private final int height

isCompressed	back to summary
private final boolean isCompressed

width	back to summary
private final int width

Constructor Detail

ImageInfo	back to summary
public ImageInfo(final ByteBuffer data, final int width, final int height, final boolean compressed, final int compressionFormat)

Method Detail

getCompressionFormat	back to summary
public int getCompressionFormat()

getData	back to summary
public ByteBuffer getData()

getHeight	back to summary
public int getHeight()

getWidth	back to summary
public int getWidth()

isCompressed	back to summary
public boolean isCompressed()

Modifier and Type	Field and Description
pack-priv int	alphaBitDepth
pack-priv int	backBufferCountOrDepth
pack-priv int	colorSpaceHighValue
pack-priv int	colorSpaceLowValue
pack-priv int	ddsCaps1
pack-priv int	ddsCaps2
pack-priv int	ddsCapsReserved1
pack-priv int	ddsCapsReserved2
pack-priv int	destBltColorSpaceHighValue
pack-priv int	destBltColorSpaceLowValue
pack-priv int	flags
pack-priv int	height
pack-priv int	mipMapCountOrAux
pack-priv int	pfABitMask
pack-priv int	pfBBitMask
pack-priv int	pfFlags
pack-priv int	pfFourCC
pack-priv int	pfGBitMask
pack-priv int	pfRBitMask
pack-priv int	pfRGBBitCount
pack-priv int	pfSize
pack-priv int	pitchOrLinearSize
pack-priv int	reserved1
pack-priv int	size
pack-priv int	srcBltColorSpaceHighValue
pack-priv int	srcBltColorSpaceLowValue
pack-priv int	srcOverlayColorSpaceHighValue
pack-priv int	srcOverlayColorSpaceLowValue
pack-priv int	surface
pack-priv int	textureStage
pack-priv int	width

Modifier and Type	Method and Description
private static int	pfSize()
pack-priv void	read(final ByteBuffer buf)
private static int	size()
pack-priv void	write(final ByteBuffer buf)
private static int	writtenSize()

public Class DDSImage

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

pack-priv Class DDSImage.Header

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public Class DDSImage.ImageInfo

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail