org.lwjgl.opengl.ARBCLEvent 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 static org.lwjgl.system.Checks.*;

import org.lwjgl.opencl.*;

/**
 * Native bindings to the ARB_cl_event extension.
 * 
 * This extension allows creating OpenGL sync objects linked to OpenCL event objects, potentially improving efficiency of sharing images and buffers between
 * the two APIs. The companion {@link org.lwjgl.opencl.KHRGLEvent cl_khr_gl_event} OpenCL extension provides the complementary functionality of creating an
 * OpenCL event object from an OpenGL fence sync object.
 * 
 * Requires {@link GL32 OpenGL 3.2} or {@link ARBSync ARB_sync}. Requires an OpenCL implementation supporting sharing event objects with OpenGL.
 */
public class ARBCLEvent {

    /** Returned in {@code values} for {@link GL32#glGetSynciv GetSynciv} {@code pname} {@link GL32#GL_OBJECT_TYPE OBJECT_TYPE}. */
    public static final int GL_SYNC_CL_EVENT_ARB = 0x8240;

    /** Returned in {@code values} for {@link GL32#glGetSynciv GetSynciv} {@code pname} {@link GL32#GL_SYNC_CONDITION SYNC_CONDITION}. */
    public static final int GL_SYNC_CL_EVENT_COMPLETE_ARB = 0x8241;

    static { GL.initialize(); }

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

    static boolean isAvailable(GLCapabilities caps) {
        return checkFunctions(
            caps.glCreateSyncFromCLeventARB
        );
    }

    // --- [ glCreateSyncFromCLeventARB ] ---

    /** Unsafe version of: {@link #glCreateSyncFromCLeventARB CreateSyncFromCLeventARB} */
    public static native long nglCreateSyncFromCLeventARB(long context, long event, int flags);

    /**
     * Creates a linked sync object. {@code context} and {@code event} must be handles to a valid OpenCL context and a valid event in that context,
     * respectively. {@code context} must support sharing with GL, and must have been created with respect to the current GL context, or to a share group
     * including the current GL context.
     * 
     * The status of such a sync object depends on {@code event}. When the status of {@code event} is {@link CL10#CL_QUEUED}, {@link CL10#CL_SUBMITTED}, or {@link CL10#CL_RUNNING},
     * the status of the linked sync object will be {@link GL32#GL_UNSIGNALED UNSIGNALED}. When the status of {@code event} changes to {@link CL10#CL_COMPLETE}, the status of the linked
     * sync object will become {@link GL32#GL_SIGNALED SIGNALED}.
     * 
     * Creating a linked sync object places a reference on the linked OpenCL event object. When the sync object is deleted, the reference will be removed from
     * the event object.
     *
     * @param context a valid OpenCL context
     * @param event   a valid OpenCL event
     * @param flags   must be 0 (placeholder for anticipated future extensions of sync object capabilities)
     */
    public static long glCreateSyncFromCLeventARB(long context, long event, int flags) {
        if (CHECKS) {
            check(context);
            check(event);
        }
        return nglCreateSyncFromCLeventARB(context, event, flags);
    }

}