scl::gl_vertex_buffer Class Reference

#include <gl_buffer.h>

Inheritance diagram for scl::gl_vertex_buffer:

Public Member Functions
u32	GetCount () const override
render_primitive::handle	GetHandle () const override
	gl_vertex_buffer (u32 Count, const vertex_layout &VertexLayout)
	gl_vertex_buffer (const void *Vertices, u32 Count, const vertex_layout &VertexLayout)
	~gl_vertex_buffer ()
void	Bind () const override
void	Unbind () const override
void	Update (const void *Vertices, u32 Count) override
void	Free () override
Public Member Functions inherited from scl::vertex_buffer
vertex_layout	GetVertexLayout () const
	vertex_buffer (const vertex_layout &VertexLayout)
virtual	~vertex_buffer ()=default
virtual void	Bind () const =0
virtual void	Unbind () const =0
virtual void	Update (const void *Vertices, u32 Count)=0
virtual void	Free ()=0
virtual u32	GetCount () const =0

Additional Inherited Members
Static Public Member Functions inherited from scl::vertex_buffer
static shared< vertex_buffer >	Create (u32 Count, const vertex_layout &VertexLayout)
static shared< vertex_buffer >	Create (const void *Vertices, u32 Count, const vertex_layout &VertexLayout)
Protected Attributes inherited from scl::vertex_buffer
vertex_layout	VertexLayout {}

Detailed Description

Vertex bufer interface.

Definition at line 83 of file gl_buffer.h.

Constructor & Destructor Documentation

gl_vertex_buffer() [1/2]

scl::gl_vertex_buffer::gl_vertex_buffer	(	u32	Count,
		const vertex_layout &	VertexLayout
	)

• Empty vertex buffer constructor.

Parameters

Count	- vertices in buffer count.
VertexLayout	- layout of vertices in buffer.

Returns

constant buffer pointer.

Definition at line 76 of file gl_buffer.cpp.

                                                                                  :
    vertex_buffer(VertexLayout)
{
    this->VerticesCount = Count;
 
    glGenBuffers(1, &Id);
    glBindBuffer(GL_ARRAY_BUFFER, Id);
    glBufferData(GL_ARRAY_BUFFER, Count, nullptr, GL_DYNAMIC_DRAW);
    glBindBuffer(GL_ARRAY_BUFFER, 0);
 
    SCL_CORE_SUCCES("OpenGL Vertex buffer with id {} and {} verices created.", Id, Count);
}

gl_vertex_buffer() [2/2]

scl::gl_vertex_buffer::gl_vertex_buffer	(	const void *	Vertices,
		u32	Count,
		const vertex_layout &	VertexLayout
	)

• Vertex buffer filled with data constructor.

Parameters

Vertices	- buffer data pointer.
Count	- vertices in buffer count.
VertexLayout	- layout of vertices in buffer.

Definition at line 89 of file gl_buffer.cpp.

                                                                                                        :
    vertex_buffer(VertexLayout)
{
    this->VerticesCount = Count;
 
    glCreateBuffers(1, &Id);
    glBindBuffer(GL_ARRAY_BUFFER, Id);
    glBufferData(GL_ARRAY_BUFFER, (u64)Count * VertexLayout.GetSize(), Vertices, GL_STATIC_DRAW);
    glBindBuffer(GL_ARRAY_BUFFER, 0);
 
    SCL_CORE_SUCCES("OpenGL Vertex buffer with id {} and {} verices created.", Id, Count);
}

~gl_vertex_buffer()

scl::gl_vertex_buffer::~gl_vertex_buffer

(

)

Vertex buffer default destructor.

Definition at line 102 of file gl_buffer.cpp.

{
    Free();
}

Member Function Documentation

Bind()

void scl::gl_vertex_buffer::Bind ( ) const

overridevirtual

• Bind buffer to current render stage function.

Parameters

None.

Returns

None.

Implements scl::vertex_buffer.

Definition at line 107 of file gl_buffer.cpp.

{
    if (Id != 0) glBindBuffer(GL_ARRAY_BUFFER, Id);
}

Free()

void scl::gl_vertex_buffer::Free ( )

overridevirtual

• Clear buffer from GPU memory function.

Parameters

None.

Returns

None.

Implements scl::vertex_buffer.

Definition at line 129 of file gl_buffer.cpp.

{
    if (Id != 0)
    {
        glDeleteBuffers(1, &Id);
 
        SCL_CORE_INFO("OpenGL Vertex buffer with id {} freed.", Id);
        Id = 0, VerticesCount = 0;
    }
}

GetCount()

u32 scl::gl_vertex_buffer::GetCount ( ) const

inlineoverridevirtual

Vertex buffer data getter/setter functions.

Vertex buffer vertices count getter function.

Implements scl::vertex_buffer.

Definition at line 91 of file gl_buffer.h.

{ return VerticesCount; }

GetHandle()

render_primitive::handle scl::gl_vertex_buffer::GetHandle ( ) const

inlineoverride

Backend api render primitive hadnle getter function.

Definition at line 95 of file gl_buffer.h.

{ return Id; }

Unbind()

void scl::gl_vertex_buffer::Unbind ( ) const

overridevirtual

• Unbind buffer from current render stage function.

Parameters

None.

Returns

None.

Implements scl::vertex_buffer.

Definition at line 112 of file gl_buffer.cpp.

{
    glBindBuffer(GL_ARRAY_BUFFER, 0);
}

Update()

void scl::gl_vertex_buffer::Update ( const void *  Vertices, u32  Count  )

overridevirtual

• Update buffer data function.

Parameters

Vertices	- verices array.
Count	- length of vertices array.

Returns

None.

Implements scl::vertex_buffer.

Definition at line 117 of file gl_buffer.cpp.

{
    if (Id != 0)
    {
        SCL_CORE_ASSERT(Count == this->VerticesCount, "Vertices count can't be changed.");
 
        glBindBuffer(GL_ARRAY_BUFFER, Id);
        glBufferSubData(GL_ARRAY_BUFFER, 0, (u64)Count * VertexLayout.GetSize(), Vertices);
        glBindBuffer(GL_ARRAY_BUFFER, 0);
    }
}

---

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

• platform/opengl/gl_buffer.h
• platform/opengl/gl_buffer.cpp