Skip to content

Commit

Permalink
Clarify that program build callbacks can query build status (#285)
Browse files Browse the repository at this point in the history
* Clarify that program build callbacks can query build status

Fixes #274

* Further clarification

* Generalize statement about program queries
  • Loading branch information
jrprice authored May 26, 2020
1 parent 7a07ec6 commit e7e570d
Showing 1 changed file with 8 additions and 1 deletion.
9 changes: 8 additions & 1 deletion api/opencl_runtime_layer.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -5867,6 +5867,9 @@ include::{generated}/api/version-notes/clBuildProgram.asciidoc[]
If _pfn_notify_ is not `NULL`, {clBuildProgram} does not need to wait for
the build to complete and can return immediately once the build operation
can begin.
Any state changes of the program object that result from calling
{clBuildProgram} (e.g. build status or log) will be observable from this
callback function.
The build operation can begin if the context, program whose sources are
being compiled and linked, list of devices and build options specified are
all valid and appropriate host and device resources needed to perform the
Expand Down Expand Up @@ -6002,6 +6005,9 @@ include::{generated}/api/version-notes/clCompileProgram.asciidoc[]
If _pfn_notify_ is not `NULL`, {clCompileProgram} does not need to wait for
the compiler to complete and can return immediately once the compilation can
begin.
Any state changes of the program object that result from calling
{clCompileProgram} (e.g. compile status or log) will be observable from this
callback function.
The compilation can begin if the context, program whose sources are being
compiled, list of devices, input headers, programs that describe input
headers and compiler options specified are all valid and appropriate host
Expand Down Expand Up @@ -6161,7 +6167,8 @@ linker to complete, and can return immediately once the linking operation can
begin.
Once the linker has completed, the _pfn_notify_ callback function is called
which returns the program object returned by {clLinkProgram}.
The application can query the link status and log for this program object.
Any state changes of the program object that result from calling {clLinkProgram}
(e.g. link status or log) will be observable from this callback function.
This callback function may be called asynchronously by the OpenCL
implementation.
It is the applications responsibility to ensure that the callback function
Expand Down

0 comments on commit e7e570d

Please sign in to comment.