Incorporated TextureIO texture loader (and, eventually, writer) and

associated classes for being able to easily read in and display
textures with OpenGL. Collaboration with Chris Campbell from the
Java2D team. Supports multiple file formats both through ImageIO as
well as custom texture loaders for DDS, SGI and TGA files. Writing of
textures back to disk is not yet implemented. Reading of mipmaps from
files which support it as well as autogeneration of mipmaps are not
yet well supported and usage of mipmap arguments in the API still need
to be rethought. Added TestTexture demo to jogl-demos workspace to
show simple usage.


git-svn-id: file:///usr/local/projects/SUN/JOGL/git-svn/svn-server-sync/jogl/trunk@519 232f8b59-042b-4e1e-8c03-345bb8c30851

1 files changed, 151 insertions, 0 deletions

diff --git a/src/classes/com/sun/opengl/utils/TextureProvider.java b/src/classes/com/sun/opengl/utils/TextureProvider.java
new file mode 100755
index 000000000..4b71ae982
--- /dev/null
+++ b/src/classes/com/sun/opengl/utils/TextureProvider.java
@@ -0,0 +1,151 @@
+/*
+ * Copyright (c) 2005 Sun Microsystems, Inc. All Rights Reserved.
+ * 
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions are
+ * met:
+ * 
+ * - Redistribution of source code must retain the above copyright
+ *   notice, this list of conditions and the following disclaimer.
+ * 
+ * - Redistribution in binary form must reproduce the above copyright
+ *   notice, this list of conditions and the following disclaimer in the
+ *   documentation and/or other materials provided with the distribution.
+ * 
+ * Neither the name of Sun Microsystems, Inc. or the names of
+ * contributors may be used to endorse or promote products derived from
+ * this software without specific prior written permission.
+ * 
+ * This software is provided "AS IS," without a warranty of any kind. ALL
+ * EXPRESS OR IMPLIED CONDITIONS, REPRESENTATIONS AND WARRANTIES,
+ * INCLUDING ANY IMPLIED WARRANTY OF MERCHANTABILITY, FITNESS FOR A
+ * PARTICULAR PURPOSE OR NON-INFRINGEMENT, ARE HEREBY EXCLUDED. SUN
+ * MICROSYSTEMS, INC. ("SUN") AND ITS LICENSORS SHALL NOT BE LIABLE FOR
+ * ANY DAMAGES SUFFERED BY LICENSEE AS A RESULT OF USING, MODIFYING OR
+ * DISTRIBUTING THIS SOFTWARE OR ITS DERIVATIVES. IN NO EVENT WILL SUN OR
+ * ITS LICENSORS BE LIABLE FOR ANY LOST REVENUE, PROFIT OR DATA, OR FOR
+ * DIRECT, INDIRECT, SPECIAL, CONSEQUENTIAL, INCIDENTAL OR PUNITIVE
+ * DAMAGES, HOWEVER CAUSED AND REGARDLESS OF THE THEORY OF LIABILITY,
+ * ARISING OUT OF THE USE OF OR INABILITY TO USE THIS SOFTWARE, EVEN IF
+ * SUN HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.
+ * 
+ * You acknowledge that this software is not designed or intended for use
+ * in the design, construction, operation or maintenance of any nuclear
+ * facility.
+ * 
+ * Sun gratefully acknowledges that this software was originally authored
+ * and developed by Kenneth Bradley Russell and Christopher John Kline.
+ */
+
+package com.sun.opengl.utils;
+
+import java.io.*;
+import java.net.*;
+
+/** Plug-in interface to TextureIO to support reading OpenGL textures
+    from new file formats. For all methods, either internalFormat or
+    pixelFormat may be 0 in which case they must be inferred as
+    e.g. RGB or RGBA depending on the file contents.
+*/
+
+public interface TextureProvider {
+
+  /**
+   * Produces a TextureData object from a file, or returns null if the
+   * file format was not supported by this TextureProvider. Does not
+   * do any OpenGL-related work. The resulting TextureData can be
+   * converted into an OpenGL texture in a later step.
+   *
+   * @param file         the file from which to read the texture data
+   *
+   * @param mipmapLevel  the mipmap level of the resulting texture being
+   *                     read (FIXME: needs rethinking, not yet working)
+   *
+   * @param internalFormat the OpenGL internal format to be used for
+   *                       the texture, or 0 if it should be inferred
+   *                       from the file's contents
+   *
+   * @param pixelFormat    the OpenGL pixel format to be used for
+   *                       the texture, or 0 if it should be inferred
+   *                       from the file's contents
+   *
+   * @param fileSuffix     the file suffix to be used as a hint to the
+   *                       provider to more quickly decide whether it
+   *                       can handle the file, or null if the
+   *                       provider should infer the type from the
+   *                       file's contents
+   *
+   * @throws IOException if an error occurred while reading the file
+   */
+  public TextureData newTextureData(File file,
+                                    int mipmapLevel,
+                                    int internalFormat,
+                                    int pixelFormat,
+                                    String fileSuffix) throws IOException;
+
+  /**
+   * Produces a TextureData object from a stream, or returns null if
+   * the file format was not supported by this TextureProvider. Does
+   * not do any OpenGL-related work. The resulting TextureData can be
+   * converted into an OpenGL texture in a later step.
+   *
+   * @param stream       the stream from which to read the texture data
+   *
+   * @param mipmapLevel  the mipmap level of the resulting texture being
+   *                     read (FIXME: needs rethinking, not yet working)
+   *
+   * @param internalFormat the OpenGL internal format to be used for
+   *                       the texture, or 0 if it should be inferred
+   *                       from the file's contents
+   *
+   * @param pixelFormat    the OpenGL pixel format to be used for
+   *                       the texture, or 0 if it should be inferred
+   *                       from the file's contents
+   *
+   * @param fileSuffix     the file suffix to be used as a hint to the
+   *                       provider to more quickly decide whether it
+   *                       can handle the file, or null if the
+   *                       provider should infer the type from the
+   *                       file's contents
+   *
+   * @throws IOException if an error occurred while reading the stream
+   */
+  public TextureData newTextureData(InputStream stream,
+                                    int mipmapLevel,
+                                    int internalFormat,
+                                    int pixelFormat,
+                                    String fileSuffix) throws IOException;
+
+  /**
+   * Produces a TextureData object from a URL, or returns null if the
+   * file format was not supported by this TextureProvider. Does not
+   * do any OpenGL-related work. The resulting TextureData can be
+   * converted into an OpenGL texture in a later step.
+   *
+   * @param url          the URL from which to read the texture data
+   *
+   * @param mipmapLevel  the mipmap level of the resulting texture being
+   *                     read (FIXME: needs rethinking, not yet working)
+   *
+   * @param internalFormat the OpenGL internal format to be used for
+   *                       the texture, or 0 if it should be inferred
+   *                       from the file's contents
+   *
+   * @param pixelFormat    the OpenGL pixel format to be used for
+   *                       the texture, or 0 if it should be inferred
+   *                       from the file's contents
+   *
+   * @param fileSuffix     the file suffix to be used as a hint to the
+   *                       provider to more quickly decide whether it
+   *                       can handle the file, or null if the
+   *                       provider should infer the type from the
+   *                       file's contents
+   *
+   * @throws IOException if an error occurred while reading the URL
+   */
+  public TextureData newTextureData(URL url,
+                                    int mipmapLevel,
+                                    int internalFormat,
+                                    int pixelFormat,
+                                    String fileSuffix) throws IOException;
+}