path: root/src/jogl/classes/jogamp/opengl/util/glsl/fixedfunc/FixedFuncHook.java

/*
 * Copyright 2009 Sun Microsystems, Inc. All Rights Reserved.
 * Copyright 2010 JogAmp Community. All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without modification, are
 * permitted provided that the following conditions are met:
 *
 *    1. Redistributions of source code must retain the above copyright notice, this list of
 *       conditions and the following disclaimer.
 *
 *    2. Redistributions 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.
 *
 * THIS SOFTWARE IS PROVIDED BY JogAmp Community ``AS IS'' AND ANY EXPRESS OR IMPLIED
 * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
 * FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL JogAmp Community OR
 * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
 * ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
 * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
 * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 *
 * The views and conclusions contained in the software and documentation are those of the
 * authors and should not be interpreted as representing official policies, either expressed
 * or implied, of JogAmp Community.
 */

package jogamp.opengl.util.glsl.fixedfunc;

import java.nio.Buffer;
import java.nio.IntBuffer;

import com.jogamp.opengl.GL;
import com.jogamp.opengl.GL2ES2;
import com.jogamp.opengl.GLArrayData;
import com.jogamp.opengl.GLException;
import com.jogamp.opengl.GLProfile;
import com.jogamp.opengl.fixedfunc.GLLightingFunc;
import com.jogamp.opengl.fixedfunc.GLMatrixFunc;
import com.jogamp.opengl.fixedfunc.GLPointerFunc;

import com.jogamp.common.nio.Buffers;
import com.jogamp.common.util.ValueConv;
import com.jogamp.opengl.util.GLArrayDataWrapper;
import com.jogamp.opengl.util.GLBuffers;
import com.jogamp.opengl.util.PMVMatrix;
import com.jogamp.opengl.util.glsl.fixedfunc.ShaderSelectionMode;

public class FixedFuncHook implements GLLightingFunc, GLMatrixFunc, GLPointerFunc {
    public static final int MAX_TEXTURE_UNITS = 8;

    protected final GLProfile gl2es1GLProfile;
    protected FixedFuncPipeline fixedFunction;
    protected PMVMatrix pmvMatrix;
    protected boolean ownsPMVMatrix;
    protected GL2ES2 gl;

    /**
     * @param gl
     * @param mode TODO
     * @param pmvMatrix optional pass through PMVMatrix for the {@link FixedFuncHook} and {@link FixedFuncPipeline}
     */
    public FixedFuncHook (final GL2ES2 gl, final ShaderSelectionMode mode, final PMVMatrix pmvMatrix) {
        this.gl2es1GLProfile = GLProfile.createCustomGLProfile(GLProfile.GL2ES1, gl.getGLProfile().getImpl());
        this.gl = gl;
        if(null != pmvMatrix) {
            this.ownsPMVMatrix = false;
            this.pmvMatrix = pmvMatrix;
        } else {
            this.ownsPMVMatrix = true;
            this.pmvMatrix = new PMVMatrix();
        }
        fixedFunction = new FixedFuncPipeline(this.gl, mode, this.pmvMatrix);
    }

    /**
     * @param gl
     * @param mode TODO
     * @param pmvMatrix optional pass through PMVMatrix for the {@link FixedFuncHook} and {@link FixedFuncPipeline}
     */
    public FixedFuncHook(final GL2ES2 gl, final ShaderSelectionMode mode, final PMVMatrix pmvMatrix,
                         final Class<?> shaderRootClass, final String shaderSrcRoot, final String shaderBinRoot,
                         final String vertexColorFile, final String vertexColorLightFile,
                         final String fragmentColorFile, final String fragmentColorTextureFile) {
        this.gl2es1GLProfile = GLProfile.createCustomGLProfile(GLProfile.GL2ES1, gl.getGLProfile().getImpl());
        this.gl = gl;
        if(null != pmvMatrix) {
            this.ownsPMVMatrix = false;
            this.pmvMatrix = pmvMatrix;
        } else {
            this.ownsPMVMatrix = true;
            this.pmvMatrix = new PMVMatrix();
        }

        fixedFunction = new FixedFuncPipeline(this.gl, mode, this.pmvMatrix, shaderRootClass, shaderSrcRoot,
                                              shaderBinRoot, vertexColorFile, vertexColorLightFile, fragmentColorFile, fragmentColorTextureFile);
    }

    public boolean verbose() { return fixedFunction.verbose(); }

