mirror of
https://github.com/boostorg/compute.git
synced 2026-01-27 18:52:15 +00:00
5164ab4bd0
This cleans up the constructor methods for the OpenCL wrapper classes and unifies the API used for creating a wrapper class object from the underlying OpenCL objects. Now, every wrapper class has a constructor taking the OpenCL object and an optional boolean retain parameter which indicates whether the constructor should increment the reference count.
181 lines
5.3 KiB
XML
181 lines
5.3 KiB
XML
<?xml version="1.0" encoding="utf-8"?>
|
|
<header name="boost/compute/program.hpp">
|
|
<namespace name="boost">
|
|
<namespace name="compute">
|
|
|
|
<!-- boost::compute::program -->
|
|
<class name="program">
|
|
<purpose>A compute program</purpose>
|
|
|
|
<description>
|
|
<para>
|
|
See also: <classname>kernel</classname>
|
|
</para>
|
|
</description>
|
|
|
|
<!-- program::program() -->
|
|
<constructor>
|
|
<description>
|
|
<para>
|
|
Creates a null program object.
|
|
</para>
|
|
</description>
|
|
</constructor>
|
|
|
|
<!-- program::program(cl_program, bool) -->
|
|
<constructor specifiers="explicit">
|
|
<parameter name="program">
|
|
<paramtype>cl_program</paramtype>
|
|
</parameter>
|
|
<parameter name="retain">
|
|
<paramtype>bool</paramtype>
|
|
<default>true</default>
|
|
</parameter>
|
|
|
|
<description>
|
|
<para>
|
|
Creates a new program object for <code>program</code>. If
|
|
<code>retain</code> is <code>true</code> (the default) the
|
|
reference count for <code>program</code> will be incremented.
|
|
</para>
|
|
</description>
|
|
</constructor>
|
|
|
|
<!-- program::program(const program&) -->
|
|
<constructor>
|
|
<parameter name="other">
|
|
<paramtype>const <classname>program</classname>&</paramtype>
|
|
</parameter>
|
|
|
|
<description>
|
|
<para>
|
|
Creates a new program object as a copy of <code>other</code>.
|
|
</para>
|
|
</description>
|
|
</constructor>
|
|
|
|
<!-- operator=(const program&) -->
|
|
<copy-assignment>
|
|
<parameter name="other">
|
|
<paramtype>const <classname>program</classname>&</paramtype>
|
|
</parameter>
|
|
|
|
<description>
|
|
<para>
|
|
Copies the program from <code>other</code>.
|
|
</para>
|
|
</description>
|
|
</copy-assignment>
|
|
|
|
<!-- program::~program() -->
|
|
<destructor>
|
|
<description>
|
|
<para>
|
|
Destroys the program object.
|
|
</para>
|
|
</description>
|
|
</destructor>
|
|
|
|
<method-group name="public member functions">
|
|
|
|
<!-- program::source() -->
|
|
<method name="source" cv="const">
|
|
<type>std::string</type>
|
|
|
|
<description>
|
|
<para>
|
|
Returns the source code for the program.
|
|
</para>
|
|
</description>
|
|
</method>
|
|
|
|
<!-- program::get_info<T>(cl_program_info) -->
|
|
<method name="get_info" cv="const">
|
|
<template>
|
|
<template-type-parameter name="T"/>
|
|
</template>
|
|
|
|
<type>T</type>
|
|
|
|
<parameter name="info">
|
|
<paramtype>cl_program_info</paramtype>
|
|
</parameter>
|
|
|
|
<description>
|
|
<para>
|
|
Returns information about the program.
|
|
</para>
|
|
</description>
|
|
</method>
|
|
|
|
<!-- program::build(options) -->
|
|
<method name="build">
|
|
<parameter name="options">
|
|
<paramtype>const std::string&</paramtype>
|
|
<default>std::string()</default>
|
|
</parameter>
|
|
|
|
<type>void</type>
|
|
|
|
<description>
|
|
<para>
|
|
Builds the program with <code>options</code>.
|
|
</para>
|
|
</description>
|
|
</method>
|
|
|
|
<!-- operator program::cl_program() -->
|
|
<method name="operator cl_program" cv="const">
|
|
<description>
|
|
<para>
|
|
Converts the program object to a <code>cl_program</code>.
|
|
</para>
|
|
</description>
|
|
</method>
|
|
</method-group>
|
|
|
|
<method-group name="public static functions">
|
|
|
|
<!-- program::create_with_source(source, context) -->
|
|
<method name="create_with_source" specifiers="static">
|
|
<type><classname>program</classname></type>
|
|
|
|
<parameter name="source">
|
|
<paramtype>const std::string&</paramtype>
|
|
</parameter>
|
|
<parameter name="context">
|
|
<paramtype>const <classname>context</classname>&</paramtype>
|
|
</parameter>
|
|
|
|
<description>
|
|
<para>
|
|
Creates a new program object with <code>source</code> in
|
|
<code>context</code>.
|
|
</para>
|
|
</description>
|
|
</method>
|
|
|
|
<!-- program::create_with_source_file(file, context) -->
|
|
<method name="create_with_source_file" specifiers="static">
|
|
<type><classname>program</classname></type>
|
|
|
|
<parameter name="file">
|
|
<paramtype>const std::string&</paramtype>
|
|
</parameter>
|
|
<parameter name="context">
|
|
<paramtype>const <classname>context</classname>&</paramtype>
|
|
</parameter>
|
|
|
|
<description>
|
|
<para>
|
|
Creates a new program object with <code>file</code> in
|
|
<code>context</code>.
|
|
</para>
|
|
</description>
|
|
</method>
|
|
</method-group>
|
|
</class>
|
|
</namespace>
|
|
</namespace>
|
|
</header>
|