blob: 38844967db2a9cd524dc51876ee2fea43d7ac85e [file] [log] [blame]
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook MathML Module V1.1b1//EN"
<holder>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.</holder>
<!-- ================================ SYNOPSIS -->
<refnamediv id="clTerminateContextKHR">
Terminates all pending work associated with the context and renders all data owned by the context invalid.
<refsynopsisdiv xmlns:xlink=""><title></title>
<link xlink:href="scalarDataTypes.html">cl_int</link> <function>clTerminateContextKHR</function>
<paramdef><link xlink:href="abstractDataTypes.html">cl_context</link> <parameter>context</parameter></paramdef>
<!-- ================================ PARAMETERS -->
<refsect1 id="parameters">
<!-- ================================ NOTES -->
<!-- Use <function /> to refer ONLY to the function that this page describes. All other functions should use
<citerefentry /><refentrytitle /> to make it a link. Use <varname /> for parameters. Use <constant /> for
constants (or anything to be set in monospace, non-bold type. -->
<refsect1 id="notes"><title>Notes</title>
It is the responsibility of the application to release all objects associated with the
context being terminated.
When a context is terminated:
<itemizedlist mark="opencircle">
The execution status of enqueued commands will be
<constant>CL_TERMINATED_KHR</constant>. Event
objects can be queried using
Event callbacks can be registered and
registered event callbacks will be called with
<varname>event_command_exec_status</varname> set to
will return as immediately for commands
associated with event objects specified in
<varname>event_list</varname>. The status of user events can be set.
Event objects can be retained and released.
The context is considered to be terminated.
A callback function registered when the
context was created will be called. Only
queries, retain and release operations can be
performed on the context. All other APIs that
use a context as an argument will return
The contents of the memory regions of the
memory objects is undefined. Queries,
registering a destructor callback, retain
and release operations can be performed on the
memory objects.
Once a context has been terminated, all OpenCL API
calls that create objects or enqueue
commands will return
APIs that release OpenCL
objects will continue to operate as though
<function>clTerminateContextKHR</function> was not called.
The behavior of callbacks will remain unchanged,
and will report appropriate error, if
executing after termination of context. This
behavior is similar to enqueued commands,
after the command queue has become invalid.
An implementation that supports this extension
must be able to terminate commands currently
executing on devices or queued across all
command-queues associated with the context that is
being terminated. The implementation cannot
implement this extension by waiting for currently
executing (or queued) commands to finish execution
on devices associated with this context (i.e.
doing a <citerefentry><refentrytitle>clFinish</refentrytitle></citerefentry>).
In Table 4.5, (see
can be specified in the context properties only if all devices
associated with the context support the ability
to support context termination (i.e.
is set for
Otherwise, context creation fails with error
code of <errorname>CL_INVALID_PROPERTY</errorname>.
<!-- ================================ ERRORS -->
<refsect1 id="errors"><title>Errors</title>
<function>clTerminateContextKHR</function> returns <errorname>CL_SUCCESS</errorname>
if the function is executed successfully.
Otherwise, it returns one of the following errors:
<itemizedlist mark="disc">
<errorname>CL_INVALID_CONTEXT</errorname> if <varname>context</varname> is not a valid OpenCL context.
<errorname>CL_CONTEXT_TERMINATED_KHR</errorname> if <varname>context</varname> has already been terminated.
<errorname>CL_INVALID_OPERATION</errorname> if
<varname>context</varname> was not created with
set to <constant>CL_TRUE</constant>.
<errorname>CL_OUT_OF_RESOURCES</errorname> if there
is a failure to allocate resources required by the
OpenCL implementation on the device.
<errorname>CL_OUT_OF_HOST_MEMORY</errorname> if there
is a failure to allocate resources required by the
OpenCL implementation on the host.
<!-- ================================ EXAMPLE -->
<refsect2 id="example1">
<informaltable frame="none">
<tgroup cols="1" align="left" colsep="0" rowsep="0">
<colspec colname="col1" colnum="1" />
Example goes here - it will be set in "code" type with white space preserved.
<!-- ================================ SPECIFICATION -->
<!-- Set the "uri" attribute in the <olink /> element to the "named destination" for the PDF page
<refsect1 id="specification"><title>Specification</title>
<imagedata fileref="pdficon_small1.gif" format="gif" />
<olink uri="clTerminateContextKHR">OpenCL Specification</olink>
<!-- ================================ ALSO SEE -->
<refsect1 id="seealso"><title>Also see</title>
<!-- ================================ COPYRIGHT -->
<!-- Content included from -->
<refsect3 id="Copyright"><title></title>
<imagedata fileref="KhronosLogo.jpg" format="jpg" />
<para />
<!-- 22-Dec-2013, rev. 19 -->