summaryrefslogtreecommitdiff
path: root/examples/gpu-printing/gpu-printing.h
diff options
context:
space:
mode:
authorEllie Hermaszewska <ellieh@nvidia.com>2024-10-29 14:49:26 +0800
committerGitHub <noreply@github.com>2024-10-29 14:49:26 +0800
commitf65d756bff8d4c5cbc15bd0322a2ae8e6b896a21 (patch)
treeea1d61342cd29368e19135000ec2948813096205 /examples/gpu-printing/gpu-printing.h
parenta729c15e9dce9f5116a38afc66329ab2ca4cea54 (diff)
format
* format * Minor test fixes * enable checking cpp format in ci
Diffstat (limited to 'examples/gpu-printing/gpu-printing.h')
-rw-r--r--examples/gpu-printing/gpu-printing.h50
1 files changed, 25 insertions, 25 deletions
diff --git a/examples/gpu-printing/gpu-printing.h b/examples/gpu-printing/gpu-printing.h
index 64eaf770a..84c036548 100644
--- a/examples/gpu-printing/gpu-printing.h
+++ b/examples/gpu-printing/gpu-printing.h
@@ -19,39 +19,39 @@
#include <map>
#include <string>
- /// Stores state used for executing print commands generated by GPU shaders
+/// Stores state used for executing print commands generated by GPU shaders
struct GPUPrinting
{
public:
- /// Load any string literals used by a Slang program.
- ///
- /// The `slangReflection` should be the layout and reflection
- /// object for a Slang shader program that might need to produce
- /// printed output. This function will load any strings
- /// referenced by the program into its database for mapping
- /// string hashes back to the original strings.
- ///
+ /// Load any string literals used by a Slang program.
+ ///
+ /// The `slangReflection` should be the layout and reflection
+ /// object for a Slang shader program that might need to produce
+ /// printed output. This function will load any strings
+ /// referenced by the program into its database for mapping
+ /// string hashes back to the original strings.
+ ///
void loadStrings(slang::ProgramLayout* slangReflection);
- /// Process a buffer of GPU printing commands and write output to `stdout`.
- ///
- /// This function attempts to read print commands from the buffer
- /// pointed to by `data` and execute them to produce output.
- ///
- /// The buffer pointed at by `data` (of size `dataSize`) should be allocated
- /// in host-visible memory.
- ///
- /// Before executing GPU work, the first four bytes pointed to by `data`
- /// should have been cleared to zero.
- ///
- /// If GPU work has attempted to write more data than the buffer
- /// can fit, a warning will be printed to `stderr`, and printing commands
- /// that could not fit completely in the buffer will be skipped.
- ///
+ /// Process a buffer of GPU printing commands and write output to `stdout`.
+ ///
+ /// This function attempts to read print commands from the buffer
+ /// pointed to by `data` and execute them to produce output.
+ ///
+ /// The buffer pointed at by `data` (of size `dataSize`) should be allocated
+ /// in host-visible memory.
+ ///
+ /// Before executing GPU work, the first four bytes pointed to by `data`
+ /// should have been cleared to zero.
+ ///
+ /// If GPU work has attempted to write more data than the buffer
+ /// can fit, a warning will be printed to `stderr`, and printing commands
+ /// that could not fit completely in the buffer will be skipped.
+ ///
void processGPUPrintCommands(const void* data, size_t dataSize);
private:
typedef int StringHash;
- std::map<StringHash, std::string> m_hashedStrings;
+ std::map<StringHash, std::string> m_hashedStrings;
};