com.jme3.texture

Class Image

java.lang.Object

com.jme3.util.NativeObject

com.jme3.texture.Image

All Implemented Interfaces:

Savable, java.lang.Cloneable

public class Image
extends NativeObject
implements Savable

Image defines a data format for a graphical image. The image is defined by a format, a height and width, and the image data. The width and height must be greater than 0. The data is contained in a byte buffer, and should be packed before creation of the image object.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Image.Format

Field Summary

Fields

Modifier and Type	Field and Description
protected ColorSpace	colorSpace
protected java.util.ArrayList<java.nio.ByteBuffer>	data
protected int	depth
protected Image.Format	format
protected int	height
protected LastTextureState	lastTextureState
protected int[]	mipMapSizes
protected boolean	mipsWereGenerated
protected int	multiSamples
protected boolean	needGeneratedMips
protected int	width

Fields inherited from class com.jme3.util.NativeObject

handleRef, id, INVALID_ID, objectManager, OBJTYPE_AUDIOBUFFER, OBJTYPE_AUDIOSTREAM, OBJTYPE_BO, OBJTYPE_FILTER, OBJTYPE_FRAMEBUFFER, OBJTYPE_SHADER, OBJTYPE_SHADERSOURCE, OBJTYPE_TEXTURE, OBJTYPE_VERTEXBUFFER, updateNeeded

Constructor Summary

Constructors

Modifier	Constructor and Description
	Image() Constructor instantiates a new Image object.
	Image(Image.Format format, int width, int height, java.nio.ByteBuffer data) Deprecated. use Image(com.jme3.texture.Image.Format, int, int, java.nio.ByteBuffer, com.jme3.texture.image.ColorSpace)
	Image(Image.Format format, int width, int height, java.nio.ByteBuffer data, ColorSpace colorSpace) Constructor instantiates a new Image object.
	Image(Image.Format format, int width, int height, java.nio.ByteBuffer data, int[] mipMapSizes) Deprecated. use Image(com.jme3.texture.Image.Format, int, int, java.nio.ByteBuffer, int[], com.jme3.texture.image.ColorSpace)
	Image(Image.Format format, int width, int height, java.nio.ByteBuffer data, int[] mipMapSizes, ColorSpace colorSpace) Constructor instantiates a new Image object.
	Image(Image.Format format, int width, int height, int depth, java.util.ArrayList<java.nio.ByteBuffer> data) Deprecated. use Image(com.jme3.texture.Image.Format, int, int, int, java.util.ArrayList, com.jme3.texture.image.ColorSpace)
	Image(Image.Format format, int width, int height, int depth, java.util.ArrayList<java.nio.ByteBuffer> data, ColorSpace colorSpace) Constructor instantiates a new Image object.
	Image(Image.Format format, int width, int height, int depth, java.util.ArrayList<java.nio.ByteBuffer> data, int[] mipMapSizes) Deprecated. use Image(com.jme3.texture.Image.Format, int, int, int, java.util.ArrayList, int[], com.jme3.texture.image.ColorSpace)
	Image(Image.Format format, int width, int height, int depth, java.util.ArrayList<java.nio.ByteBuffer> data, int[] mipMapSizes, ColorSpace colorSpace) Constructor instantiates a new Image object.
protected	Image(int id)

Method Summary

Modifier and Type	Method and Description
void	addData(java.nio.ByteBuffer data)
Image	clone() This should create a deep clone.
NativeObject	createDestructableClone() Creates a shallow clone of this GL Object.
protected void	deleteNativeBuffers() Deletes any associated native buffers.
void	deleteObject(java.lang.Object rendererObject) Deletes the GL object from the GPU when it is no longer used.
boolean	equals(java.lang.Object other)
ColorSpace	getColorSpace() Specifies that this image is an SRGB image and therefore must undergo an sRGB -> linear RGB color conversion prior to being read by a shader and with the Renderer.setLinearizeSrgbImages(boolean) option is enabled.
java.util.List<java.nio.ByteBuffer>	getData() getData returns the data for this image.
java.nio.ByteBuffer	getData(int index) getData returns the data for this image.
int	getDepth() getDepth returns the depth of this image (for 3d images).
java.lang.Object	getEfficentData() Deprecated. This feature is no longer used by the engine
Image.Format	getFormat() getFormat returns the image format for this image.
int	getHeight() getHeight returns the height of this image.
LastTextureState	getLastTextureState() Internal use only.
int[]	getMipMapSizes() Returns the mipmap sizes for this image.
int	getMultiSamples()
long	getUniqueId() Returns a unique ID for this NativeObject.
int	getWidth() getWidth returns the width of this image.
int	hashCode()
boolean	hasMipmaps() Returns whether the image data contains mipmaps.
boolean	isGeneratedMipmapsRequired()
boolean	isMipmapsGenerated() Internal use only.
boolean	isNPOT() Determine if the image is NPOT.
void	read(JmeImporter e)
void	resetObject() Called when the GL context is restarted to reset all IDs.
void	setColorSpace(ColorSpace colorSpace) image loader is responsible for setting this attribute based on the color space in which the image has been encoded with.
void	setData(java.util.ArrayList<java.nio.ByteBuffer> data) setData sets the data that makes up the image.
void	setData(java.nio.ByteBuffer data) setData sets the data that makes up the image.
void	setData(int index, java.nio.ByteBuffer data)
void	setDepth(int depth) setDepth sets the depth value of the image.
void	setFormat(Image.Format format) setFormat sets the image format for this image.
void	setHeight(int height) setHeight sets the height value of the image.
void	setMipmapsGenerated(boolean generated) Internal use only.
void	setMipMapSizes(int[] mipMapSizes) Sets the mipmap sizes stored in this image's data buffer.
void	setMultiSamples(int multiSamples)
void	setUpdateNeeded() Sets the update needed flag, while also checking if mipmaps need to be regenerated.
void	setWidth(int width) setWidth sets the width value of the image.
java.lang.String	toString()
void	write(JmeExporter e)

