An abstraction for a shader program. More...

#include <Shader.h>

Inheritance diagram for Muto::Shader:

Public Member Functions
virtual void	Bind () const =0
	connects the shader program for use.

virtual const std::string &	GetName () const =0

virtual void	SetFloat (const std::string &name, float value)=0
	Sets a single float uniform in the shader.

virtual void	SetFloat3 (const std::string &name, const glm::vec3 &value)=0
	Sets a 3-component float vector uniform in the shader.

virtual void	SetFloat4 (const std::string &name, const glm::vec4 &value)=0
	Sets a 4-component float vector uniform in the shader.

virtual void	SetInt (const std::string &name, int value)=0
	Sets a single integer uniform in the shader.

virtual void	SetIntArray (const std::string &name, int *values, uint32_t count)=0
	Sets an array of integers uniform in the shader.

virtual void	SetMat4 (const std::string &name, const glm::mat4 &value)=0
	Sets a 4x4 matrix uniform in the shader.

virtual void	Unbind () const =0
	disconnects the shader program.

virtual	~Shader ()=default

Static Public Member Functions
static Ref< Shader >	Create (const std::string &filepath)
	Creates a shader from a file.

static Ref< Shader >	Create (const std::string &name, const std::string &vertexSrc, const std::string &fragmentSrc)
	Creates a new shader from vertex and fragment shader source code.

Detailed Description

An abstraction for a shader program.

Constructor & Destructor Documentation

◆ ~Shader()

virtual Muto::Shader::~Shader ( )

virtualdefault

Member Function Documentation

◆ Bind()

virtual void Muto::Shader::Bind ( ) const

pure virtual

connects the shader program for use.

Implemented in Muto::OpenGLShader.

◆ Create() [1/2]

Ref< Shader > Muto::Shader::Create ( const std::string & filepath )

static

Creates a shader from a file.

Parameters

filepath The path to the shader file to load.

Returns: A reference to the created shader object.

Todo:: Adjust function to return a MutoResult and have the shader as an out parameter, to allow for error handling during shader compilation.

    {
        switch (Renderer::GetAPI())
        {
        case RenderAPI::API::RAPI_None: MU_CORE_ASSERT(false, "RenderAPI::None is currently not supported!"); return nullptr;
        case RenderAPI::API::RAPI_OpenGL:   return CreateRef<OpenGLShader>(filepath);
        }
        MU_CORE_ASSERT(false, "Unknown RenderAPI!");
        return nullptr;
    }

References Muto::Renderer::GetAPI(), Muto::RenderAPI::RAPI_None, and Muto::RenderAPI::RAPI_OpenGL.

◆ Create() [2/2]

Ref< Shader > Muto::Shader::Create	(	const std::string &	name,
		const std::string &	vertexSrc,
		const std::string &	fragmentSrc
	)

static

Creates a new shader from vertex and fragment shader source code.

Parameters

name	The name to assign to the shader.
vertexSrc	The vertex shader source code as a string.
fragmentSrc	The fragment shader source code as a string.

Returns: A reference to the newly created shader object.

Todo:: Adjust function to return a MutoResult and have the shader as an out parameter, to allow for error handling during shader compilation.

    {
        switch (Renderer::GetAPI())
        {
            case RenderAPI::API::RAPI_None: MU_CORE_ASSERT(false, "RenderAPI::None is currently not supported!"); return nullptr;
            case RenderAPI::API::RAPI_OpenGL:   return CreateRef<OpenGLShader>(name, vertexSrc, fragmentSrc);
        }
        MU_CORE_ASSERT(false, "Unknown RenderAPI!");
        return nullptr;
    }