mesytec-mnode/external/taskflow-3.8.0/docs/xml/classtf_1_1cudaEvent.xml
2025-01-04 01:25:05 +01:00

94 lines
4.8 KiB
XML

<?xml version='1.0' encoding='UTF-8' standalone='no'?>
<doxygen xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="compound.xsd" version="1.9.1" xml:lang="en-US">
<compounddef id="classtf_1_1cudaEvent" kind="class" language="C++" prot="public">
<compoundname>tf::cudaEvent</compoundname>
<basecompoundref prot="public" virt="non-virtual">cudaObject&lt; cudaEvent_t, cudaEventCreator, cudaEventDeleter &gt;</basecompoundref>
<includes refid="cuda__stream_8hpp" local="no">taskflow/cuda/cuda_stream.hpp</includes>
<sectiondef kind="public-func">
<memberdef kind="function" id="classtf_1_1cudaEvent_1ad0b23cb864f0c7acee306f7fe49a3c23" prot="public" static="no" const="no" explicit="yes" inline="yes" virt="non-virtual">
<type></type>
<definition>tf::cudaEvent::cudaEvent</definition>
<argsstring>(cudaEvent_t event)</argsstring>
<name>cudaEvent</name>
<param>
<type>cudaEvent_t</type>
<declname>event</declname>
</param>
<briefdescription>
<para>constructs an RAII-styled CUDA event object from the given CUDA event </para>
</briefdescription>
<detaileddescription>
</detaileddescription>
<inbodydescription>
</inbodydescription>
<location file="taskflow/cuda/cuda_stream.hpp" line="211" column="14" bodyfile="taskflow/cuda/cuda_stream.hpp" bodystart="211" bodyend="211"/>
</memberdef>
<memberdef kind="function" id="classtf_1_1cudaEvent_1aef986b15a45d9992a31caa6e42e4e945" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
<type></type>
<definition>tf::cudaEvent::cudaEvent</definition>
<argsstring>()=default</argsstring>
<name>cudaEvent</name>
<briefdescription>
<para>constructs an RAII-styled CUDA event object </para>
</briefdescription>
<detaileddescription>
</detaileddescription>
<inbodydescription>
</inbodydescription>
<location file="taskflow/cuda/cuda_stream.hpp" line="216" column="5"/>
</memberdef>
<memberdef kind="function" id="classtf_1_1cudaEvent_1af6d6a9c4f98ae85927985a1f89cdeee1" prot="public" static="no" const="no" explicit="yes" inline="yes" virt="non-virtual">
<type></type>
<definition>tf::cudaEvent::cudaEvent</definition>
<argsstring>(unsigned int flag)</argsstring>
<name>cudaEvent</name>
<param>
<type>unsigned int</type>
<declname>flag</declname>
</param>
<briefdescription>
<para>constructs an RAII-styled CUDA event object with the given flag </para>
</briefdescription>
<detaileddescription>
</detaileddescription>
<inbodydescription>
</inbodydescription>
<location file="taskflow/cuda/cuda_stream.hpp" line="221" column="14" bodyfile="taskflow/cuda/cuda_stream.hpp" bodystart="221" bodyend="221"/>
</memberdef>
</sectiondef>
<briefdescription>
<para>class to create an RAII-styled wrapper over a native CUDA event </para>
</briefdescription>
<detaileddescription>
<para>A <ref refid="classtf_1_1cudaEvent" kindref="compound">cudaEvent</ref> object is an RAII-styled wrapper over a native CUDA event (<computeroutput>cudaEvent_t</computeroutput>). A <ref refid="classtf_1_1cudaEvent" kindref="compound">cudaEvent</ref> object is move-only. </para>
</detaileddescription>
<inheritancegraph>
<node id="2">
<label>cudaObject&lt; cudaEvent_t, cudaEventCreator, cudaEventDeleter &gt;</label>
</node>
<node id="1">
<label>tf::cudaEvent</label>
<link refid="classtf_1_1cudaEvent"/>
<childnode refid="2" relation="public-inheritance">
</childnode>
</node>
</inheritancegraph>
<collaborationgraph>
<node id="2">
<label>cudaObject&lt; cudaEvent_t, cudaEventCreator, cudaEventDeleter &gt;</label>
</node>
<node id="1">
<label>tf::cudaEvent</label>
<link refid="classtf_1_1cudaEvent"/>
<childnode refid="2" relation="public-inheritance">
</childnode>
</node>
</collaborationgraph>
<location file="taskflow/cuda/cuda_stream.hpp" line="203" column="1" bodyfile="taskflow/cuda/cuda_stream.hpp" bodystart="204" bodyend="222"/>
<listofallmembers>
<member refid="classtf_1_1cudaEvent_1ad0b23cb864f0c7acee306f7fe49a3c23" prot="public" virt="non-virtual"><scope>tf::cudaEvent</scope><name>cudaEvent</name></member>
<member refid="classtf_1_1cudaEvent_1aef986b15a45d9992a31caa6e42e4e945" prot="public" virt="non-virtual"><scope>tf::cudaEvent</scope><name>cudaEvent</name></member>
<member refid="classtf_1_1cudaEvent_1af6d6a9c4f98ae85927985a1f89cdeee1" prot="public" virt="non-virtual"><scope>tf::cudaEvent</scope><name>cudaEvent</name></member>
</listofallmembers>
</compounddef>
</doxygen>