ShaderUtil Class Reference

Provides supporting functions for ShaderType enum. More...

#include <ignition/rendering/ShaderType.hh>

Static Public Member Functions
static ShaderType	Enum (const std::string &_name)
	Get enum value by human-readable name. The given string should match watch is returned by GetName. If an invalid name is given, ST_UNKNOWN will be returned. More...
static bool	IsValid (ShaderType _type)
	Determine if given type is valid ShaderType enum. More...
static std::string	Name (ShaderType _type)
	Get human-readable name for shader type value. More...
static ShaderType	Sanitize (ShaderType _type)
	Sanitize given type. If the given value is invalid, ST_UNKNOWN will be returned, otherwise input will be returned unchanged. More...

Detailed Description

Provides supporting functions for ShaderType enum.

Member Function Documentation

Enum()

static ShaderType Enum ( const std::string &  _name )

static

Get enum value by human-readable name. The given string should match watch is returned by GetName. If an invalid name is given, ST_UNKNOWN will be returned.

Parameters

[in]

_name

Name of the shader type to be retrieved

Returns

The specified ShaderType enum value

IsValid()

static bool IsValid ( ShaderType  _type )

static

Determine if given type is valid ShaderType enum.

Parameters

[in]

_type

Enum value to be evaluated

Returns

True if the given type is valid

Name()

static std::string Name ( ShaderType  _type )

static

Get human-readable name for shader type value.

Parameters

[in]

_type

Shader type enum value

Returns

The type name

Sanitize()

static ShaderType Sanitize ( ShaderType  _type )

static

Sanitize given type. If the given value is invalid, ST_UNKNOWN will be returned, otherwise input will be returned unchanged.

Parameters

[in]

_type

Shader type to be sanitized

Returns

The santized shader type

---

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

• gz/rendering/ShaderType.hh