scl::vertex_array Class Reference

#include <vertex_array.h>

Inheritance diagram for scl::vertex_array:

Public Member Functions
mesh_type	GetType () const
const shared< vertex_buffer > &	GetVertexBuffer () const
const shared< index_buffer > &	GetIndexBuffer () const
virtual void	SetVertexBuffer (const shared< vertex_buffer > &VertexBuffer)=0
virtual void	SetIndexBuffer (const shared< index_buffer > &IndexBuffer)=0
	vertex_array (mesh_type MeshType)
virtual	~vertex_array ()=default
virtual void	Bind () const =0
virtual void	Unbind () const =0

Static Public Member Functions
static shared< vertex_array >	Create (mesh_type Mesh_type)

Protected Attributes
mesh_type	Type {}
shared< vertex_buffer >	VertexBuffer {}
shared< index_buffer >	IndexBuffer {}

Detailed Description

Mesh interface.

Definition at line 27 of file vertex_array.h.

Constructor & Destructor Documentation

vertex_array()

scl::vertex_array::vertex_array

(

mesh_type

MeshType

)

Vertex array default constructor.

Definition at line 14 of file vertex_array.cpp.

                                                :
    Type(MeshType) {}

~vertex_array()

virtual scl::vertex_array::~vertex_array ( )

virtualdefault

Vertex array default destructor.

Member Function Documentation

Bind()

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

pure virtual

• Bind vertex array to current render stage function.

Parameters

None.

Returns

None.

Implemented in scl::gl_vertex_array.

Create()

scl::shared< scl::vertex_array > scl::vertex_array::Create ( mesh_type  Mesh_type )

static

• Create vertex array function.

Parameters

Type	- creating mesh type.
VertexBuffer	- vertex buffer to link to vertex array.
IndexBuffer	- vartex indicies buffer to be linked to vertex array.

Returns

pointer to created vertex array.

Definition at line 17 of file vertex_array.cpp.

{
    switch (render_context::GetApi())
    {
    case scl::render_context_api::OpenGL:  return CreateShared<gl_vertex_array>(Mesh_type);
    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;
}

GetIndexBuffer()

const shared< index_buffer > & scl::vertex_array::GetIndexBuffer ( ) const

inline

Index buffer, linked to vertex array getter function.

Definition at line 40 of file vertex_array.h.

{ return IndexBuffer; }

GetType()

mesh_type scl::vertex_array::GetType ( ) const

inline

Vertex array getter/setter functions.

Mesh type getter function.

Definition at line 36 of file vertex_array.h.

{ return Type; }

GetVertexBuffer()

const shared< vertex_buffer > & scl::vertex_array::GetVertexBuffer ( ) const

inline

Vertex buffer, linked to vertex array getter function.

Definition at line 38 of file vertex_array.h.

{ return VertexBuffer; }

SetIndexBuffer()

virtual void scl::vertex_array::SetIndexBuffer ( const shared< index_buffer > &  IndexBuffer )

pure virtual

Link index buffer to vertex array function.

Implemented in scl::gl_vertex_array.

SetVertexBuffer()

virtual void scl::vertex_array::SetVertexBuffer ( const shared< vertex_buffer > &  VertexBuffer )

pure virtual

Link vertex buffer to vertex array function.

Implemented in scl::gl_vertex_array.

Unbind()

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

pure virtual

• Unbind vertex array from current render stage function.

Parameters

None.

Returns

None.

Implemented in scl::gl_vertex_array.

Member Data Documentation

IndexBuffer

shared<index_buffer> scl::vertex_array::IndexBuffer {}

protected

Definition at line 32 of file vertex_array.h.

Type

mesh_type scl::vertex_array::Type {}

protected

Vertex array data.

Definition at line 30 of file vertex_array.h.

VertexBuffer

shared<vertex_buffer> scl::vertex_array::VertexBuffer {}

protected

Definition at line 31 of file vertex_array.h.

---

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

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