Method SummaryModifier and TypeMethodDescription
intReturns the pixel height of the underlying image.Retrieve the color at the given coordinate.
getWidth()Returns the pixel width of the underlying image.
voidSets the pixel at the given coordinate to the given color.
(Image image, int slice, int mipMapLevel, boolean convertToLinear)
setSlicepublic void setSlice
getWidthpublic int getWidth()Returns the pixel width of the underlying image.
getHeightpublic int getHeight()Returns the pixel height of the underlying image.
setPixelpublic void setPixel
(int x, int y, ColorRGBA color)Sets the pixel at the given coordinate to the given color.
For all integer based formats (those not ending in "F"), the color is first clamped to 0.0 - 1.0 before converting it to an integer to avoid overflow. For floating point based formats, components larger than 1.0 can be represented, but components lower than 0.0 are still not allowed (as all formats are unsigned).
If the underlying format is grayscale (e.g. one of the luminance formats, such as
Image.Format.Luminance8) then a color to grayscale conversion is done first, before writing the result into the image.
If the image lacks some components (such as alpha, or any of the color components), then these components will be ignored. The only exception to this is luminance formats for which the color is converted to luminance first (see above).
After writing the color, the image shall be marked as requiring an update. The next time it is used for rendering, all pixel changes will be reflected when the image is rendered.
getPixelRetrieve the color at the given coordinate.
Any components that are not defined in the image format will be set to 1.0 in the returned color. For example, reading from an
Image.Format.Alpha8format will return a ColorRGBA with the R, G, and B components set to 1.0, and the A component set to the alpha in the image.
For grayscale or luminance formats, the luminance value is replicated in the R, G, and B components.
Integer formats are converted to the range 0.0 - 1.0, based on the maximum possible integer value that can be represented by the number of bits the component has. For example, the
Image.Format.RGB5A1format can contain the integer values 0 - 31, a conversion to floating point is done by diving the integer value by 31 (done with floating point precision).
- Specified by:
x- The x coordinate, from 0 to width - 1.
y- The y coordinate, from 0 to height - 1.
store- Storage location for the read color, if
null, then a new ColorRGBA is created and returned with the read color.
- The store parameter, if it is null, then a new ColorRGBA with the read color.