CSCI441::UniformBufferObject Class Reference

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, 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	copyToOffset (unsigned int offset, void *addr, 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, void *addr, size_t len)
	copies the value pointed to by addr to the corresponding location within the UBO as denoted by the uniform name
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, 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

copyToBuffer()

void CSCI441::UniformBufferObject::copyToBuffer ( const char *  UNIFORM_NAME, void *  addr, 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
addr	starting address of source to copy from
len	length of buffer to copy

copyToOffset()

void CSCI441::UniformBufferObject::copyToOffset ( unsigned int  offset, void *  addr, 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
addr	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

setupWithShaderProgram()

void CSCI441::UniformBufferObject::setupWithShaderProgram ( ShaderProgram *  shaderProgram, GLuint  bindingPoint  )

inline

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.

Parameters

shaderProgram	ShaderProgram object that utilizes the uniformBlock
bindingPoint	Binding point to bind the UBO and ShaderProgram Uniform Block to

---

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

• UniformBufferObject.hpp