org.lwjgl.opengl.ARBTransposeMatrix Maven / Gradle / Ivy

/*
 * Copyright LWJGL. All rights reserved.
 * License terms: https://www.lwjgl.org/license
 * MACHINE GENERATED FILE, DO NOT EDIT
 */
package org.lwjgl.opengl;

import java.nio.*;

import static org.lwjgl.system.Checks.*;
import static org.lwjgl.system.JNI.*;
import static org.lwjgl.system.MemoryUtil.*;

/**
 * Native bindings to the ARB_transpose_matrix extension.
 * 
 * New functions and tokens are added allowing application matrices stored in row major order rather than column major order to be transferred to the
 * OpenGL implementation. This allows an application to use standard C-language 2-dimensional arrays ({@code m[row][col]}) and have the array indices match the
 * expected matrix row and column indexes. These arrays are referred to as transpose matrices since they are the transpose of the standard matrices passed
 * to OpenGL.
 * 
 * This extension adds an interface for transfering data to and from the OpenGL pipeline, it does not change any OpenGL processing or imply any changes in
 * state representation.
 * 
 * Promoted to core in {@link GL13 OpenGL 1.3}.
 */
public class ARBTransposeMatrix {

    /** Accepted by the {@code pname} parameter of GetBooleanv, GetIntegerv, GetFloatv, and GetDoublev. */
    public static final int
        GL_TRANSPOSE_MODELVIEW_MATRIX_ARB  = 0x84E3,
        GL_TRANSPOSE_PROJECTION_MATRIX_ARB = 0x84E4,
        GL_TRANSPOSE_TEXTURE_MATRIX_ARB    = 0x84E5,
        GL_TRANSPOSE_COLOR_MATRIX_ARB      = 0x84E6;

    static { GL.initialize(); }

    protected ARBTransposeMatrix() {
        throw new UnsupportedOperationException();
    }

    static boolean isAvailable(GLCapabilities caps) {
        return checkFunctions(
            caps.glLoadTransposeMatrixfARB, caps.glLoadTransposeMatrixdARB, caps.glMultTransposeMatrixfARB, caps.glMultTransposeMatrixdARB
        );
    }

    // --- [ glLoadTransposeMatrixfARB ] ---

    /** Unsafe version of: {@link #glLoadTransposeMatrixfARB LoadTransposeMatrixfARB} */
    public static native void nglLoadTransposeMatrixfARB(long m);

    /**
     * Sets the current matrix to a 4 × 4 matrix in row-major order.
     * 
     * The matrix is stored as 16 consecutive values, i.e. as:
     * 
     * 
     * 
     * 
     * 
     * 
     * a1 a2 a3 a4
a5 a6 a7 a8
a9 a10 a11 a12
a13 a14 a15 a16
     *
     * @param m the matrix data
     */
    public static void glLoadTransposeMatrixfARB(FloatBuffer m) {
        if (CHECKS) {
            check(m, 16);
        }
        nglLoadTransposeMatrixfARB(memAddress(m));
    }

    // --- [ glLoadTransposeMatrixdARB ] ---

    /** Unsafe version of: {@link #glLoadTransposeMatrixdARB LoadTransposeMatrixdARB} */
    public static native void nglLoadTransposeMatrixdARB(long m);

    /**
     * Double version of {@link #glLoadTransposeMatrixfARB LoadTransposeMatrixfARB}.
     *
     * @param m the matrix data
     */
    public static void glLoadTransposeMatrixdARB(DoubleBuffer m) {
        if (CHECKS) {
            check(m, 16);
        }
        nglLoadTransposeMatrixdARB(memAddress(m));
    }

    // --- [ glMultTransposeMatrixfARB ] ---

    /** Unsafe version of: {@link #glMultTransposeMatrixfARB MultTransposeMatrixfARB} */
    public static native void nglMultTransposeMatrixfARB(long m);

    /**
     * Multiplies the current matrix with a 4 × 4 matrix in row-major order. See {@link #glLoadTransposeMatrixfARB LoadTransposeMatrixfARB} for details.
     *
     * @param m the matrix data
     */
    public static void glMultTransposeMatrixfARB(FloatBuffer m) {
        if (CHECKS) {
            check(m, 16);
        }
        nglMultTransposeMatrixfARB(memAddress(m));
    }

    // --- [ glMultTransposeMatrixdARB ] ---

    /** Unsafe version of: {@link #glMultTransposeMatrixdARB MultTransposeMatrixdARB} */
    public static native void nglMultTransposeMatrixdARB(long m);

    /**
     * Double version of {@link #glMultTransposeMatrixfARB MultTransposeMatrixfARB}.
     *
     * @param m the matrix data
     */
    public static void glMultTransposeMatrixdARB(DoubleBuffer m) {
        if (CHECKS) {
            check(m, 16);
        }
        nglMultTransposeMatrixdARB(memAddress(m));
    }

    /** Array version of: {@link #glLoadTransposeMatrixfARB LoadTransposeMatrixfARB} */
    public static void glLoadTransposeMatrixfARB(float[] m) {
        long __functionAddress = GL.getICD().glLoadTransposeMatrixfARB;
        if (CHECKS) {
            check(__functionAddress);
            check(m, 16);
        }
        callPV(__functionAddress, m);
    }

    /** Array version of: {@link #glLoadTransposeMatrixdARB LoadTransposeMatrixdARB} */
    public static void glLoadTransposeMatrixdARB(double[] m) {
        long __functionAddress = GL.getICD().glLoadTransposeMatrixdARB;
        if (CHECKS) {
            check(__functionAddress);
            check(m, 16);
        }
        callPV(__functionAddress, m);
    }

    /** Array version of: {@link #glMultTransposeMatrixfARB MultTransposeMatrixfARB} */
    public static void glMultTransposeMatrixfARB(float[] m) {
        long __functionAddress = GL.getICD().glMultTransposeMatrixfARB;
        if (CHECKS) {
            check(__functionAddress);
            check(m, 16);
        }
        callPV(__functionAddress, m);
    }

    /** Array version of: {@link #glMultTransposeMatrixdARB MultTransposeMatrixdARB} */
    public static void glMultTransposeMatrixdARB(double[] m) {
        long __functionAddress = GL.getICD().glMultTransposeMatrixdARB;
        if (CHECKS) {
            check(__functionAddress);
            check(m, 16);
        }
        callPV(__functionAddress, m);
    }

}