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

A class that enumerates the different possible types of GraphicsDevice that may exist. More...

#include <omGraphicsDeviceType.h>

Public Types

enum  Enum {
  OPENGL, DIRECT3D_9, DIRECT3D_10, DIRECT3D_11,
  DEFAULT, UNDEFINED
}
 An enum type which represents the different graphics device types. More...
 

Public Member Functions

 GraphicsDeviceType (Enum newType)
 Create a new graphics device type with the specified device type enum value. More...
 
 operator Enum () const
 Convert this graphics device type to an enum value. More...
 
String toString () const
 Return a string representation of the graphics device type. More...
 
 operator String () const
 Convert this graphics device type into a string representation. More...
 

Detailed Description

A class that enumerates the different possible types of GraphicsDevice that may exist.

A GraphicsDevice represents a particular interface to the system's graphics hardware, such as OpenGL or Direct3D. This class indicates the type of interface that a device uses. This allows the user to determine which device to use when rendering graphics on a given system platform.

Member Enumeration Documentation

An enum type which represents the different graphics device types.

Enumerator
OPENGL 

A graphics device type that uses the OpenGL API to draw graphics.

DIRECT3D_9 

A graphics device type that uses the Direct3D 9 API to draw graphics.

DIRECT3D_10 

A graphics device type that uses the Direct3D 10 API to draw graphics.

DIRECT3D_11 

A graphics device type that uses the Direct3D 11 API to draw graphics.

DEFAULT 

The default graphics device for a given platform.

UNDEFINED 

An undefined or unknown graphics device type.

Constructor & Destructor Documentation

om::graphics::devices::GraphicsDeviceType::GraphicsDeviceType ( Enum  newType)
inline

Create a new graphics device type with the specified device type enum value.

Member Function Documentation

om::graphics::devices::GraphicsDeviceType::operator Enum ( ) const
inline

Convert this graphics device type to an enum value.

String om::graphics::devices::GraphicsDeviceType::toString ( ) const

Return a string representation of the graphics device type.

om::graphics::devices::GraphicsDeviceType::operator String ( ) const
inline

Convert this graphics device type into a string representation.


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