om::graphics::materials::ShaderParameterUsage Class Reference

A class that specifies the semantic usage for a shader parameter. More...

#include <omGraphicsShaderParameterUsage.h>

Public Types
enum	Enum {   UNDEFINED = 0, LANGUAGE_VERSION, VERTEX_COLORS, LIGHTING,   DIRECTIONAL_LIGHTS, DIRECTIONAL_LIGHT_COUNT, POINT_LIGHTS, POINT_LIGHT_COUNT,   SPOT_LIGHTS, SPOT_LIGHT_COUNT, SPECULAR_LIGHTING, DIFFUSE_LIGHTING,   AMBIENT_LIGHTING, SHADOWS, DIRECTIONAL_LIGHT_SHADOWS, DIRECTIONAL_LIGHT_SHADOW_COUNT,   DIRECTIONAL_LIGHT_CSM, DIRECTIONAL_LIGHT_SHADOW_CASCADE_COUNT, POINT_LIGHT_SHADOWS, POINT_LIGHT_SHADOW_COUNT,   SPOT_LIGHT_SHADOWS, SPOT_LIGHT_SHADOW_COUNT, SHADOW_FILTERING, NORMAL_FLIPPING,   TEXTURES, NORMAL_MAPPING, SUB_PIXEL_ANTIALIASING }
	An enum type which represents the semantic usage for a shader parameter. More...

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

Detailed Description

A class that specifies the semantic usage for a shader parameter.

Member Enumeration Documentation

enum om::graphics::materials::ShaderParameterUsage::Enum

An enum type which represents the semantic usage for a shader parameter.

Enumerator
UNDEFINED	An undefined shader parameter usage.
LANGUAGE_VERSION	An integer parameter indicating the full major/minor version of the shader language.
VERTEX_COLORS	A boolean parameter (0 or 1) indicating whether or not vertex colors are enabled.
LIGHTING	A boolean parameter (0 or 1) indicating whether or not lighting is enabled.
DIRECTIONAL_LIGHTS	A boolean parameter (0 or 1) indicating whether or not directional lights are enabled.
DIRECTIONAL_LIGHT_COUNT	An integer parameter indicating the number of directional lights that the shader should support.
POINT_LIGHTS	A boolean parameter (0 or 1) indicating whether or not point lights are enabled.
POINT_LIGHT_COUNT	An integer parameter indicating the number of point lights that the shader should support.
SPOT_LIGHTS	A boolean parameter (0 or 1) indicating whether or not spot lights are enabled.
SPOT_LIGHT_COUNT	An integer parameter indicating the number of spot lights that the shader should support.
SPECULAR_LIGHTING	A boolean parameter (0 or 1) indicating whether or not specular lighting is enabled.
DIFFUSE_LIGHTING	A boolean parameter (0 or 1) indicating whether or not diffuse lighting is enabled.
AMBIENT_LIGHTING	A boolean parameter (0 or 1) indicating whether or not ambient lighting is enabled.
SHADOWS	A boolean parameter (0 or 1) indicating whether or not shadows are enabled.
DIRECTIONAL_LIGHT_SHADOWS	A boolean parameter (0 or 1) indicating whether or not directional light shadows are enabled.
DIRECTIONAL_LIGHT_SHADOW_COUNT	An integer parameter indicating the number of directional light shadow maps that the shader should support.
DIRECTIONAL_LIGHT_CSM	A boolean parameter (0 or 1) indicating whether or not directional light cascaded shadow mapping is enabled.
DIRECTIONAL_LIGHT_SHADOW_CASCADE_COUNT	An integer parameter indicating the number of directional light shadow map cascades.
POINT_LIGHT_SHADOWS	A boolean parameter (0 or 1) indicating whether or not point light shadows are enabled.
POINT_LIGHT_SHADOW_COUNT	An integer parameter indicating the number of point light shadow maps that the shader should support.
SPOT_LIGHT_SHADOWS	A boolean parameter (0 or 1) indicating whether or not spot light shadows are enabled.
SPOT_LIGHT_SHADOW_COUNT	An integer parameter indicating the number of spot light shadow maps that the shader should support.
SHADOW_FILTERING	A boolean parameter (0 or 1) indicating whether or not shadow filtering is enabled.
NORMAL_FLIPPING	A boolean parameter (0 or 1) indicating whether or not the normal should be flipped when it points away from the camera.
TEXTURES	A boolean parameter (0 or 1) indicating whether or not surface texture mapping is enabled.
NORMAL_MAPPING	A boolean parameter (0 or 1) indicating whether or not normal mapping is enabled.
SUB_PIXEL_ANTIALIASING	A boolean parameter (0 or 1) indicating whether or not sub-pixel antialiasing is is enabled (such as for font rendering).

Constructor & Destructor Documentation

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

inline

Create a new shader parameter usage with the specified usage enum value.

Member Function Documentation

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

inline

Convert this shader parameter usage to an enum value.

String om::graphics::materials::ShaderParameterUsage::toString

(

)

const

Return a string representation of the shader parameter usage.

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

inline

Convert this shader parameter usage into a string representation.

---

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

• omGraphicsShaderParameterUsage.h