com.sun.prism

Enum Texture.WrapMode

java.lang.Object

java.lang.Enum<Texture.WrapMode>

com.sun.prism.Texture.WrapMode

All Implemented Interfaces:

Serializable, Comparable<Texture.WrapMode>

Enclosing interface:

Texture

public static enum Texture.WrapMode
extends Enum<Texture.WrapMode>

Specifies the behavior when texels are accessed outside the physical bounds of the texture.

Enum Constant Summary

Enum Constants

Enum Constant and Description
CLAMP_NOT_NEEDED CLAMP_NOT_NEEDED is used for applications where the caller knows that the texture will never be sampled outside the center of the first and last pixels in the content area of the texture.
CLAMP_TO_EDGE CLAMP_TO_EDGE is used for applications where the area outside of the defined pixels should be clamped to the value of (the center of) the edge pixels.
CLAMP_TO_EDGE_SIMULATED This value can be returned from the Texture.getWrapMode() method if the caller asked for CLAMP_TO_EDGE and the mode was not supported by the hardware (due to the content area not fitting tightly into the physical dimensions along one or both axes).
CLAMP_TO_ZERO CLAMP_TO_ZERO is used for applications where the area outside of the defined pixels should interpolate from the edge pixel values at the center of those edge pixels to fully transparent at the center of the pixels just outside the content area, and then remain fully transparent out to +/- infinity.
CLAMP_TO_ZERO_SIMULATED This value can be returned from the Texture.getWrapMode() method if the caller asked for CLAMP_TO_ZERO and the mode was not supported by the hardware (via GL_CLAMP_TO_BORDER for instance) so a guard row of transparent pixels was included surrounding all 4 sides of the content area.
REPEAT REPEAT is used for applications where the pixels should be repeated from edge to edge as per the GL_REPEAT mode.
REPEAT_SIMULATED This value can be returned from the Texture.getWrapMode() method if the caller asked for REPEAT and the mode was not supported by the hardware (due to the content area not fitting tightly into the physical dimensions along one or both axes).

Method Summary

Modifier and Type	Method and Description
boolean	isCompatibleWith(Texture.WrapMode requestedMode)
Texture.WrapMode	simulatedVersion()
static Texture.WrapMode	valueOf(String name) Returns the enum constant of this type with the specified name.
static Texture.WrapMode[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

CLAMP_NOT_NEEDED

public static final Texture.WrapMode CLAMP_NOT_NEEDED

CLAMP_NOT_NEEDED is used for applications where the caller knows that the texture will never be sampled outside the center of the first and last pixels in the content area of the texture. For this mode the fitting of the pixels to the physical area and the hardware wrapping or clamping modes will not come into play. The most typical case for this is a back buffer or device-pixel cache where the texture will always be rendered 1:1 on top of pixels in the destination, but any case where the caller knows that the samples will be limited to the "safe area" as described can use this mode.

CLAMP_TO_ZERO

public static final Texture.WrapMode CLAMP_TO_ZERO

CLAMP_TO_ZERO is used for applications where the area outside of the defined pixels should interpolate from the edge pixel values at the center of those edge pixels to fully transparent at the center of the pixels just outside the content area, and then remain fully transparent out to +/- infinity. The most common uses will be cached renderings that might be stretched, scaled, rotated, or otherwise be subjected to situations where samples may be taken outside the "safe area" as described for the CLAMP_NOT_NEEDED mode and those samples should fade to zero (for instance, effect inputs and results).

CLAMP_TO_EDGE

public static final Texture.WrapMode CLAMP_TO_EDGE

CLAMP_TO_EDGE is used for applications where the area outside of the defined pixels should be clamped to the value of (the center of) the edge pixels. This is commonly used for rendering images in an ImageView or for storing the colors of a NO_CYCLE gradient.

REPEAT

public static final Texture.WrapMode REPEAT

REPEAT is used for applications where the pixels should be repeated from edge to edge as per the GL_REPEAT mode. This is typically used for ImagePattern, though it could be used for REPEAT or REFLECT gradients with a properly initialized color texture and with the caveat that the GL_REPEAT type of math does not exactly match the Gradient REPEAT/REFLECT math.

CLAMP_TO_ZERO_SIMULATED

public static final Texture.WrapMode CLAMP_TO_ZERO_SIMULATED

This value can be returned from the Texture.getWrapMode() method if the caller asked for CLAMP_TO_ZERO and the mode was not supported by the hardware (via GL_CLAMP_TO_BORDER for instance) so a guard row of transparent pixels was included surrounding all 4 sides of the content area. The content coordinates will indicate the proper region to render just the "true" content of the texture, but samples outside of that area should accurately return fully transparent pixels if they are included in the sampled areas.

CLAMP_TO_EDGE_SIMULATED

public static final Texture.WrapMode CLAMP_TO_EDGE_SIMULATED

This value can be returned from the Texture.getWrapMode() method if the caller asked for CLAMP_TO_EDGE and the mode was not supported by the hardware (due to the content area not fitting tightly into the physical dimensions along one or both axes). The resulting content will be packed tightly into the upper left corner of the resulting texture and a copy of the last row and column of pixels will be duplicated so that the samples from 0,0 to the content width and height will all return the correctly clamped values, however sampling more than half a pixel past the content width and height will not necessarily return clamped values. If the application needs the clamped values to be returned out to +infinity on either the X or Y axis, then it should make alternate arrangements to ensure that the data is fully padded to the physical dimensions of the texture (currently only needed to support NO_CYCLE gradients and the Rectangle Wrap texture, both of which adjust for this limitation).

REPEAT_SIMULATED

public static final Texture.WrapMode REPEAT_SIMULATED

This value can be returned from the Texture.getWrapMode() method if the caller asked for REPEAT and the mode was not supported by the hardware (due to the content area not fitting tightly into the physical dimensions along one or both axes). The resulting content will be packed tightly into the upper left corner of the resulting texture and a copy of the first row and column of pixels will be duplicated and placed after the last row and column so that samples from between the center of the last row and column of pixels to the center of the next row or column after that will interpolate back to the left or top edge of the image. The application should shift the texture coordinates and restrict their access to texture coordinates in the range [HALF_TEXEL, content_size+HALF_TEXEL] which will represent exactly one whole cell of the infinite field of repeating copies of the image, though shifted by half a texel in position.

Method Detail

values

public static Texture.WrapMode[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (Texture.WrapMode c : Texture.WrapMode.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static Texture.WrapMode valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

simulatedVersion

public Texture.WrapMode simulatedVersion()

isCompatibleWith

public boolean isCompatibleWith(Texture.WrapMode requestedMode)