'\" t
.\"     Title: clEnqueueUnmapMemObject
.\"    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 "CLENQUEUEUNMAPMEMOBJ" "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"
clEnqueueUnmapMemObject \- Enqueues a command to unmap a previously mapped region of a memory object\&.
.SH ""
.HP \w'cl_int\ clEnqueueUnmapMemObject('u
.BI "cl_int clEnqueueUnmapMemObject(cl_command_queue\ " "command_queue" ", cl_mem\ " "memobj" ", void\ *" "mapped_ptr" ", 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\&.
.RE
.PP
\fI memobj \fR
.RS 4
A valid memory object\&. The OpenCL context associated with
\fIcommand_queue\fR
and
\fImemobj\fR
must be the same\&.
.RE
.PP
\fI mapped_ptr \fR
.RS 4
The host address returned by a previous call to
\fBclEnqueueMapBuffer\fR(3clc)
or
\fBclEnqueueMapImage\fR(3clc)
for
\fImemobj\fR\&.
.RE
.PP
\fI event_wait_list ,\fR \fI num_events_in_wait_list \fR
.RS 4
Specify events that need to complete before
\fBclEnqueueUnmapMemObject\fR
can be executed\&. If
\fIevent_wait_list\fR
is NULL, then
\fBclEnqueueUnmapMemObject\fR
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\&.
.RE
.SH "NOTES"
.PP
Reads or writes from the host using the pointer returned by
\fBclEnqueueMapBuffer\fR(3clc)
or
\fBclEnqueueMapImage\fR(3clc)
are considered to be complete\&.
.PP

\fBclEnqueueMapBuffer\fR(3clc)
and
\fBclEnqueueMapImage\fR(3clc)
increment the mapped count of the memory object\&. The initial mapped count value of a memory object is zero\&. Multiple calls to
\fBclEnqueueMapBuffer\fR(3clc)
or
\fBclEnqueueMapImage\fR(3clc)
on the same memory object will increment this mapped count by appropriate number of calls\&.
\fBclEnqueueUnmapMemObject\fR
decrements the mapped count of the memory object\&.
.PP

\fBclEnqueueMapBuffer\fR(3clc)
and
\fBclEnqueueMapImage\fR(3clc)
act as synchronization points for a region of the buffer object being mapped\&.
.SH "ERRORS"
.PP
\fBclEnqueueUnmapMemObject\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_MEM_OBJECT if \fImemobj\fR is not
a valid memory object\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
CL_INVALID_VALUE if
\fImapped_ptr\fR is not a valid pointer returned by
\fBclEnqueueMapBuffer\fR(3clc)
or \fBclEnqueueMapImage\fR(3clc)
for \fImemobj\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_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
.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 \fImemobj\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
.SH "SPECIFICATION"
.PP
\m[blue]\fBOpenCL Specification\fR\m[]\&\s-2\u[1]\d\s+2
.SH "SEE ALSO"
.PP
\fBclEnqueueMapBuffer\fR(3clc),
\fBclEnqueueMapImage\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 120, section 5.4.2 - Unmapping Mapped Memory Objects
.RE