org.lwjgl.opengl.ARBInstancedArrays Maven / Gradle / Ivy
Show all versions of lwjgl-opengl Show documentation
/*
* Copyright LWJGL. All rights reserved.
* License terms: https://www.lwjgl.org/license
* MACHINE GENERATED FILE, DO NOT EDIT
*/
package org.lwjgl.opengl;
import org.lwjgl.system.*;
/**
* Native bindings to the ARB_instanced_arrays extension.
*
* A common use case in GL for some applications is to be able to draw the same object, or groups of similar objects that share vertex data, primitive
* count and type, multiple times. This extension provides a means of accelerating such use cases while restricting the number of API calls, and keeping
* the amount of duplicate data to a minimum.
*
* In particular, this extension specifies an alternative to the read-only shader variable introduced by ARB_draw_instanced. It uses the same draw calls
* introduced by that extension, but redefines them so that a vertex shader can instead use vertex array attributes as a source of instance data.
*
* This extension introduces an array "divisor" for generic vertex array attributes, which when non-zero specifies that the attribute is "instanced". An
* instanced attribute does not advance per-vertex as usual, but rather after every {@code divisor} conceptual draw calls.
*
* (Attributes which aren't instanced are repeated in their entirety for every conceptual draw call.)
*
* By specifying transform data in an instanced attribute or series of instanced attributes, vertex shaders can, in concert with the instancing draw calls,
* draw multiple instances of an object with one draw call.
*
* Promoted to core in {@link GL33 OpenGL 3.3}.
*/
public class ARBInstancedArrays {
static { GL.initialize(); }
/** Accepted by the {@code pname} parameters of GetVertexAttribdv, GetVertexAttribfv, and GetVertexAttribiv. */
public static final int GL_VERTEX_ATTRIB_ARRAY_DIVISOR_ARB = 0x88FE;
protected ARBInstancedArrays() {
throw new UnsupportedOperationException();
}
// --- [ glVertexAttribDivisorARB ] ---
/**
* Modifies the rate at which generic vertex attributes advance when rendering multiple instances of primitives in a single draw call. If {@code divisor}
* is zero, the attribute at slot {@code index} advances once per vertex. If {@code divisor} is non-zero, the attribute advances once per {@code divisor}
* instances of the set(s) of vertices being rendered. An attribute is referred to as {@code instanced} if its {@code divisor} value is non-zero.
*
* @param index the attribute index
* @param divisor the divisor value
*/
public static native void glVertexAttribDivisorARB(@NativeType("GLuint") int index, @NativeType("GLuint") int divisor);
// --- [ glVertexArrayVertexAttribDivisorEXT ] ---
/**
* {@link EXTDirectStateAccess EXT_direct_state_access} version of {@link #glVertexAttribDivisorARB VertexAttribDivisorARB}.
*
* This function was added to the extension specification in July 2013. Implemenations are allowed to expose ARB_instanced_arrays without providing this
* function. The correct way to test its availability is:
*
*
* GLCapabilities caps = GL.getCapabilities();
* if (caps.GL_ARB_instanced_arrays && ARBInstancedArrays.getInstance().VertexArrayVertexAttribDivisorEXT != NULL) {
* glVertexArrayVertexAttribDivisorEXT(...); // the DSA function can now be used
* }
*
* @param vaobj the vertex array object
* @param index the attribute index
* @param divisor the divisor value
*/
public static native void glVertexArrayVertexAttribDivisorEXT(@NativeType("GLuint") int vaobj, @NativeType("GLuint") int index, @NativeType("GLuint") int divisor);
}