org.lwjgl.opencl.CLEventCallbackI Maven / Gradle / Ivy

Go to download

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

An open, royalty-free standard for cross-platform, parallel programming of diverse processors found in personal computers, servers, mobile devices and embedded platforms.

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.opencl;

import org.lwjgl.system.*;

import static org.lwjgl.system.dyncall.DynCallback.*;

/**
 * Instances of this interface may be passed to the {@link CL11#clSetEventCallback SetEventCallback} method.
 * 
 * Type
 * 
 *  * void (*) (
 *     cl_event event,
 *     cl_int event_command_exec_status,
 *     void *user_data
 * )
 */
@FunctionalInterface
@NativeType("void (*) (cl_event, cl_int, void *)")
public interface CLEventCallbackI extends CallbackI.V {

    String SIGNATURE = Callback.__stdcall("(pip)v");

    @Override
    default String getSignature() { return SIGNATURE; }

    @Override
    default void callback(long args) {
        invoke(
            dcbArgPointer(args),
            dcbArgInt(args),
            dcbArgPointer(args)
        );
    }

    /**
     * Will be called when the execution status of the command associated with {@code event} changes to an execution status equal or past the status specified by
     * {@code command_exec_status}.
     *
     * @param event                     the event
     * @param event_command_exec_status represents the execution status of command for which this callback function is invoked. If the callback is called as the result of the command
     *                                  associated with event being abnormally terminated, an appropriate error code for the error that caused the termination will be passed to
     *                                  {@code event_command_exec_status} instead.
     * @param user_data                 the user-specified value that was passed when calling {@link CL11#clSetEventCallback SetEventCallback}
     */
    void invoke(@NativeType("cl_event") long event, @NativeType("cl_int") int event_command_exec_status, @NativeType("void *") long user_data);

}