NAME

       clEnqueueBarrierWithWaitList - A synchronization point that enqueues a barrier operation.

       cl_int clEnqueueBarrierWithWaitList(cl_command_queue command_queue, cl_uint num_events_in_wait_list,
                                           const cl_event *event_wait_list, cl_event *event);

PARAMETERS

        command_queue
           A valid command queue.

        event_wait_list ,  num_events_in_wait_list
           Specify events that need to complete before this particular command can be executed.

           If event_wait_list is NULL, num_events_in_wait_list must be 0. If event_wait_list is not NULL, the
           list of events pointed to by event_wait_list must be valid and num_events_in_wait_list must be
           greater than 0. 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. The memory associated
           with event_wait_list can be reused or freed after the function returns.

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

        event
           Returns an event object that identifies this particular command. Event objects are unique and can be
           used to identify this barrier command later on.  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.

NOTES

       Enqueues a barrier command which waits for either a list of events to complete, or if the list is empty
       it waits for all commands previously enqueued in command_queue to complete before it completes. This
       command blocks command execution, that is, any following commands enqueued after it do not execute until
       it completes. This command returns an event which can be waited on, i.e. this event can be waited on to
       insure that all events either in the event_wait_list or all previously enqueued commands, queued before
       this command to command_queue, have completed.

ERRORS

       Returns CL_SUCCESS if the function was successfully executed. Otherwise, it returns one of the following
       errors:

       •   CL_INVALID_COMMAND_QUEUE if command_queue is not a valid command-queue.

       •   CL_INVALID_EVENT_WAIT_LIST if event_wait_list is NULL and num_events_in_wait_list > 0, or
           event_wait_list is not NULL and num_events_in_wait_list is 0, or if event objects in event_wait_list
           are not valid events.

       •   CL_OUT_OF_RESOURCES if there is a failure to allocate resources required by the OpenCL implementation
           on the device.

       •   CL_OUT_OF_HOST_MEMORY if there is a failure to allocate resources required by the OpenCL
           implementation on the host.

SPECIFICATION

       OpenCL Specification[1]

SEE ALSO

       clEnqueueFillBuffer(3clc), clEnqueueCopyBuffer(3clc), clEnqueueCopyBufferRect(3clc),
       clEnqueueFillImage(3clc), clEnqueueCopyImage(3clc), clEnqueueCopyImageToBuffer(3clc),
       clEnqueueCopyBufferToImage(3clc), clEnqueueUnmapMemObject(3clc)

AUTHORS

       The Khronos Group

COPYRIGHT

       Copyright © 2007-2011 The Khronos Group Inc.
       Permission is hereby granted, free of charge, to any person obtaining a copy of this software and/or
       associated documentation files (the "Materials"), to deal in the Materials without restriction, including
       without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
       copies of the Materials, and to permit persons to whom the Materials are furnished to do so, subject to
       the condition that this copyright notice and permission notice shall be included in all copies or
       substantial portions of the Materials.

NOTES

        1. OpenCL Specification
           page 187, section 5.10 - Markers, Barriers and Waiting for Events