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

A class that specifies a kind of Buffer and how it is used. More...

#include <omGraphicsBufferType.h>

Public Types

enum  Enum { VERTEX = 1, INDEX = 2 }
 An enum type which represents the type for a hardware attribute buffer. More...
 

Public Member Functions

 BufferType (Enum newType)
 Create a new hardware attribute buffer type with the specified usage enum value. More...
 
 operator Enum () const
 Convert this hardware attribute buffer type to an enum value. More...
 
Bool supportsAttributeType (const AttributeType &attributeType) const
 Return whether or not the specified attribute type is a valid type for this buffer type. More...
 
String toString () const
 Return a string representation of the hardware attribute buffer type. More...
 
 operator String () const
 Convert this hardware attribute buffer type into a string representation. More...
 

Detailed Description

A class that specifies a kind of Buffer and how it is used.

The type specified here is used to determine the kinds of elements that a buffer can hold and how it can be used.

Member Enumeration Documentation

An enum type which represents the type for a hardware attribute buffer.

Enumerator
VERTEX 

A buffer type that holds a series of vertex data attributes.

INDEX 

A buffer type that holds a series of integer index offsets.

Constructor & Destructor Documentation

om::graphics::buffers::BufferType::BufferType ( Enum  newType)
inline

Create a new hardware attribute buffer type with the specified usage enum value.

Member Function Documentation

om::graphics::buffers::BufferType::operator Enum ( ) const
inline

Convert this hardware attribute buffer type to an enum value.

Bool om::graphics::buffers::BufferType::supportsAttributeType ( const AttributeType attributeType) const

Return whether or not the specified attribute type is a valid type for this buffer type.

String om::graphics::buffers::BufferType::toString ( ) const

Return a string representation of the hardware attribute buffer type.

om::graphics::buffers::BufferType::operator String ( ) const
inline

Convert this hardware attribute buffer type into a string representation.


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