MultiTexture (openjfx 8.0.202 API)

java.lang.Object
- com.sun.prism.MultiTexture

All Implemented Interfaces:

GraphicsResource, Texture
```
public final class MultiTexture
extends Object
implements Texture
```
A "texture" that wraps a list of sub-textures and values needed for multitexturing.

Nested Class Summary
- Nested classes/interfaces inherited from interface com.sun.prism.Texture
  Texture.Usage, Texture.WrapMode

Constructor Summary

Constructors
Constructor and Description

MultiTexture(PixelFormat format, Texture.WrapMode wrapMode, int width, int height)

Constructors
Constructor and Description
`MultiTexture(PixelFormat format, Texture.WrapMode wrapMode, int width, int height)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`assertLocked()`
`void`	`contentsNotUseful()`
`void`	`contentsUseful()`
`void`	`dispose()`
`int`	`getContentHeight()` Returns the content height of this texture, in pixels.
`int`	`getContentWidth()` Returns the content width of this texture, in pixels.
`int`	`getContentX()` Returns the content x-origin of this texture relative to the upper-left corner, in pixels.
`int`	`getContentY()` Returns the content y-origin of this texture relative to the upper-left corner, in pixels.
`int`	`getLastImageSerial()`
`boolean`	`getLinearFiltering()` Returns whether linear (smooth) filtering will be used when rendering this texture.
`int`	`getLockCount()`
`int`	`getMaxContentHeight()` Returns the max content height of this texture, in pixels.
`int`	`getMaxContentWidth()` Returns the max content width of this texture, in pixels.
`int`	`getPhysicalHeight()` Returns the physical height of this texture, in pixels.
`int`	`getPhysicalWidth()` Returns the physical width of this texture, in pixels.
`PixelFormat`	`getPixelFormat()` Returns the `PixelFormat` of this texture.
`Texture`	`getSharedTexture(Texture.WrapMode altMode)` Constructs an alternate version of this `Texture` with an alternate WrapMode if the two modes allow the underlying texture to be shared, otherwise a null value is returned.
`Texture`	`getTexture(int index)`
`Texture[]`	`getTextures()`
`boolean`	`getUseMipmap()` Returns the true if mipmapping is used for this texture.
`Texture.WrapMode`	`getWrapMode()` Returns the `WrapMode` for this texture.
`boolean`	`isLocked()`
`boolean`	`isSurfaceLost()` Called by code wanting to know if the RTTexture's surface is lost.
`void`	`lock()`
`void`	`makePermanent()`
`void`	`removeTexture(int index)`
`void`	`removeTexture(Texture tex)`
`void`	`setContentHeight(int contentHeight)` Allows the content height, which is the current height of the actual content in pixels, to be adjusted.
`void`	`setContentWidth(int contentWidth)` Allows the content width, which is the current width of the actual content in pixels, to be adjusted.
`void`	`setLastImageSerial(int serial)`
`void`	`setLinearFiltering(boolean linear)` Sets whether linear filtering will be used when rendering this texture.
`void`	`setTexture(Texture tex, int index)`
`int`	`textureCount()`
`void`	`unlock()`
`void`	`update(Buffer buffer, PixelFormat format, int dstx, int dsty, int srcx, int srcy, int srcw, int srch, int srcscan, boolean skipFlush)` Updates this texture using the contents of the given `Buffer`.
`void`	`update(Image img)` Updates this texture using the contents of the given `Image`.
`void`	`update(Image img, int dstx, int dsty)` Updates this texture using the contents of the given `Image`.
`void`	`update(Image img, int dstx, int dsty, int srcw, int srch)` Updates this texture using the contents of the given `Image`.
`void`	`update(Image img, int dstx, int dsty, int srcw, int srch, boolean skipFlush)` Updates this texture using the contents of the given `Image`.
`void`	`update(MediaFrame frame, boolean skipFlush)` Updates this texture using the contents of the provided `MediaFrame`.

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

- Constructor Detail
  - MultiTexture
```
public MultiTexture(PixelFormat format,
                    Texture.WrapMode wrapMode,
                    int width,
                    int height)
