Raven::Shader Class Reference

Represents a complete shader composed of multiple shader stage modules. More...

#include <Shader.h>

Inherits Raven::RefCounted.

Inherited by Raven::VulkanShader.

Public Member Functions
virtual	~Shader ()=default
virtual void	Release ()=0
virtual const std::string &	GetName () const =0
	Gets the shader's identifying name.
virtual const std::string &	GetFilePath () const =0
	Returns the Path to the shader.
virtual const std::unordered_map< ShaderStage, Ref< ShaderModuleHandle > > &	GetShaderModules () const =0
	Returns the collection of shader modules keyed by shader stage.
Public Member Functions inherited from Raven::RefCounted
	RefCounted ()
virtual	~RefCounted ()
void	IncRefCount ()
void	DecRefCount ()
u32	GetRefCount () const

Static Public Member Functions
static Ref< Shader >	Create (const std::string &filepath, bool forceCompile=false)
	Factory method to create a shader from a file.

Detailed Description

Represents a complete shader composed of multiple shader stage modules.

Responsible for loading and managing shader modules, typically from file. Supports retrieval of contained shader modules and querying shader name.

Constructor & Destructor Documentation

~Shader()

virtual Raven::Shader::~Shader ( )

virtualdefault

Member Function Documentation

Create()

Ref< Shader > Raven::Shader::Create ( const std::string & filepath, bool forceCompile = false )

static

Factory method to create a shader from a file.

Parameters

filepath	Path to the shader source or binary.
forceCompile	If true, forces recompilation of the shader.
disableOptimizations	Disables optimizations during compilation.

Returns

Reference to the created Shader.

GetFilePath()

virtual const std::string & Raven::Shader::GetFilePath ( ) const

pure virtual

Returns the Path to the shader.

Returns

Const reference to the shader path string.

Implemented in Raven::VulkanShader.

GetName()

virtual const std::string & Raven::Shader::GetName ( ) const

pure virtual

Gets the shader's identifying name.

Returns

Const reference to shader name string.

Implemented in Raven::VulkanShader.

GetShaderModules()

virtual const std::unordered_map< ShaderStage, Ref< ShaderModuleHandle > > & Raven::Shader::GetShaderModules ( ) const

pure virtual

Returns the collection of shader modules keyed by shader stage.

Used internally for pipeline creation and module access.

Returns

Map of ShaderStage to ShaderModuleHandle references.

Implemented in Raven::VulkanShader.

Release()

virtual void Raven::Shader::Release ( )

pure virtual

Implemented in Raven::VulkanShader.

---

The documentation for this class was generated from the following files:

• Illumine/src/Renderer/Shader.h
• Illumine/src/Renderer/Shader.cpp