'\" t
.\"     Title: clEnqueueCopyImageToBuffer
.\"    Author: The Khronos Group
.\" Generator: DocBook XSL Stylesheets v1.79.1 <http://docbook.sf.net/>
.\"      Date: 02/03/2019
.\"    Manual: OpenCL Manual
.\"    Source: The Khronos Group
.\"  Language: English
.\"
.TH "CLENQUEUECOPYIMAGETO" "3clc" "02/03/2019" "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"
clEnqueueCopyImageToBuffer \- Enqueues a command to copy an image object to a buffer object\&.
.SH ""
.HP \w'cl_int\ clEnqueueCopyImageToBuffer('u
.BI "cl_int clEnqueueCopyImageToBuffer(cl_command_queue\ " "command_queue" ", cl_mem\ " "src_image" ", cl_mem\ " "dst_buffer" ", const\ size_t\ *" "src_origin" ", const\ size_t\ *" "region" ", size_t\ " "dst_offset" ", 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
Must be a valid command\-queue\&. The OpenCL context associated with
\fIcommand_queue\fR,
\fIsrc_image\fR, and
\fIdst_buffer\fR
must be the same\&.
.RE
.PP
\fI src_image \fR
.RS 4
A valid image object\&.
.RE
.PP
\fI dst_buffer \fR
.RS 4
A valid buffer object\&.
.RE
.PP
\fI src_origin \fR
.RS 4
Defines the (x, y, z) offset in pixels in the 1D, 2D or 3D image, the (x, y) offset and the image index in the 2D image array or the (x) offset and the image index in the 1D image array\&. If
\fIsrc_image\fR
is a 2D image object,
\fIsrc_origin\fR[2] must be 0\&. If
\fIsrc_image\fR
is a 1D image or 1D image buffer object,
\fIsrc_origin\fR[1] and
\fIsrc_origin\fR[2] must be 0\&. If
\fIsrc_image\fR
is a 1D image array object,
\fIsrc_origin\fR[2] must be 0\&. If
\fIsrc_image\fR
is a 1D image array object,
\fIsrc_origin\fR[1] describes the image index in the 1D image array\&. If
\fIsrc_image\fR
is a 2D image array object,
\fIsrc_origin\fR[2] describes the image index in the 2D image array\&.
.RE
.PP
\fI region \fR
.RS 4
Defines the (width, height, depth) in pixels of the 1D, 2D or 3D rectangle, the (width, height) in pixels of the 2D rectangle and the number of images of a 2D image array or the (width) in pixels of the 1D rectangle and the number of images of a 1D image array\&. If
\fIsrc_image\fR
is a 2D image object,
\fIregion\fR[2] must be 1\&. If
\fIsrc_image\fR
is a 1D image or 1D image buffer object,
\fIregion\fR[1] and
\fIregion\fR[2] must be 1\&. If
\fIsrc_image\fR
is a 1D image array object,
\fIregion\fR[2] must be 1\&.
.RE
.PP
\fI dst_offset \fR
.RS 4
Refers to the offset where to begin copying data into
\fIdst_buffer\fR\&. The size in bytes of the region to be copied referred to as dst_cb is computed as width * height * depth * bytes/image element if
\fIsrc_image\fR
is a 3D image object, is computed as width * height * bytes/image element if
\fIsrc_image\fR
is a 2D image, is computed as width * height * arraysize * bytes/image element if
\fIsrc_image\fR
is a 2D image array object, is computed as width * bytes/image element if
\fIsrc_image\fR
is a 1D image or 1D image buffer object and is computed as width * arraysize * bytes/image element if
\fIsrc_image\fR
is a 1D image array object\&.
.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 copy 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 "ERRORS"
.PP
\fBclEnqueueCopyImageToBuffer\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, \fIsrc_image\fR and
\fIdst_buffer\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 \fIsrc_image\fR is
not a valid image object or \fIdst_buffer\fR is not a valid buffer
object or if \fIsrc_image\fR is a 1D image buffer object created
from \fIdst_buffer\fR\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
CL_INVALID_VALUE if the 1D, 2D, or 3D rectangular region
specified by \fIsrc_origin\fR and \fIsrc_origin\fR +
\fIregion\fR refers to a region outside \fIsrc_image\fR,
or if the region specified by \fIdst_offset\fR and
\fIdst_offset\fR + \fIdst_cb\fR refers to a region
outside \fIdst_buffer\fR\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
CL_INVALID_VALUE if values in \fIsrc_origin\fR
and \fIregion\fR do not follow rules described in the argument
description for \fIsrc_origin\fR and \fIregion\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
\fIdst_buffer\fR is a sub\-buffer object and \fIoffset\fR
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_INVALID_IMAGE_SIZE if image dimensions (image width,
height, specified or compute row and/or slice pitch) for \fIsrc_image\fR
are not supported by 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_INVALID_IMAGE_FORMAT if image format (image channel
order and data type) for \fIsrc_image\fR are not supported by 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 \fIsrc_image\fR
or \fIdst_buffer\fR\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
CL_INVALID_OPERATION if the device
associated with \fIcommand_queue\fR does not
support images (i\&.e\&. \fBCL_DEVICE_IMAGE_SUPPORT\fR
specified in the table  of OpenCL Device Queries for
\fBclGetDeviceInfo\fR(3clc)
is CL_FALSE)\&.
.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
\fBclEnqueueReadBuffer\fR(3clc),
\fBclEnqueueWriteBuffer\fR(3clc),
\fBclCreateBuffer\fR(3clc),
\fBclEnqueueCopyBuffer\fR(3clc),
\fBclEnqueueCopyBufferToImage\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 107, section 5.3.4 - Copying between Image and Buffer Objects
.RE