org.lwjgl.opengl.ARBGetProgramBinary 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 javax.annotation.*;
import java.nio.*;
import org.lwjgl.system.*;
/**
* Native bindings to the ARB_get_program_binary extension.
*
* This extension introduces new commands to retrieve and set the binary representation of a program object. {@link #glGetProgramBinary GetProgramBinary} allows an application to
* cache compiled and linked programs to avoid compiling and linking when used again. This may even allow the GL itself to act as an offline compiler. The
* resulting program binary can be reloaded into the GL via {@link #glProgramBinary ProgramBinary}. This is a very useful path for applications that wish to remain portable by
* shipping pure GLSL source shaders, yet would like to avoid the cost of compiling their shaders at runtime. Instead an application can supply its GLSL
* source shaders during first application run, or even during installation. The application then compiles and links its shaders and reads back the program
* binaries. On subsequent runs, only the program binaries need be supplied.
*
* {@link #glProgramBinary ProgramBinary} may also accept binaries in vendor-specific formats produced by specialized offline compilation tools. This extension does not add any
* such formats, but allows for them in further extensions. Though the level of optimization may not be identical -- the offline shader compiler may have
* the luxury of more aggressive optimization at its disposal -- program binaries generated online by the GL are interchangeable with those generated
* offline by an SDK tool.
*
* Requires {@link GL30 OpenGL 3.0}. Promoted to core in {@link GL41 OpenGL 4.1}.
*/
public class ARBGetProgramBinary {
static { GL.initialize(); }
/** Accepted by the {@code pname} parameter of ProgramParameteri and GetProgramiv. */
public static final int GL_PROGRAM_BINARY_RETRIEVABLE_HINT = 0x8257;
/** Accepted by the {@code pname} parameter of GetProgramiv. */
public static final int GL_PROGRAM_BINARY_LENGTH = 0x8741;
/** Accepted by the {@code pname} parameter of GetBooleanv, GetIntegerv, GetInteger64v, GetFloatv and GetDoublev. */
public static final int
GL_NUM_PROGRAM_BINARY_FORMATS = 0x87FE,
GL_PROGRAM_BINARY_FORMATS = 0x87FF;
protected ARBGetProgramBinary() {
throw new UnsupportedOperationException();
}
// --- [ glGetProgramBinary ] ---
/**
* Unsafe version of: {@link #glGetProgramBinary GetProgramBinary}
*
* @param bufSize the size of the buffer whose address is given by {@code binary}
*/
public static void nglGetProgramBinary(int program, int bufSize, long length, long binaryFormat, long binary) {
GL41C.nglGetProgramBinary(program, bufSize, length, binaryFormat, binary);
}
/**
* Returns a binary representation of a program object's compiled and linked executable source.
*
* @param program the name of a program object whose binary representation to retrieve
* @param length the address of a variable to receive the number of bytes written into {@code binary}
* @param binaryFormat a variable to receive a token indicating the format of the binary data returned by the GL
* @param binary an array into which the GL will return {@code program}'s binary representation
*/
public static void glGetProgramBinary(@NativeType("GLuint") int program, @Nullable @NativeType("GLsizei *") IntBuffer length, @NativeType("GLenum *") IntBuffer binaryFormat, @NativeType("void *") ByteBuffer binary) {
GL41C.glGetProgramBinary(program, length, binaryFormat, binary);
}
// --- [ glProgramBinary ] ---
/**
* Unsafe version of: {@link #glProgramBinary ProgramBinary}
*
* @param length the number of bytes contained in {@code binary}
*/
public static void nglProgramBinary(int program, int binaryFormat, long binary, int length) {
GL41C.nglProgramBinary(program, binaryFormat, binary, length);
}
/**
* Loads a program object with a program binary.
*
* @param program the name of a program object into which to load a program binary
* @param binaryFormat the format of the binary data in binary
* @param binary an array containing the binary to be loaded into {@code program}
*/
public static void glProgramBinary(@NativeType("GLuint") int program, @NativeType("GLenum") int binaryFormat, @NativeType("void const *") ByteBuffer binary) {
GL41C.glProgramBinary(program, binaryFormat, binary);
}
// --- [ glProgramParameteri ] ---
/**
* Specifies the integer value of a program object parameter.
*
* @param program the name of a program object whose parameter to modify
* @param pname the name of the parameter to modify. One of:
{@link GL41C#GL_PROGRAM_BINARY_RETRIEVABLE_HINT PROGRAM_BINARY_RETRIEVABLE_HINT} {@link GL41C#GL_PROGRAM_SEPARABLE PROGRAM_SEPARABLE}
* @param value the new value of the parameter specified by {@code pname} for {@code program}
*/
public static void glProgramParameteri(@NativeType("GLuint") int program, @NativeType("GLenum") int pname, @NativeType("GLint") int value) {
GL41C.glProgramParameteri(program, pname, value);
}
/** Array version of: {@link #glGetProgramBinary GetProgramBinary} */
public static void glGetProgramBinary(@NativeType("GLuint") int program, @Nullable @NativeType("GLsizei *") int[] length, @NativeType("GLenum *") int[] binaryFormat, @NativeType("void *") ByteBuffer binary) {
GL41C.glGetProgramBinary(program, length, binaryFormat, binary);
}
}