'\" t
.\"     Title: clEnqueueFillBuffer
.\"    Author: The Khronos Group
.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
.\"      Date: 01/14/2021
.\"    Manual: OpenCL Manual
.\"    Source: The Khronos Group
.\"  Language: English
.\"
.TH "CLENQUEUEFILLBUFFER" "3clc" "01/14/2021" "The Khronos Group" "OpenCL Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.\" http://bugs.debian.org/507673
.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\" -----------------------------------------------------------------
.\" * set default formatting
.\" -----------------------------------------------------------------
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.\" -----------------------------------------------------------------
.\" * MAIN CONTENT STARTS HERE *
.\" -----------------------------------------------------------------
.SH "NAME"
clEnqueueFillBuffer \- Enqueues a command to fill a buffer object with a pattern of a given pattern size\&.
.SH ""
.HP \w'cl_int\ clEnqueueFillBuffer('u
.BI "cl_int clEnqueueFillBuffer(cl_command_queue\ " "command_queue" ", cl_mem\ " "buffer" ", const\ void\ *" "pattern" ", size_t\ " "pattern_size" ", size_t\ " "offset" ", size_t\ " "size" ", cl_uint\ " "num_events_in_wait_list" ", const\ cl_event\ *" "event_wait_list" ", cl_event\ *" "event" ");"
.SH "PARAMETERS"
.PP
\fI command_queue \fR
.RS 4
Refers to the command\-queue in which the fill command will be queued\&. The OpenCL context associated with
\fIcommand_queue\fR
and
\fIbuffer\fR
must be the same\&.
.RE
.PP
\fI buffer \fR
.RS 4
A valid buffer object\&.
.RE
.PP
\fI pattern \fR
.RS 4
A pointer to the data pattern of size
\fIpattern_size\fR
in bytes\&.
\fIpattern\fR
will be used to fill a region in
\fIbuffer\fR
starting at
\fIoffset\fR
and is
\fIsize\fR
bytes in size\&. The data pattern must be a scalar or vector integer or floating\-point data type\&. For example, if
\fIbuffer\fR
is to be filled with a pattern of
\fBfloat4\fR
values, then
\fIpattern\fR
will be a pointer to a
\fBcl_float4\fR
value and
\fIpattern_size\fR
will be
sizeof(cl_float4)\&. The maximum value of
\fIpattern_size\fR
is the size of the largest integer or floating\-point vector data type supported by the OpenCL device\&. The memory associated with
\fIpattern\fR
can be reused or freed after the function returns\&.
.RE
.PP
\fI offset \fR
.RS 4
The location in bytes of the region being filled in
\fIbuffer\fR
and must be a multiple of
\fIpattern_size\fR\&.
.RE
.PP
\fI size \fR
.RS 4
The size in bytes of region being filled in
\fIbuffer\fR
and must be a multiple of
\fIpattern_size\fR\&.
.RE
.PP
\fI event_wait_list ,\fR \fI num_events_in_wait_list \fR
.RS 4
Specify events that need to complete before this particular command can be executed\&. If
\fIevent_wait_list\fR
is NULL, then this particular command does not wait on any event to complete\&. If
\fIevent_wait_list\fR
is NULL,
\fInum_events_in_wait_list\fR
must be 0\&. If
\fIevent_wait_list\fR
is not NULL, the list of events pointed to by
\fIevent_wait_list\fR
must be valid and
\fInum_events_in_wait_list\fR
must be greater than 0\&. The events specified in
\fIevent_wait_list\fR
act as synchronization points\&. The context associated with events in
\fIevent_wait_list\fR
and
\fIcommand_queue\fR
must be the same\&. The memory associated with
\fIevent_wait_list\fR
can be reused or freed after the function returns\&.
.RE
.PP
\fI event \fR
.RS 4
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\&.
\fIevent\fR
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\&.
\fBclEnqueueBarrierWithWaitList\fR(3clc)
can be used instead\&. If the
\fIevent_wait_list\fR
and the
\fIevent\fR
arguments are not NULL, the
\fIevent\fR
argument should not refer to an element of the
\fIevent_wait_list\fR
array\&.
.RE
.SH "NOTES"
.PP
Enqueues a command to fill a buffer object with a pattern of a given pattern size\&. The usage information which indicates whether the memory object can be read or written by a kernel and/or the host and is given by the
\fBcl_mem_flags\fR
argument value specified when buffer is created is ignored by
\fBclEnqueueFillBuffer\fR\&.
.SH "ERRORS"
.PP
\fBclEnqueueFillBuffer\fR
returns
CL_SUCCESS
if the function is executed successfully\&. Otherwise, it returns one of the following errors\&.
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
CL_INVALID_COMMAND_QUEUE if \fIcommand_queue\fR
is not a valid command\-queue\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
CL_INVALID_CONTEXT if the context associated with
\fIcommand_queue\fR and \fIbuffer\fR are not the same
or if the context associated with \fIcommand_queue\fR and events in
\fIevent_wait_list\fR are not the same\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
CL_INVALID_MEM_OBJECT if \fIbuffer\fR is not
a valid buffer object\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
CL_INVALID_VALUE if \fIoffset\fR or
\fIoffset\fR + \fIsize\fR require accessing elements
outside the \fIbuffer\fR buffer object respectively\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
CL_INVALID_VALUE if \fIpattern\fR is NULL
or if \fIpattern_size\fR is 0 or if \fIpattern_size\fR
is not one of {1, 2, 4, 8, 16, 32, 64, 128}\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
CL_INVALID_VALUE if \fIoffset\fR and
\fIsize\fR are not a multiple of \fIpattern_size\fR\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
CL_INVALID_EVENT_WAIT_LIST
if \fIevent_wait_list\fR is NULL and
\fInum_events_in_wait_list\fR > 0,
or \fIevent_wait_list\fR is not NULL and
\fInum_events_in_wait_list\fR is 0, or if event objects in
\fIevent_wait_list\fR are not valid events\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
CL_MISALIGNED_SUB_BUFFER_OFFSET if \fIbuffer\fR
is a sub\-buffer object and offset specified when the sub\-buffer object is created
is not aligned to \fBCL_DEVICE_MEM_BASE_ADDR_ALIGN\fR value for
device associated with \fIqueue\fR\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
CL_MEM_OBJECT_ALLOCATION_FAILURE if there is a failure to
allocate memory for data store associated with \fIbuffer\fR\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
CL_OUT_OF_RESOURCES if there is a failure to allocate
resources required by the OpenCL implementation on the device\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
CL_OUT_OF_HOST_MEMORY if there is a failure to allocate
resources required by the OpenCL implementation on the host\&.
.RE
.SH "SPECIFICATION"
.PP
\m[blue]\fBOpenCL Specification\fR\m[]\&\s-2\u[1]\d\s+2
.SH "SEE ALSO"
.PP
\fBclEnqueueBarrierWithWaitList\fR(3clc)
.SH "AUTHORS"
.PP
\fBThe Khronos Group\fR
.SH "COPYRIGHT"
.br
Copyright \(co 2007-2011 The Khronos Group Inc.
.br
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.
.sp
.SH "NOTES"
.IP " 1." 4
OpenCL Specification
.RS 4
\%page 84, section 5.2.2 - Reading, Writing and Copying Buffer Objects
.RE