com.jme3.texture
Class Texture2D

java.lang.Object
  extended by com.jme3.texture.Texture
      extended by com.jme3.texture.Texture2D
All Implemented Interfaces:
CloneableSmartAsset, Savable, java.lang.Cloneable

public class Texture2D
extends Texture


Nested Class Summary
 
Nested classes/interfaces inherited from class com.jme3.texture.Texture
Texture.MagFilter, Texture.MinFilter, Texture.ShadowCompareMode, Texture.Type, Texture.WrapAxis, Texture.WrapMode
 
Constructor Summary
Texture2D()
          Creates a new two-dimensional texture with default attributes.
Texture2D(Image img)
          Creates a new two-dimensional texture using the given image.
Texture2D(int width, int height, Image.Format format)
          Creates a new two-dimensional texture for the purpose of offscreen rendering.
Texture2D(int width, int height, int numSamples, Image.Format format)
          Creates a new two-dimensional texture for the purpose of offscreen rendering.
 
Method Summary
 Texture createSimpleClone()
           
 Texture createSimpleClone(Texture rVal)
          Retrieve a basic clone of this Texture (ie, clone everything but the image data, which is shared)
 boolean equals(java.lang.Object other)
           
 Texture.Type getType()
           
 Texture.WrapMode getWrap(Texture.WrapAxis axis)
          getWrap returns the wrap mode for a given coordinate axis on this texture.
 int hashCode()
           
 void read(JmeImporter e)
           
 void setWrap(Texture.WrapAxis axis, Texture.WrapMode mode)
          setWrap sets the wrap mode of this texture for a particular axis.
 void setWrap(Texture.WrapMode mode)
          setWrap sets the wrap mode of this texture for all axis.
 void write(JmeExporter e)
           
 
Methods inherited from class com.jme3.texture.Texture
clone, getAnisotropicFilter, getImage, getKey, getMagFilter, getMinFilter, getName, getShadowCompareMode, setAnisotropicFilter, setImage, setKey, setMagFilter, setMinFilter, setName, setShadowCompareMode, toString
 
Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait
 

Constructor Detail

Texture2D

public Texture2D()
Creates a new two-dimensional texture with default attributes.


Texture2D

public Texture2D(Image img)
Creates a new two-dimensional texture using the given image.

Parameters:
img - The image to use.

Texture2D

public Texture2D(int width,
                 int height,
                 Image.Format format)
Creates a new two-dimensional texture for the purpose of offscreen rendering.

Parameters:
width -
height -
format -
See Also:
FrameBuffer

Texture2D

public Texture2D(int width,
                 int height,
                 int numSamples,
                 Image.Format format)
Creates a new two-dimensional texture for the purpose of offscreen rendering.

Parameters:
width -
height -
format -
numSamples -
See Also:
FrameBuffer
Method Detail

createSimpleClone

public Texture createSimpleClone()
Specified by:
createSimpleClone in class Texture

createSimpleClone

public Texture createSimpleClone(Texture rVal)
Description copied from class: Texture
Retrieve a basic clone of this Texture (ie, clone everything but the image data, which is shared)

Overrides:
createSimpleClone in class Texture
Returns:
Texture

setWrap

public void setWrap(Texture.WrapAxis axis,
                    Texture.WrapMode mode)
setWrap sets the wrap mode of this texture for a particular axis.

Specified by:
setWrap in class Texture
Parameters:
axis - the texture axis to define a wrapmode on.
mode - the wrap mode for the given axis of the texture.
Throws:
java.lang.IllegalArgumentException - if axis or mode are null

setWrap

public void setWrap(Texture.WrapMode mode)
setWrap sets the wrap mode of this texture for all axis.

Specified by:
setWrap in class Texture
Parameters:
mode - the wrap mode for the given axis of the texture.
Throws:
java.lang.IllegalArgumentException - if mode is null

getWrap

public Texture.WrapMode getWrap(Texture.WrapAxis axis)
getWrap returns the wrap mode for a given coordinate axis on this texture.

Specified by:
getWrap in class Texture
Parameters:
axis - the axis to return for
Returns:
the wrap mode of the texture.
Throws:
java.lang.IllegalArgumentException - if axis is null

getType

public Texture.Type getType()
Specified by:
getType in class Texture

equals

public boolean equals(java.lang.Object other)
Overrides:
equals in class Texture

hashCode

public int hashCode()
Overrides:
hashCode in class Texture

write

public void write(JmeExporter e)
           throws java.io.IOException
Specified by:
write in interface Savable
Overrides:
write in class Texture
Throws:
java.io.IOException

read

public void read(JmeImporter e)
          throws java.io.IOException
Specified by:
read in interface Savable
Overrides:
read in class Texture
Throws:
java.io.IOException