om::graphics::materials::TechniqueUsage Class Reference

A class that represents the semantic usage for a Technique. More...

#include <omGraphicsTechniqueUsage.h>

Public Types
enum	Enum {   UNDEFINED = 0, FLAT, LAMBERTIAN, PHONG,   DEPTH, SKY_BOX, GUI_BORDER, GUI_BORDER_SOLID,   GUI_BORDER_RAISED, GUI_BORDER_SUNKEN, GUI_BACKGROUND, GUI_IMAGE,   GUI_TEXT, GUI_SELECTION, GUI_POINT, GUI_LINE }
	An enum value that indicates the type of technique usage. More...

Public Member Functions
	TechniqueUsage ()
	Create a new technique usage with an undefined usage enum value.. More...
	TechniqueUsage (Enum newUsage)
	Create a new technique usage with the specified technique usage enum value. More...
	operator Enum () const
	Convert this technique usage to an enum value. More...
String	toString () const
	Return a string representation of the technique usage. More...
	operator String () const
	Convert this technique usage into a string representation. More...

Detailed Description

A class that represents the semantic usage for a Technique.

This enum class contains various values which describe different common types of shading.

Member Enumeration Documentation

enum om::graphics::materials::TechniqueUsage::Enum

An enum value that indicates the type of technique usage.

Enumerator
UNDEFINED	This usage specifies an undefined technique usage.
FLAT	The technique renders geometry using a flat-shading model (no lighting). This shading model should use a uniform surface color.
LAMBERTIAN	The technique renders geometry using a lambertian illumination model.
PHONG	The technique renders geometry using a phong illumination model.
DEPTH	The technique is used to render depth information only, i.e. for shadow maps.
SKY_BOX	The technique is used to render a sky box in the scene background.
GUI_BORDER	The technique is used to draw a generic GUI rectangle border.
GUI_BORDER_SOLID	The technique is used to draw a solid GUI rectangle border.
GUI_BORDER_RAISED	The technique is used to draw a raised GUI rectangle border.
GUI_BORDER_SUNKEN	The technique is used to draw a sunken GUI rectangle border.
GUI_BACKGROUND	The technique is used to draw the background of a GUI rectangle.
GUI_IMAGE	The technique is used to draw raster images.
GUI_TEXT	The technique is used to draw text glyphs.
GUI_SELECTION	The technique is used to draw highlighted overlays for selected objects (such as text).
GUI_POINT	The technique used to draw fancy points for a GUI.
GUI_LINE	The technique used to draw fancy lines for a GUI.

Constructor & Destructor Documentation

om::graphics::materials::TechniqueUsage::TechniqueUsage ( )

inline

Create a new technique usage with an undefined usage enum value..

om::graphics::materials::TechniqueUsage::TechniqueUsage ( Enum  newUsage )

inline

Create a new technique usage with the specified technique usage enum value.

Member Function Documentation

om::graphics::materials::TechniqueUsage::operator Enum ( ) const

inline

Convert this technique usage to an enum value.

String om::graphics::materials::TechniqueUsage::toString

(

)

const

Return a string representation of the technique usage.

om::graphics::materials::TechniqueUsage::operator String ( ) const

inline

Convert this technique usage into a string representation.

---

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

• omGraphicsTechniqueUsage.h