Methods inherited from class com.jme3.util.NativeObject

clearUpdateNeeded, dispose, getId, getWeakRef, isUpdateNeeded, setId

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

format

protected Image.Format format

width

protected int width

height

protected int height

depth

protected int depth

mipMapSizes

protected int[] mipMapSizes

data

protected java.util.ArrayList<java.nio.ByteBuffer> data

multiSamples

protected int multiSamples

colorSpace

protected ColorSpace colorSpace

mipsWereGenerated

protected boolean mipsWereGenerated

needGeneratedMips

protected boolean needGeneratedMips

lastTextureState

protected LastTextureState lastTextureState

Constructor Detail

Image

public Image()

Constructor instantiates a new Image object. All values are undefined.

Image

protected Image(int id)

Image

public Image(Image.Format format,
             int width,
             int height,
             int depth,
             java.util.ArrayList<java.nio.ByteBuffer> data,
             int[] mipMapSizes,
             ColorSpace colorSpace)

Constructor instantiates a new Image object. The attributes of the image are defined during construction.

Parameters:

format - the data format of the image.

width - the width of the image.

height - the height of the image.

depth - the desired image depth

data - the image data.

mipMapSizes - the array of mipmap sizes, or null for no mipmaps.

colorSpace - the colorSpace of the image

Image

@Deprecated
public Image(Image.Format format,
                         int width,
                         int height,
                         int depth,
                         java.util.ArrayList<java.nio.ByteBuffer> data,
                         int[] mipMapSizes)

Deprecated. use Image(com.jme3.texture.Image.Format, int, int, int, java.util.ArrayList, int[], com.jme3.texture.image.ColorSpace)

Parameters:

format - the desired data format

width - the desired width (in pixels)

height - the desired height (in pixels)

depth - the desired image depth

data - the image data to use

mipMapSizes - the desired mipmap sizes, or null for no mipmaps

See Also:

Image(com.jme3.texture.Image.Format, int, int, int, java.util.ArrayList, int[], com.jme3.texture.image.ColorSpace)

Image

public Image(Image.Format format,
             int width,
             int height,
             java.nio.ByteBuffer data,
             int[] mipMapSizes,
             ColorSpace colorSpace)

Constructor instantiates a new Image object. The attributes of the image are defined during construction.

Parameters:

format - the data format of the image.

width - the width of the image.

height - the height of the image.

data - the image data.

mipMapSizes - the array of mipmap sizes, or null for no mipmaps.

colorSpace - the colorSpace of the image

Image

@Deprecated
public Image(Image.Format format,
                         int width,
                         int height,
                         java.nio.ByteBuffer data,
                         int[] mipMapSizes)

Deprecated. use Image(com.jme3.texture.Image.Format, int, int, java.nio.ByteBuffer, int[], com.jme3.texture.image.ColorSpace)

Parameters:

format - the desired data format

width - the desired width (in pixels)

height - the desired height (in pixels)

data - the image data to use

mipMapSizes - the desired mipmap sizes, or null for no mipmaps

See Also:

Image(com.jme3.texture.Image.Format, int, int, java.nio.ByteBuffer, int[], com.jme3.texture.image.ColorSpace)

Image

public Image(Image.Format format,
             int width,
             int height,
             int depth,
             java.util.ArrayList<java.nio.ByteBuffer> data,
             ColorSpace colorSpace)

