scl::index_buffer Class Reference

#include <buffer.h>

Inheritance diagram for scl::index_buffer:

Public Member Functions
virtual	~index_buffer ()=default
virtual void	Bind () const =0
virtual void	Unbind () const =0
virtual void	Free ()=0
virtual void	Update (u32 *Indices, u32 Count)=0
virtual u32	GetCount () const =0

Static Public Member Functions
static shared< index_buffer >	Create (u32 *Indices, u32 Count)

Detailed Description

Vertices indices buffer interface.

Definition at line 182 of file buffer.h.

Constructor & Destructor Documentation

~index_buffer()

virtual scl::index_buffer::~index_buffer ( )

virtualdefault

Index buffer default destructor.

Member Function Documentation

Bind()

virtual void scl::index_buffer::Bind ( ) const

pure virtual

• Bind buffer to current render stage function.

Parameters

None.

Returns

None.

Implemented in scl::gl_index_buffer.

Create()

scl::shared< scl::index_buffer > scl::index_buffer::Create ( u32 *  Indices, u32  Count  )

static

• Create API specific index buffer by indices count and data.

Parameters

Indices	- indices array.
Count	- indices in buffer count.

Returns

vertex buffer pointer.

Definition at line 65 of file buffer.cpp.

{
    switch (render_context::GetApi())
    {
    case scl::render_context_api::OpenGL:  return CreateShared<scl::gl_index_buffer>(Indices, Count);
    case scl::render_context_api::DirectX: SCL_CORE_ASSERT(0, "This API is currently unsupported."); return nullptr;
    }
 
    SCL_CORE_ASSERT(0, "Unknown render API was selected.");
    return nullptr;
}

Free()

virtual void scl::index_buffer::Free ( )

pure virtual

• Clear buffer from GPU memory function.

Parameters

None.

Returns

None.

Implemented in scl::gl_index_buffer.

GetCount()

virtual u32 scl::index_buffer::GetCount ( ) const

pure virtual

• Index biffer indices count getter function.

Parameters

None.

Returns

indicies count.

Implemented in scl::gl_index_buffer.

Unbind()

virtual void scl::index_buffer::Unbind ( ) const

pure virtual

• Unbind buffer from current render stage function.

Parameters

None.

Returns

None.

Implemented in scl::gl_index_buffer.

Update()

virtual void scl::index_buffer::Update ( u32 *  Indices, u32  Count  )

pure virtual

• Update buffer function function.

Parameters

Indices	- array of indices.
Count

Implemented in scl::gl_index_buffer.

---

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

• core/render/primitives/buffer.h
• core/render/primitives/buffer.cpp