Enqueues a command to fill a region in memory with a pattern of a given pattern size.
command_queue
Refers to the host command-queue in which the fill command will be queued.
The OpenCL context associated with command_queue
and SVM pointer referred to by svm_ptr
must be the same.
svm_ptr
A pointer to a memory region that will be filled with
pattern
. It must be aligned to
pattern_size
bytes. If
svm_ptr
is allocated using
clSVMAlloc
then it must be allocated from the
same context from which
command_queue
was created.
Otherwise the behavior is undefined.
pattern
A pointer to the data pattern of size pattern_size
in bytes. pattern
will be used to fill a region
in buffer
starting at svm_ptr
and is size
bytes in size. The data pattern
must be a scalar or vector integer or floating-point data type. For
example, if region pointed to by svm_ptr
is to be filled with a pattern of
float4 values, then pattern
will be a pointer
to a cl_float4 value and pattern_size
will be sizeof(cl_float4)
. The maximum value of
pattern_size
is the size of the largest integer
or floating-point vector data type supported by the OpenCL device.
The memory associated with pattern
can be reused or
freed after the function returns.
size
The size in bytes of region being filled starting with svm_ptr
and must be a multiple of pattern_size
.
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, then this particular command does not wait on any
event to complete. 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.
event
Returns an event object that identifies this particular write
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.
clEnqueueBarrierWithWaitList
can be used instead. 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.
clEnqueueSVMMemFill
returns CL_SUCCESS if
the function is executed successfully. Otherwise, it returns one of the following errors.
command_queue
is not a valid host command-queue.
command_queue
and events in
event_wait_list
are not the same.
svm_ptr
is NULL.
svm_ptr
is not aligned to pattern_size
bytes.
pattern
is NULL
or if pattern_size
is 0 or if pattern_size
is not one of {1, 2, 4, 8, 16, 32, 64, 128}.
size
is not a multiple of pattern_size
.
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.