Sets up a default Gouraud Shader with vertex position and color inputs. More...

#include "ShaderUtils.hpp"
#include "objects.hpp"
#include <glad/gl.h>
#include <glm/glm.hpp>
#include <glm/gtc/type_ptr.hpp>
#include <string>
#include <vector>

Namespaces
namespace	CSCI441
	CSCI441 Helper Functions for OpenGL.

namespace	SimpleShader2
	Abstracts the process of working with a 2D shader program.

namespace	SimpleShader3
	Abstracts the process of working with a 3D shader program.

Functions
void	CSCI441::SimpleShader2::enableFlatShading ()
	turns on Flat Shading

void	CSCI441::SimpleShader2::enableSmoothShading ()
	turns on Smooth Shading

void	CSCI441::SimpleShader2::setupSimpleShader ()
	Registers a simple Gouraud shader for 2-Dimensional drawing.

GLuint	CSCI441::SimpleShader2::registerVertexArray (const std::vector< glm::vec2 > &VERTEX_POINTS, const std::vector< glm::vec3 > &VERTEX_COLORS)
	registers the associated vertex locations and colors with the GPU

void	CSCI441::SimpleShader2::updateVertexArray (GLuint VAOD, const std::vector< glm::vec2 > &VERTEX_POINTS, const std::vector< glm::vec3 > &VERTEX_COLORS)
	Updates GL_ARRAY_BUFFER for the corresponding VAO.

GLuint	CSCI441::SimpleShader2::registerVertexArray (GLuint NUM_POINTS, const glm::vec2 VERTEX_POINTS[], const glm::vec3 VERTEX_COLORS[])
	registers the associated vertex locations and colors with the GPU

void	CSCI441::SimpleShader2::updateVertexArray (GLuint VAOD, GLuint NUM_POINTS, const glm::vec2 VERTEX_POINTS[], const glm::vec3 VERTEX_COLORS[])
	Updates GL_ARRAY_BUFFER for the corresponding VAO.

void	CSCI441::SimpleShader2::setProjectionMatrix (const glm::mat4 &PROJECTION_MATRIX)
	Sets the Projection Matrix.

void	CSCI441::SimpleShader2::pushTransformation (const glm::mat4 &TRANSFORMATION_MATRIX)
	Pushes a transformation to the stack and updates our model matrix.

void	CSCI441::SimpleShader2::popTransformation ()
	Pops the last transformation off the stack and updates our model matrix by the inverse of the last transformation.

void	CSCI441::SimpleShader2::resetTransformationMatrix ()
	Sets the model matrix back to the identity matrix and clears the transformation stack.

void	CSCI441::SimpleShader2::draw (GLint PRIMITIVE_TYPE, GLuint VAOD, GLuint VERTEX_COUNT)
	loads associated VAO, drawing given primitive made up of corresponding number of vertices

void	CSCI441::SimpleShader3::enableFlatShading ()
	turns on Flat Shading

void	CSCI441::SimpleShader3::enableSmoothShading ()
	turns on Smooth Shading

void	CSCI441::SimpleShader3::setupSimpleShader ()
	Registers a simple Gouraud Shader with Lambertian Illumination for 3-Dimensional drawing.

GLuint	CSCI441::SimpleShader3::registerVertexArray (const std::vector< glm::vec3 > &VERTEX_POINTS, const std::vector< glm::vec3 > &VERTEX_NORMALS)
	registers the associated vertex locations and colors with the GPU

void	CSCI441::SimpleShader3::updateVertexArray (GLuint VAOD, const std::vector< glm::vec3 > &VERTEX_POINTS, const std::vector< glm::vec3 > &VERTEX_NORMALS)
	Updates GL_ARRAY_BUFFER for the corresponding VAO.

GLuint	CSCI441::SimpleShader3::registerVertexArray (GLuint NUM_POINTS, const glm::vec3 VERTEX_POINTS[], const glm::vec3 VERTEX_NORMALS[])
	registers the associated vertex locations and colors with the GPU

void	CSCI441::SimpleShader3::updateVertexArray (GLuint VAOD, GLuint NUM_POINTS, const glm::vec3 VERTEX_POINTS[], const glm::vec3 VERTEX_NORMALS[])
	Updates GL_ARRAY_BUFFER for the corresponding VAO.

