#include <Shader.hpp>

A shader program is a set of shader (for instance vertex shader + pixel shader) defining the rendering pipeline. More...

Description

A shader program is a set of shader (for instance vertex shader + pixel shader) defining the rendering pipeline.

This is a move-only ressource.

This class provide an interface to define the OpenGL uniforms and attributes using GLM objects.

See also: Shader

Definition at line 114 of file Shader.hpp.

Public Member Functions
	ShaderProgram ()
	The constructor. The ShaderProgram is initially invalid. You need to call AddShader and Link before being able to use it. More...

void	AddShader (const Shader &shader)
	Add a Shader to the program list. This must called multiple time for each shader components before calling Link. More...

void	Link () const
	Add a Shader to the program list. More...

bool	IsReady () const

bool	LinkStatus () const

void	Use () const
	Bind the ShaderProgram. Future draw will use it. This unbind any previously bound ShaderProgram. More...

void	Unuse () const
	Unbind the ShaderProgram. More...

GLuint	id () const
	The GPU id to the ShaderProgram. More...

GLint	Attribute (const std::string &name) const
	Return the GPU attribute id. More...

void	SetAttribute (const std::string &name, GLint size, GLsizei stride, GLuint offset, GLboolean normalize, GLenum type) const
	Set an OpenGL attribute properties. More...

void	SetAttribute (const std::string &name, GLint size, GLsizei stride, GLuint offset, GLboolean normalize) const
	Set an OpenGL attribute properties, assuming data are float. More...

void	SetAttribute (const std::string &name, GLint size, GLsizei stride, GLuint offset, GLenum type) const
	Set an OpenGL attribute properties, assuming data are float. More...

void	SetAttribute (const std::string &name, GLint size, GLsizei stride, GLuint offset) const
	Set an OpenGL attribute properties, assuming data are float. More...

GLint	Uniform (const std::string &name)
	Return the uniform ID. More...

GLint	operator[] (const std::string &name)

void	SetUniform (const std::string &name, float x, float y, float z)
	Assign shader vec3 uniform. More...

void	SetUniform (const std::string &name, const glm::vec3 &v)

void	SetUniform (const std::string &name, const glm::vec4 &v)

void	SetUniform (const std::string &name, const glm::mat4 &m)

void	SetUniform (const std::string &name, const glm::mat3 &m)

void	SetUniform (const std::string &name, float val)
	Assign shader float uniform. More...

void	SetUniform (const std::string &name, int val)
	Assign shader int uniform. More...

	ShaderProgram (ShaderProgram &&) noexcept

	ShaderProgram (const ShaderProgram &)

ShaderProgram &	operator= (ShaderProgram &&) noexcept

ShaderProgram &	operator= (const ShaderProgram &)

bool	operator== (const ShaderProgram &rhs) const

bool	operator!= (const ShaderProgram &rhs) const

Constructor & Destructor Documentation

◆ ShaderProgram()

smk::ShaderProgram::ShaderProgram ( )

The constructor. The ShaderProgram is initially invalid. You need to call AddShader and Link before being able to use it.

Definition at line 219 of file Shader.cpp.

219: impl_(std::make_shared<Impl>()) {}

Member Function Documentation

◆ AddShader()

void smk::ShaderProgram::AddShader ( const Shader & shader )

Add a Shader to the program list. This must called multiple time for each shader components before calling Link.

Parameters

shader The Shader to be added to the program list.

Definition at line 224 of file Shader.cpp.

                                                  {
  if (!impl_->id) {
    impl_->id = glCreateProgram();
    if (!impl_->id) {
      std::cerr << "[Error] Impossible to create a new Shader" << std::endl;
    }
  }
 
  glAttachShader(id(), shader.id());
}

◆ Attribute()

GLint smk::ShaderProgram::Attribute ( const std::string & name ) const

Return the GPU attribute id.

Parameters

name	The attribute name in the Shader.

Returns: The GPU attribute ID. Return 0 and display an error if not found.

