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

A class that specifies how an attribute buffer should be used. More...

#include <omGraphicsBufferUsage.h>

Public Types

enum  Enum { STATIC = 1, DYNAMIC = 2, STREAM = 3 }
 An enum type which represents the usage for a hardware attribute buffer. More...
 

Public Member Functions

 BufferUsage (Enum newUsage)
 Create a new attribute buffer usage with the specified usage enum value. More...
 
 operator Enum () const
 Convert this hardware attribute buffer usage to an enum value. More...
 
String toString () const
 Return a string representation of the hardware attribute buffer usage. More...
 
 operator String () const
 Convert this hardware attribute buffer usage into a string representation. More...
 

Detailed Description

A class that specifies how an attribute buffer should be used.

The usage specified here is used as a hint to the GPU to how the hardware attribute buffer is handled. The usage hints at how often a buffer will be updated and used to draw.

Member Enumeration Documentation

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

Enumerator
STATIC 

A usage where the buffer contents are set once and used to draw many times.

DYNAMIC 

A usage where the buffer contents are set and used to draw many times.

STREAM 

A usage where the buffer contents are set once and used to draw only a few times.

Constructor & Destructor Documentation

om::graphics::buffers::BufferUsage::BufferUsage ( Enum  newUsage)
inline

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

Member Function Documentation

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

Convert this hardware attribute buffer usage to an enum value.

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

Return a string representation of the hardware attribute buffer usage.

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

Convert this hardware attribute buffer usage into a string representation.


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