void	CSCI441::SimpleShader3::setProjectionMatrix (const glm::mat4 &PROJECTION_MATRIX)
	Sets the Projection Matrix.

void	CSCI441::SimpleShader3::setViewMatrix (const glm::mat4 &VIEW_MATRIX)
	Sets the View Matrix.

void	CSCI441::SimpleShader3::setLightPosition (const glm::vec3 &LIGHT_POSITION)
	sets position of single global light in world space

void	CSCI441::SimpleShader3::setLightColor (const glm::vec3 &LIGHT_COLOR)
	sets color of single global light

void	CSCI441::SimpleShader3::setMaterialColor (const glm::vec3 &MATERIAL_COLOR)
	sets current diffuse material color to apply to object

void	CSCI441::SimpleShader3::pushTransformation (const glm::mat4 &TRANSFORMATION_MATRIX)
	Pushes a transformation to the stack and updates our model matrix.

void	CSCI441::SimpleShader3::popTransformation ()
	Pops the last transformation off the stack and updates our model matrix by the inverse of the last transformation.

void	CSCI441::SimpleShader3::resetTransformationMatrix ()
	Sets the model matrix back to the identity matrix and clears the transformation stack.

void	CSCI441::SimpleShader3::enableLighting ()
	turns on lighting and applies Phong Illumination to fragment

void	CSCI441::SimpleShader3::disableLighting ()
	turns off lighting and applies material color to fragment

void	CSCI441::SimpleShader3::draw (GLint PRIMITIVE_TYPE, GLuint VAOD, GLuint VERTEX_COUNT)
	loads associated VAO, drawing given primitive made up of corresponding number of vertices

Detailed Description

Sets up a default Gouraud Shader with vertex position and color inputs.

Author: Dr. Jeffrey Paone

Copyright: MIT License Copyright (c) 2020 Dr. Jeffrey Paone

These functions, classes, and constants help minimize common code that needs to be written.

Warning: NOTE: This header file will only work with OpenGL 4.1; NOTE: This header file depends upon glm; NOTE: This header file depends upon GLAD (or alternatively GLEW)

Function Documentation

◆ disableLighting()

void CSCI441::SimpleShader3::disableLighting ( )

inline

turns off lighting and applies material color to fragment

Warning: must call after to setupSimpleShader

◆ draw() [1/2]

void CSCI441::SimpleShader2::draw	(	GLint	PRIMITIVE_TYPE,
		GLuint	VAOD,
		GLuint	VERTEX_COUNT
	)

inline

loads associated VAO, drawing given primitive made up of corresponding number of vertices

Parameters

PRIMITIVE_TYPE	primitive type to use
VAOD	VAO to load
VERTEX_COUNT	number of vertices to draw

◆ draw() [2/2]

void CSCI441::SimpleShader3::draw	(	GLint	PRIMITIVE_TYPE,
		GLuint	VAOD,
		GLuint	VERTEX_COUNT
	)

inline

loads associated VAO, drawing given primitive made up of corresponding number of vertices

Parameters

PRIMITIVE_TYPE	primitive type to use
VAOD	VAO to load
VERTEX_COUNT	number of vertices to draw

◆ enableFlatShading() [1/2]

void CSCI441::SimpleShader2::enableFlatShading ( )

inline

turns on Flat Shading

Warning: must call prior to setupSimpleShader

◆ enableFlatShading() [2/2]

void CSCI441::SimpleShader3::enableFlatShading ( )

inline

turns on Flat Shading

Warning: must call prior to setupSimpleShader

◆ enableLighting()

void CSCI441::SimpleShader3::enableLighting ( )

inline

turns on lighting and applies Phong Illumination to fragment

Warning: must call after to setupSimpleShader

◆ enableSmoothShading() [1/2]

void CSCI441::SimpleShader2::enableSmoothShading ( )

inline

turns on Smooth Shading

Warning: must call prior to setupSimpleShader

◆ enableSmoothShading() [2/2]

void CSCI441::SimpleShader3::enableSmoothShading ( )

inline

turns on Smooth Shading

Warning: must call prior to setupSimpleShader

◆ pushTransformation() [1/2]

void CSCI441::SimpleShader2::pushTransformation ( const glm::mat4 & TRANSFORMATION_MATRIX )

inline

Pushes a transformation to the stack and updates our model matrix.

Parameters