Constructor instantiates a new Image object. The attributes of the image are defined during construction.

Parameters:

format - the data format of the image.

width - the width of the image.

height - the height of the image.

depth - the desired image depth

data - the image data.

colorSpace - the colorSpace of the image

Image

@Deprecated
public Image(Image.Format format,
                         int width,
                         int height,
                         int depth,
                         java.util.ArrayList<java.nio.ByteBuffer> data)

Deprecated. use Image(com.jme3.texture.Image.Format, int, int, int, java.util.ArrayList, com.jme3.texture.image.ColorSpace)

Parameters:

format - the desired data format

width - the desired width (in pixels)

height - the desired height (in pixels)

depth - the desired image depth

data - the image data to use

See Also:

Image(com.jme3.texture.Image.Format, int, int, int, java.util.ArrayList, com.jme3.texture.image.ColorSpace)

Image

public Image(Image.Format format,
             int width,
             int height,
             java.nio.ByteBuffer data,
             ColorSpace colorSpace)

Constructor instantiates a new Image object. The attributes of the image are defined during construction.

Parameters:

format - the data format of the image.

width - the width of the image.

height - the height of the image.

data - the image data.

colorSpace - the colorSpace of the image

Image

@Deprecated
public Image(Image.Format format,
                         int width,
                         int height,
                         java.nio.ByteBuffer data)

Deprecated. use Image(com.jme3.texture.Image.Format, int, int, java.nio.ByteBuffer, com.jme3.texture.image.ColorSpace)

Parameters:

format - the desired data format

width - the desired width (in pixels)

height - the desired height (in pixels)

data - the image data

See Also:

Image(com.jme3.texture.Image.Format, int, int, java.nio.ByteBuffer, com.jme3.texture.image.ColorSpace)

Method Detail

getLastTextureState

public LastTextureState getLastTextureState()

Internal use only. The renderer stores the texture state set from the last texture so it doesn't have to change it unless necessary.

Returns:

The image parameter state.

setMipmapsGenerated

public void setMipmapsGenerated(boolean generated)

Internal use only. The renderer marks which images have generated mipmaps in VRAM and which do not, so it can generate them as needed.

Parameters:

generated - If mipmaps were generated or not.

isMipmapsGenerated

public boolean isMipmapsGenerated()

Internal use only. Check if the renderer has generated mipmaps for this image in VRAM or not.

Returns:

If mipmaps were generated already.

isGeneratedMipmapsRequired

public boolean isGeneratedMipmapsRequired()

Returns:

True if the image needs to have mipmaps generated for it (as requested by the texture). This stays true even after mipmaps have been generated.

setUpdateNeeded

public void setUpdateNeeded()

Sets the update needed flag, while also checking if mipmaps need to be regenerated.

Overrides:

setUpdateNeeded in class NativeObject

isNPOT

public boolean isNPOT()

Determine if the image is NPOT.

Returns:

if the image is a non-power-of-2 image, e.g. having dimensions that are not powers of 2.

resetObject

public void resetObject()

Description copied from class: NativeObject

Called when the GL context is restarted to reset all IDs. Prevents "white textures" on display restart.

Specified by:

resetObject in class NativeObject

deleteNativeBuffers

protected void deleteNativeBuffers()

Description copied from class: NativeObject

Deletes any associated native buffers. This is necessary because it is unlikely that native buffers will be garbage collected naturally (due to how GC works), therefore the collection must be handled manually. Only implementations that manage native buffers need to override this method. Note that the behavior that occurs when a deleted native buffer is used is not defined, therefore this method is protected

Overrides:

deleteNativeBuffers in class NativeObject

deleteObject

public void deleteObject(java.lang.Object rendererObject)

Description copied from class: NativeObject

Deletes the GL object from the GPU when it is no longer used. Called automatically by the GL object manager.

Specified by:

deleteObject in class NativeObject

Parameters:

rendererObject - The renderer to be used to delete the object

createDestructableClone

public NativeObject createDestructableClone()

Description copied from class: NativeObject

Creates a shallow clone of this GL Object. The deleteObject method should be functional for this object.

Specified by:

createDestructableClone in class NativeObject

Returns:

a new instance

getUniqueId

public long getUniqueId()

Description copied from class: NativeObject

Returns a unique ID for this NativeObject. No other NativeObject shall have the same ID.

Specified by:

getUniqueId in class NativeObject

Returns:

unique ID for this NativeObject.

clone

public Image clone()

Description copied from class: NativeObject

This should create a deep clone. For a shallow clone, use createDestructableClone().

Overrides:

clone in class NativeObject

Returns:

A shallow clone of this image. The data is not cloned.

getMultiSamples