Definition at line 304 of file Shader.cpp.

                                                          {
  GLint attrib = glGetAttribLocation(id(), name.c_str());
  if (attrib == GL_INVALID_OPERATION || attrib < 0) {
    std::cerr << "[Error] Attribute " << name << " doesn't exist in program"
              << std::endl;
  }
 
  return attrib;
}

◆ id()

GLuint smk::ShaderProgram::id ( ) const

The GPU id to the ShaderProgram.

Returns: The GPU id to the ShaderProgram.

Definition at line 441 of file Shader.cpp.

                               {
  return impl_->id;
}

◆ IsReady()

bool smk::ShaderProgram::IsReady ( ) const

Definition at line 244 of file Shader.cpp.

                                  {
  if (g_khr_parallel_shader) {
    GLint completion_status = {};
    std::cerr << GL_COMPLETION_STATUS_KHR << std::endl;
    std::cerr << id() << std::endl;
    glGetProgramiv(id(), GL_COMPLETION_STATUS_KHR, &completion_status);
    return completion_status == GL_TRUE;
  }
 
  return true;
}

◆ Link()

void smk::ShaderProgram::Link ( ) const

Add a Shader to the program list.

Definition at line 236 of file Shader.cpp.

                               {
  glLinkProgram(id());
}

◆ LinkStatus()

bool smk::ShaderProgram::LinkStatus ( ) const

Definition at line 256 of file Shader.cpp.

                                     {
  GLint result = {};
  glGetProgramiv(id(), GL_LINK_STATUS, &result);
  if (result == GL_TRUE) {
    return true;
  }
 
  std::cout << "[Error] linkage error" << std::endl;
 
  GLsizei logsize = 0;
  glGetProgramiv(id(), GL_INFO_LOG_LENGTH, &logsize);
 
  std::vector<char> log(logsize);
  glGetProgramInfoLog(id(), logsize, &logsize, log.data());
 
  std::cout << log.data() << std::endl;
  return false;
}

◆ operator!=()

bool smk::ShaderProgram::operator!= ( const ShaderProgram & rhs ) const

Definition at line 449 of file Shader.cpp.

                                                             {
  return impl_ != rhs.impl_;
}

◆ operator==()

bool smk::ShaderProgram::operator== ( const ShaderProgram & rhs ) const

Definition at line 445 of file Shader.cpp.

                                                             {
  return impl_ == rhs.impl_;
}

◆ operator[]()

GLint smk::ShaderProgram::operator[] ( const std::string & name )

Definition at line 297 of file Shader.cpp.

                                                     {
  return Uniform(name);
}

◆ SetAttribute() [1/4]

void smk::ShaderProgram::SetAttribute	(	const std::string &	name,
		GLint	size,
		GLsizei	stride,
		GLuint	offset
	)		const

Set an OpenGL attribute properties, assuming data are float.

See also: SetAttribute.

Definition at line 365 of file Shader.cpp.

                                                      {
  SetAttribute(name, size, stride, offset, false, GL_FLOAT);
}

◆ SetAttribute() [2/4]

void smk::ShaderProgram::SetAttribute	(	const std::string &	name,
		GLint	size,
		GLsizei	stride,
		GLuint	offset,
		GLboolean	normalize
	)		const

Set an OpenGL attribute properties, assuming data are float.

See also: SetAttribute.

Definition at line 345 of file Shader.cpp.

                                                            {
  SetAttribute(name, size, stride, offset, normalize, GL_FLOAT);
}

◆ SetAttribute() [3/4]

void smk::ShaderProgram::SetAttribute	(	const std::string &	name,
		GLint	size,
		GLsizei	stride,
		GLuint	offset,
		GLboolean	normalize,
		GLenum	type
	)		const

Set an OpenGL attribute properties.

Parameters

name	Attribute name in the Shader.
size	Specify the number of component per object. One of {1,2,3,4}.
stride	Specify the byte offset in between consecutive attribute of the same kind.
offset	Offset of the attribute in the struct.
type	The type of data. For instance GL_FLOAT.

