org.lwjgl.opengles.EXTWin32KeyedMutex Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of lwjgl-opengles Show documentation

A royalty-free, cross-platform API for full-function 2D and 3D graphics on embedded systems - including consoles, phones, appliances and vehicles.

There is a newer version: 3.3.4

Show newest version

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

import org.lwjgl.system.*;

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

/**
 * Native bindings to the EXT_win32_keyed_mutex extension.
 * 
 * Direct3D image objects may have a built-in synchronization primitive associated with them that can be used to synchronize access to their contents
 * across process and API boundaries. This extension provides access to that synchronization primitive via two new commands that operate on GL memory
 * objects.
 * 
 * Requires {@link EXTMemoryObject EXT_memory_object}.
 */
public class EXTWin32KeyedMutex {

    static { GLES.initialize(); }

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

    static boolean isAvailable(GLESCapabilities caps) {
        return checkFunctions(
            caps.glAcquireKeyedMutexWin32EXT, caps.glReleaseKeyedMutexWin32EXT
        );
    }

    // --- [ glAcquireKeyedMutexWin32EXT ] ---

    /**
     * Blocks GL command processing until a keyed mutex is acquired.
     *
     * @param memory  identifies which keyed mutex to acquire
     * @param key     is the mutex value to wait for
     * @param timeout the time, in milliseconds, to wait before failing the acquire operation
     */
    @NativeType("GLboolean")
    public static native boolean glAcquireKeyedMutexWin32EXT(@NativeType("GLuint") int memory, @NativeType("GLuint64") long key, @NativeType("GLuint") int timeout);

    // --- [ glReleaseKeyedMutexWin32EXT ] ---

    /**
     * Releases a keyed mutex after all prior GL command processing has completed.
     *
     * @param memory identifies the keyed mutex to release
     * @param key    the mutex value set by the release operation
     */
    @NativeType("GLboolean")
    public static native boolean glReleaseKeyedMutexWin32EXT(@NativeType("GLuint") int memory, @NativeType("GLuint64") long key);

}