Texture (JSFML API)

java.lang.Object
- org.jsfml.internal.SFMLNativeObject
- - org.jsfml.graphics.Texture

All Implemented Interfaces:

ConstTexture, Const
```
public class Texture
extends SFMLNativeObject
implements ConstTexture
```
Represents a 2D texture stored on the graphics card for rendering.

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class Texture.CoordinateType
Enumeation of texture coordinate types that can be used for rendering.

Nested Classes
Modifier and Type	Class and Description
`static class`	`Texture.CoordinateType` Enumeation of texture coordinate types that can be used for rendering.

Constructor Summary

Constructors
Constructor and Description

Texture()
Constructs a new texture.

Texture(ConstTexture other)
Constructs a new texture by copying another texture.

Constructors
Constructor and Description
`Texture()` Constructs a new texture.
`Texture(ConstTexture other)` Constructs a new texture by copying another texture.

Method Summary

Methods
Modifier and Type	Method and Description
`static void`	`bind(ConstTexture texture)` Activates a texture for rendering, using the `Texture.CoordinateType.NORMALIZED` coordinate type.
`static void`	`bind(ConstTexture texture, Texture.CoordinateType coordinateType)` Activates a texture for rendering with the specified coordinate type.
`Image`	`copyToImage()` Copies this texture to an editable `Image`.
`void`	`create(int width, int height)` Generates an empty texture with the specified dimensions.
`static int`	`getMaximumSize()` Gets the maximum texture size supported by the current hardware.
`Vector2i`	`getSize()` Gets the dimensions of the texture.
`boolean`	`isRepeated()` Checks whether texture repeating is enabled.
`boolean`	`isSmooth()` Checks whether the smooth filter is enabled.
`void`	`loadFromFile(Path path)` Attempts to load the texture from a file.
`void`	`loadFromFile(Path path, IntRect area)` Attempts to load the texture from a file.
`void`	`loadFromImage(Image image)` Attempts to load the texture from a source image.
`void`	`loadFromImage(Image image, IntRect area)` Attempts to load the texture from a source image portion.
`void`	`loadFromStream(InputStream in)` Fully loads all available bytes from an `InputStream` and attempts to load the texture from it.
`void`	`loadFromStream(InputStream in, IntRect area)` Fully loads all available bytes from an `InputStream` and attempts to load the texture portion from it.
`protected long`	`nativeCreate()` Deprecated.
`protected void`	`nativeDelete()` Deprecated.
`protected void`	`nativeSetExPtr()` Deprecated.
`void`	`setRepeated(boolean repeated)` Enables or disables texture repeating.
`void`	`setSmooth(boolean smooth)` Enables or disables the smooth filter.
`void`	`update(Image image, int x, int y)` Updates a part of the texture from an image.
`void`	`update(Window window)` Updates the texture from the contents of a window.
`void`	`update(Window window, int x, int y)` Updates a part of the texture from the contents of a window.

Methods inherited from class org.jsfml.internal.SFMLNativeObject
finalize

Methods inherited from class java.lang.Object
clone, equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - Texture
```
public Texture()
```
    Constructs a new texture.
  - Texture
```
public Texture(ConstTexture other)
```
    Constructs a new texture by copying another texture.
    
    Parameters:
    other - The texture to copy.
- Method Detail
  - getMaximumSize
```
public static int getMaximumSize()
```
    Gets the maximum texture size supported by the current hardware.
    
    Returns:
    the maximum texture size supported by the current hardware.
  - bind
```
public static void bind(ConstTexture texture,
        Texture.CoordinateType coordinateType)
```
    Activates a texture for rendering with the specified coordinate type.
    This is required only if you wish to use JSFML textures in custom OpenGL code.
    
    Parameters:
    texture - the texture to bind, or null to indicate that no texture is to be used..
    coordinateType - the coordinate type to use.
  - bind
```
public static void bind(ConstTexture texture)
```
    Activates a texture for rendering, using the Texture.CoordinateType.NORMALIZED coordinate type.
  - nativeCreate
```
@Deprecated
protected long nativeCreate()
```
    Deprecated.
    
    Description copied from class: SFMLNativeObject
    
    Creates a new native SFML object of the represented SFML class in the JVM memory heap.
    
    Specified by:
    
    nativeCreate in class SFMLNativeObject
    
    Returns:
    the pointer to the newly created native SFML object.
  - nativeSetExPtr
```
@Deprecated
protected void nativeSetExPtr()
```
    Deprecated.
    
    Description copied from class: SFMLNativeObject
    
    This method is expected to fill the extra pointers array, if any.
    It is called after the object has been created or wrapped around an already existing pointer.
    
    Specified by:
    
    nativeSetExPtr in class SFMLNativeObject
  - nativeDelete
