blender::gpu::UniformBuf Class Reference

#include <gpu_uniform_buffer_private.hh>

Inherited by blender::gpu::GLUniformBuf, blender::gpu::MTLUniformBuf, and blender::gpu::VKUniformBuffer.

Public Member Functions
	UniformBuf (size_t size, const char *name)
virtual	~UniformBuf ()
virtual void	update (const void *data)=0
virtual void	clear_to_zero ()=0
virtual void	bind (int slot)=0
virtual void	bind_as_ssbo (int slot)=0
virtual void	unbind ()=0
void	attach_data (void *data)

Protected Attributes
size_t	size_in_bytes_
void *	data_ = nullptr
char	name_ [DEBUG_NAME_LEN]

Detailed Description

Implementation of Uniform Buffers. Base class which is then specialized for each implementation (GL, VK, ...).

Definition at line 28 of file gpu_uniform_buffer_private.hh.

Constructor & Destructor Documentation

UniformBuf()

blender::gpu::UniformBuf::UniformBuf	(	size_t	size,
		const char *	name )

Definition at line 31 of file gpu_uniform_buffer.cc.

References BLI_assert, name_, size(), size_in_bytes_, and STRNCPY.

~UniformBuf()

blender::gpu::UniformBuf::~UniformBuf ( )

virtual

Definition at line 41 of file gpu_uniform_buffer.cc.

References data_, and MEM_SAFE_FREE.

Member Function Documentation

attach_data()

void blender::gpu::UniformBuf::attach_data ( void * data )

inline

Used to defer data upload at drawing time. This is useful if the thread has no context bound. This transfers ownership to this UniformBuf.

Definition at line 50 of file gpu_uniform_buffer_private.hh.

References data, and data_.

Referenced by GPU_uniformbuf_create_from_list().

bind()

virtual void blender::gpu::UniformBuf::bind ( int slot )

pure virtual

Implemented in blender::gpu::GLUniformBuf, blender::gpu::MTLUniformBuf, and blender::gpu::VKUniformBuffer.

bind_as_ssbo()

virtual void blender::gpu::UniformBuf::bind_as_ssbo ( int slot )

pure virtual

Implemented in blender::gpu::GLUniformBuf, blender::gpu::MTLUniformBuf, and blender::gpu::VKUniformBuffer.

clear_to_zero()

virtual void blender::gpu::UniformBuf::clear_to_zero ( )

pure virtual

Implemented in blender::gpu::GLUniformBuf, blender::gpu::MTLUniformBuf, and blender::gpu::VKUniformBuffer.

unbind()

virtual void blender::gpu::UniformBuf::unbind ( )

pure virtual

Implemented in blender::gpu::GLUniformBuf, blender::gpu::MTLUniformBuf, and blender::gpu::VKUniformBuffer.

update()

virtual void blender::gpu::UniformBuf::update ( const void * data )

pure virtual

Implemented in blender::gpu::GLUniformBuf, blender::gpu::MTLUniformBuf, and blender::gpu::VKUniformBuffer.

Referenced by GPU_uniformbuf_create_ex().

Member Data Documentation

data_

void* blender::gpu::UniformBuf::data_ = nullptr

protected

Continuous memory block to copy to GPU. This data is owned by the UniformBuf.

Definition at line 33 of file gpu_uniform_buffer_private.hh.

Referenced by attach_data(), blender::gpu::GLUniformBuf::bind(), blender::gpu::MTLUniformBuf::bind(), blender::gpu::GLUniformBuf::bind_as_ssbo(), blender::gpu::MTLUniformBuf::bind_as_ssbo(), blender::gpu::VKUniformBuffer::ensure_updated(), and ~UniformBuf().

name_

char blender::gpu::UniformBuf::name_[DEBUG_NAME_LEN]

protected

Debugging name

Definition at line 35 of file gpu_uniform_buffer_private.hh.

Referenced by blender::gpu::GLUniformBuf::bind(), blender::gpu::MTLUniformBuf::get_name(), UniformBuf(), and blender::gpu::MTLUniformBuf::update().

size_in_bytes_

size_t blender::gpu::UniformBuf::size_in_bytes_

protected

Data size in bytes.

Definition at line 31 of file gpu_uniform_buffer_private.hh.

Referenced by blender::gpu::MTLUniformBuf::bind_as_ssbo(), blender::gpu::MTLUniformBuf::clear_to_zero(), blender::gpu::MTLUniformBuf::get_size(), blender::gpu::VKUniformBuffer::size_in_bytes(), UniformBuf(), blender::gpu::GLUniformBuf::update(), blender::gpu::MTLUniformBuf::update(), and blender::gpu::VKUniformBuffer::update().

---

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

• gpu_uniform_buffer_private.hh
• gpu_uniform_buffer.cc