public int getMultiSamples()

Returns:

The number of samples (for multisampled textures).

See Also:

setMultiSamples(int)

setMultiSamples

public void setMultiSamples(int multiSamples)

Parameters:

multiSamples - Set the number of samples to use for this image, setting this to a value higher than 1 turns this image/texture into a multisample texture (on OpenGL3.1 and higher).

setData

public void setData(java.util.ArrayList<java.nio.ByteBuffer> data)

setData sets the data that makes up the image. This data is packed into an array of ByteBuffer objects.

Parameters:

data - the data that contains the image information.

setData

public void setData(java.nio.ByteBuffer data)

setData sets the data that makes up the image. This data is packed into a single ByteBuffer.

Parameters:

data - the data that contains the image information.

addData

public void addData(java.nio.ByteBuffer data)

setData

public void setData(int index,
                    java.nio.ByteBuffer data)

getEfficentData

@Deprecated
public java.lang.Object getEfficentData()

Deprecated. This feature is no longer used by the engine

Returns:

null

setMipMapSizes

public void setMipMapSizes(int[] mipMapSizes)

Sets the mipmap sizes stored in this image's data buffer. Mipmaps are stored sequentially, and the first mipmap is the main image data. To specify no mipmaps, pass null and this will automatically be expanded into a single mipmap of the full

Parameters:

mipMapSizes - the mipmap sizes array, or null for a single image map.

setHeight

public void setHeight(int height)

setHeight sets the height value of the image. It is typically a good idea to try to keep this as a multiple of 2.

Parameters:

height - the height of the image.

setDepth

public void setDepth(int depth)

setDepth sets the depth value of the image. It is typically a good idea to try to keep this as a multiple of 2. This is used for 3d images.

Parameters:

depth - the depth of the image.

setWidth

public void setWidth(int width)

setWidth sets the width value of the image. It is typically a good idea to try to keep this as a multiple of 2.

Parameters:

width - the width of the image.

setFormat

public void setFormat(Image.Format format)

setFormat sets the image format for this image.

Parameters:

format - the image format (not null)

Throws:

java.lang.IllegalArgumentException - if format is null

See Also:

Image.Format

getFormat

public Image.Format getFormat()

getFormat returns the image format for this image.

Returns:

the image format.

See Also:

Image.Format

getWidth

public int getWidth()

getWidth returns the width of this image.

Returns:

the width of this image.

getHeight

public int getHeight()

getHeight returns the height of this image.

Returns:

the height of this image.

getDepth

public int getDepth()

getDepth returns the depth of this image (for 3d images).

Returns:

the depth of this image.

getData

public java.util.List<java.nio.ByteBuffer> getData()

getData returns the data for this image. If the data is undefined, null will be returned.

Returns:

the data for this image.

getData

public java.nio.ByteBuffer getData(int index)

getData returns the data for this image. If the data is undefined, null will be returned.

Parameters:

index - index of the data buffer to access

Returns:

the data for this image.

hasMipmaps

public boolean hasMipmaps()

Returns whether the image data contains mipmaps.

Returns:

true if the image data contains mipmaps, false if not.

getMipMapSizes

public int[] getMipMapSizes()

Returns the mipmap sizes for this image.

Returns:

the mipmap sizes for this image.

setColorSpace

public void setColorSpace(ColorSpace colorSpace)

image loader is responsible for setting this attribute based on the color space in which the image has been encoded with. In the majority of cases, this flag will be set to sRGB by default since many image formats do not contain any color space information and the most frequently used colors space is sRGB The material loader may override this attribute to Linear if it determines that such conversion must not be performed, for example, when loading normal maps.

Parameters:

colorSpace - Set to sRGB to enable srgb -> linear conversion, Linear otherwise.

See Also:

Renderer.setLinearizeSrgbImages(boolean)

getColorSpace

public ColorSpace getColorSpace()

Specifies that this image is an SRGB image and therefore must undergo an sRGB -> linear RGB color conversion prior to being read by a shader and with the Renderer.setLinearizeSrgbImages(boolean) option is enabled. This option is only supported for the 8-bit color and grayscale image formats. Determines if the image is in SRGB color space or not.

Returns:

True, if the image is an SRGB image, false if it is linear RGB.

See Also:

Renderer.setLinearizeSrgbImages(boolean)

toString

public java.lang.String toString()

Overrides:

toString in class NativeObject

equals

public boolean equals(java.lang.Object other)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

write

public void write(JmeExporter e)
           throws java.io.IOException

Specified by:

write in interface Savable

Throws:

java.io.IOException

read

public void read(JmeImporter e)
          throws java.io.IOException

Specified by:

read in interface Savable

Throws:

java.io.IOException