aboutsummaryrefslogtreecommitdiff
path: root/include
diff options
context:
space:
mode:
authordan sinclair <dj2@everburning.com>2019-04-17 08:14:53 -0400
committerGitHub <noreply@github.com>2019-04-17 08:14:53 -0400
commit3ba84017a953c88c9951f8b63a2a506ca6fd0765 (patch)
tree844cd269afa8bc7f3b67df53d21677d6f57c60b6 /include
parent2dcaa50fcc7a41adab57508b3f7f634f5b4ec44b (diff)
downloadamber-3ba84017a953c88c9951f8b63a2a506ca6fd0765.tar.gz
Flush out some class/method documentation. (#476)
This CL adds class/method documentation to a few more classes.
Diffstat (limited to 'include')
-rw-r--r--include/amber/amber.h2
-rw-r--r--include/amber/shader_info.h3
-rw-r--r--include/amber/value.h2
3 files changed, 7 insertions, 0 deletions
diff --git a/include/amber/amber.h b/include/amber/amber.h
index 694b40b..a8977e6 100644
--- a/include/amber/amber.h
+++ b/include/amber/amber.h
@@ -43,6 +43,7 @@ struct EngineConfig {
virtual ~EngineConfig();
};
+/// Stores information for a biffer.
struct BufferInfo {
BufferInfo();
BufferInfo(const BufferInfo&);
@@ -75,6 +76,7 @@ class Delegate {
virtual uint64_t GetTimestampNs() const = 0;
};
+/// Stores configuration options for Amber.
struct Options {
Options();
~Options();
diff --git a/include/amber/shader_info.h b/include/amber/shader_info.h
index 9dc5553..367c385 100644
--- a/include/amber/shader_info.h
+++ b/include/amber/shader_info.h
@@ -38,8 +38,11 @@ enum ShaderType {
kShaderTypeMulti,
};
+/// Stores information for a shader.
struct ShaderInfo {
+ /// The format of the shader.
ShaderFormat format;
+ /// The type of shader.
ShaderType type;
/// This is a unique name for this shader. The name is produced from the
/// input script, possibly with extra prefix contents. This name, if used
diff --git a/include/amber/value.h b/include/amber/value.h
index 5bda540..633d1ab 100644
--- a/include/amber/value.h
+++ b/include/amber/value.h
@@ -19,6 +19,8 @@
namespace amber {
+/// Wrapper for a single value. The value will be either an integer or a
+/// floating point value.
class Value {
public:
Value();