visutwin::canvas::IndexBuffer Class Reference

#include <platform/graphics/indexBuffer.h>

Inheritance diagram for visutwin::canvas::IndexBuffer:

Public Member Functions
IndexFormat	format () const
	IndexBuffer (GraphicsDevice *graphicsDevice, IndexFormat format, int numIndices)
virtual void *	nativeBuffer () const
int	numIndices () const
virtual bool	setData (const std::vector< uint8_t > &data)
const std::vector< uint8_t > &	storage () const
virtual	~IndexBuffer ()=default

Protected Attributes
GraphicsDevice *	_device = nullptr
std::vector< uint8_t >	_storage

Detailed Description

An index buffer stores index values into a VertexBuffer. Indexed graphical primitives can normally use less memory than unindexed primitives (if vertices are shared).

Typically, index buffers are set on Mesh objects.

Definition at line 27 of file indexBuffer.h.

Constructor & Destructor Documentation

IndexBuffer()

visutwin::canvas::IndexBuffer::IndexBuffer	(	GraphicsDevice *	graphicsDevice,
		IndexFormat	format,
		int	numIndices )

Definition at line 16 of file indexBuffer.cpp.

References _device, format(), and numIndices().

Referenced by visutwin::canvas::MetalIndexBuffer::MetalIndexBuffer().

~IndexBuffer()

virtual visutwin::canvas::IndexBuffer::~IndexBuffer ( )

virtualdefault

Member Function Documentation

format()

IndexFormat visutwin::canvas::IndexBuffer::format ( ) const

inline

Definition at line 33 of file indexBuffer.h.

Referenced by IndexBuffer(), visutwin::canvas::MetalIndexBuffer::MetalIndexBuffer(), and visutwin::canvas::MetalIndexBuffer::setData().

nativeBuffer()

virtual void * visutwin::canvas::IndexBuffer::nativeBuffer ( ) const

inlinevirtual

Reimplemented in visutwin::canvas::MetalIndexBuffer.

Definition at line 37 of file indexBuffer.h.

numIndices()

int visutwin::canvas::IndexBuffer::numIndices ( ) const

inline

Definition at line 35 of file indexBuffer.h.

Referenced by IndexBuffer(), visutwin::canvas::MetalIndexBuffer::MetalIndexBuffer(), and visutwin::canvas::MetalIndexBuffer::setData().

setData()

virtual bool visutwin::canvas::IndexBuffer::setData ( const std::vector< uint8_t > & data )

inlinevirtual

Reimplemented in visutwin::canvas::MetalIndexBuffer.

Definition at line 39 of file indexBuffer.h.

storage()

const std::vector< uint8_t > & visutwin::canvas::IndexBuffer::storage ( ) const

inline

CPU-side index data. Used by BatchManager to read indices for merging.

Definition at line 42 of file indexBuffer.h.

References _storage.

Member Data Documentation

_device

GraphicsDevice* visutwin::canvas::IndexBuffer::_device = nullptr

protected

Definition at line 48 of file indexBuffer.h.

Referenced by IndexBuffer(), and visutwin::canvas::MetalIndexBuffer::setData().

_storage

std::vector<uint8_t> visutwin::canvas::IndexBuffer::_storage

protected

Definition at line 49 of file indexBuffer.h.

Referenced by visutwin::canvas::MetalIndexBuffer::setData(), and storage().

---

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

• platform/graphics/indexBuffer.h
• platform/graphics/indexBuffer.cpp