Package org.lwjgl.opencl

Class KHREGLImage

java.lang.Object

org.lwjgl.opencl.KHREGLImage

public class KHREGLImage
extends java.lang.Object

Native bindings to the khr_egl_image extension.

This extension provides a mechanism for creating derived resources, such as OpenCL image objects, from EGLImages.

Field Summary

Fields

Modifier and Type	Field	Description
static int	CL_COMMAND_ACQUIRE_EGL_OBJECTS_KHR CL_COMMAND_RELEASE_EGL_OBJECTS_KHR	Command types.
static int	CL_EGL_RESOURCE_NOT_ACQUIRED_KHR CL_INVALID_EGL_OBJECT_KHR	Error Codes

Method Summary

Modifier and Type	Method	Description
static long	clCreateFromEGLImageKHR(long context, long display, long image, long flags, PointerBuffer properties, int[] errcode_ret)	Array version of: CreateFromEGLImageKHR
static long	clCreateFromEGLImageKHR(long context, long display, long image, long flags, PointerBuffer properties, java.nio.IntBuffer errcode_ret)	Creates an EGLImage target of type cl_mem from the EGLImage source provided as image.
static int	clEnqueueAcquireEGLObjectsKHR(long command_queue, PointerBuffer mem_objects, PointerBuffer event_wait_list, PointerBuffer event)	Acquires OpenCL memory objects that have been created from EGL resources.
static int	clEnqueueReleaseEGLObjectsKHR(long command_queue, long mem_object, PointerBuffer event_wait_list, PointerBuffer event)	Releases OpenCL memory objects that have been created from EGL resources.
static int	clEnqueueReleaseEGLObjectsKHR(long command_queue, PointerBuffer mem_objects, PointerBuffer event_wait_list, PointerBuffer event)	Releases OpenCL memory objects that have been created from EGL resources.
static long	nclCreateFromEGLImageKHR(long context, long display, long image, long flags, long properties, long errcode_ret)	Unsafe version of: CreateFromEGLImageKHR
static int	nclEnqueueAcquireEGLObjectsKHR(long command_queue, int num_objects, long mem_objects, int num_events_in_wait_list, long event_wait_list, long event)	Unsafe version of: EnqueueAcquireEGLObjectsKHR
static int	nclEnqueueReleaseEGLObjectsKHR(long command_queue, int num_objects, long mem_objects, int num_events_in_wait_list, long event_wait_list, long event)	Unsafe version of: EnqueueReleaseEGLObjectsKHR

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

CL_EGL_RESOURCE_NOT_ACQUIRED_KHR, CL_INVALID_EGL_OBJECT_KHR

Error Codes

CL_COMMAND_ACQUIRE_EGL_OBJECTS_KHR, CL_COMMAND_RELEASE_EGL_OBJECTS_KHR

Command types.

Method Detail

nclCreateFromEGLImageKHR

public static long nclCreateFromEGLImageKHR(long context,
                                            long display,
                                            long image,
                                            long flags,
                                            long properties,
                                            long errcode_ret)

Unsafe version of: CreateFromEGLImageKHR

clCreateFromEGLImageKHR

public static long clCreateFromEGLImageKHR(long context,
                                           long display,
                                           long image,
                                           long flags,
                                           @Nullable
                                           PointerBuffer properties,
                                           @Nullable
                                           java.nio.IntBuffer errcode_ret)

Creates an EGLImage target of type cl_mem from the EGLImage source provided as image.

Parameters:

display - an EGLDisplay

image - an EGLImageKHR

flags - a bit-field that is used to specify usage information about the memory object being created

properties - a list of property names and their corresponding values

errcode_ret - will return an appropriate error code. If errcode_ret is NULL, no error code is returned.

nclEnqueueAcquireEGLObjectsKHR

public static int nclEnqueueAcquireEGLObjectsKHR(long command_queue,
                                                 int num_objects,
                                                 long mem_objects,
                                                 int num_events_in_wait_list,
                                                 long event_wait_list,
                                                 long event)

Unsafe version of: EnqueueAcquireEGLObjectsKHR

Parameters:

num_objects - the number of memory objects to be acquired in mem_objects

