working on style guide, typed pipeline, features, backend

StyleGuide.md

 # Style Guide
 
 
+## Formatting
+
+* The `.clang-format` in this repository is mandatory
+
+
 ## Types
 
 * Reference types in `UpperCamelCase` (and `class`)
@@ -27,9 +32,17 @@
 ## Parameters
 
 * East-side const, especially `int const&` instead of `const int&`
+* `SharedType`s should be passed as `const&`
 
 
 ## Casts
 
 * For built-in primitives, C casts are OK
-* For any complex types, `static_cast`, `dynamic_cast`, etc. are mandatory
+* For complex type, `static_cast`, `dynamic_cast`, etc. are mandatory
+
+
+## Namespaces
+
+* Namespaces are `lower_snake_case`
+* Namespaces should be short
+* `detail` namespace is used for internal code and should not be used externally

src/tg/backend/backend.hh

@@ -2,10 +2,8 @@
 
 namespace tg
 {
-enum class backend
+class Backend
 {
-    vulkan,
-    lava,
-	glow
+    virtual ~Backend() {}
 };
-}
\ No newline at end of file
+} // namespace tg
\ No newline at end of file

src/tg/builder/pipelines/PrimitivePipelineBuilder.hh

@@ -8,7 +8,7 @@
 
 namespace tg
 {
-template <class VertexT, class FragmentT, class ConstantT = void>
+template <class VertexT, class FragmentT, class ConstantT = void, class... ResourceSets>
 struct PrimitivePipelineBuilder
 {
     PrimitivePipelineBuilder(SharedVertexShader<VertexT> const& vs, SharedFragmentShader<FragmentT> const& fs, topology topology = topology::triangles)

src/tg/data/features.hh

+#pragma once
+
+namespace tg
+{
+// feature::defaults() is about OGL 4.0
+// feature::minimal() is about OGL 3.0
+// feature::all() is bleeding edge everything (e.g. raytracing, sparse binding, ...)
+struct features
+{
+    // "big" features
+    bool raytracing = false;
+    bool tessellation = true;
+    bool transform_feedback = true;
+    // TODO: more
+
+    // "small" features
+    bool anisotropic_filtering = true;
+    // TODO: more
+
+    static features defaults() { return {}; }
+    static features minimal()
+    {
+        features f;
+        f.tessellation = false;
+        return f;
+    }
+    static features all()
+    {
+        features f;
+        f.raytracing = true;
+        return f;
+    }
+};
+} // namespace tg
\ No newline at end of file

src/tg/objects/Device.cc

@@ -31,17 +31,20 @@ SharedCommandBuffer Device::createCommandBuffer()
     return std::make_shared<CommandBuffer>();
 }
 
-Device::Device(backend backend, bool isDebug) : mBackend(backend), mIsDebug(isDebug) {}
+Device::Device(tg::features features, SharedBackend backend, bool isDebug, use_create_method)
+  : _features(features), _backend(std::move(backend)), _isDebug(isDebug)
+{
+}
 
-SharedDevice Device::create(backend backend)
+SharedDevice Device::create(tg::features features, SharedBackend backend)
 {
     // TODO
-    return std::make_shared<Device>(backend, false);
+    return std::make_shared<Device>(features, std::move(backend), false, use_create_method{});
 }
 
-SharedDevice Device::createDebug(backend backend)
+SharedDevice Device::createDebug(tg::features features, SharedBackend backend)
 {
     // TODO
-    return std::make_shared<Device>(backend, true);
+    return std::make_shared<Device>(features, std::move(backend), true, use_create_method{});
 }
 } // namespace tg

src/tg/objects/Device.hh

@@ -10,7 +10,9 @@
 
 #include <tg/builder/builder.hh>
 
-#include <tg/backend/backend.hh>
+#include <tg/backend/Backend.hh>
+
+#include <tg/data/features.hh>
 
 #include "CommandBuffer.hh"
 