TRANSFORMATION_MATRIX homogeneous transformation to stack on model matrix

◆ pushTransformation() [2/2]

void CSCI441::SimpleShader3::pushTransformation ( const glm::mat4 & TRANSFORMATION_MATRIX )

inline

Pushes a transformation to the stack and updates our model matrix.

Parameters

TRANSFORMATION_MATRIX transformation to stack on model matrix

◆ registerVertexArray() [1/4]

GLuint CSCI441::SimpleShader2::registerVertexArray	(	const std::vector< glm::vec2 > &	VERTEX_POINTS,
		const std::vector< glm::vec3 > &	VERTEX_COLORS
	)

inline

registers the associated vertex locations and colors with the GPU

Parameters

VERTEX_POINTS	vector of vertex (x,y) locations
VERTEX_COLORS	vector of vertex (r,g,b) colors

Returns: generated Vertex Array Object Descriptor (vaod)

◆ registerVertexArray() [2/4]

GLuint CSCI441::SimpleShader3::registerVertexArray	(	const std::vector< glm::vec3 > &	VERTEX_POINTS,
		const std::vector< glm::vec3 > &	VERTEX_NORMALS
	)

inline

registers the associated vertex locations and colors with the GPU

Parameters

VERTEX_POINTS	vector of vertex (x,y,z) locations in object space
VERTEX_NORMALS	vector of vertex (x,y,z) normals in object space

Returns: generated Vertex Array Object Descriptor (vaod)

◆ registerVertexArray() [3/4]

GLuint CSCI441::SimpleShader2::registerVertexArray	(	GLuint	NUM_POINTS,
		const glm::vec2	VERTEX_POINTS[],
		const glm::vec3	VERTEX_COLORS[]
	)

inline

registers the associated vertex locations and colors with the GPU

Parameters

NUM_POINTS	number of points in each array
VERTEX_POINTS	array of vertex (x,y) locations
VERTEX_COLORS	array of vertex (r,g,b) colors

Returns: generated Vertex Array Object Descriptor (vaod)

◆ registerVertexArray() [4/4]

GLuint CSCI441::SimpleShader3::registerVertexArray	(	GLuint	NUM_POINTS,
		const glm::vec3	VERTEX_POINTS[],
		const glm::vec3	VERTEX_NORMALS[]
	)

inline

registers the associated vertex locations and colors with the GPU

Parameters

NUM_POINTS	number of points in each array
VERTEX_POINTS	array of vertex (x,y,z) locations in object space
VERTEX_NORMALS	array of vertex (x,y,z) normals in object space

Returns: generated Vertex Array Object Descriptor (vaod)

◆ setLightColor()

void CSCI441::SimpleShader3::setLightColor ( const glm::vec3 & LIGHT_COLOR )

inline

sets color of single global light

Parameters

LIGHT_COLOR light color in RGB space

◆ setLightPosition()

void CSCI441::SimpleShader3::setLightPosition ( const glm::vec3 & LIGHT_POSITION )

inline

sets position of single global light in world space

Parameters

LIGHT_POSITION position of light in world space

◆ setMaterialColor()

void CSCI441::SimpleShader3::setMaterialColor ( const glm::vec3 & MATERIAL_COLOR )

inline

sets current diffuse material color to apply to object

Parameters

MATERIAL_COLOR diffuse material color in RGB space

◆ setProjectionMatrix() [1/2]

void CSCI441::SimpleShader2::setProjectionMatrix ( const glm::mat4 & PROJECTION_MATRIX )

inline

Sets the Projection Matrix.

Parameters

PROJECTION_MATRIX homogeneous projection matrix to set

◆ setProjectionMatrix() [2/2]

void CSCI441::SimpleShader3::setProjectionMatrix ( const glm::mat4 & PROJECTION_MATRIX )

inline

Sets the Projection Matrix.

Parameters

PROJECTION_MATRIX homogeneous projection matrix to set

◆ setViewMatrix()

void CSCI441::SimpleShader3::setViewMatrix ( const glm::mat4 & VIEW_MATRIX )

inline

Sets the View Matrix.

Parameters

VIEW_MATRIX homogeneous view matrix to set

◆ updateVertexArray() [1/4]

void CSCI441::SimpleShader2::updateVertexArray	(	GLuint	VAOD,
		const std::vector< glm::vec2 > &	VERTEX_POINTS,
		const std::vector< glm::vec3 > &	VERTEX_COLORS
	)

