LiteFX 0.3.1.2022
Computer Graphics Engine
LiteFX::Rendering::IShaderModule Class Referenceabstract

Represents a single shader module, i.e. a part of a IShaderProgram. More...

#include <rendering_api.hpp>

Inherited by LiteFX::Rendering::Backends::DirectX12ShaderModule, and LiteFX::Rendering::Backends::VulkanShaderModule.

Public Member Functions

virtual ~IShaderModule () noexcept=default
 
virtual const ShaderStage & type () const noexcept=0
 Returns the type of the shader module. More...
 
virtual const StringfileName () const noexcept=0
 Returns the file name of the shader module. More...
 
virtual const StringentryPoint () const noexcept=0
 Returns the name of the shader module entry point. More...
 

Detailed Description

Represents a single shader module, i.e. a part of a IShaderProgram.

A shader module corresponds to a single shader source file.

Constructor & Destructor Documentation

◆ ~IShaderModule()

virtual LiteFX::Rendering::IShaderModule::~IShaderModule ( )
virtualdefaultnoexcept

Member Function Documentation

◆ entryPoint()

virtual const String & LiteFX::Rendering::IShaderModule::entryPoint ( ) const
pure virtualnoexcept

Returns the name of the shader module entry point.

Returns
The name of the shader module entry point.

Implemented in LiteFX::Rendering::Backends::DirectX12ShaderModule, and LiteFX::Rendering::Backends::VulkanShaderModule.

◆ fileName()

virtual const String & LiteFX::Rendering::IShaderModule::fileName ( ) const
pure virtualnoexcept

Returns the file name of the shader module.

Returns
The file name of the shader module.

Implemented in LiteFX::Rendering::Backends::DirectX12ShaderModule, and LiteFX::Rendering::Backends::VulkanShaderModule.

◆ type()

virtual const ShaderStage & LiteFX::Rendering::IShaderModule::type ( ) const
pure virtualnoexcept

Returns the type of the shader module.

Returns
The type of the shader module.

Implemented in LiteFX::Rendering::Backends::DirectX12ShaderModule, and LiteFX::Rendering::Backends::VulkanShaderModule.