Class KHRCommandBuffer


  • public class KHRCommandBuffer
    extends java.lang.Object
    Native bindings to the khr_command_buffer extension.

    Command-buffers enable a reduction in overhead when enqueuing the same workload multiple times. By separating the command-queue setup from dispatch, the ability to replay a set of previously created commands is introduced.

    Device-side cl_sync_point_khr synchronization-points can be used within command-buffers to define command dependencies. This allows the commands of a command-buffer to execute out-of-order on a single compatible command-queue. The command-buffer itself has no inherent in-order/out-of-order property, this ordering is inferred from the command-queue used on command recording. Out-of-order enqueues without event dependencies of both regular commands, such as EnqueueFillBuffer, and command-buffers are allowed to execute concurrently, and it is up to the user to express any dependencies using events.

    The command-queues a command-buffer will be executed on can be set on replay via parameters to EnqueueCommandBufferKHR, provided they are compatible with the command-queues used on command-buffer recording.

    Requires CL12.

    • Method Summary

      All Methods Static Methods Concrete Methods 
      Modifier and Type Method Description
      static int clCommandBarrierWithWaitListKHR​(long command_buffer, long command_queue, int[] sync_point_wait_list, int[] sync_point, org.lwjgl.PointerBuffer mutable_handle)
      static int clCommandBarrierWithWaitListKHR​(long command_buffer, long command_queue, java.nio.IntBuffer sync_point_wait_list, java.nio.IntBuffer sync_point, org.lwjgl.PointerBuffer mutable_handle)
      Records a barrier operation used as a synchronization point.
      static int clCommandCopyBufferKHR​(long command_buffer, long command_queue, long src_buffer, long dst_buffer, long src_offset, long dst_offset, long size, int[] sync_point_wait_list, int[] sync_point, org.lwjgl.PointerBuffer mutable_handle)
      Array version of: CommandCopyBufferKHR
      static int clCommandCopyBufferKHR​(long command_buffer, long command_queue, long src_buffer, long dst_buffer, long src_offset, long dst_offset, long size, java.nio.IntBuffer sync_point_wait_list, java.nio.IntBuffer sync_point, org.lwjgl.PointerBuffer mutable_handle)
      Records a command to copy from one buffer object to another.
      static int clCommandCopyBufferRectKHR​(long command_buffer, long command_queue, long src_buffer, long dst_buffer, org.lwjgl.PointerBuffer src_origin, org.lwjgl.PointerBuffer dst_origin, org.lwjgl.PointerBuffer region, long src_row_pitch, long src_slice_pitch, long dst_row_pitch, long dst_slice_pitch, int[] sync_point_wait_list, int[] sync_point, org.lwjgl.PointerBuffer mutable_handle)
      Array version of: CommandCopyBufferRectKHR
      static int clCommandCopyBufferRectKHR​(long command_buffer, long command_queue, long src_buffer, long dst_buffer, org.lwjgl.PointerBuffer src_origin, org.lwjgl.PointerBuffer dst_origin, org.lwjgl.PointerBuffer region, long src_row_pitch, long src_slice_pitch, long dst_row_pitch, long dst_slice_pitch, java.nio.IntBuffer sync_point_wait_list, java.nio.IntBuffer sync_point, org.lwjgl.PointerBuffer mutable_handle)
      Records a command to copy a rectangular region from a buffer object to another buffer object.
      static int clCommandCopyBufferToImageKHR​(long command_buffer, long command_queue, long src_buffer, long dst_image, long src_offset, org.lwjgl.PointerBuffer dst_origin, org.lwjgl.PointerBuffer region, int[] sync_point_wait_list, int[] sync_point, org.lwjgl.PointerBuffer mutable_handle)
      Array version of: CommandCopyBufferToImageKHR
      static int clCommandCopyBufferToImageKHR​(long command_buffer, long command_queue, long src_buffer, long dst_image, long src_offset, org.lwjgl.PointerBuffer dst_origin, org.lwjgl.PointerBuffer region, java.nio.IntBuffer sync_point_wait_list, java.nio.IntBuffer sync_point, org.lwjgl.PointerBuffer mutable_handle)
      Records a command to copy a buffer object to an image object.
      static int clCommandCopyImageKHR​(long command_buffer, long command_queue, long src_image, long dst_image, org.lwjgl.PointerBuffer src_origin, org.lwjgl.PointerBuffer dst_origin, org.lwjgl.PointerBuffer region, int[] sync_point_wait_list, int[] sync_point, org.lwjgl.PointerBuffer mutable_handle)
      Array version of: CommandCopyImageKHR
      static int clCommandCopyImageKHR​(long command_buffer, long command_queue, long src_image, long dst_image, org.lwjgl.PointerBuffer src_origin, org.lwjgl.PointerBuffer dst_origin, org.lwjgl.PointerBuffer region, java.nio.IntBuffer sync_point_wait_list, java.nio.IntBuffer sync_point, org.lwjgl.PointerBuffer mutable_handle)
      Records a command to copy image objects.
      static int clCommandCopyImageToBufferKHR​(long command_buffer, long command_queue, long src_image, long dst_buffer, org.lwjgl.PointerBuffer src_origin, org.lwjgl.PointerBuffer region, long dst_offset, int[] sync_point_wait_list, int[] sync_point, org.lwjgl.PointerBuffer mutable_handle)
      Array version of: CommandCopyImageToBufferKHR
      static int clCommandCopyImageToBufferKHR​(long command_buffer, long command_queue, long src_image, long dst_buffer, org.lwjgl.PointerBuffer src_origin, org.lwjgl.PointerBuffer region, long dst_offset, java.nio.IntBuffer sync_point_wait_list, java.nio.IntBuffer sync_point, org.lwjgl.PointerBuffer mutable_handle)
      Records a command to copy an image object to a buffer object.
      static int clCommandFillBufferKHR​(long command_buffer, long command_queue, long buffer, java.nio.ByteBuffer pattern, long offset, long size, int[] sync_point_wait_list, int[] sync_point, org.lwjgl.PointerBuffer mutable_handle)
      Array version of: CommandFillBufferKHR
      static int clCommandFillBufferKHR​(long command_buffer, long command_queue, long buffer, java.nio.ByteBuffer pattern, long offset, long size, java.nio.IntBuffer sync_point_wait_list, java.nio.IntBuffer sync_point, org.lwjgl.PointerBuffer mutable_handle)
      Records a command to fill a buffer object with a pattern of a given pattern size.
      static int clCommandFillImageKHR​(long command_buffer, long command_queue, long image, float[] fill_color, org.lwjgl.PointerBuffer origin, org.lwjgl.PointerBuffer region, int[] sync_point_wait_list, int[] sync_point, org.lwjgl.PointerBuffer mutable_handle)
      Array version of: CommandFillImageKHR
      static int clCommandFillImageKHR​(long command_buffer, long command_queue, long image, int[] fill_color, org.lwjgl.PointerBuffer origin, org.lwjgl.PointerBuffer region, int[] sync_point_wait_list, int[] sync_point, org.lwjgl.PointerBuffer mutable_handle)
      Array version of: CommandFillImageKHR
      static int clCommandFillImageKHR​(long command_buffer, long command_queue, long image, java.nio.ByteBuffer fill_color, org.lwjgl.PointerBuffer origin, org.lwjgl.PointerBuffer region, int[] sync_point_wait_list, int[] sync_point, org.lwjgl.PointerBuffer mutable_handle)
      Array version of: CommandFillImageKHR
      static int clCommandFillImageKHR​(long command_buffer, long command_queue, long image, java.nio.ByteBuffer fill_color, org.lwjgl.PointerBuffer origin, org.lwjgl.PointerBuffer region, java.nio.IntBuffer sync_point_wait_list, java.nio.IntBuffer sync_point, org.lwjgl.PointerBuffer mutable_handle)
      Records a command to fill an image object with a specified color.
      static int clCommandFillImageKHR​(long command_buffer, long command_queue, long image, java.nio.FloatBuffer fill_color, org.lwjgl.PointerBuffer origin, org.lwjgl.PointerBuffer region, java.nio.IntBuffer sync_point_wait_list, java.nio.IntBuffer sync_point, org.lwjgl.PointerBuffer mutable_handle)
      Records a command to fill an image object with a specified color.
      static int clCommandFillImageKHR​(long command_buffer, long command_queue, long image, java.nio.IntBuffer fill_color, org.lwjgl.PointerBuffer origin, org.lwjgl.PointerBuffer region, java.nio.IntBuffer sync_point_wait_list, java.nio.IntBuffer sync_point, org.lwjgl.PointerBuffer mutable_handle)
      Records a command to fill an image object with a specified color.
      static int clCommandNDRangeKernelKHR​(long command_buffer, long command_queue, long[] properties, long kernel, int work_dim, org.lwjgl.PointerBuffer global_work_offset, org.lwjgl.PointerBuffer global_work_size, org.lwjgl.PointerBuffer local_work_size, int[] sync_point_wait_list, int[] sync_point, org.lwjgl.PointerBuffer mutable_handle)
      Array version of: CommandNDRangeKernelKHR
      static int clCommandNDRangeKernelKHR​(long command_buffer, long command_queue, java.nio.LongBuffer properties, long kernel, int work_dim, org.lwjgl.PointerBuffer global_work_offset, org.lwjgl.PointerBuffer global_work_size, org.lwjgl.PointerBuffer local_work_size, java.nio.IntBuffer sync_point_wait_list, java.nio.IntBuffer sync_point, org.lwjgl.PointerBuffer mutable_handle)
      Records a command to execute a kernel on a device.
      static long clCreateCommandBufferKHR​(org.lwjgl.PointerBuffer queues, long[] properties, int[] errcode_ret)
      Array version of: CreateCommandBufferKHR
      static long clCreateCommandBufferKHR​(org.lwjgl.PointerBuffer queues, java.nio.LongBuffer properties, java.nio.IntBuffer errcode_ret)
      Creates a command-buffer that can record commands to the specified queues.
      static int clEnqueueCommandBufferKHR​(org.lwjgl.PointerBuffer queues, long command_buffer, org.lwjgl.PointerBuffer event_wait_list, org.lwjgl.PointerBuffer event)
      Enqueues a command-buffer to execute on command-queues specified by queues, or on default command-queues used during recording if queues is empty.
      static int clFinalizeCommandBufferKHR​(long command_buffer)
      Finalizes command recording ready for enqueuing the command-buffer on a command-queue.
      static int clGetCommandBufferInfoKHR​(long command_buffer, int param_name, int[] param_value, org.lwjgl.PointerBuffer param_value_size_ret)
      Array version of: GetCommandBufferInfoKHR
      static int clGetCommandBufferInfoKHR​(long command_buffer, int param_name, java.nio.ByteBuffer param_value, org.lwjgl.PointerBuffer param_value_size_ret)
      Queries information about a command-buffer.
      static int clGetCommandBufferInfoKHR​(long command_buffer, int param_name, java.nio.IntBuffer param_value, org.lwjgl.PointerBuffer param_value_size_ret)
      Queries information about a command-buffer.
      static int clGetCommandBufferInfoKHR​(long command_buffer, int param_name, org.lwjgl.PointerBuffer param_value, org.lwjgl.PointerBuffer param_value_size_ret)
      Queries information about a command-buffer.
      static int clReleaseCommandBufferKHR​(long command_buffer)
      Decrements the command_buffer reference count.
      static int clRetainCommandBufferKHR​(long command_buffer)
      Increments the command_buffer reference count.
      static int nclCommandBarrierWithWaitListKHR​(long command_buffer, long command_queue, int num_sync_points_in_wait_list, long sync_point_wait_list, long sync_point, long mutable_handle)
      static int nclCommandCopyBufferKHR​(long command_buffer, long command_queue, long src_buffer, long dst_buffer, long src_offset, long dst_offset, long size, int num_sync_points_in_wait_list, long sync_point_wait_list, long sync_point, long mutable_handle)
      Unsafe version of: CommandCopyBufferKHR
      static int nclCommandCopyBufferRectKHR​(long command_buffer, long command_queue, long src_buffer, long dst_buffer, long src_origin, long dst_origin, long region, long src_row_pitch, long src_slice_pitch, long dst_row_pitch, long dst_slice_pitch, int num_sync_points_in_wait_list, long sync_point_wait_list, long sync_point, long mutable_handle)
      Unsafe version of: CommandCopyBufferRectKHR
      static int nclCommandCopyBufferToImageKHR​(long command_buffer, long command_queue, long src_buffer, long dst_image, long src_offset, long dst_origin, long region, int num_sync_points_in_wait_list, long sync_point_wait_list, long sync_point, long mutable_handle)
      Unsafe version of: CommandCopyBufferToImageKHR
      static int nclCommandCopyImageKHR​(long command_buffer, long command_queue, long src_image, long dst_image, long src_origin, long dst_origin, long region, int num_sync_points_in_wait_list, long sync_point_wait_list, long sync_point, long mutable_handle)
      Unsafe version of: CommandCopyImageKHR
      static int nclCommandCopyImageToBufferKHR​(long command_buffer, long command_queue, long src_image, long dst_buffer, long src_origin, long region, long dst_offset, int num_sync_points_in_wait_list, long sync_point_wait_list, long sync_point, long mutable_handle)
      Unsafe version of: CommandCopyImageToBufferKHR
      static int nclCommandFillBufferKHR​(long command_buffer, long command_queue, long buffer, long pattern, long pattern_size, long offset, long size, int num_sync_points_in_wait_list, long sync_point_wait_list, long sync_point, long mutable_handle)
      Unsafe version of: CommandFillBufferKHR
      static int nclCommandFillImageKHR​(long command_buffer, long command_queue, long image, long fill_color, long origin, long region, int num_sync_points_in_wait_list, long sync_point_wait_list, long sync_point, long mutable_handle)
      Unsafe version of: CommandFillImageKHR
      static int nclCommandNDRangeKernelKHR​(long command_buffer, long command_queue, long properties, long kernel, int work_dim, long global_work_offset, long global_work_size, long local_work_size, int num_sync_points_in_wait_list, long sync_point_wait_list, long sync_point, long mutable_handle)
      Unsafe version of: CommandNDRangeKernelKHR
      static long nclCreateCommandBufferKHR​(int num_queues, long queues, long properties, long errcode_ret)
      Unsafe version of: CreateCommandBufferKHR
      static int nclEnqueueCommandBufferKHR​(int num_queues, long queues, long command_buffer, int num_events_in_wait_list, long event_wait_list, long event)
      Unsafe version of: EnqueueCommandBufferKHR
      static int nclGetCommandBufferInfoKHR​(long command_buffer, int param_name, long param_value_size, long param_value, long param_value_size_ret)
      Unsafe version of: GetCommandBufferInfoKHR
      • Methods inherited from class java.lang.Object

        equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Method Detail

      • nclCreateCommandBufferKHR

        public static long nclCreateCommandBufferKHR​(int num_queues,
                                                     long queues,
                                                     long properties,
                                                     long errcode_ret)
        Unsafe version of: CreateCommandBufferKHR
        Parameters:
        num_queues - the number of command-queues listed in queues. This extension only supports a single command-queue, so this must be one.
      • clCreateCommandBufferKHR

        public static long clCreateCommandBufferKHR​(org.lwjgl.PointerBuffer queues,
                                                    @Nullable
                                                    java.nio.LongBuffer properties,
                                                    @Nullable
                                                    java.nio.IntBuffer errcode_ret)
        Creates a command-buffer that can record commands to the specified queues.
        Parameters:
        queues - a pointer to a command-queue that the command-buffer commands will be recorded to. queues must be a non-NULL value.
        properties - a list of properties for the command-buffer and their corresponding values.

        Each property name is immediately followed by the corresponding desired value. The list is terminated with 0. If a supported property and its value is not specified in properties, its default value will be used. properties can be NULL in which case the default values for supported command-buffer properties will be used.

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

        public static int clRetainCommandBufferKHR​(long command_buffer)
        Increments the command_buffer reference count.
        Parameters:
        command_buffer - the command-buffer to retain
      • clReleaseCommandBufferKHR

        public static int clReleaseCommandBufferKHR​(long command_buffer)
        Decrements the command_buffer reference count.
        Parameters:
        command_buffer - the command-buffer to release
      • clFinalizeCommandBufferKHR

        public static int clFinalizeCommandBufferKHR​(long command_buffer)
        Finalizes command recording ready for enqueuing the command-buffer on a command-queue.
        Parameters:
        command_buffer - a valid command-buffer object
      • nclEnqueueCommandBufferKHR

        public static int nclEnqueueCommandBufferKHR​(int num_queues,
                                                     long queues,
                                                     long command_buffer,
                                                     int num_events_in_wait_list,
                                                     long event_wait_list,
                                                     long event)
        Unsafe version of: EnqueueCommandBufferKHR
        Parameters:
        num_queues - the number of command-queues listed in queues
        num_events_in_wait_list - the number of events in event_wait_list
      • clEnqueueCommandBufferKHR

        public static int clEnqueueCommandBufferKHR​(@Nullable
                                                    org.lwjgl.PointerBuffer queues,
                                                    long command_buffer,
                                                    @Nullable
                                                    org.lwjgl.PointerBuffer event_wait_list,
                                                    @Nullable
                                                    org.lwjgl.PointerBuffer event)
        Enqueues a command-buffer to execute on command-queues specified by queues, or on default command-queues used during recording if queues is empty.
        Parameters:
        queues - a pointer to an ordered list of command-queues compatible with the command-queues used on recording.

        queues can be NULL in which case the default command-queues used on command-buffer creation are used and num_queues must be 0.

        command_buffer - a valid command-buffer object
        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.
      • nclCommandBarrierWithWaitListKHR

        public static int nclCommandBarrierWithWaitListKHR​(long command_buffer,
                                                           long command_queue,
                                                           int num_sync_points_in_wait_list,
                                                           long sync_point_wait_list,
                                                           long sync_point,
                                                           long mutable_handle)
      • clCommandBarrierWithWaitListKHR

        public static int clCommandBarrierWithWaitListKHR​(long command_buffer,
                                                          long command_queue,
                                                          @Nullable
                                                          java.nio.IntBuffer sync_point_wait_list,
                                                          @Nullable
                                                          java.nio.IntBuffer sync_point,
                                                          @Nullable
                                                          org.lwjgl.PointerBuffer mutable_handle)
        Records a barrier operation used as a synchronization point.
        Parameters:
        command_buffer - a valid command-buffer object
        command_queue - the command-queue the command will be recorded to.

        Parameter is unused by this extension as only a single command-queue is supported and must be NULL.

        sync_point_wait_list - the synchronization-points that need to complete before this particular command can be executed.

        If sync_point_wait_list is NULL, num_sync_points_in_wait_list must be 0. If sync_point_wait_list is not NULL, the list of synchronization-points pointed to by sync_point_wait_list must be valid and num_sync_points_in_wait_list must be greater than 0. The synchronization-points specified in sync_point_wait_list are device side synchronization-points. The command-buffer associated with synchronization-points in sync_point_wait_list must be the same as command_buffer. The memory associated with sync_point_wait_list can be reused or freed after the function returns.

        If sync_point_wait_list is NULL, then this particular command waits until all previous recorded commands to command_queue have completed.

        sync_point - returns a synchronization-point ID that identifies this particular command.

        Synchronization-point objects are unique and can be used to identify this barrier command later on. sync_point can be NULL in which case it will not be possible for the application to record a wait for this command to complete. If the sync_point_wait_list and the sync_point arguments are not NULL, the sync_point argument should not refer to an element of the sync_point_wait_list array.

        mutable_handle - returns a handle to the command.

        Handle is unused by this extension and must be passed as NULL.

      • nclCommandCopyBufferKHR

        public static int nclCommandCopyBufferKHR​(long command_buffer,
                                                  long command_queue,
                                                  long src_buffer,
                                                  long dst_buffer,
                                                  long src_offset,
                                                  long dst_offset,
                                                  long size,
                                                  int num_sync_points_in_wait_list,
                                                  long sync_point_wait_list,
                                                  long sync_point,
                                                  long mutable_handle)
        Unsafe version of: CommandCopyBufferKHR
      • clCommandCopyBufferKHR

        public static int clCommandCopyBufferKHR​(long command_buffer,
                                                 long command_queue,
                                                 long src_buffer,
                                                 long dst_buffer,
                                                 long src_offset,
                                                 long dst_offset,
                                                 long size,
                                                 @Nullable
                                                 java.nio.IntBuffer sync_point_wait_list,
                                                 @Nullable
                                                 java.nio.IntBuffer sync_point,
                                                 @Nullable
                                                 org.lwjgl.PointerBuffer mutable_handle)
        Records a command to copy from one buffer object to another.
        Parameters:
        command_buffer - a valid command-buffer object
        command_queue - the command-queue the command will be recorded to.

        Parameter is unused by this extension as only a single command-queue is supported and must be NULL.

        sync_point_wait_list - the synchronization-points that need to complete before this particular command can be executed.

        If sync_point_wait_list is NULL, num_sync_points_in_wait_list must be 0. If sync_point_wait_list is not NULL, the list of synchronization-points pointed to by sync_point_wait_list must be valid and num_sync_points_in_wait_list must be greater than 0. The synchronization-points specified in sync_point_wait_list are device side synchronization-points. The command-buffer associated with synchronization-points in sync_point_wait_list must be the same as command_buffer. The memory associated with sync_point_wait_list can be reused or freed after the function returns.

        If sync_point_wait_list is NULL, then this particular command waits until all previous recorded commands to command_queue have completed.

        sync_point - returns a synchronization-point ID that identifies this particular command.

        Synchronization-point objects are unique and can be used to identify this barrier command later on. sync_point can be NULL in which case it will not be possible for the application to record a wait for this command to complete. If the sync_point_wait_list and the sync_point arguments are not NULL, the sync_point argument should not refer to an element of the sync_point_wait_list array.

        mutable_handle - returns a handle to the command.

        Handle is unused by this extension and must be passed as NULL.

      • nclCommandCopyBufferRectKHR

        public static int nclCommandCopyBufferRectKHR​(long command_buffer,
                                                      long command_queue,
                                                      long src_buffer,
                                                      long dst_buffer,
                                                      long src_origin,
                                                      long dst_origin,
                                                      long region,
                                                      long src_row_pitch,
                                                      long src_slice_pitch,
                                                      long dst_row_pitch,
                                                      long dst_slice_pitch,
                                                      int num_sync_points_in_wait_list,
                                                      long sync_point_wait_list,
                                                      long sync_point,
                                                      long mutable_handle)
        Unsafe version of: CommandCopyBufferRectKHR
      • clCommandCopyBufferRectKHR

        public static int clCommandCopyBufferRectKHR​(long command_buffer,
                                                     long command_queue,
                                                     long src_buffer,
                                                     long dst_buffer,
                                                     org.lwjgl.PointerBuffer src_origin,
                                                     org.lwjgl.PointerBuffer dst_origin,
                                                     org.lwjgl.PointerBuffer region,
                                                     long src_row_pitch,
                                                     long src_slice_pitch,
                                                     long dst_row_pitch,
                                                     long dst_slice_pitch,
                                                     @Nullable
                                                     java.nio.IntBuffer sync_point_wait_list,
                                                     @Nullable
                                                     java.nio.IntBuffer sync_point,
                                                     @Nullable
                                                     org.lwjgl.PointerBuffer mutable_handle)
        Records a command to copy a rectangular region from a buffer object to another buffer object.
        Parameters:
        command_buffer - a valid command-buffer object
        command_queue - the command-queue the command will be recorded to.

        Parameter is unused by this extension as only a single command-queue is supported and must be NULL.

        sync_point_wait_list - the synchronization-points that need to complete before this particular command can be executed.

        If sync_point_wait_list is NULL, num_sync_points_in_wait_list must be 0. If sync_point_wait_list is not NULL, the list of synchronization-points pointed to by sync_point_wait_list must be valid and num_sync_points_in_wait_list must be greater than 0. The synchronization-points specified in sync_point_wait_list are device side synchronization-points. The command-buffer associated with synchronization-points in sync_point_wait_list must be the same as command_buffer. The memory associated with sync_point_wait_list can be reused or freed after the function returns.

        If sync_point_wait_list is NULL, then this particular command waits until all previous recorded commands to command_queue have completed.

        sync_point - returns a synchronization-point ID that identifies this particular command.

        Synchronization-point objects are unique and can be used to identify this barrier command later on. sync_point can be NULL in which case it will not be possible for the application to record a wait for this command to complete. If the sync_point_wait_list and the sync_point arguments are not NULL, the sync_point argument should not refer to an element of the sync_point_wait_list array.

        mutable_handle - returns a handle to the command.

        Handle is unused by this extension and must be passed as NULL.

      • nclCommandCopyBufferToImageKHR

        public static int nclCommandCopyBufferToImageKHR​(long command_buffer,
                                                         long command_queue,
                                                         long src_buffer,
                                                         long dst_image,
                                                         long src_offset,
                                                         long dst_origin,
                                                         long region,
                                                         int num_sync_points_in_wait_list,
                                                         long sync_point_wait_list,
                                                         long sync_point,
                                                         long mutable_handle)
        Unsafe version of: CommandCopyBufferToImageKHR
      • clCommandCopyBufferToImageKHR

        public static int clCommandCopyBufferToImageKHR​(long command_buffer,
                                                        long command_queue,
                                                        long src_buffer,
                                                        long dst_image,
                                                        long src_offset,
                                                        org.lwjgl.PointerBuffer dst_origin,
                                                        org.lwjgl.PointerBuffer region,
                                                        @Nullable
                                                        java.nio.IntBuffer sync_point_wait_list,
                                                        @Nullable
                                                        java.nio.IntBuffer sync_point,
                                                        @Nullable
                                                        org.lwjgl.PointerBuffer mutable_handle)
        Records a command to copy a buffer object to an image object.
        Parameters:
        command_buffer - a valid command-buffer object
        command_queue - the command-queue the command will be recorded to.

        Parameter is unused by this extension as only a single command-queue is supported and must be NULL.

        sync_point_wait_list - the synchronization-points that need to complete before this particular command can be executed.

        If sync_point_wait_list is NULL, num_sync_points_in_wait_list must be 0. If sync_point_wait_list is not NULL, the list of synchronization-points pointed to by sync_point_wait_list must be valid and num_sync_points_in_wait_list must be greater than 0. The synchronization-points specified in sync_point_wait_list are device side synchronization-points. The command-buffer associated with synchronization-points in sync_point_wait_list must be the same as command_buffer. The memory associated with sync_point_wait_list can be reused or freed after the function returns.

        If sync_point_wait_list is NULL, then this particular command waits until all previous recorded commands to command_queue have completed.

        sync_point - returns a synchronization-point ID that identifies this particular command.

        Synchronization-point objects are unique and can be used to identify this barrier command later on. sync_point can be NULL in which case it will not be possible for the application to record a wait for this command to complete. If the sync_point_wait_list and the sync_point arguments are not NULL, the sync_point argument should not refer to an element of the sync_point_wait_list array.

        mutable_handle - returns a handle to the command.

        Handle is unused by this extension and must be passed as NULL.

      • nclCommandCopyImageKHR

        public static int nclCommandCopyImageKHR​(long command_buffer,
                                                 long command_queue,
                                                 long src_image,
                                                 long dst_image,
                                                 long src_origin,
                                                 long dst_origin,
                                                 long region,
                                                 int num_sync_points_in_wait_list,
                                                 long sync_point_wait_list,
                                                 long sync_point,
                                                 long mutable_handle)
        Unsafe version of: CommandCopyImageKHR
      • clCommandCopyImageKHR

        public static int clCommandCopyImageKHR​(long command_buffer,
                                                long command_queue,
                                                long src_image,
                                                long dst_image,
                                                org.lwjgl.PointerBuffer src_origin,
                                                org.lwjgl.PointerBuffer dst_origin,
                                                org.lwjgl.PointerBuffer region,
                                                @Nullable
                                                java.nio.IntBuffer sync_point_wait_list,
                                                @Nullable
                                                java.nio.IntBuffer sync_point,
                                                @Nullable
                                                org.lwjgl.PointerBuffer mutable_handle)
        Records a command to copy image objects.
        Parameters:
        command_buffer - a valid command-buffer object
        command_queue - the command-queue the command will be recorded to.

        Parameter is unused by this extension as only a single command-queue is supported and must be NULL.

        sync_point_wait_list - the synchronization-points that need to complete before this particular command can be executed.

        If sync_point_wait_list is NULL, num_sync_points_in_wait_list must be 0. If sync_point_wait_list is not NULL, the list of synchronization-points pointed to by sync_point_wait_list must be valid and num_sync_points_in_wait_list must be greater than 0. The synchronization-points specified in sync_point_wait_list are device side synchronization-points. The command-buffer associated with synchronization-points in sync_point_wait_list must be the same as command_buffer. The memory associated with sync_point_wait_list can be reused or freed after the function returns.

        If sync_point_wait_list is NULL, then this particular command waits until all previous recorded commands to command_queue have completed.

        sync_point - returns a synchronization-point ID that identifies this particular command.

        Synchronization-point objects are unique and can be used to identify this barrier command later on. sync_point can be NULL in which case it will not be possible for the application to record a wait for this command to complete. If the sync_point_wait_list and the sync_point arguments are not NULL, the sync_point argument should not refer to an element of the sync_point_wait_list array.

        mutable_handle - returns a handle to the command.

        Handle is unused by this extension and must be passed as NULL.

      • nclCommandCopyImageToBufferKHR

        public static int nclCommandCopyImageToBufferKHR​(long command_buffer,
                                                         long command_queue,
                                                         long src_image,
                                                         long dst_buffer,
                                                         long src_origin,
                                                         long region,
                                                         long dst_offset,
                                                         int num_sync_points_in_wait_list,
                                                         long sync_point_wait_list,
                                                         long sync_point,
                                                         long mutable_handle)
        Unsafe version of: CommandCopyImageToBufferKHR
      • clCommandCopyImageToBufferKHR

        public static int clCommandCopyImageToBufferKHR​(long command_buffer,
                                                        long command_queue,
                                                        long src_image,
                                                        long dst_buffer,
                                                        org.lwjgl.PointerBuffer src_origin,
                                                        org.lwjgl.PointerBuffer region,
                                                        long dst_offset,
                                                        @Nullable
                                                        java.nio.IntBuffer sync_point_wait_list,
                                                        @Nullable
                                                        java.nio.IntBuffer sync_point,
                                                        @Nullable
                                                        org.lwjgl.PointerBuffer mutable_handle)
        Records a command to copy an image object to a buffer object.
        Parameters:
        command_buffer - a valid command-buffer object
        command_queue - the command-queue the command will be recorded to.

        Parameter is unused by this extension as only a single command-queue is supported and must be NULL.

        sync_point_wait_list - the synchronization-points that need to complete before this particular command can be executed.

        If sync_point_wait_list is NULL, num_sync_points_in_wait_list must be 0. If sync_point_wait_list is not NULL, the list of synchronization-points pointed to by sync_point_wait_list must be valid and num_sync_points_in_wait_list must be greater than 0. The synchronization-points specified in sync_point_wait_list are device side synchronization-points. The command-buffer associated with synchronization-points in sync_point_wait_list must be the same as command_buffer. The memory associated with sync_point_wait_list can be reused or freed after the function returns.

        If sync_point_wait_list is NULL, then this particular command waits until all previous recorded commands to command_queue have completed.

        sync_point - returns a synchronization-point ID that identifies this particular command.

        Synchronization-point objects are unique and can be used to identify this barrier command later on. sync_point can be NULL in which case it will not be possible for the application to record a wait for this command to complete. If the sync_point_wait_list and the sync_point arguments are not NULL, the sync_point argument should not refer to an element of the sync_point_wait_list array.

        mutable_handle - returns a handle to the command.

        Handle is unused by this extension and must be passed as NULL.

      • nclCommandFillBufferKHR

        public static int nclCommandFillBufferKHR​(long command_buffer,
                                                  long command_queue,
                                                  long buffer,
                                                  long pattern,
                                                  long pattern_size,
                                                  long offset,
                                                  long size,
                                                  int num_sync_points_in_wait_list,
                                                  long sync_point_wait_list,
                                                  long sync_point,
                                                  long mutable_handle)
        Unsafe version of: CommandFillBufferKHR
      • clCommandFillBufferKHR

        public static int clCommandFillBufferKHR​(long command_buffer,
                                                 long command_queue,
                                                 long buffer,
                                                 java.nio.ByteBuffer pattern,
                                                 long offset,
                                                 long size,
                                                 @Nullable
                                                 java.nio.IntBuffer sync_point_wait_list,
                                                 @Nullable
                                                 java.nio.IntBuffer sync_point,
                                                 @Nullable
                                                 org.lwjgl.PointerBuffer mutable_handle)
        Records a command to fill a buffer object with a pattern of a given pattern size.
        Parameters:
        command_buffer - a valid command-buffer object
        command_queue - the command-queue the command will be recorded to.

        Parameter is unused by this extension as only a single command-queue is supported and must be NULL.

        sync_point_wait_list - the synchronization-points that need to complete before this particular command can be executed.

        If sync_point_wait_list is NULL, num_sync_points_in_wait_list must be 0. If sync_point_wait_list is not NULL, the list of synchronization-points pointed to by sync_point_wait_list must be valid and num_sync_points_in_wait_list must be greater than 0. The synchronization-points specified in sync_point_wait_list are device side synchronization-points. The command-buffer associated with synchronization-points in sync_point_wait_list must be the same as command_buffer. The memory associated with sync_point_wait_list can be reused or freed after the function returns.

        If sync_point_wait_list is NULL, then this particular command waits until all previous recorded commands to command_queue have completed.

        sync_point - returns a synchronization-point ID that identifies this particular command.

        Synchronization-point objects are unique and can be used to identify this barrier command later on. sync_point can be NULL in which case it will not be possible for the application to record a wait for this command to complete. If the sync_point_wait_list and the sync_point arguments are not NULL, the sync_point argument should not refer to an element of the sync_point_wait_list array.

        mutable_handle - returns a handle to the command.

        Handle is unused by this extension and must be passed as NULL.

      • nclCommandFillImageKHR

        public static int nclCommandFillImageKHR​(long command_buffer,
                                                 long command_queue,
                                                 long image,
                                                 long fill_color,
                                                 long origin,
                                                 long region,
                                                 int num_sync_points_in_wait_list,
                                                 long sync_point_wait_list,
                                                 long sync_point,
                                                 long mutable_handle)
        Unsafe version of: CommandFillImageKHR
      • clCommandFillImageKHR

        public static int clCommandFillImageKHR​(long command_buffer,
                                                long command_queue,
                                                long image,
                                                java.nio.ByteBuffer fill_color,
                                                org.lwjgl.PointerBuffer origin,
                                                org.lwjgl.PointerBuffer region,
                                                @Nullable
                                                java.nio.IntBuffer sync_point_wait_list,
                                                @Nullable
                                                java.nio.IntBuffer sync_point,
                                                @Nullable
                                                org.lwjgl.PointerBuffer mutable_handle)
        
        public static int clCommandFillImageKHR​(long command_buffer,
                                                long command_queue,
                                                long image,
                                                java.nio.IntBuffer fill_color,
                                                org.lwjgl.PointerBuffer origin,
                                                org.lwjgl.PointerBuffer region,
                                                @Nullable
                                                java.nio.IntBuffer sync_point_wait_list,
                                                @Nullable
                                                java.nio.IntBuffer sync_point,
                                                @Nullable
                                                org.lwjgl.PointerBuffer mutable_handle)
        
        public static int clCommandFillImageKHR​(long command_buffer,
                                                long command_queue,
                                                long image,
                                                java.nio.FloatBuffer fill_color,
                                                org.lwjgl.PointerBuffer origin,
                                                org.lwjgl.PointerBuffer region,
                                                @Nullable
                                                java.nio.IntBuffer sync_point_wait_list,
                                                @Nullable
                                                java.nio.IntBuffer sync_point,
                                                @Nullable
                                                org.lwjgl.PointerBuffer mutable_handle)
        
        Records a command to fill an image object with a specified color.
        Parameters:
        command_buffer - a valid command-buffer object
        command_queue - the command-queue the command will be recorded to.

        Parameter is unused by this extension as only a single command-queue is supported and must be NULL.

        sync_point_wait_list - the synchronization-points that need to complete before this particular command can be executed.

        If sync_point_wait_list is NULL, num_sync_points_in_wait_list must be 0. If sync_point_wait_list is not NULL, the list of synchronization-points pointed to by sync_point_wait_list must be valid and num_sync_points_in_wait_list must be greater than 0. The synchronization-points specified in sync_point_wait_list are device side synchronization-points. The command-buffer associated with synchronization-points in sync_point_wait_list must be the same as command_buffer. The memory associated with sync_point_wait_list can be reused or freed after the function returns.

        If sync_point_wait_list is NULL, then this particular command waits until all previous recorded commands to command_queue have completed.

        sync_point - returns a synchronization-point ID that identifies this particular command.

        Synchronization-point objects are unique and can be used to identify this barrier command later on. sync_point can be NULL in which case it will not be possible for the application to record a wait for this command to complete. If the sync_point_wait_list and the sync_point arguments are not NULL, the sync_point argument should not refer to an element of the sync_point_wait_list array.

        mutable_handle - returns a handle to the command.

        Handle is unused by this extension and must be passed as NULL.

      • nclCommandNDRangeKernelKHR

        public static int nclCommandNDRangeKernelKHR​(long command_buffer,
                                                     long command_queue,
                                                     long properties,
                                                     long kernel,
                                                     int work_dim,
                                                     long global_work_offset,
                                                     long global_work_size,
                                                     long local_work_size,
                                                     int num_sync_points_in_wait_list,
                                                     long sync_point_wait_list,
                                                     long sync_point,
                                                     long mutable_handle)
        Unsafe version of: CommandNDRangeKernelKHR
      • clCommandNDRangeKernelKHR

        public static int clCommandNDRangeKernelKHR​(long command_buffer,
                                                    long command_queue,
                                                    @Nullable
                                                    java.nio.LongBuffer properties,
                                                    long kernel,
                                                    int work_dim,
                                                    @Nullable
                                                    org.lwjgl.PointerBuffer global_work_offset,
                                                    @Nullable
                                                    org.lwjgl.PointerBuffer global_work_size,
                                                    @Nullable
                                                    org.lwjgl.PointerBuffer local_work_size,
                                                    @Nullable
                                                    java.nio.IntBuffer sync_point_wait_list,
                                                    @Nullable
                                                    java.nio.IntBuffer sync_point,
                                                    @Nullable
                                                    org.lwjgl.PointerBuffer mutable_handle)
        Records a command to execute a kernel on a device.
        Parameters:
        command_buffer - a valid command-buffer object
        command_queue - the command-queue the command will be recorded to.

        Parameter is unused by this extension as only a single command-queue is supported and must be NULL.

        kernel - a valid kernel object
        sync_point_wait_list - the synchronization-points that need to complete before this particular command can be executed.

        If sync_point_wait_list is NULL, num_sync_points_in_wait_list must be 0. If sync_point_wait_list is not NULL, the list of synchronization-points pointed to by sync_point_wait_list must be valid and num_sync_points_in_wait_list must be greater than 0. The synchronization-points specified in sync_point_wait_list are device side synchronization-points. The command-buffer associated with synchronization-points in sync_point_wait_list must be the same as command_buffer. The memory associated with sync_point_wait_list can be reused or freed after the function returns.

        If sync_point_wait_list is NULL, then this particular command waits until all previous recorded commands to command_queue have completed.

        sync_point - returns a synchronization-point ID that identifies this particular command.

        Synchronization-point objects are unique and can be used to identify this barrier command later on. sync_point can be NULL in which case it will not be possible for the application to record a wait for this command to complete. If the sync_point_wait_list and the sync_point arguments are not NULL, the sync_point argument should not refer to an element of the sync_point_wait_list array.

        mutable_handle - returns a handle to the command.

        Handle is unused by this extension and must be passed as NULL.

      • nclGetCommandBufferInfoKHR

        public static int nclGetCommandBufferInfoKHR​(long command_buffer,
                                                     int param_name,
                                                     long param_value_size,
                                                     long param_value,
                                                     long param_value_size_ret)
        Unsafe version of: GetCommandBufferInfoKHR
        Parameters:
        param_value_size - the size in bytes of memory pointed to by param_value. This size must be ≥ size of return type. If param_value is NULL, it is ignored.
      • clGetCommandBufferInfoKHR

        public static int clGetCommandBufferInfoKHR​(long command_buffer,
                                                    int param_name,
                                                    @Nullable
                                                    java.nio.ByteBuffer param_value,
                                                    @Nullable
                                                    org.lwjgl.PointerBuffer param_value_size_ret)
        
        public static int clGetCommandBufferInfoKHR​(long command_buffer,
                                                    int param_name,
                                                    @Nullable
                                                    java.nio.IntBuffer param_value,
                                                    @Nullable
                                                    org.lwjgl.PointerBuffer param_value_size_ret)
        
        public static int clGetCommandBufferInfoKHR​(long command_buffer,
                                                    int param_name,
                                                    @Nullable
                                                    org.lwjgl.PointerBuffer param_value,
                                                    @Nullable
                                                    org.lwjgl.PointerBuffer param_value_size_ret)
        
        Queries information about a command-buffer.
        Parameters:
        command_buffer - the command-buffer being queried
        param_name - the information to query
        param_value - a pointer to memory where the appropriate result being queried is returned. If param_value is NULL, it is ignored.
        param_value_size_ret - the actual size in bytes of data being queried by param_value. If NULL, it is ignored.
      • clCreateCommandBufferKHR

        public static long clCreateCommandBufferKHR​(org.lwjgl.PointerBuffer queues,
                                                    @Nullable
                                                    long[] properties,
                                                    @Nullable
                                                    int[] errcode_ret)
        Array version of: CreateCommandBufferKHR
      • clCommandBarrierWithWaitListKHR

        public static int clCommandBarrierWithWaitListKHR​(long command_buffer,
                                                          long command_queue,
                                                          @Nullable
                                                          int[] sync_point_wait_list,
                                                          @Nullable
                                                          int[] sync_point,
                                                          @Nullable
                                                          org.lwjgl.PointerBuffer mutable_handle)
      • clCommandCopyBufferKHR

        public static int clCommandCopyBufferKHR​(long command_buffer,
                                                 long command_queue,
                                                 long src_buffer,
                                                 long dst_buffer,
                                                 long src_offset,
                                                 long dst_offset,
                                                 long size,
                                                 @Nullable
                                                 int[] sync_point_wait_list,
                                                 @Nullable
                                                 int[] sync_point,
                                                 @Nullable
                                                 org.lwjgl.PointerBuffer mutable_handle)
        Array version of: CommandCopyBufferKHR
      • clCommandCopyBufferRectKHR

        public static int clCommandCopyBufferRectKHR​(long command_buffer,
                                                     long command_queue,
                                                     long src_buffer,
                                                     long dst_buffer,
                                                     org.lwjgl.PointerBuffer src_origin,
                                                     org.lwjgl.PointerBuffer dst_origin,
                                                     org.lwjgl.PointerBuffer region,
                                                     long src_row_pitch,
                                                     long src_slice_pitch,
                                                     long dst_row_pitch,
                                                     long dst_slice_pitch,
                                                     @Nullable
                                                     int[] sync_point_wait_list,
                                                     @Nullable
                                                     int[] sync_point,
                                                     @Nullable
                                                     org.lwjgl.PointerBuffer mutable_handle)
        Array version of: CommandCopyBufferRectKHR
      • clCommandCopyBufferToImageKHR

        public static int clCommandCopyBufferToImageKHR​(long command_buffer,
                                                        long command_queue,
                                                        long src_buffer,
                                                        long dst_image,
                                                        long src_offset,
                                                        org.lwjgl.PointerBuffer dst_origin,
                                                        org.lwjgl.PointerBuffer region,
                                                        @Nullable
                                                        int[] sync_point_wait_list,
                                                        @Nullable
                                                        int[] sync_point,
                                                        @Nullable
                                                        org.lwjgl.PointerBuffer mutable_handle)
        Array version of: CommandCopyBufferToImageKHR
      • clCommandCopyImageKHR

        public static int clCommandCopyImageKHR​(long command_buffer,
                                                long command_queue,
                                                long src_image,
                                                long dst_image,
                                                org.lwjgl.PointerBuffer src_origin,
                                                org.lwjgl.PointerBuffer dst_origin,
                                                org.lwjgl.PointerBuffer region,
                                                @Nullable
                                                int[] sync_point_wait_list,
                                                @Nullable
                                                int[] sync_point,
                                                @Nullable
                                                org.lwjgl.PointerBuffer mutable_handle)
        Array version of: CommandCopyImageKHR
      • clCommandCopyImageToBufferKHR

        public static int clCommandCopyImageToBufferKHR​(long command_buffer,
                                                        long command_queue,
                                                        long src_image,
                                                        long dst_buffer,
                                                        org.lwjgl.PointerBuffer src_origin,
                                                        org.lwjgl.PointerBuffer region,
                                                        long dst_offset,
                                                        @Nullable
                                                        int[] sync_point_wait_list,
                                                        @Nullable
                                                        int[] sync_point,
                                                        @Nullable
                                                        org.lwjgl.PointerBuffer mutable_handle)
        Array version of: CommandCopyImageToBufferKHR
      • clCommandFillBufferKHR

        public static int clCommandFillBufferKHR​(long command_buffer,
                                                 long command_queue,
                                                 long buffer,
                                                 java.nio.ByteBuffer pattern,
                                                 long offset,
                                                 long size,
                                                 @Nullable
                                                 int[] sync_point_wait_list,
                                                 @Nullable
                                                 int[] sync_point,
                                                 @Nullable
                                                 org.lwjgl.PointerBuffer mutable_handle)
        Array version of: CommandFillBufferKHR
      • clCommandFillImageKHR

        public static int clCommandFillImageKHR​(long command_buffer,
                                                long command_queue,
                                                long image,
                                                java.nio.ByteBuffer fill_color,
                                                org.lwjgl.PointerBuffer origin,
                                                org.lwjgl.PointerBuffer region,
                                                @Nullable
                                                int[] sync_point_wait_list,
                                                @Nullable
                                                int[] sync_point,
                                                @Nullable
                                                org.lwjgl.PointerBuffer mutable_handle)
        
        public static int clCommandFillImageKHR​(long command_buffer,
                                                long command_queue,
                                                long image,
                                                int[] fill_color,
                                                org.lwjgl.PointerBuffer origin,
                                                org.lwjgl.PointerBuffer region,
                                                @Nullable
                                                int[] sync_point_wait_list,
                                                @Nullable
                                                int[] sync_point,
                                                @Nullable
                                                org.lwjgl.PointerBuffer mutable_handle)
        
        public static int clCommandFillImageKHR​(long command_buffer,
                                                long command_queue,
                                                long image,
                                                float[] fill_color,
                                                org.lwjgl.PointerBuffer origin,
                                                org.lwjgl.PointerBuffer region,
                                                @Nullable
                                                int[] sync_point_wait_list,
                                                @Nullable
                                                int[] sync_point,
                                                @Nullable
                                                org.lwjgl.PointerBuffer mutable_handle)
        
        Array version of: CommandFillImageKHR
      • clCommandNDRangeKernelKHR

        public static int clCommandNDRangeKernelKHR​(long command_buffer,
                                                    long command_queue,
                                                    @Nullable
                                                    long[] properties,
                                                    long kernel,
                                                    int work_dim,
                                                    @Nullable
                                                    org.lwjgl.PointerBuffer global_work_offset,
                                                    @Nullable
                                                    org.lwjgl.PointerBuffer global_work_size,
                                                    @Nullable
                                                    org.lwjgl.PointerBuffer local_work_size,
                                                    @Nullable
                                                    int[] sync_point_wait_list,
                                                    @Nullable
                                                    int[] sync_point,
                                                    @Nullable
                                                    org.lwjgl.PointerBuffer mutable_handle)
        Array version of: CommandNDRangeKernelKHR
      • clGetCommandBufferInfoKHR

        public static int clGetCommandBufferInfoKHR​(long command_buffer,
                                                    int param_name,
                                                    @Nullable
                                                    int[] param_value,
                                                    @Nullable
                                                    org.lwjgl.PointerBuffer param_value_size_ret)
        Array version of: GetCommandBufferInfoKHR