@@ -22,9 +24,11 @@ class Device : std::enable_shared_from_this<Device>
 {
     TG_REFERENCE_TYPE(Device);
 
+    // properties
 public:
-    bool isDebug() const { return mIsDebug; }
-    backend getBackend() const { return mBackend; }
+    bool isDebug() const { return _isDebug; }
+    SharedBackend const& backend() const { return _backend; }
+    features features() const { return _features; }
 
     // windows
 public:
@@ -59,8 +63,9 @@ public:
     SharedRenderPass createRenderPass(RenderPassBuilder const& builder);
     SharedRenderPass createRenderPass(SubPassBuilder const& builder);
 
-    template <class VertexT, class FragmentT, class ConstantT>
-    SharedPrimitivePipeline<VertexT, FragmentT, ConstantT> createPrimitivePipeline(PrimitivePipelineBuilder<VertexT, FragmentT, ConstantT> const& builder);
+    template <class VertexT, class FragmentT, class ConstantT, class... ResourceSets>
+    SharedPrimitivePipeline<VertexT, FragmentT, ConstantT, ResourceSets...> createPrimitivePipeline(
+        PrimitivePipelineBuilder<VertexT, FragmentT, ConstantT, ResourceSets...> const& builder);
 
     // commands
 public:
@@ -68,30 +73,33 @@ public:
 
     TG_NO_DISCARD CommandBuffer::Recorder submitGraphicsCommands()
     {
-        // TODO: user one-time submit option
-
         // TODO
         return {true};
     }
 
 public:
-    static SharedDevice create(backend backend = backend::vulkan);
-    static SharedDevice createDebug(backend backend = backend::vulkan);
+    static SharedDevice create(tg::features features = {}, SharedBackend backend = nullptr);
+    static SharedDevice createDebug(tg::features features = {}, SharedBackend backend = nullptr);
 
 public:
-    Device(backend backend, bool isDebug);
+    struct use_create_method
+    {
+    };
+    Device(tg::features features, SharedBackend backend, bool isDebug, use_create_method);
 
 private:
-    backend mBackend;
-    bool mIsDebug;
+    tg::features _features;
+    SharedBackend _backend;
+    bool _isDebug;
 };
 
 // ========= IMPLEMENTATION ==========
 
-template <class VertexT, class FragmentT, class ConstantT>
-SharedPrimitivePipeline<VertexT, FragmentT, ConstantT> Device::createPrimitivePipeline(PrimitivePipelineBuilder<VertexT, FragmentT, ConstantT> const& builder)
+template <class VertexT, class FragmentT, class ConstantT, class... ResourceSets>
+SharedPrimitivePipeline<VertexT, FragmentT, ConstantT, ResourceSets...> Device::createPrimitivePipeline(
+    PrimitivePipelineBuilder<VertexT, FragmentT, ConstantT, ResourceSets...> const& builder)
 {
     // TODO
-    return std::make_shared<PrimitivePipeline<VertexT, FragmentT, ConstantT>>();
+    return std::make_shared<PrimitivePipeline<VertexT, FragmentT, ConstantT, ResourceSets...>>();
 }
 } // namespace tg

src/tg/objects/Image.hh

@@ -26,7 +26,7 @@ public:
     /// NOTE: this is an expensive operation that rebuilds many resources
     ///       (should be used seldom, e.g. when window is resized)
     /// NOTE: only resizes if size is different (s == size() is a guaranteed no-op)
-    void resize(size<D, int> s)
+    void resize(tg::size<D, int> s)
     {
         if (s == _size)
             return;
@@ -41,6 +41,6 @@ public:
     Image() = default;
 
 private:
-    size<D, int> _size;
+    tg::size<D, int> _size;
 };
 } // namespace tg

src/tg/objects/ImageView.hh

@@ -4,6 +4,7 @@
 
 namespace tg
 {
+	// TODO: Cube and CubeArray
 template <int D, class DataT>
 class ImageView
 {

src/tg/objects/pipelines/PrimitivePipeline.hh

@@ -29,7 +29,7 @@ namespace tg
  * TODO:
  *	* for now, viewport and scissor is always dynamic
  */
-template <class VertexT, class FragmentT, class ConstantT>
+template <class VertexT, class FragmentT, class ConstantT, class... ResourceSets>
 class PrimitivePipeline
 {
     TG_REFERENCE_TYPE(PrimitivePipeline);

src/tg/typed-graphics-lean.hh

@@ -9,6 +9,7 @@
 // TODO: maybe better management?
 namespace tg
 {
+TG_SHARED(class, Backend);
 TG_SHARED(class, Device);
 
 TG_SHARED(class, Window);
@@ -16,9 +17,14 @@ TG_SHARED(class, Window);
 TG_SHARED(class, CommandBuffer);
 
 TG_SHARED(class, RenderPass);
-TG_SHARED_T3D1(class, PrimitivePipeline, VertexT, FragmentT, ConstantT, void);
 TG_SHARED_T1(class, Framebuffer, FragmentT);
 
+// pipelines
+template <class VertexT, class FragmentT, class ConstantT = void, class... ResourceSets>
+class PrimitivePipeline;
+template <class VertexT, class FragmentT, class ConstantT = void, class... ResourceSets>
+using SharedPrimitivePipeline = std::shared_ptr<PrimitivePipeline<VertexT, FragmentT, ConstantT, ResourceSets...>>;
+
 TG_SHARED_T1(class, Buffer, DataT);
 TG_SHARED_T1(class, BufferView, DataT);