    public void setVerbose(final boolean v) { fixedFunction.setVerbose(v); }

    public void destroy() {
        fixedFunction.destroy(gl);
        fixedFunction = null;
        pmvMatrix=null;
        gl=null;
    }

    public PMVMatrix getMatrix() { return pmvMatrix; }

    //
    // FixedFuncHookIf - hooks
    //
    public final boolean isGL4core() {
        return false;
    }
    public final boolean isGL3core() {
        return false;
    }
    public final boolean isGLcore() {
        return false;
    }
    public final boolean isGLES2Compatible() {
        return false;
    }
    public final boolean isGLES3Compatible() {
        return false;
    }
    public final GLProfile getGLProfile() {
        return gl2es1GLProfile;
    }
    public void glDrawArrays(final int mode, final int first, final int count) {
        fixedFunction.glDrawArrays(gl, mode, first, count);
    }
    public void glDrawElements(final int mode, final int count, final int type, final java.nio.Buffer indices) {
        fixedFunction.glDrawElements(gl, mode, count, type, indices);
    }
    public void glDrawElements(final int mode, final int count, final int type, final long indices_buffer_offset) {
        fixedFunction.glDrawElements(gl, mode, count, type, indices_buffer_offset);
    }

    public void glActiveTexture(final int texture) {
        fixedFunction.glActiveTexture(texture);
        gl.glActiveTexture(texture);
    }
    public void glEnable(final int cap) {
        if(fixedFunction.glEnable(cap, true)) {
            gl.glEnable(cap);
        }
    }
    public void glDisable(final int cap) {
        if(fixedFunction.glEnable(cap, false)) {
            gl.glDisable(cap);
        }
    }
    @Override
    public void glGetFloatv(final int pname, final java.nio.FloatBuffer params) {
        if(PMVMatrix.isMatrixGetName(pname)) {
            pmvMatrix.glGetFloatv(pname, params);
            return;
        }
        gl.glGetFloatv(pname, params);
    }
    @Override
    public void glGetFloatv(final int pname, final float[] params, final int params_offset) {
        if(PMVMatrix.isMatrixGetName(pname)) {
            pmvMatrix.glGetFloatv(pname, params, params_offset);
            return;
        }
        gl.glGetFloatv(pname, params, params_offset);
    }
    @Override
    public void glGetIntegerv(final int pname, final IntBuffer params) {
        if(PMVMatrix.isMatrixGetName(pname)) {
            pmvMatrix.glGetIntegerv(pname, params);
            return;
        }
        gl.glGetIntegerv(pname, params);
    }
    @Override
    public void glGetIntegerv(final int pname, final int[] params, final int params_offset) {
        if(PMVMatrix.isMatrixGetName(pname)) {
            pmvMatrix.glGetIntegerv(pname, params, params_offset);
            return;
        }
        gl.glGetIntegerv(pname, params, params_offset);
    }

    public void glTexEnvi(final int target, final int pname, final int value) {
        fixedFunction.glTexEnvi(target, pname, value);
    }
    public void glGetTexEnviv(final int target, final int pname,  final IntBuffer params) {
        fixedFunction.glGetTexEnviv(target, pname, params);
    }
    public void glGetTexEnviv(final int target, final int pname,  final int[] params, final int params_offset) {
        fixedFunction.glGetTexEnviv(target, pname, params, params_offset);
    }
    public void glBindTexture(final int target, final int texture) {
        fixedFunction.glBindTexture(target, texture);
        gl.glBindTexture(target, texture);
    }
    public void glTexImage2D(final int target, final int level, int internalformat, final int width, final int height, final int border,
                             final int format, final int type,  final Buffer pixels) {
        // align internalformat w/ format, an ES2 requirement
        switch(internalformat) {
            case 3: internalformat= ( GL.GL_RGBA == format ) ? GL.GL_RGBA : GL.GL_RGB; break;
            case 4: internalformat= ( GL.GL_RGB  == format ) ? GL.GL_RGB  : GL.GL_RGBA; break;
        }
        fixedFunction.glTexImage2D(target, /* level, */ internalformat, /*width, height, border, */ format /*, type, pixels*/);
        gl.glTexImage2D(target, level, internalformat, width, height, border, format, type, pixels);
    }
    public void glTexImage2D(final int target, final int level, int internalformat, final int width, final int height, final int border,
                             final int format, final int type,  final long pixels_buffer_offset) {
        // align internalformat w/ format, an ES2 requirement
        switch(internalformat) {
            case 3: internalformat= ( GL.GL_RGBA == format ) ? GL.GL_RGBA : GL.GL_RGB; break;
            case 4: internalformat= ( GL.GL_RGB  == format ) ? GL.GL_RGB  : GL.GL_RGBA; break;
        }
        fixedFunction.glTexImage2D(target, /* level, */ internalformat, /*width, height, border, */ format /*, type, pixels*/);
        gl.glTexImage2D(target, level, internalformat, width, height, border, format, type, pixels_buffer_offset);
    }