```
- Method Detail
  - getSharedTexture
```
public Texture getSharedTexture(Texture.WrapMode altMode)
```
    Description copied from interface: Texture
    
    Constructs an alternate version of this Texture with an alternate WrapMode if the two modes allow the underlying texture to be shared, otherwise a null value is returned. This method can only be used to create a shared texture for REPEAT or CLAMP_TO_EDGE textures, which must necessarily have content that spans their entire physical dimensions (if their content was smaller then they would have a _SIMULATED type of wrap mode). This method expects the texture to be already locked (and checked for a valid surface) and if it returns a non-null value then that return value will have an outstanding lock in addition to retaining the lock on the original texture. Note that if the requested WrapMode is the same as the wrap mode of this texture, then this same object will be returned after having its lock count increased by 1. Thus, in all cases, the caller is responsible for locking this texture before the call, and eventually unlocking this texture after the call, and also for eventually unlocking the return value if it is non-null.
    
    Specified by:
    
    getSharedTexture in interface Texture
  - textureCount
```
public int textureCount()
```
  - setTexture
```
public void setTexture(Texture tex,
                       int index)
```
  - getTexture
```
public Texture getTexture(int index)
```
  - getTextures
```
public Texture[] getTextures()
```
  - removeTexture
```
public void removeTexture(Texture tex)
```
  - removeTexture
```
public void removeTexture(int index)
```
  - getPixelFormat
```
public PixelFormat getPixelFormat()
```
    Description copied from interface: Texture
    
    Returns the PixelFormat of this texture.
    
    Specified by:
    
    getPixelFormat in interface Texture
    
    Returns:
    
    the PixelFormat of this texture
  - getPhysicalWidth
```
public int getPhysicalWidth()
```
    Description copied from interface: Texture
    
    Returns the physical width of this texture, in pixels. Note that the physical size of a texture may be larger than the requested size due to hardware restrictions (e.g. lack of non-power-of-two texture support). The physical width will be greater than or equal to the content width.
    
    Specified by:
    
    getPhysicalWidth in interface Texture
    
    Returns:
    
    the physical width of this texture, in pixels
  - getPhysicalHeight
```
public int getPhysicalHeight()
```
    Description copied from interface: Texture
    
    Returns the physical height of this texture, in pixels. Note that the physical size of a texture may be larger than the requested size due to hardware restrictions (e.g. lack of non-power-of-two texture support). The physical height will be greater than or equal to the content height.
    
    Specified by:
    
    getPhysicalHeight in interface Texture
    
    Returns:
    
    the physical height of this texture, in pixels
  - getContentX
```
public int getContentX()
```
    Description copied from interface: Texture
    
    Returns the content x-origin of this texture relative to the upper-left corner, in pixels. This value will be greater than equal to zero.
    
    Specified by:
    
    getContentX in interface Texture
    
    Returns:
    
    the content x-origin of this texture
  - getContentY
```
public int getContentY()
```
    Description copied from interface: Texture
    
    Returns the content y-origin of this texture relative to the upper-left corner, in pixels. This value will be greater than equal to zero.
    
    Specified by:
    
    getContentY in interface Texture
    
    Returns:
    
    the content y-origin of this texture
  - getContentWidth
```
public int getContentWidth()
```
    Description copied from interface: Texture
    
    Returns the content width of this texture, in pixels. Note that the content size of a texture may be smaller than the requested size due to hardware restrictions (e.g. lack of non-power-of-two texture support). The content width will be less than or equal to the content width.
    For example, if the hardware does not support non-power-of-two textures, and you call ResourceFactory.createTexture(400, 200), the returned Texture will have physical dimensions of 512x256, but the content dimensions will be 400x200.
    
    Specified by:
    
    getContentWidth in interface Texture
    
    Returns:
    
    the content width of this texture, in pixels
  - getContentHeight
```
public int getContentHeight()
```
    Description copied from interface: Texture
    
    Returns the content height of this texture, in pixels. Note that the content size of a texture may be smaller than the requested size due to hardware restrictions (e.g. lack of non-power-of-two texture support). The content height will be less than or equal to the content height.
    For example, if the hardware does not support non-power-of-two textures, and you call ResourceFactory.createTexture(400, 200), the returned Texture will have physical dimensions of 512x256, but the content dimensions will be 400x200.
    
    Specified by:
    
    getContentHeight in interface Texture
    
    Returns:
    
    the content height of this texture, in pixels
  - getLastImageSerial
```
public int getLastImageSerial()
```
    Specified by:
    
    getLastImageSerial in interface Texture
  - setLastImageSerial
```
public void setLastImageSerial(int serial)
```
    Specified by:
    
    setLastImageSerial in interface Texture
  - update
```
public void update(Image img)
```
    Description copied from interface: Texture
    Updates this texture using the contents of the given Image. The upper-left corner of the image data will be positioned at (contentX, contentY) of the texture, and the full width and height of the image will be uploaded. This method will cause the vertex buffer to be flushed prior to uploading the pixels.
    This is equivalent to calling:
```
     update(img, 0, 0);
 