Returns: The GPU attribute ID. Return 0 and display an error if not found.

See also: glVertexAttribPointer

Definition at line 331 of file Shader.cpp.

                                                    {
  GLint loc = Attribute(name);
  glEnableVertexAttribArray(loc);
  glVertexAttribPointer(loc, size, type, normalize, stride,
                        reinterpret_cast<void*>(offset)); // NOLINT
}

◆ SetAttribute() [4/4]

void smk::ShaderProgram::SetAttribute	(	const std::string &	name,
		GLint	size,
		GLsizei	stride,
		GLuint	offset,
		GLenum	type
	)		const

Set an OpenGL attribute properties, assuming data are float.

See also: SetAttribute.

Definition at line 355 of file Shader.cpp.

                                                    {
  SetAttribute(name, size, stride, offset, false, type);
}

◆ SetUniform() [1/3]

void smk::ShaderProgram::SetUniform	(	const std::string &	name,
		float	val
	)

Assign shader float uniform.

Parameters

val	float value This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

Definition at line 415 of file Shader.cpp.

                                                               {
  glUniform1f(Uniform(name), val);
}

◆ SetUniform() [2/3]

void smk::ShaderProgram::SetUniform	(	const std::string &	name,
		float	x,
		float	y,
		float	z
	)

Assign shader vec3 uniform.

Parameters

x	First vec3 component.
y	Second vec3 component.
z	Third vec3 component This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

Definition at line 377 of file Shader.cpp.

                                        {
  glUniform3f(Uniform(name), x, y, z);
}

◆ SetUniform() [3/3]

void smk::ShaderProgram::SetUniform	(	const std::string &	name,
		int	val
	)

Assign shader int uniform.

Parameters

val	int value This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

Definition at line 422 of file Shader.cpp.

                                                             {
  glUniform1i(Uniform(name), val);
}

◆ Uniform()

GLint smk::ShaderProgram::Uniform ( const std::string & name )

Return the uniform ID.

Parameters

name	The uniform name in the Shader.

Returns: The GPU uniform ID. Return 0 and display an error if not found.

Definition at line 278 of file Shader.cpp.

                                                  {
  auto it = impl_->uniforms.find(name);
  if (it == impl_->uniforms.end()) {
    // impl_->uniforms that is not referenced
    GLint r = glGetUniformLocation(id(), name.c_str());
 
    if (r == GL_INVALID_OPERATION || r < 0) {
      std::cerr << "[Error] Uniform " << name << " doesn't exist in program"
                << std::endl;
    }
    // add it anyways
    impl_->uniforms[name] = r;
 
    return r;
  } else {
    return it->second;
  }
}

◆ Unuse()

void smk::ShaderProgram::Unuse ( ) const

Unbind the ShaderProgram.

Definition at line 435 of file Shader.cpp.

                                {
  glUseProgram(0);
}

◆ Use()

void smk::ShaderProgram::Use ( ) const

Bind the ShaderProgram. Future draw will use it. This unbind any previously bound ShaderProgram.

Definition at line 429 of file Shader.cpp.

                              {
  glUseProgram(id());
}

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

/home/arthursonzogni/programmation/real/smk/include/smk/Shader.hpp
/home/arthursonzogni/programmation/real/smk/src/smk/Shader.cpp

Description

Public Member Functions

Constructor & Destructor Documentation

◆ ShaderProgram()

Member Function Documentation

◆ AddShader()

◆ Attribute()

◆ id()

◆ IsReady()

◆ Link()

◆ LinkStatus()

◆ operator!=()

◆ operator==()

◆ operator[]()

◆ SetAttribute() [1/4]

◆ SetAttribute() [2/4]

◆ SetAttribute() [3/4]

◆ SetAttribute() [4/4]

◆ SetUniform() [1/3]

◆ SetUniform() [2/3]

◆ SetUniform() [3/3]

◆ Uniform()

◆ Unuse()

◆ Use()