API Documentation
Static Public Member Functions | List of all members
nkGraphics::ComparisonFunctionUtils Class Referencefinal

Offers utility to work with the associated enumeration. More...

Static Public Member Functions

static nkMemory::StringView toString (COMPARISON_FUNCTION value)
 
static COMPARISON_FUNCTION fromString (nkMemory::StringView value)
 
static COMPARISON_FUNCTION fromIndex (unsigned int value)
 

Detailed Description

Offers utility to work with the associated enumeration.

Member Function Documentation

◆ toString()

static nkMemory::StringView nkGraphics::ComparisonFunctionUtils::toString ( COMPARISON_FUNCTION  value)
static

Converts an enum entry to its string representation.

Parameters
valueThe enum value to convert.
Returns
The string expressing the enum value, "UNKNOWN" if the value is not in the enum range.

◆ fromString()

static COMPARISON_FUNCTION nkGraphics::ComparisonFunctionUtils::fromString ( nkMemory::StringView  value)
static

Converts a string to its equivalent enum value.

Parameters
valueThe string to convert.
Returns
The enum value associated with the string, COMPARISON_FUNCTION::FUNCTION_NEVER if the string does not represent an enumeration value.

◆ fromIndex()

static COMPARISON_FUNCTION nkGraphics::ComparisonFunctionUtils::fromIndex ( unsigned int  value)
static

Retrieves an enum value by index. Allows to loop over all values, for instance.

Parameters
valueThe index of the enum to retrieve.
Returns
The enum value with index associated, -1 if no value available.

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