```
@Deprecated
protected void nativeDelete()
```
    Deprecated.
    
    Description copied from class: SFMLNativeObject
    
    Deletes the underlying SFML object.
    
    Specified by:
    
    nativeDelete in class SFMLNativeObject
  - create
```
public void create(int width,
          int height)
            throws TextureCreationException
```
    Generates an empty texture with the specified dimensions.
    
    Parameters:
    width - the texture's width.
    height - the texture's height.
    
    Throws:
    
    TextureCreationException - if the texture could not be created.
  - loadFromStream
```
public void loadFromStream(InputStream in,
                  IntRect area)
                    throws IOException
```
    Fully loads all available bytes from an InputStream and attempts to load the texture portion from it.
    
    Parameters:
    in - the input stream to read from.
    area - the area of the image to load into the texture.
    
    Throws:
    
    IOException - in case an I/O error occurs.
  - loadFromStream
```
public final void loadFromStream(InputStream in)
                          throws IOException
```
    Fully loads all available bytes from an InputStream and attempts to load the texture from it.
    
    Parameters:
    in - the input stream to read from.
    
    Throws:
    
    IOException - in case an I/O error occurs.
  - loadFromFile
```
public void loadFromFile(Path path,
                IntRect area)
                  throws IOException
```
    Attempts to load the texture from a file.
    
    Parameters:
    path - the path to the file to load the texture from.
    area - the area of the image to load into the texture.
    
    Throws:
    
    IOException - in case an I/O error occurs.
  - loadFromFile
```
public final void loadFromFile(Path path)
                        throws IOException
```
    Attempts to load the texture from a file.
    
    Parameters:
    path - the path to the file to load the texture from.
    
    Throws:
    
    IOException - in case an I/O error occurs.
  - loadFromImage
```
public void loadFromImage(Image image,
                 IntRect area)
                   throws TextureCreationException
```
    Attempts to load the texture from a source image portion.
    
    Parameters:
    image - the source image.
    area - the area of the image to load into the texture.
    
    Throws:
    
    TextureCreationException - if the texture could not be loaded from the image.
  - loadFromImage
```
public final void loadFromImage(Image image)
                         throws TextureCreationException
```
    Attempts to load the texture from a source image.
    
    Parameters:
    image - the source image.
    
    Throws:
    
    TextureCreationException - if the texture could not be loaded from the image.
  - getSize
```
public Vector2i getSize()
```
    Gets the dimensions of the texture.
    
    Specified by:
    
    getSize in interface ConstTexture
    
    Returns:
    the dimensions of the texture.
  - copyToImage
```
public Image copyToImage()
```
    Description copied from interface: ConstTexture
    
    Copies this texture to an editable Image.
    
    Specified by:
    
    copyToImage in interface ConstTexture
    
    Returns:
    the image that contains a coyp of the texure's contents.
  - update
```
public void update(Image image,
          int x,
          int y)
```
    Updates a part of the texture from an image.
    
    Parameters:
    image - the image to update from.
    x - the X offset inside the texture.
    y - the Y offset inside the texture.
  - update
```
public void update(Window window,
          int x,
          int y)
```
    Updates a part of the texture from the contents of a window.
    
    Parameters:
    window - the window to update from.
    x - the X offset inside the texture.
    y - the Y offset inside the texture.
  - update
```
public final void update(Window window)
```
    Updates the texture from the contents of a window.
    
    Parameters:
    window - the window to update from.
  - setSmooth
```
public void setSmooth(boolean smooth)
```
    Enables or disables the smooth filter.
    The smooth filter is disabled by default.
    
    Parameters:
    smooth - true to enable, false to disable.
  - isSmooth
```
public boolean isSmooth()
```
    Description copied from interface: ConstTexture
    
    Checks whether the smooth filter is enabled.
    
    Specified by:
    
    isSmooth in interface ConstTexture
    
    Returns:
    true if enabled, false if disabled.
  - setRepeated
```
public void setRepeated(boolean repeated)
```
    Enables or disables texture repeating.
    Texture repeating is disabled by default.
    
    Parameters:
    repeated - true to enable, false to disable.
  - isRepeated
```
public boolean isRepeated()
```
    Description copied from interface: ConstTexture
    
    Checks whether texture repeating is enabled.
    
    Specified by:
    
    isRepeated in interface ConstTexture
    
    Returns:
    true if enabled, false if disabled.

Class Texture

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class org.jsfml.internal.SFMLNativeObject

Methods inherited from class java.lang.Object

Constructor Detail

Texture

Texture

Method Detail

getMaximumSize

bind

bind

nativeCreate

nativeSetExPtr

nativeDelete

create

loadFromStream

loadFromStream

loadFromFile

loadFromFile

loadFromImage

loadFromImage

getSize

copyToImage

update

update

update

setSmooth

isSmooth

setRepeated

isRepeated