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

A class that specifies a kind of Shader. More...

#include <omGraphicsShaderType.h>

Public Types

enum  Enum {
  UNDEFINED = 0, VERTEX, FRAGMENT, GEOMETRY,
  TESSELLATION
}
 An enum type which represents the type for a shader. More...
 

Public Member Functions

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

Detailed Description

A class that specifies a kind of Shader.

The type specified here is used to determine the kinds of operations that a shader can perform, as well as how it may be structured (inputs/outputs).

Member Enumeration Documentation

An enum type which represents the type for a shader.

Enumerator
UNDEFINED 

An undefined shader type.

VERTEX 

A shader that handles processing of individual vertices.

This allows transformations and other operations to be performed on a per-vertex basis.

FRAGMENT 

A shader that is executed for each output fragment (pixel) for a primitive.

This allows shading and other operations to be performed on a per-pixel basis. The output of the fragment shader is the final color value sent to the render target.

GEOMETRY 

A shader that takes an input primitive (i.e. triangles) and outputs 0 or more output primitives.

This allows things like geometry instancing.

TESSELLATION 

A shader that tessellates primitives into smaller primitives.

This allows additional geometric complexity to be generated in the shader.

Constructor & Destructor Documentation

om::graphics::materials::ShaderType::ShaderType ( )
inline

Create a new shader type with the ShaderType::UNDEFINED type.

om::graphics::materials::ShaderType::ShaderType ( Enum  newType)
inline

Create a new shader type with the specified type enum value.

Member Function Documentation

om::graphics::materials::ShaderType::operator Enum ( ) const
inline

Convert this shader type to an enum value.

String om::graphics::materials::ShaderType::toString ( ) const

Return a string representation of the shader type.

om::graphics::materials::ShaderType::operator String ( ) const
inline

Convert this shader type into a string representation.


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