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

A class that represents the version number of a shader language. More...

#include <omGraphicsShaderLanguageVersion.h>

Public Member Functions

 ShaderLanguageVersion ()
 Create a version object representing the default version: 0.0.0. More...
 
 ShaderLanguageVersion (UInt newMajorVersion, UInt newMinorVersion=0, UInt newRevisionVersion=0)
 Create a version object representing the specified major/minor/revision version. More...
 
 ShaderLanguageVersion (const String &versionString)
 Create a version object that attempts to parse the specified version string. More...
 
UInt getMajor () const
 Return the major version number for this shader language version object. More...
 
void setMajor (UInt newMajorVersion)
 Set the major version number for this shader language version object. More...
 
UInt getMinor () const
 Return the minor version number for this shader language version object. More...
 
void setMinor (UInt newMinorVersion)
 Set the minor version number for this shader language version object. More...
 
UInt getRevision () const
 Return the revision version number for this shader language version object. More...
 
void setRevision (UInt newRevisionVersion)
 Set the revision version number for this shader language version object. More...
 
Bool operator== (const ShaderLanguageVersion &other) const
 Return whether or not this filter version number is exactly equal to another version number. More...
 
Bool operator!= (const ShaderLanguageVersion &other) const
 Return whether or not this filter version number is not equal to another version number. More...
 
Bool operator< (const ShaderLanguageVersion &other) const
 Return whether or not this filter version number is earlier than another version number. More...
 
Bool operator<= (const ShaderLanguageVersion &other) const
 Return whether or not this filter version number is earlier than or equal to another version number. More...
 
Bool operator> (const ShaderLanguageVersion &other) const
 Return whether or not this filter version number is later than another version number. More...
 
Bool operator>= (const ShaderLanguageVersion &other) const
 Return whether or not this filter version number is later than or equal to another version number. More...
 
String toString () const
 Convert this filter version to a human-readable string format. More...
 
 operator String () const
 Convert this filter version to a human-readable string format. More...
 

Detailed Description

A class that represents the version number of a shader language.

A version number is specified by a major version number, minor version number, and revision number

Constructor & Destructor Documentation

om::graphics::materials::ShaderLanguageVersion::ShaderLanguageVersion ( )
inline

Create a version object representing the default version: 0.0.0.

om::graphics::materials::ShaderLanguageVersion::ShaderLanguageVersion ( UInt  newMajorVersion,
UInt  newMinorVersion = 0,
UInt  newRevisionVersion = 0 
)
inline

Create a version object representing the specified major/minor/revision version.

om::graphics::materials::ShaderLanguageVersion::ShaderLanguageVersion ( const String &  versionString)

Create a version object that attempts to parse the specified version string.

The string must be of the form "M.m.r" where 'M' is the major version number, 'm' is the minor version number, and 'r' is the revision number. If there is an error in parsing the string, the created version numbers are 0.0.0

Member Function Documentation

UInt om::graphics::materials::ShaderLanguageVersion::getMajor ( ) const
inline

Return the major version number for this shader language version object.

void om::graphics::materials::ShaderLanguageVersion::setMajor ( UInt  newMajorVersion)
inline

Set the major version number for this shader language version object.

UInt om::graphics::materials::ShaderLanguageVersion::getMinor ( ) const
inline

Return the minor version number for this shader language version object.

void om::graphics::materials::ShaderLanguageVersion::setMinor ( UInt  newMinorVersion)
inline

Set the minor version number for this shader language version object.

UInt om::graphics::materials::ShaderLanguageVersion::getRevision ( ) const
inline

Return the revision version number for this shader language version object.

void om::graphics::materials::ShaderLanguageVersion::setRevision ( UInt  newRevisionVersion)
inline

Set the revision version number for this shader language version object.

Bool om::graphics::materials::ShaderLanguageVersion::operator== ( const ShaderLanguageVersion other) const
inline

Return whether or not this filter version number is exactly equal to another version number.

Bool om::graphics::materials::ShaderLanguageVersion::operator!= ( const ShaderLanguageVersion other) const
inline

Return whether or not this filter version number is not equal to another version number.

Bool om::graphics::materials::ShaderLanguageVersion::operator< ( const ShaderLanguageVersion other) const

Return whether or not this filter version number is earlier than another version number.

Bool om::graphics::materials::ShaderLanguageVersion::operator<= ( const ShaderLanguageVersion other) const

Return whether or not this filter version number is earlier than or equal to another version number.

Bool om::graphics::materials::ShaderLanguageVersion::operator> ( const ShaderLanguageVersion other) const

Return whether or not this filter version number is later than another version number.

Bool om::graphics::materials::ShaderLanguageVersion::operator>= ( const ShaderLanguageVersion other) const

Return whether or not this filter version number is later than or equal to another version number.

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

Convert this filter version to a human-readable string format.

The returned string is of the form "M.m.r" where 'M' is the major version number, 'm' is the minor version number, and 'r' is the revision number.

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

Convert this filter version to a human-readable string format.

The returned string is of the form "M.m.r" where 'M' is the major version number, 'm' is the minor version number, and 'r' is the revision number.


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