Storage of UBO related data. More...

#include <UniformBufferObject.hpp>

Public Member Functions
	UniformBufferObject ()=delete

	UniformBufferObject (UniformBufferObject &unused)=delete

UniformBufferObject &	operator= (UniformBufferObject &unused)=delete

	UniformBufferObject (UniformBufferObject &&) noexcept
	Move Constructor an existing UBO.

UniformBufferObject &	operator= (UniformBufferObject &&) noexcept
	Move Assign an existing UBO.

	UniformBufferObject (const char UNIFORM_BLOCK_NAME, const std::initializer_list< const char > uniformNamesList)
	Initializes the UniformBufferObject object.

	~UniformBufferObject ()
	Deletes the UBO from the GPU and frees all memory on the CPU.

	UniformBufferObject (const UniformBufferObject &)=delete
	do not allow UBOs to be copied

UniformBufferObject &	operator= (const UniformBufferObject &)=delete
	do not allow UBOs to be copied

void	setupWithShaderProgram (ShaderProgram *shaderProgram, GLuint bindingPoint)
	creates the UBO and allocates memory on both the CPU & GPU. binds the UBO and the uniform block for the provided ShaderProgram to the same binding point.

void	bindToShaderProgram (ShaderProgram *shaderProgram)
	sets the shader programs binding point to match this uniform buffer object

void	copyToOffset (unsigned int offset, const void *src, size_t len)
	copies the value pointed to by addr to the corresponding location within the UBO as denoted by the offset

void	copyToBuffer (const char UNIFORM_NAME, const void src, size_t len)
	copies the value pointed to by addr to the corresponding location within the UBO as denoted by the uniform name

void	setUniform (const char *UNIFORM_NAME, GLboolean value)
	sets the uniform value within the uniform buffer block

void	setUniform (const char *UNIFORM_NAME, GLint value)
	sets the uniform value within the uniform buffer block

void	setUniform (const char *UNIFORM_NAME, GLfloat value)
	sets the uniform value within the uniform buffer block

void	setUniform (const char *UNIFORM_NAME, glm::vec3 vec)
	sets the uniform value within the uniform buffer block

void	setUniform (const char *UNIFORM_NAME, glm::vec4 vec)
	sets the uniform value within the uniform buffer block

void	setUniform (const char *UNIFORM_NAME, glm::mat4 mtx)
	sets the uniform value within the uniform buffer block

void	setUniform (const char UNIFORM_NAME, const GLint pArray, GLint count)
	sets the uniform value within the uniform buffer block

void	setUniform (const char UNIFORM_NAME, const glm::ivec4 pArray, GLint count)
	sets the uniform value within the uniform buffer block

void	bindBuffer () const
	binds UBO object to UBO buffer

void	bufferSubData () const
	transfers UBO data to UBO buffer

Detailed Description

Storage of UBO related data.

Constructor & Destructor Documentation

◆ UniformBufferObject() [1/3]

CSCI441::UniformBufferObject::UniformBufferObject ( )

delete

Note: must use `UniformBufferObject(const char*, std::initializer_list<const char*>

◆ UniformBufferObject() [2/3]

CSCI441::UniformBufferObject::UniformBufferObject ( UniformBufferObject & unused )

delete

Note: cannot copy UBOs

◆ UniformBufferObject() [3/3]

CSCI441::UniformBufferObject::UniformBufferObject	(	const char *	UNIFORM_BLOCK_NAME,
		const std::initializer_list< const char * >	uniformNamesList
	)

inline

Initializes the UniformBufferObject object.

Parameters

UNIFORM_BLOCK_NAME	name of the uniform block
uniformNamesList	list of names that makeup the uniform block components

Member Function Documentation

◆ bindToShaderProgram()

void CSCI441::UniformBufferObject::bindToShaderProgram ( ShaderProgram * shaderProgram )

inline

sets the shader programs binding point to match this uniform buffer object

Parameters

shaderProgram

Note: need to call UniformBufferObject::setupWithShaderProgram() before calling this with a second shader program

◆ copyToBuffer()

void CSCI441::UniformBufferObject::copyToBuffer	(	const char *	UNIFORM_NAME,
		const void *	src,
		size_t	len
	)

inline

copies the value pointed to by addr to the corresponding location within the UBO as denoted by the uniform name

Parameters

UNIFORM_NAME	name of the uniform within the block to copy value to
src	starting address of source to copy from
len	length of buffer to copy

◆ copyToOffset()

void CSCI441::UniformBufferObject::copyToOffset	(	unsigned int	offset,
		const void *	src,
		size_t	len
	)

inline

copies the value pointed to by addr to the corresponding location within the UBO as denoted by the offset

Parameters

offset	UBO offset to copy value to
src	starting address of source to copy from
len	length of buffer to copy

◆ operator=() [1/2]

CSCI441::UniformBufferObject & CSCI441::UniformBufferObject::operator= ( UniformBufferObject && src )

inlinenoexcept

Move Assign an existing UBO.

Returns: this now reconfigured UBO

◆ operator=() [2/2]

UniformBufferObject & CSCI441::UniformBufferObject::operator= ( UniformBufferObject & unused )

delete

Note: cannot copy UBOs