ComputeNodeDescriptor.h

Go to the documentation of this file.

 
#ifndef LLUVIA_CORE_NODE_COMPUTE_NODE_DESCRIPTOR_H_
#define LLUVIA_CORE_NODE_COMPUTE_NODE_DESCRIPTOR_H_
 
#include "lluvia/core/node/Node.h"
#include "lluvia/core/node/Parameter.h"
#include "lluvia/core/node/PushConstants.h"
 
#include "lluvia/core/types.h"
 
#include <array>
#include <map>
#include <memory>
#include <string>
#include <tuple>
 
namespace ll {
 
class ComputeNode;
class Program;
 
class ComputeNodeDescriptor {
 
public:
    ComputeNodeDescriptor()                                        = default;
    ComputeNodeDescriptor(const ComputeNodeDescriptor& descriptor) = default;
    ComputeNodeDescriptor(ComputeNodeDescriptor&& descriptor)      = default;
 
    ~ComputeNodeDescriptor() = default;
 
    ComputeNodeDescriptor& operator=(const ComputeNodeDescriptor& descriptor) = default;
    ComputeNodeDescriptor& operator=(ComputeNodeDescriptor&& descriptor)      = default;
 
    ComputeNodeDescriptor& setProgram(const std::shared_ptr<ll::Program>& tProgram) noexcept;
 
    ComputeNodeDescriptor& setProgram(const std::shared_ptr<ll::Program>& tProgram, const std::string& tFunctionName) noexcept;
 
    ComputeNodeDescriptor& setParameter(const std::string& name, const ll::Parameter& value);
 
    ComputeNodeDescriptor& setFunctionName(const std::string& name) noexcept;
 
    ComputeNodeDescriptor& setBuilderName(const std::string& name) noexcept;
 
    ComputeNodeDescriptor& addPort(const ll::PortDescriptor& port);
 
    ComputeNodeDescriptor& addPorts(const std::initializer_list<ll::PortDescriptor>& ports);
 
    ComputeNodeDescriptor& setGridX(const uint32_t x) noexcept;
 
    ComputeNodeDescriptor& setGridY(const uint32_t y) noexcept;
 
    ComputeNodeDescriptor& setGridZ(const uint32_t z) noexcept;
 
    ComputeNodeDescriptor& setGridShape(const ll::vec3ui& shape) noexcept;
 
    ComputeNodeDescriptor& configureGridShape(const ll::vec3ui& globalShape) noexcept;
 
    ComputeNodeDescriptor& setLocalX(const uint32_t x) noexcept;
 
    ComputeNodeDescriptor& setLocalY(const uint32_t y) noexcept;
 
    ComputeNodeDescriptor& setLocalZ(const uint32_t z) noexcept;
 
    ComputeNodeDescriptor& setLocalShape(const ll::vec3ui& shape) noexcept;
 
    ComputeNodeDescriptor& setPushConstants(const ll::PushConstants& constants) noexcept;
 
    std::shared_ptr<ll::Program> getProgram() const noexcept;
 
    const ll::PortDescriptor& getPort(const std::string& name) const;
 
    const ll::Parameter& getParameter(const std::string& name) const;
 
    const std::string& getFunctionName() const noexcept;
 
    const std::string& getBuilderName() const noexcept;
 
    ll::vec3ui getGridShape() const noexcept;
 
    ll::vec3ui getLocalShape() const noexcept;
 
    uint32_t getGridX() const noexcept;
    uint32_t getGridY() const noexcept;
    uint32_t getGridZ() const noexcept;
 
    uint32_t getLocalX() const noexcept;
    uint32_t getLocalY() const noexcept;
    uint32_t getLocalZ() const noexcept;
 
    const ll::PushConstants& getPushConstants() const noexcept;
 
    std::vector<vk::DescriptorSetLayoutBinding> getParameterBindings() const;
 
private:
    std::shared_ptr<ll::Program> m_program;
    std::string                  m_functionName;
    std::string                  m_builderName;
 
    // local and global work group
    ll::vec3ui m_localShape {1, 1, 1};
    ll::vec3ui m_gridShape {1, 1, 1};
 
    std::map<std::string, ll::PortDescriptor> m_ports;
    std::map<std::string, ll::Parameter>      m_parameters;
 
    ll::PushConstants m_pushConstants;
};
 
} // namespace ll
 
#endif /* LLUVIA_CORE_NODE_COMPUTE_NODE_DESCRIPTOR_H_ */