    public void glPointSize(final float size) {
        fixedFunction.glPointSize(size);
    }
    public  void glPointParameterf(final int pname, final float param) {
        fixedFunction.glPointParameterf(pname, param);
    }
    public  void glPointParameterfv(final int pname, final float[] params, final int params_offset) {
        fixedFunction.glPointParameterfv(pname, params, params_offset);
    }
    public  void glPointParameterfv(final int pname, final java.nio.FloatBuffer params) {
        fixedFunction.glPointParameterfv(pname, params);
    }

    //
    // MatrixIf
    //
    public int  glGetMatrixMode() {
        return pmvMatrix.glGetMatrixMode();
    }
    @Override
    public void glMatrixMode(final int mode) {
        pmvMatrix.glMatrixMode(mode);
    }
    @Override
    public void glLoadMatrixf(final java.nio.FloatBuffer m) {
        pmvMatrix.glLoadMatrixf(m);
    }
    @Override
    public void glLoadMatrixf(final float[] m, final int m_offset) {
        glLoadMatrixf(Buffers.newDirectFloatBuffer(m, m_offset));
    }
    @Override
    public void glPopMatrix() {
        pmvMatrix.glPopMatrix();
    }
    @Override
    public void glPushMatrix() {
        pmvMatrix.glPushMatrix();
    }
    @Override
    public void glLoadIdentity() {
        pmvMatrix.glLoadIdentity();
    }
    @Override
    public void glMultMatrixf(final java.nio.FloatBuffer m) {
        pmvMatrix.glMultMatrixf(m);
    }
    @Override
    public void glMultMatrixf(final float[] m, final int m_offset) {
        glMultMatrixf(Buffers.newDirectFloatBuffer(m, m_offset));
    }
    @Override
    public void glTranslatef(final float x, final float y, final float z) {
        pmvMatrix.glTranslatef(x, y, z);
    }
    @Override
    public void glRotatef(final float angdeg, final float x, final float y, final float z) {
        pmvMatrix.glRotatef(angdeg, x, y, z);
    }
    @Override
    public void glScalef(final float x, final float y, final float z) {
        pmvMatrix.glScalef(x, y, z);
    }
    public void glOrtho(final double left, final double right, final double bottom, final double top, final double near_val, final double far_val) {
        glOrthof((float) left, (float) right, (float) bottom, (float) top, (float) near_val, (float) far_val);
    }
    @Override
    public void glOrthof(final float left, final float right, final float bottom, final float top, final float zNear, final float zFar) {
        pmvMatrix.glOrthof(left, right, bottom, top, zNear, zFar);
    }
    public void glFrustum(final double left, final double right, final double bottom, final double top, final double zNear, final double zFar) {
        glFrustumf((float) left, (float) right, (float) bottom, (float) top, (float) zNear, (float) zFar);
    }
    @Override
    public void glFrustumf(final float left, final float right, final float bottom, final float top, final float zNear, final float zFar) {
        pmvMatrix.glFrustumf(left, right, bottom, top, zNear, zFar);
    }

    //
    // LightingIf
    //
    @Override
    public void glColor4f(final float red, final float green, final float blue, final float alpha) {
      fixedFunction.glColor4f(gl, red, green, blue, alpha);
    }