```
    Specified by:
    
    update in interface Texture
    
    Parameters:
    
    img - the image data to be uploaded to this texture
  - update
```
public void update(Image img,
                   int dstx,
                   int dsty)
```
    Description copied from interface: Texture
    Updates this texture using the contents of the given Image. The upper-left corner of the image data will be positioned at (contentX+dstx, contentY+dsty) of the texture, and the full width and height of the image will be uploaded. This method will cause the vertex buffer to be flushed prior to uploading the pixels.
    This is equivalent to calling:
```
     update(img, dstx, dsty, img.getWidth(), img.getHeight());
 
```
    Specified by:
    
    update in interface Texture
    
    Parameters:
    
    img - the image data to be uploaded to this texture
    
    dstx - the x-offset of the image data, in pixels, relative to the contentX of this texture
    
    dsty - the y-offset of the image data, in pixels, relative to the contentY of this texture
  - update
```
public void update(Image img,
                   int dstx,
                   int dsty,
                   int srcw,
                   int srch)
```
    Description copied from interface: Texture
    Updates this texture using the contents of the given Image. The upper-left corner of the image data will be positioned at (contentX+dstx, contentY+dsty) of the texture, and the source region to be uploaded will be srcw by srch pixels. This method will cause the vertex buffer to be flushed prior to uploading the pixels.
    This is equivalent to calling:
```
     update(img, dstx, dsty, srcw, srch, false);
 
```
    Specified by:
    
    update in interface Texture
    
    Parameters:
    
    img - the image data to be uploaded to this texture
    
    dstx - the x-offset of the image data, in pixels, relative to the contentX of this texture
    
    dsty - the y-offset of the image data, in pixels, relative to the contentY of this texture
    
    srcw - the width of the pixel region from the source image
    
    srch - the height of the pixel region from the source image
  - update
```
public void update(Image img,
                   int dstx,
                   int dsty,
                   int srcw,
                   int srch,
                   boolean skipFlush)
```
    Description copied from interface: Texture
    Updates this texture using the contents of the given Image. The upper-left corner of the image data will be positioned at (contentX+dstx, contentY+dsty) of the texture, and the source region to be uploaded will be srcw by srch pixels. This method will cause the vertex buffer to be flushed unless skipFlush is true.
    This is equivalent to calling:
```
     update(img.getPixelBuffer(), img.getPixelFormat(),
            dstx, dsty, img.getMinX(), img.getMinY(),
            srcw, srch, img.getScanlineStride(), skipFlush);
 