num_events_in_wait_list - the number of events in event_wait_list

clEnqueueAcquireEGLObjectsKHR

public static int clEnqueueAcquireEGLObjectsKHR(long command_queue,
                                                PointerBuffer mem_objects,
                                                @Nullable
                                                PointerBuffer event_wait_list,
                                                @Nullable
                                                PointerBuffer event)

Acquires OpenCL memory objects that have been created from EGL resources. The EGL objects are acquired by the OpenCL context associated with command_queue and can therefore be used by all command-queues associated with the OpenCL context.

Parameters:

command_queue - a valid command-queue

mem_objects - a pointer to a list of OpenCL memory objects that were created from EGL resources, within the context associated with command_queue

event_wait_list - a list of events that need to complete before this particular command can be executed. If event_wait_list is NULL, then this particular command does not wait on any event to complete. The events specified in event_wait_list act as synchronization points. The context associated with events in event_wait_list and command_queue must be the same.

event - Returns an event object that identifies this particular command and can be used to query or queue a wait for this particular command to complete. event can be NULL in which case it will not be possible for the application to query the status of this command or queue a wait for this command to complete. If the event_wait_list and the event arguments are not NULL, the event argument should not refer to an element of the event_wait_list array.

nclEnqueueReleaseEGLObjectsKHR

public static int nclEnqueueReleaseEGLObjectsKHR(long command_queue,
                                                 int num_objects,
                                                 long mem_objects,
                                                 int num_events_in_wait_list,
                                                 long event_wait_list,
                                                 long event)

Unsafe version of: EnqueueReleaseEGLObjectsKHR

Parameters:

num_objects - the number of memory objects to be released in mem_objects

num_events_in_wait_list - the number of events in event_wait_list

clEnqueueReleaseEGLObjectsKHR

public static int clEnqueueReleaseEGLObjectsKHR(long command_queue,
                                                PointerBuffer mem_objects,
                                                @Nullable
                                                PointerBuffer event_wait_list,
                                                @Nullable
                                                PointerBuffer event)

Releases OpenCL memory objects that have been created from EGL resources. The EGL objects are released by the OpenCL context associated with command_queue.

Parameters:

command_queue - a valid command-queue

mem_objects - a pointer to a list of OpenCL memory objects that were created from EGL resources, within the context associated with command_queue

event_wait_list - a list of events that need to complete before this particular command can be executed. If event_wait_list is NULL, then this particular command does not wait on any event to complete. The events specified in event_wait_list act as synchronization points. The context associated with events in event_wait_list and command_queue must be the same.

event - Returns an event object that identifies this particular command and can be used to query or queue a wait for this particular command to complete. event can be NULL in which case it will not be possible for the application to query the status of this command or queue a wait for this command to complete. If the event_wait_list and the event arguments are not NULL, the event argument should not refer to an element of the event_wait_list array.

clEnqueueReleaseEGLObjectsKHR

public static int clEnqueueReleaseEGLObjectsKHR(long command_queue,
                                                long mem_object,
                                                @Nullable
                                                PointerBuffer event_wait_list,
                                                @Nullable
                                                PointerBuffer event)

Releases OpenCL memory objects that have been created from EGL resources. The EGL objects are released by the OpenCL context associated with command_queue.

Parameters:

command_queue - a valid command-queue

event_wait_list - a list of events that need to complete before this particular command can be executed. If event_wait_list is NULL, then this particular command does not wait on any event to complete. The events specified in event_wait_list act as synchronization points. The context associated with events in event_wait_list and command_queue must be the same.

event - Returns an event object that identifies this particular command and can be used to query or queue a wait for this particular command to complete. event can be NULL in which case it will not be possible for the application to query the status of this command or queue a wait for this command to complete. If the event_wait_list and the event arguments are not NULL, the event argument should not refer to an element of the event_wait_list array.

clCreateFromEGLImageKHR

public static long clCreateFromEGLImageKHR(long context,
                                           long display,
                                           long image,
                                           long flags,
                                           @Nullable
                                           PointerBuffer properties,
                                           @Nullable
                                           int[] errcode_ret)

Array version of: CreateFromEGLImageKHR