    public  void glColor4ub(final byte red, final byte green, final byte blue, final byte alpha) {
      glColor4f(ValueConv.byte_to_float(red, false),
                ValueConv.byte_to_float(green, false),
                ValueConv.byte_to_float(blue, false),
                ValueConv.byte_to_float(alpha, false) );
    }
    @Override
    public void glLightfv(final int light, final int pname, final java.nio.FloatBuffer params) {
      fixedFunction.glLightfv(gl, light, pname, params);
    }
    @Override
    public void glLightfv(final int light, final int pname, final float[] params, final int params_offset) {
        glLightfv(light, pname, Buffers.newDirectFloatBuffer(params, params_offset));
    }
    @Override
    public void glMaterialfv(final int face, final int pname, final java.nio.FloatBuffer params) {
      fixedFunction.glMaterialfv(gl, face, pname, params);
    }
    @Override
    public void glMaterialfv(final int face, final int pname, final float[] params, final int params_offset) {
        glMaterialfv(face, pname, Buffers.newDirectFloatBuffer(params, params_offset));
    }
    @Override
    public void glMaterialf(final int face, final int pname, final float param) {
        glMaterialfv(face, pname, Buffers.newDirectFloatBuffer(new float[] { param }));
    }

    //
    // Misc Simple States
    //
    @Override
    public void glShadeModel(final int mode) {
      fixedFunction.glShadeModel(gl, mode);
    }
    public  void glAlphaFunc(final int func, final float ref) {
        fixedFunction.glAlphaFunc(func, ref);
    }

    /** ES2 supports CullFace implicit
    public void glCullFace(int faceName) {
        fixedFunction.glCullFace(faceName);
        gl.glCullFace(faceName);
    } */

    //
    // PointerIf
    //
    public void glClientActiveTexture(final int textureUnit) {
      fixedFunction.glClientActiveTexture(textureUnit);
    }
    @Override
    public void glEnableClientState(final int glArrayIndex) {
      fixedFunction.glEnableClientState(gl, glArrayIndex);
    }
    @Override
    public void glDisableClientState(final int glArrayIndex) {
      fixedFunction.glDisableClientState(gl, glArrayIndex);
    }

    @Override
    public void glVertexPointer(final GLArrayData array) {
      if(array.isVBO()) {
          if(!gl.isVBOArrayBound()) {
            throw new GLException("VBO array is not enabled: "+array);
          }
      } else {
          if(gl.isVBOArrayBound()) {
            throw new GLException("VBO array is not disabled: "+array);
          }
          Buffers.rangeCheck(array.getBuffer(), 1);
          if (!Buffers.isDirect(array.getBuffer())) {
            throw new GLException("Argument \"pointer\" was not a direct buffer"); }
      }
      fixedFunction.glVertexPointer(gl, array);
    }

    @Override
    public void glVertexPointer(final int size, final int type, final int stride, final java.nio.Buffer pointer) {
      glVertexPointer(GLArrayDataWrapper.createFixed(GL_VERTEX_ARRAY, size, type, GLBuffers.isGLTypeFixedPoint(type), stride,
                                                     pointer, 0, 0, 0, GL.GL_ARRAY_BUFFER));
    }
    @Override
    public void glVertexPointer(final int size, final int type, final int stride, final long pointer_buffer_offset) {
      final int vboName = gl.getBoundBuffer(GL.GL_ARRAY_BUFFER);
      if(vboName==0) {
        throw new GLException("no GL_ARRAY_BUFFER VBO bound");
      }
      glVertexPointer(GLArrayDataWrapper.createFixed(GL_VERTEX_ARRAY, size, type, GLBuffers.isGLTypeFixedPoint(type), stride,
                                                     null, vboName, pointer_buffer_offset, GL.GL_STATIC_DRAW, GL.GL_ARRAY_BUFFER));
    }

    @Override
    public void glColorPointer(final GLArrayData array) {
      if(array.isVBO()) {
          if(!gl.isVBOArrayBound()) {
            throw new GLException("VBO array is not enabled: "+array);
          }
      } else {
          if(gl.isVBOArrayBound()) {
            throw new GLException("VBO array is not disabled: "+array);
          }
          Buffers.rangeCheck(array.getBuffer(), 1);
          if (!Buffers.isDirect(array.getBuffer())) {
            throw new GLException("Argument \"pointer\" was not a direct buffer"); }
      }
      fixedFunction.glColorPointer(gl, array);
    }
    @Override
    public void glColorPointer(final int size, final int type, final int stride, final java.nio.Buffer pointer) {
      glColorPointer(GLArrayDataWrapper.createFixed(GL_COLOR_ARRAY, size, type, GLBuffers.isGLTypeFixedPoint(type), stride,
                                                    pointer, 0, 0, 0, GL.GL_ARRAY_BUFFER));
    }
    @Override
    public void glColorPointer(final int size, final int type, final int stride, final long pointer_buffer_offset) {
      final int vboName = gl.getBoundBuffer(GL.GL_ARRAY_BUFFER);
      if(vboName==0) {
        throw new GLException("no GL_ARRAY_BUFFER VBO bound");
      }
      glColorPointer(GLArrayDataWrapper.createFixed(GL_COLOR_ARRAY, size, type, GLBuffers.isGLTypeFixedPoint(type), stride,
                                                   null, vboName, pointer_buffer_offset, GL.GL_STATIC_DRAW, GL.GL_ARRAY_BUFFER));
    }