```
    Specified by:
    
    update in interface Texture
    
    Parameters:
    
    img - the image data to be uploaded to this texture
    
    dstx - the x-offset of the image data, in pixels, relative to the contentX of this texture
    
    dsty - the y-offset of the image data, in pixels, relative to the contentY of this texture
    
    srcw - the width of the pixel region from the source image
    
    srch - the height of the pixel region from the source image
    
    skipFlush - if true, the vertex buffer will not be flushed
  - update
```
public void update(Buffer buffer,
                   PixelFormat format,
                   int dstx,
                   int dsty,
                   int srcx,
                   int srcy,
                   int srcw,
                   int srch,
                   int srcscan,
                   boolean skipFlush)
```
    Description copied from interface: Texture
    
    Updates this texture using the contents of the given Buffer. The upper-left corner of the image data will be positioned at (contentX+dstx, contentY+dsty) of the texture, and the source region to be uploaded will be srcw by srch pixels. This method will cause the vertex buffer to be flushed unless skipFlush is true.
    
    Specified by:
    
    update in interface Texture
    
    format - the format of the data contained in the pixel buffer
    
    dstx - the x-offset of the image data, in pixels, relative to the contentX of this texture
    
    dsty - the y-offset of the image data, in pixels, relative to the contentY of this texture
    
    srcx - the x-offset into the source buffer, in pixels
    
    srcy - the y-offset into the source buffer, in pixels
    
    srcw - the width of the pixel region from the source buffer
    
    srch - the height of the pixel region from the source buffer
    
    srcscan - the scanline stride of the source buffer, in bytes
    
    skipFlush - if true, the vertex buffer will not be flushed
  - update
```
public void update(MediaFrame frame,
                   boolean skipFlush)
