Om  1.0.0
A universal framework for multimedia simulation
Public Member Functions | List of all members
om::graphics::buffers::IndexRange Class Reference

A class that specifies a range of primitives to render from either a vertex or index buffer. More...

#include <omGraphicsIndexRange.h>

Public Member Functions

 IndexRange ()
 Create a new buffer range with the UNDEFINED primitive type and zero length. More...
 
 IndexRange (const IndexedPrimitiveType &newPrimitiveType, Size newVertexCount, Index newStartIndex=0)
 Create a new buffer range with the specified primitive type, vertex count, and start index. More...
 
const IndexedPrimitiveTypegetPrimitiveType () const
 Return an object describing the type of primitive this buffer range corresponds to. More...
 
void setPrimitiveType (const IndexedPrimitiveType &newPrimitiveType)
 Set the type of primitive this buffer range corresponds to. More...
 
Size getPrimitiveCount () const
 Return the number of primitives that are specified by this buffer range. More...
 
Index getStartIndex () const
 Return the start index offset within the buffer. More...
 
void setStartIndex (Index newStartIndex)
 Set the start index offset within the buffer. More...
 
Size getVertexCount () const
 Return the number of vertices to draw from the buffer. More...
 
void setVertexCount (Size newVertexCount)
 Set the number of vertices to draw from the buffer. More...
 

Detailed Description

A class that specifies a range of primitives to render from either a vertex or index buffer.

Constructor & Destructor Documentation

om::graphics::buffers::IndexRange::IndexRange ( )
inline

Create a new buffer range with the UNDEFINED primitive type and zero length.

om::graphics::buffers::IndexRange::IndexRange ( const IndexedPrimitiveType newPrimitiveType,
Size  newVertexCount,
Index  newStartIndex = 0 
)
inline

Create a new buffer range with the specified primitive type, vertex count, and start index.

Member Function Documentation

const IndexedPrimitiveType& om::graphics::buffers::IndexRange::getPrimitiveType ( ) const
inline

Return an object describing the type of primitive this buffer range corresponds to.

void om::graphics::buffers::IndexRange::setPrimitiveType ( const IndexedPrimitiveType newPrimitiveType)
inline

Set the type of primitive this buffer range corresponds to.

Size om::graphics::buffers::IndexRange::getPrimitiveCount ( ) const
inline

Return the number of primitives that are specified by this buffer range.

Index om::graphics::buffers::IndexRange::getStartIndex ( ) const
inline

Return the start index offset within the buffer.

void om::graphics::buffers::IndexRange::setStartIndex ( Index  newStartIndex)
inline

Set the start index offset within the buffer.

Size om::graphics::buffers::IndexRange::getVertexCount ( ) const
inline

Return the number of vertices to draw from the buffer.

void om::graphics::buffers::IndexRange::setVertexCount ( Size  newVertexCount)
inline

Set the number of vertices to draw from the buffer.


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