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

Show more of this group Show more artifacts with this name
Show all versions of org.lwjgl.opengl Show documentation
LWJGL OSGi bundle (OpenGL bindings)
There is a newer version: 3.3.0
/*
 * 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 GLX_SGI_video_sync extension.
 * 
 * This extension provides a means for synchronization with the video frame rate of a monitor.
 */
public class GLXSGIVideoSync {

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

    static boolean isAvailable(GLXCapabilities caps) {
        return checkFunctions(
            caps.glXGetVideoSyncSGI, caps.glXWaitVideoSyncSGI
        );
    }

    // --- [ glXGetVideoSyncSGI ] ---

    /** Unsafe version of: {@link #glXGetVideoSyncSGI GetVideoSyncSGI} */
    public static int nglXGetVideoSyncSGI(long count) {
        long __functionAddress = GL.getCapabilitiesGLXClient().glXGetVideoSyncSGI;
        if (CHECKS) {
            check(__functionAddress);
        }
        return callPI(__functionAddress, count);
    }

    /**
     * Returns the value of the video sync counter in {@code count}. Zero is returned if the call is successful.
     *
     * @param count the video sync counter value
     */
    public static int glXGetVideoSyncSGI(IntBuffer count) {
        if (CHECKS) {
            check(count, 1);
        }
        return nglXGetVideoSyncSGI(memAddress(count));
    }

    // --- [ glXWaitVideoSyncSGI ] ---

    /** Unsafe version of: {@link #glXWaitVideoSyncSGI WaitVideoSyncSGI} */
    public static int nglXWaitVideoSyncSGI(int divisor, int remainder, long count) {
        long __functionAddress = GL.getCapabilitiesGLXClient().glXWaitVideoSyncSGI;
        if (CHECKS) {
            check(__functionAddress);
        }
        return callPI(__functionAddress, divisor, remainder, count);
    }

    /**
     * Puts the calling process to sleep until
     * 
     * (C mod D) = R
     * 
     * where {@code C} is the video sync counter, {@code D} is specified by the {@code divisor} parameter of {@code glXWaitVideoSyncSGI}, and {@code R} is
     * specified by the {@code remainder} parameter of {@code glXWaitVideoSyncSGI}. {@code glXWaitVideoSyncSGI} returns the current video sync counter value in
     * {@code count}. Zero is returned by {@code glXWaitVideoSyncSGI} if it is successful.
     *
     * @param divisor   the divisor value
     * @param remainder the remainder value
     * @param count     the video sync counter value
     */
    public static int glXWaitVideoSyncSGI(int divisor, int remainder, IntBuffer count) {
        if (CHECKS) {
            check(count, 1);
        }
        return nglXWaitVideoSyncSGI(divisor, remainder, memAddress(count));
    }

    /** Array version of: {@link #glXGetVideoSyncSGI GetVideoSyncSGI} */
    public static int glXGetVideoSyncSGI(int[] count) {
        long __functionAddress = GL.getCapabilitiesGLXClient().glXGetVideoSyncSGI;
        if (CHECKS) {
            check(__functionAddress);
            check(count, 1);
        }
        return callPI(__functionAddress, count);
    }

    /** Array version of: {@link #glXWaitVideoSyncSGI WaitVideoSyncSGI} */
    public static int glXWaitVideoSyncSGI(int divisor, int remainder, int[] count) {
        long __functionAddress = GL.getCapabilitiesGLXClient().glXWaitVideoSyncSGI;
        if (CHECKS) {
            check(__functionAddress);
            check(count, 1);
        }
        return callPI(__functionAddress, divisor, remainder, count);
    }

}