```
    Description copied from interface: Texture
    
    Updates this texture using the contents of the provided MediaFrame. The source and destination coordinates are implicit, you can only update the entire video texture.
    
    Specified by:
    
    update in interface Texture
    
    Parameters:
    
    frame - the source video buffer to update the texture data from
    
    skipFlush - if true, the vertex buffer will not be flushed
  - getWrapMode
```
public Texture.WrapMode getWrapMode()
```
    Description copied from interface: Texture
    
    Returns the WrapMode for this texture.
    
    Specified by:
    
    getWrapMode in interface Texture
    
    Returns:
    
    the WrapMode for this texture
  - getUseMipmap
```
public boolean getUseMipmap()
```
    Description copied from interface: Texture
    
    Returns the true if mipmapping is used for this texture.
    
    Specified by:
    
    getUseMipmap in interface Texture
    
    Returns:
    
    the useMipmap flag for this texture
  - getLinearFiltering
```
public boolean getLinearFiltering()
```
    Description copied from interface: Texture
    
    Returns whether linear (smooth) filtering will be used when rendering this texture. If false, a simple nearest neighbor algorithm will be used.
    
    Specified by:
    
    getLinearFiltering in interface Texture
    
    Returns:
    
    whether linear filtering will be used for this texture
  - setLinearFiltering
```
public void setLinearFiltering(boolean linear)
```
    Description copied from interface: Texture
    
    Sets whether linear filtering will be used when rendering this texture.
    
    Specified by:
    
    setLinearFiltering in interface Texture
    
    Parameters:
    
    linear - if true, enables linear filtering; if false, enables nearest neighbor filtering
  - lock
```
public void lock()
```
    Specified by:
    
    lock in interface Texture
  - unlock
```
public void unlock()
```
    Specified by:
    
    unlock in interface Texture
  - isLocked
```
public boolean isLocked()
```
    Specified by:
    
    isLocked in interface Texture
  - getLockCount
```
public int getLockCount()
```
    Specified by:
    
    getLockCount in interface Texture
  - assertLocked
```
public void assertLocked()
```
    Specified by:
    
    assertLocked in interface Texture
  - makePermanent
```
public void makePermanent()
```
    Specified by:
    
    makePermanent in interface Texture
  - contentsUseful
```
public void contentsUseful()
```
    Specified by:
    
    contentsUseful in interface Texture
  - contentsNotUseful
```
public void contentsNotUseful()
```
    Specified by:
    
    contentsNotUseful in interface Texture
  - isSurfaceLost
```
public boolean isSurfaceLost()
```
    Description copied from interface: Texture
    
    Called by code wanting to know if the RTTexture's surface is lost. This happens in some cases (mostly on Windows) when, for example, the user presses Ctrl+Alt+Delete, or the system goes to sleep.
    
    Specified by:
    
    isSurfaceLost in interface Texture
    
    Returns:
    
    True if the backing surface of this RTTexture is gone and the image is therefore no longer usable. False if it is still OK.
  - dispose
```
public void dispose()
```
    Specified by:
    
    dispose in interface GraphicsResource
  - getMaxContentWidth
```
public int getMaxContentWidth()
```
    Description copied from interface: Texture
    
    Returns the max content width of this texture, in pixels. Note that the content size of a texture may be smaller than the requested size due to hardware restrictions (e.g. lack of non-power-of-two texture support). The content width will be less than or equal to the max content width.
    For example, if the hardware does not support non-power-of-two textures, and you call ResourceFactory.createTexture(400, 200), the returned Texture will have physical dimensions of 512x256 and the max content dimensions will be 512x256 minus any padding needed by the implementation to simulate edge conditions., but the content dimensions will be 400x200.
    
    Specified by:
    
    getMaxContentWidth in interface Texture
    
    Returns:
    
    the max content width of this texture, in pixels
  - getMaxContentHeight
```
public int getMaxContentHeight()
```
    Description copied from interface: Texture
    
    Returns the max content height of this texture, in pixels. Note that the content size of a texture may be smaller than the requested size due to hardware restrictions (e.g. lack of non-power-of-two texture support). The content height will be less than or equal to the max content height.
    For example, if the hardware does not support non-power-of-two textures, and you call ResourceFactory.createTexture(400, 200), the returned Texture will have physical dimensions of 512x256 and the max content dimensions will be 512x256 minus any padding needed by the implementation to simulate edge conditions., but the content dimensions will be 400x200.
    
    Specified by:
    
    getMaxContentHeight in interface Texture
    
    Returns:
    
    the max content height of this texture, in pixels
  - setContentWidth
```
public void setContentWidth(int contentWidth)
```
    Description copied from interface: Texture
    
    Allows the content width, which is the current width of the actual content in pixels, to be adjusted. The height must be between 0 and maxContentHeight
    
    Specified by:
    
    setContentWidth in interface Texture
    
    Parameters:
    
    contentWidth - The actual new width of user pixels.
  - setContentHeight
```
public void setContentHeight(int contentHeight)
```
    Description copied from interface: Texture
    
    Allows the content height, which is the current height of the actual content in pixels, to be adjusted. The height must be between 0 and maxContentHeight . *
    
    Specified by:
    
    setContentHeight in interface Texture
    
    Parameters:
    
    contentHeight - The actual new height of user pixels.

Class MultiTexture

Nested Class Summary

Nested classes/interfaces inherited from interface com.sun.prism.Texture

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

MultiTexture

Method Detail

getSharedTexture

textureCount

setTexture

getTexture

getTextures

removeTexture

removeTexture

getPixelFormat

getPhysicalWidth

getPhysicalHeight

getContentX

getContentY

getContentWidth

getContentHeight

getLastImageSerial

setLastImageSerial

update

update

update

update

update

update

getWrapMode

getUseMipmap

getLinearFiltering

setLinearFiltering

lock

unlock

isLocked

getLockCount

assertLocked

makePermanent

contentsUseful

contentsNotUseful

isSurfaceLost

dispose

getMaxContentWidth

getMaxContentHeight

setContentWidth

setContentHeight