inline

Updates GL_ARRAY_BUFFER for the corresponding VAO.

Copies the data for the vertex positions and colors from CPU RAM to the GPU for the already registered VAO. The data is copied in to the GL_ARRAY_BUFFER VBO for this VAO. When function completes, the passed VAO is currently bound.

Warning: Requires that the same number of vertex points, or less, are passed as when the VAO was registered

Parameters

VAOD	Vertex Array Object Descriptor
VERTEX_POINTS	vector of vertex (x,y) locations
VERTEX_COLORS	vector of vertex (r,g,b) colors

◆ updateVertexArray() [2/4]

void CSCI441::SimpleShader3::updateVertexArray	(	GLuint	VAOD,
		const std::vector< glm::vec3 > &	VERTEX_POINTS,
		const std::vector< glm::vec3 > &	VERTEX_NORMALS
	)

inline

Updates GL_ARRAY_BUFFER for the corresponding VAO.

Copies the data for the vertex positions and colors from CPU RAM to the GPU for the already registered VAO. The data is copied in to the GL_ARRAY_BUFFER VBO for this VAO. When function completes, the passed VAO is currently bound.

Warning: Requires that the same number of vertex points, or less, are passed as when the VAO was registered

Parameters

VAOD	Vertex Array Object Descriptor
VERTEX_POINTS	vector of vertex (x,y,z) locations in object space
VERTEX_NORMALS	vector of vertex (x,y,z) normals in object space

◆ updateVertexArray() [3/4]

void CSCI441::SimpleShader2::updateVertexArray	(	GLuint	VAOD,
		GLuint	NUM_POINTS,
		const glm::vec2	VERTEX_POINTS[],
		const glm::vec3	VERTEX_COLORS[]
	)

inline

Updates GL_ARRAY_BUFFER for the corresponding VAO.

Copies the data for the vertex positions and colors from CPU RAM to the GPU for the already registered VAO. The data is copied in to the GL_ARRAY_BUFFER VBO for this VAO. When function completes, the passed VAO is currently bound.

Warning: Requires that the same number of vertex points, or less, are passed as when the VAO was registered

Parameters

VAOD	Vertex Array Object Descriptor
NUM_POINTS	number of points in each array
VERTEX_POINTS	vector of vertex (x,y) locations
VERTEX_COLORS	vector of vertex (r,g,b) colors

◆ updateVertexArray() [4/4]

void CSCI441::SimpleShader3::updateVertexArray	(	GLuint	VAOD,
		GLuint	NUM_POINTS,
		const glm::vec3	VERTEX_POINTS[],
		const glm::vec3	VERTEX_NORMALS[]
	)

inline

Updates GL_ARRAY_BUFFER for the corresponding VAO.

Copies the data for the vertex positions and colors from CPU RAM to the GPU for the already registered VAO. The data is copied in to the GL_ARRAY_BUFFER VBO for this VAO. When function completes, the passed VAO is currently bound.

Warning: Requires that the same number of vertex points, or less, are passed as when the VAO was registered

Parameters

VAOD	Vertex Array Object Descriptor
NUM_POINTS	number of points in each array
VERTEX_POINTS	array of vertex (x,y,z) locations in object space
VERTEX_NORMALS	array of vertex (x,y,z) normals in object space

Namespaces

Functions

Detailed Description

Function Documentation

◆ disableLighting()

◆ draw() [1/2]

◆ draw() [2/2]

◆ enableFlatShading() [1/2]

◆ enableFlatShading() [2/2]

◆ enableLighting()

◆ enableSmoothShading() [1/2]

◆ enableSmoothShading() [2/2]

◆ pushTransformation() [1/2]

◆ pushTransformation() [2/2]

◆ registerVertexArray() [1/4]

◆ registerVertexArray() [2/4]

◆ registerVertexArray() [3/4]

◆ registerVertexArray() [4/4]

◆ setLightColor()

◆ setLightPosition()

◆ setMaterialColor()

◆ setProjectionMatrix() [1/2]

◆ setProjectionMatrix() [2/2]

◆ setViewMatrix()

◆ updateVertexArray() [1/4]

◆ updateVertexArray() [2/4]

◆ updateVertexArray() [3/4]

◆ updateVertexArray() [4/4]