Ignition Rendering

API Reference

6.3.1
GraphicsAPIUtils Class Reference

Utils to convert GraphicsAPI to and from strings. More...

#include <GraphicsAPI.hh>

Static Public Member Functions

static GraphicsAPI Set (const std::string &_str)
 Set an enum from a string. This function requires a valid string, and an array of names for the enum must exist. The string is not case sensitive. More...
 
static std::string Str (GraphicsAPI _e)
 Convert enum value to string. More...
 

Detailed Description

Utils to convert GraphicsAPI to and from strings.

Member Function Documentation

◆ Set()

static GraphicsAPI Set ( const std::string _str)
static

Set an enum from a string. This function requires a valid string, and an array of names for the enum must exist. The string is not case sensitive.

Parameters
[in]_strString value to convert to enum value.
Returns
GraphicsAPI enum

◆ Str()

static std::string Str ( GraphicsAPI  _e)
static

Convert enum value to string.

Parameters
[in]_eEnum value to convert.
Returns
String representation of the enum. An empty string is returned if _e is invalid, or the names for the enum have not been set.

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