Class VulkanShader#

Defined in File VulkanShader.h

Inheritance Relationships#

Base Type#

public TRAP::Graphics::Shader (Class Shader)

Class Documentation#

class VulkanShader : public TRAP::Graphics::Shader #

Public Functions

VulkanShader(RendererAPI::ShaderType shaderType, std::string name, const std::filesystem::path &filepath, const RendererAPI::BinaryShaderDesc &desc, const std::vector<Macro> &userMacros = {})#

Constructor.

Parameters:

shaderType – Type of the shader.
name – Name for the shader.
filepath – Filepath of the shader.
desc – Binary shader description.
userMacros – Optional user defined macros. Default: nullptr.

VulkanShader(RendererAPI::ShaderType shaderType, std::string name, const RendererAPI::BinaryShaderDesc &desc, const std::vector<Macro> &userMacros = {})#

Constructor.

Parameters:

shaderType – Type of the shader.
name – Name for the shader.
desc – Binary shader description.
userMacros – Optional user defined macros. Default: nullptr.

VulkanShader(RendererAPI::ShaderType shaderType, std::string name, const std::filesystem::path &filepath, const std::vector<Macro> &userMacros = {})#

Constructor. Creates an invalid placeholder shader.

Note

Used for invalid shaders, this doesn’t create a usable shader.

Parameters:

shaderType – Type of the shader.
name – Name for the shader.
filepath – Filepath of the shader.
userMacros – Optional user defined macros. Default: nullptr.
stages – Optional Stages of the shader. Default: None.

~VulkanShader() override#: Destructor.

consteval VulkanShader(const VulkanShader&) noexcept = delete#: Copy constructor.

consteval VulkanShader &operator=(const VulkanShader&) noexcept = delete#: Copy assignment operator.

VulkanShader(VulkanShader&&) noexcept = default#: Move constructor.

VulkanShader &operator=(VulkanShader&&) noexcept = default#: Move assignment operator.

constexpr std::span<const VkShaderModule> GetVkShaderModules() const noexcept#

Retrieve the Vulkan shader module handles of each contained shader stage.

Returns:: Vulkan shader module handles.

TRAP::Ref<ShaderReflection::PipelineReflection> GetReflection() const noexcept#

Retrieve the reflection data of each contained shader stage.

Returns:: Shader reflection data.

virtual constexpr usize GetID() const noexcept override#: Retrieve the unique identifier of the shader.

Note

The ID of the shader changes when reloaded.

virtual void Use(const Window &window) override#

Use shader for rendering on the given window.

Remark