JDK-8117373 : PixelFormat.Type is undocumented.
  • Type: Bug
  • Component: javafx
  • Sub-Component: scenegraph
  • Affected Version: 8
  • Priority: P4
  • Status: Closed
  • Resolution: Duplicate
  • Submitted: 2013-05-31
  • Updated: 2015-06-17
  • Resolved: 2013-08-01
Related Reports
Duplicate :  
JDK-8123813 - PixelFormat not properly documented
Duplicate :  
JDK-8116994 - [DOC] : Enum PixelFormat.Type needs to be documented
Relates :  
JDK-8096637 - PixelFormat class has not documented members
Relates :  
JDK-8101141 - Image Ops
Relates :  
JDK-8102161 - Add @since tag to all API classes
Description
The enum javafx.scene.image.PixelFormat$Type has all values properly documented, but the class-level documentation is missing. The @since generator created a comment with the tag, but some text should be added.
Comments
I had not realized that the missing support for BYTE_INDEXED was unintentional. Thank you for clarifications Jim and for addressing the underlying issues.
01-08-2013
Fixed under the umbrella RT-24343 issue...
01-08-2013
Actually, there is still a bug in the support for WritableImages. The previously mentioned bugs only fix the case of reading a grayscale JPEG and getting a PixelReader from it (which failed due to missing support for BYTE_INDEXED images, but in a different way). The WritableImage bug is tracked under RT-27752 and is still considered a bug, not a documentable "reserved for future use" situation.
01-08-2013
Please don't confuse bugs with documentation. The missing support for BYTE_INDEXED was unintentional, is already fixed, and was never something "to be documented". (The fix for the BYTE_INDEXED bug is integrated and should be in the latest promotions of JDK8.0 since b93 and will appear in the upcoming 2.2.40, part of 7u40.) See RT-30254 and RT-30709 to track the fixes for the BYTE_INDEXED bugs...
01-08-2013
I noticed in testing earlier 2.x releases (not sure if it still applies to 8.x), that PixelFormat.BYTE_INDEXED is defined, however the functionality required to support it in the JavaFX implementation was not implemented. For these kind of things it would be nice to have some kind of javadoc comment like "Currently not applicable, reserved for future use", so that a user knows that the functionality isn't really supported by the platform yet. Background: http://docs.oracle.com/javafx/2/api/javafx/scene/image/PixelFormat.Type.html#BYTE_INDEXED https://forums.oracle.com/message/10884855 "Problem using byte indexed pixel format in setPixels method of PixelWriter" Related issue: RT-27752 "Trouble with PixelWriter using PixelFormat of Type.BYTE_INDEXED"
01-08-2013
This will be handled under the related RT-24343 issue.
01-08-2013