Top Description Fields Constructors Methods
org.lwjgl.opencl

public Class KHREGLImage

extends Object
Class Inheritance
Imports
javax.annotation.*, java.nio.*, org.lwjgl.*, org.lwjgl.system.*

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

Modifier and TypeField and Description
public static final int
public static final int
public static final int
public static final int

Constructor Summary

AccessConstructor and Description
protected

Method Summary

Modifier and TypeMethod and Description
public static long
clCreateFromEGLImageKHR(long context, long
an EGLDisplay
display
,
long
an EGLImageKHR
image
,
long
a bit-field that is used to specify usage information about the memory object being created
flags
,
PointerBuffer
a list of property names and their corresponding values
properties
,
IntBuffer
will return an appropriate error code. If errcode_ret is NULL, no error code is returned.
errcode_ret
)

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

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

Array version of: CreateFromEGLImageKHR

public static int
clEnqueueAcquireEGLObjectsKHR(long
a valid command-queue
command_queue
,
PointerBuffer
a pointer to a list of OpenCL memory objects that were created from EGL resources, within the context associated with command_queue
mem_objects
,
PointerBuffer
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_wait_list
,
PointerBuffer
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.
event
)

Acquires OpenCL memory objects that have been created from EGL resources.

public static int
clEnqueueReleaseEGLObjectsKHR(long
a valid command-queue
command_queue
,
PointerBuffer
a pointer to a list of OpenCL memory objects that were created from EGL resources, within the context associated with command_queue
mem_objects
,
PointerBuffer
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_wait_list
,
PointerBuffer
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.
event
)

Releases OpenCL memory objects that have been created from EGL resources.

public static int
clEnqueueReleaseEGLObjectsKHR(long
a valid command-queue
command_queue
,
long mem_object, PointerBuffer
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_wait_list
,
PointerBuffer
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.
event
)

Releases OpenCL memory objects that have been created from EGL resources.

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

Unsafe version of: CreateFromEGLImageKHR

public static int
nclEnqueueAcquireEGLObjectsKHR(long command_queue, int
the number of memory objects to be acquired in mem_objects
num_objects
,
long mem_objects, int
the number of events in event_wait_list
num_events_in_wait_list
,
long event_wait_list, long event)

Unsafe version of: EnqueueAcquireEGLObjectsKHR

public static int
nclEnqueueReleaseEGLObjectsKHR(long command_queue, int
the number of memory objects to be released in mem_objects
num_objects
,
long mem_objects, int
the number of events in event_wait_list
num_events_in_wait_list
,
long event_wait_list, long event)

Unsafe version of: EnqueueReleaseEGLObjectsKHR

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

CL_COMMAND_ACQUIRE_EGL_OBJECTS_KHRback to summary
public static final int CL_COMMAND_ACQUIRE_EGL_OBJECTS_KHR

Command types.

CL_COMMAND_RELEASE_EGL_OBJECTS_KHRback to summary
public static final int CL_COMMAND_RELEASE_EGL_OBJECTS_KHR

Command types.

CL_EGL_RESOURCE_NOT_ACQUIRED_KHRback to summary
public static final int CL_EGL_RESOURCE_NOT_ACQUIRED_KHR

Error Codes

CL_INVALID_EGL_OBJECT_KHRback to summary
public static final int CL_INVALID_EGL_OBJECT_KHR

Error Codes

Constructor Detail

KHREGLImageback to summary
protected KHREGLImage()

Method Detail

clCreateFromEGLImageKHRback to summary
public static long clCreateFromEGLImageKHR(long context, long display, long image, long flags, PointerBuffer properties, IntBuffer errcode_ret)

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

Parameters
display:long

an EGLDisplay

image:long

an EGLImageKHR

flags:long

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

properties:PointerBuffer

a list of property names and their corresponding values

errcode_ret:IntBuffer

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

Annotations
@NativeType:cl_mem
clCreateFromEGLImageKHRback to summary
public static long clCreateFromEGLImageKHR(long context, long display, long image, long flags, PointerBuffer properties, int[] errcode_ret)

Array version of: CreateFromEGLImageKHR

Annotations
@NativeType:cl_mem
clEnqueueAcquireEGLObjectsKHRback to summary
public 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. 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:long

a valid command-queue

mem_objects:PointerBuffer

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:PointerBuffer

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:PointerBuffer

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.

Annotations
@NativeType:cl_int
clEnqueueReleaseEGLObjectsKHRback to summary
public 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. The EGL objects are released by the OpenCL context associated with command_queue.

Parameters
command_queue:long

a valid command-queue

mem_objects:PointerBuffer

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:PointerBuffer

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:PointerBuffer

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.

Annotations
@NativeType:cl_int
clEnqueueReleaseEGLObjectsKHRback to summary
public 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. The EGL objects are released by the OpenCL context associated with command_queue.

Parameters
command_queue:long

a valid command-queue

event_wait_list:PointerBuffer

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:PointerBuffer

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.

Annotations
@NativeType:cl_int
nclCreateFromEGLImageKHRback to summary
public static long nclCreateFromEGLImageKHR(long context, long display, long image, long flags, long properties, long errcode_ret)

Unsafe version of: CreateFromEGLImageKHR

nclEnqueueAcquireEGLObjectsKHRback to summary
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:int

the number of memory objects to be acquired in mem_objects

num_events_in_wait_list:int

the number of events in event_wait_list

nclEnqueueReleaseEGLObjectsKHRback to summary
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:int

the number of memory objects to be released in mem_objects

num_events_in_wait_list:int

the number of events in event_wait_list