    @Override
    public void glNormalPointer(final GLArrayData array) {
      if(array.getCompsPerElem()!=3) {
        throw new GLException("Only 3 components per normal allowed");
      }
      if(array.isVBO()) {
          if(!gl.isVBOArrayBound()) {
            throw new GLException("VBO array is not enabled: "+array);
          }
      } else {
          if(gl.isVBOArrayBound()) {
            throw new GLException("VBO array is not disabled: "+array);
          }
          Buffers.rangeCheck(array.getBuffer(), 1);
          if (!Buffers.isDirect(array.getBuffer())) {
            throw new GLException("Argument \"pointer\" was not a direct buffer"); }
      }
      fixedFunction.glNormalPointer(gl, array);
    }
    @Override
    public void glNormalPointer(final int type, final int stride, final java.nio.Buffer pointer) {
      glNormalPointer(GLArrayDataWrapper.createFixed(GL_NORMAL_ARRAY, 3, type, GLBuffers.isGLTypeFixedPoint(type), stride,
                                                     pointer, 0, 0, 0, GL.GL_ARRAY_BUFFER));
    }
    @Override
    public void glNormalPointer(final int type, final int stride, final long pointer_buffer_offset) {
      final int vboName = gl.getBoundBuffer(GL.GL_ARRAY_BUFFER);
      if(vboName==0) {
        throw new GLException("no GL_ARRAY_BUFFER VBO bound");
      }
      glNormalPointer(GLArrayDataWrapper.createFixed(GL_NORMAL_ARRAY, 3, type, GLBuffers.isGLTypeFixedPoint(type), stride,
                                                     null, vboName, pointer_buffer_offset, GL.GL_STATIC_DRAW, GL.GL_ARRAY_BUFFER));
    }

    @Override
    public void glTexCoordPointer(final GLArrayData array) {
      if(array.isVBO()) {
          if(!gl.isVBOArrayBound()) {
            throw new GLException("VBO array is not enabled: "+array);
          }
      } else {
          if(gl.isVBOArrayBound()) {
            throw new GLException("VBO array is not disabled: "+array);
          }
          Buffers.rangeCheck(array.getBuffer(), 1);
          if (!Buffers.isDirect(array.getBuffer())) {
            throw new GLException("Argument \"pointer\" was not a direct buffer"); }
      }
      fixedFunction.glTexCoordPointer(gl, array);
    }
    @Override
    public void glTexCoordPointer(final int size, final int type, final int stride, final java.nio.Buffer pointer) {
      glTexCoordPointer(
        GLArrayDataWrapper.createFixed(GL_TEXTURE_COORD_ARRAY, size, type, GLBuffers.isGLTypeFixedPoint(type), stride,
                                       pointer, 0, 0, 0, GL.GL_ARRAY_BUFFER));
    }
    @Override
    public void glTexCoordPointer(final int size, final int type, final int stride, final long pointer_buffer_offset) {
      final int vboName = gl.getBoundBuffer(GL.GL_ARRAY_BUFFER);
      if(vboName==0) {
        throw new GLException("no GL_ARRAY_BUFFER VBO bound");
      }
      glTexCoordPointer(
        GLArrayDataWrapper.createFixed(GL_TEXTURE_COORD_ARRAY, size, type, GLBuffers.isGLTypeFixedPoint(type), stride,
                                       null, vboName, pointer_buffer_offset, GL.GL_STATIC_DRAW, GL.GL_ARRAY_BUFFER) );
    }

    @Override
    public final String toString() {
          final StringBuilder buf = new StringBuilder();
          buf.append(getClass().getName()+" (");
          if(null!=pmvMatrix) {
              buf.append(", matrixDirty: "+ (0 != pmvMatrix.getModifiedBits(false)));
          }
          buf.append("\n\t, FixedFunction: "+fixedFunction);
          buf.append(gl);
          buf.append(" )");

          return buf.toString();
    }

}