#functions
##Description
###char ofBinaryToChar(&value)
_inlined_description: _
Convert a binary string to an char.
Interprets a string consisting only of 1s and 0s as an char and returns the corresponding int value.
\value The binary string.
Returns: the char represented by the string or 0 on failure.
_description: _
Interprets a string consisting only of 1s and 0s as a char, and returns the corresponding char value.
###float ofBinaryToFloat(&value)
_inlined_description: _
Convert a binary string to a float.
Interprets a string consisting only of 1s and 0s as an a float (little-endian, 32-bit IEEE 754), and returns the corresponding float value.
\value The binary string.
Returns: the float represented by the string or 0 on failure.
_description: _
Interprets a string consisting only of 1s and 0s as a float (little-endian, 32-bit IEEE 754), and returns the corresponding float value.
###int ofBinaryToInt(&value)
_inlined_description: _
Convert a binary string to an int.
Interprets a string consisting only of 1s and 0s as an int (little-endian, 32-bit), and returns the corresponding int value.
\value The binary string.
Returns: the integer represented by the string or 0 on failure.
_description: _
Interprets a string consisting only of 1s and 0s as an int (little-endian, 32-bit), and returns the corresponding int value.
###string ofBinaryToString(&value)
_inlined_description: _
Convert a binary string to ASCII characters.
Interprets a string consisting only of 1s and 0s as 8-bit ASCII characters and returns the corresponding string.
\value The binary string.
Returns: the ASCII string represented by the string.
_description: _
Interprets a string consisting only of 1s and 0s as 8-bit ASCII characters, and returns the corresponding string.
###bool ofContains(&values, &target)
_inlined_description: _
Search for a target value in a vector of values. \tparam T the type contained by the vector.
Parameters:
values The vector of values to be searched.
target The target value to be found.
Returns: true if at least one value equal to the target value is found.
_description: _
returns true if the vector values contains target
###void ofDisableDataPath()
_inlined_description: _
Disable the use of the data path.
This function causes ofToDataPath() to ignore the relative path set with ofSetDataPathRoot().
_description: _
Disables the conversion of paths to realtive to data/
###void ofEnableDataPath()
_inlined_description: _
\section Data Path Enable the use of the data path.
This function causes ofToDataPath() to respect the relative path set with ofSetDataPathRoot(). This is enabled by default.
_description: _
Enables the conversion of paths to relative to data/ This is enabled by default.
###size_t ofFind(&values, &target)
_inlined_description: _
Search for a target value in a vector of values. \tparam T the type contained by the vector.
Parameters:
values The vector of values to be searched.
target The target value to be found.
Returns: true the index of the first target value found.
See also: http://www.cplusplus.com/reference/iterator/distance/
_description: _
###const char * ofFromString(&value)
_inlined_description: _
Convert a string represetnation to another string.
Equivalent to calling the .c_str() on a std::string.
Parameters:
value The string value to convert to another string.
Returns: the string converted to a c-style string.
_description: _
###T ofFromString(&value)
_inlined_description: _
Convert a string represetnation to another type.
Often, this method will be used to convert a string to a numerical type.
\tparam T The target data type.
Parameters:
value The string value to convert to type T.
Returns: the string converted to the target data type T.
_description: _
###string ofFromString(&value)
_inlined_description: _
Convert a string represetnation to another string.
Parameters:
value The string value to convert to another string.
Returns: the string converted to another string.
_description: _
###ofTime ofGetCurrentTime()
_inlined_description: _
Get the system time.
Returns: the system time.
_description: _
###int ofGetDay()
_inlined_description: _
Get the current day within the month.
Returns: the day witin the month [1-31].
_description: _
###uint64_t ofGetElapsedTimeMicros()
_inlined_description: _
Get the elapsed time in microseconds.
This returns the elapsed time since ofResetElapsedTimeCounter() was called. Usually ofResetElapsedTimeCounter() is called automatically upon program startup.
Returns: the elapsed time in microseconds (1000000 microseconds = 1 second).
_description: _
returns the elapsed time since the application started in microseconds (1000000 microsecs = 1 second)
###uint64_t ofGetElapsedTimeMillis()
_inlined_description: _
Get the elapsed time in milliseconds.
This returns the elapsed time since ofResetElapsedTimeCounter() was called. Usually ofResetElapsedTimeCounter() is called automatically once during program startup.
Returns: the elapsed time in milliseconds (1000 milliseconds = 1 second).
_description: _
###float ofGetElapsedTimef()
_inlined_description: _
Get the elapsed time in seconds.
This returns the elapsed time since ofResetElapsedTimeCounter() was called. Usually ofResetElapsedTimeCounter() is called automatically once during program startup.
Returns: the floating point elapsed time in seconds.
_description: _
returns the elapsed time since the application started in seconds as a float
###string ofGetEnv(&var)
_inlined_description: _
Get the value of a given environment variable. \note The available environment variables differ between operating systems.
Returns: the environmnt variable's value or an empty string if not found.
_description: _
###uint64_t ofGetFrameNum()
_inlined_description: _
Get the number of frames rendered since the program started.
Returns: the number of frames rendered since the program started.
_description: _
###int ofGetHours()
_inlined_description: _
Get the hour of the day.
Returns: the hour of the day [0-23].
_description: _
###int ofGetMinutes()
_inlined_description: _
Get minutes after the hour.
Returns: the minutes after the hour [0-59].
_description: _
###int ofGetMonth()
_inlined_description: _
Get the current month.
Returns: the current month [1-12].
_description: _
###int ofGetSeconds()
_inlined_description: _
\section System Time Get the seconds after the minute.
Returns: the seconds after the minute [0-59].
_description: _
###uint64_t ofGetSystemTimeMicros()
_inlined_description: _
Get the system time in microseconds.
Returns: the system time in microseconds.
_description: _
###uint64_t ofGetSystemTimeMillis()
_inlined_description: _
Get the system time in milliseconds.
Returns: the system time in milliseconds.
_description: _
###ofTargetPlatform ofGetTargetPlatform()
_inlined_description: _
Get the target platform of the current system.
Returns: the current ofTargetPlatform.
_description: _
###string ofGetTimestampString(×tampFormat)
_inlined_description: _
Formats the current system time according to the given format.
The format string is used as a template to format the date and is copied character by character except for the following special characters, which are replaced by the corresponding value.
| specifier | Replaced by | Example |
|---|---|---|
| %a | Abbreviated weekday name | Thu |
| %A | Full weekday name | Thursday |
| %b | Abbreviated month name | Aug |
| %B | Full month name | August |
| %c | Date and time representation | Thu Aug 23 14:55:02 2001 |
| %C | Year divided by 100 and truncated to integer (00-99) | 20 |
| %d | Day of the month, zero-padded (01-31) | 23 |
| %D | Short MM/DD/YY date, equivalent to %m/%d/%y | 08/23/01 |
| %e | Day of the month, space-padded ( 1-31) | 23 |
| %F | Short YYYY-MM-DD date, equivalent to %Y-%m-%d | 2001-08-23 |
| %g | Week-based year, last two digits (00-99) | 01 |
| %G | Week-based year | 2001 |
| %h | Abbreviated month name (same as %b) | Aug |
| %H | Hour in 24h format (00-23) | 14 |
| %I | Hour in 12h format (01-12) | 02 |
| %j | Day of the year (001-366) | 235 |
| %m | Month as a decimal number (01-12) | 08 |
| %M | Minute (00-59) | 55 |
| %n | New-line character | ('\n') |
| %p | AM or PM designation | PM |
| %r | 12-hour clock time | 02:55:02 pm |
| %R | 24-hour HH:MM time, equivalent to %H:%M | 14:55 |
| %S | Second (00-61) | 02 |
| %t | Horizontal-tab character | ('\t') |
| %T | ISO 8601 time format (HH:MM:SS), equivalent to %H:%M:%S | 14:55:02 |
| %u | ISO 8601 weekday as number with Monday as 1 (1-7) | 4 |
| %U | Week number with the first Sunday as the first day of week one (00-53) | 33 |
| %V | ISO 8601 week number (01-53) | 34 |
| %w | Weekday as a decimal number with Sunday as 0 (0-6) | 4 |
| %W | Week number with the first Monday as the first day of week one (00-53) | 34 |
| %x | Date representation | 08/23/01 |
| %X | Time representation | 14:55:02 |
| %y | Year, last two digits (00-99) | 01 |
| %Y | Year | 2001 |
| %z | ISO 8601 offset from UTC in timezone (1 minute=1, 1 hour=100) If timezone cannot be determined, no characters | +100 |
| %Z | Timezone name or abbreviation. If timezone cannot be determined, no characters | CDT |
| %% | A % sign | % |
Parameters:
timestampFormat The formatting pattern.
Returns: the formatted timestamp as a string.
Warning: an invalid timestampFormat may crash windows apps.
_description: _
###string ofGetTimestampString()
_inlined_description: _
Formats the current system time according to the given format.
The default timestamp format is "%Y-%m-%d-%H-%M-%S-%i" (e.g. 2011-01-15-18-29-35-299).
Returns: the current time as a string with the default format.
_description: _
###unsigned int ofGetUnixTime()
_inlined_description: _
Get the number of seconds since Midnight, January 1, 1970.
Resolution is in seconds.
Returns: the number of seconds since Midnight, January 1, 1970 (epoch time).
_description: _
###string ofGetVersionInfo()
_inlined_description: _
\section openFrameworks Version Get the current version of openFrameworks as a string.
openFrameworks uses the semantic versioning system.
See also: http://semver.org/
Returns: The string representation of the version (e.g. 0.9.0).
_description: _
###unsigned int ofGetVersionMajor()
_inlined_description: _
Get the major version number of openFrameworks.
openFrameworks uses the semantic versioning system.
See also: http://semver.org/
Returns: The major version number.
_description: _
###unsigned int ofGetVersionMinor()
_inlined_description: _
Get the minor version number of openFrameworks.
openFrameworks uses the semantic versioning system.
See also: http://semver.org/
Returns: The minor version number.
_description: _
###unsigned int ofGetVersionPatch()
_inlined_description: _
Get the patch version number of openFrameworks.
openFrameworks uses the semantic versioning system.
See also: http://semver.org/
Returns: The patch version number.
_description: _
###string ofGetVersionPreRelease()
_inlined_description: _
Get the pre-release version of openFrameworks.
openFrameworks uses the semantic versioning system.
For pre-release versions of openFrameworks, including development versions, this string will describe the pre-release state. Examples might include "master", "rc1", "rc2", etc. For all stable releases, this string will be empty.
See also: http://semver.org/
Returns: The pre-release version string.
_description: _
###int ofGetWeekday()
_inlined_description: _
Get the current weekday.
Values 0 = Sunday, 1 = Monday, ..., 6 = Saturday.
Returns: the current weekday [0-6].
_description: _
###int ofGetYear()
_inlined_description: _
Get the current year.
Returns: the current year.
_description: _
###char ofHexToChar(&charHexString)
_inlined_description: _
Convert a string representing an char in hexadecimal to a char.
Converts a hexadecimal representation of an char (e.g., "61") to an actual
char (e.g., a).
Parameters:
charHexString The string representing an char in hexadecimal.
Returns: the char represented by the string.
_description: _
Converts a hexadecimal representation of an char (e.g., "61") to an actual char (e.g., a).
###float ofHexToFloat(&floatHexString)
_inlined_description: _
Convert a string representing an float in hexadecimal to a float.
Converts a hexadecimal representation of an float (little-endian, 32-bit
IEEE 754, e.g., "43000000") to an actual float (e.g., 128.f).
Parameters:
floatHexString The string representing an float in hexadecimal.
Returns: the float represented by the string.
_description: _
Converts a hexadecimal representation of an float (little-endian, 32-bit IEEE 754, e.g., "4060000000000000") to an actual float (e.g., 128.f).
###int ofHexToInt(&intHexString)
_inlined_description: _
Convert a string representing an integer in hexadecimal to a string.
Converts a hexadecimal representation of an int (little-endian, 32-bit,
e.g., "0xbadf00d" or "badf00d") to an actual int.
Parameters:
intHexString The string representing an integer in hexadecimal.
Returns: the integer represented by the string.
_description: _
Converts a hexadecimal representation of an int (little-endian, 32-bit, e.g., "0xbadf00d" or "badf00d") to an actual int.
###string ofHexToString(&stringHexString)
_inlined_description: _
Convert a string representing an string in hexadecimal to a string.
Converts a hexadecimal representation of an string (e.g.,
"61626364656667") to an actual string ("abcdefg").
Parameters:
stringHexString The string representing an string in hexadecimal.
Returns: the string represented by the string.
_description: _
Converts a hexadecimal representation of an string (e.g., "61626364656667") to an actual string ("abcdefg");
###bool ofIsStringInString(&haystack, &needle)
_inlined_description: _
Check if string contains another string.
Example:
std::string haystack = "foobar";
ofLog() << ofIsStringInString(haystack, "foo"); // Outputs 1.
ofLog() << ofIsStringInString(haystack,"bar"); // Outputs 1.
ofLog() << ofIsStringInString(haystack, "something else"); // Outputs 0.
Parameters:
haystack The string to check for occurrence in.
needle The string to check for.
_description: _
Checks if the string needle exists in the string haystack.
string haystack = "foobar";
ofLog() << ofIsStringInString(haystack, "foo"); // outputs 1
ofLog() << ofIsStringInString(haystack,"bar"); // outputs 1
ofLog() << ofIsStringInString(haystack, "something else"); // outputs 0
###string ofJoinString(&stringElements, &delimiter)
_inlined_description: _
Join a vector of strings together into one string.
Parameters:
stringElements The vector of strings to join.
delimiter The delimiter to put betweeen each string.
_description: _
Turns a stringElements into a single string, with an instance of delimiter between all the elements.
###void ofLaunchBrowser(&url, uriEncodeQuery = false)
_inlined_description: _
Open a browser windows with the specified URL
// Open the OpenFrameworks site :
ofLaunchBrowser("https://openframeworks.cc/", false);
_description: _
###void ofRandomize(&values)
_inlined_description: _
\section Vectors Randomly reorder the values in a vector. \tparam T the type contained by the vector.
Parameters:
values The vector of values to modify.
See also: http://www.cplusplus.com/reference/algorithm/random_shuffle/
_description: _
###void ofRemove(&values, shouldErase)
_inlined_description: _
Conditionally remove values from a vector.
Values are removed if, when passed to the BoolFunction, the BoolFunction function returns true. The given BoolFunction can be a custom function or a built-in function.
Example of a custom function to remove odd numbers from a std::vector of integers:
bool IsOdd(int i) {
return ((i % 2) == 1);
}
To call the function, one might use:
std::vector<int> myInts;
// Fill the vector with integers.
for (int i = 0; i < 10; ++i)
{
myInts.push_back(i);
}
ofRemove(myInts, IsOdd);
The resulting vector will contain the following values:
0, 2, 4, 6, 8
\tparam T the type contained by the vector. \tparam BoolFunction the boolean function used to erase.
Parameters:
values The vector of values to modify.
shouldErase A boolean function as described above.
See also: http://www.cplusplus.com/reference/algorithm/remove_if/
_description: _
###void ofResetElapsedTimeCounter()
_inlined_description: _
\section Elapsed Time Reset the elapsed time counter.
This method resets the times returned by ofGetElapsedTimef(), ofGetElapsedTimeMillis() and ofGetElapsedTimeMicros() to zero.
\note This is called on the first frame during app startup.
_description: _
###bool ofRestoreWorkingDirectoryToDefault()
_inlined_description: _
Reset the working directory to the platform default.
The default working directory is where the application was started from or the exe directory in case of osx bundles. GLUT might change the default working directory to the resources directory in the bundle in osx. This will restore it to the exe dir or whatever was the current dir when the application was started
_description: _
###void ofSaveFrame(bUseViewport = false)
_inlined_description: _
Saves the current frame as a PNG image.
The PNG image will be named according to an internal counter in sequence. The count will be restarted each time the program is restarted. For more options, use the ofSaveImage() function from ofImage class.
Parameters:
bUseViewport Set to true if the current viewport should be used.
_description: _
###void ofSaveScreen(&filename)
_inlined_description: _
Frame Saving Saves the current screen image to a file on disk.
Example:
ofSaveScreen("screen.png"); // Will save screen.png in the /data folder.
The output file type will be deduced from the given file name.
Parameters:
filename The image output file.
_description: _
Saves the current screen image into a given file name (string filename). Example:
string filename;
filename = "screen1.png";
ofSaveScreen(filename);
###void ofSaveViewport(&filename)
_inlined_description: _
Saves the current viewport as an image.
The output file type will be deduced from the given file name.
Parameters:
filename The image output file.
_description: _
###void ofSetDataPathRoot(&root)
_inlined_description: _
Set the relative path to the data/ folder from the executable.
This method can be useful when users want to embed the data as a resource folder within an *.app bundle on OSX or perhaps work from a shared data folder in the user's Documents directory.
Warning: The provided path must have a trailing slash (/).
Parameters:
root The path to the data/ folder relative to the app executable.
_description: _
###void ofSleepMillis(millis)
_inlined_description: _
Sleeps the current thread for the specified amount of milliseconds.
Parameters:
millis The number of millseconds to sleep.
_description: _
###void ofSort(&values)
_inlined_description: _
Sort a vector of values into ascending order.
The elements are compared using operator< for the first version. Equivalent elements are not guaranteed to keep their original relative order.
\tparam T the type contained by the vector.
Parameters:
values The vector of values to be sorted.
See also: http://www.cplusplus.com/reference/algorithm/sort/
_description: _
###void ofSort(&values, compare)
_inlined_description: _
Sort a vector of values into an order defined by a comparator.
Example of a custom function to sort descending of integers:
bool sortDescending(int i, int j)
{
return (j < i);
}
This binary function must accept two elements in the range as arguments and return a value convertible to bool. The value returned indicates whether the element passed as first argument is considered to go before the second in the specific strict weak ordering it defines. The function shall not modify any of its arguments. This can either be a function pointer or a function object.
To call the function, one might use:
std::vector<int> myInts;
// Fill the vector with integers.
for (int i = 0; i < 10; ++i)
{
myInts.push_back(i);
}
ofSort(myInts, sortDescending);
The resulting vector will contain the following values:
9, 8, 7, 6, 5, 4, 3, 2, 1, 0.
\tparam T the type contained by the vector.
Parameters:
values The vector of values to be sorted.
compare The comparison function.
See also: http://www.cplusplus.com/reference/algorithm/sort/
_description: _
###int ofSplitString()
_inlined_description: _
\section String Manipulation Splits a string using a delimiter.
ofSplitString splits a string and returns the collection of string tokens inside of a std::vectorstd::string.
A useful application is to use delimiter " ":
result = ofSplitString("of rocks", " ");
// result[0] = "of"
// result[1] = "rocks"
Like this a big string can be "cut" and turned it into a collection of words. The user can also ignore empty tokens. Empty tokens occur when a there are multiple delimiters in a row (e.g. "of,rocks,,!"). The user can also "trim" the tokens. This will remove whitespace from before and after each token. This might be useful when a delimted string is padded with with spaces (e.g. "of , rocks ,!").
Parameters:
source The string to split.
delimiter The delimiter string.
ignoreEmpty Set to true to remove empty tokens.
trim Set to true to trim the resulting tokens.
Returns: A vector of strings split with the delimiter.
_description: _
Splits source using delimiter and returns the separate tokens. In modern versions of openFrameworks, delimiter can be a multi-character string. In older versions of openFrameworks, delimiter was interpreted as multiple single-character delimiters.
###void ofStringReplace(&input, &searchStr, &replaceStr)
_inlined_description: _
Replace all occurrences of a string with another string. \note The input string is passed by reference, so it will be modified.
Parameters:
input The string to run the replacement on.
searchStr The string to be replaced.
replaceStr The string to put in place.
_description: _
Searches input for instances of searchStr and replaces them with replaceStr.
string message = "hello, world!";
ofStringReplace(message,"hello","goodbye");
ofLog() << message; // outputs "goodbye, world!"
###size_t ofStringTimesInString(&haystack, &needle)
_inlined_description: _
Check how many times a string contains another string.
Parameters:
haystack The string to check for occurrence in .
needle The string to check for.
_description: _
###string ofSystem(&command)
_inlined_description: _
Executes a system command. Similar to run a command in terminal. \note Will block until the executed program/command has finished.
Returns: the system command output as string.
_description: _
Executes an application or a system command and returns its output as string. Will block until the executed program/command has finished.
###T ofTo(&str)
_inlined_description: _
_description: _
###string ofToBinary(&value)
_inlined_description: _
Converts any datatype value to a string of only 1s and 0s.
The corresponding string of 1s and 0s corresponds to the way value is stored in memory.
\tparam T The data type of the value to convert to a binary string.
Parameters:
value The data to convert to a binary string.
Returns: a binary string.
_description: _
Converts any datatype value to a string of only 1s and 0s corresponding to the way value is stored in memory.
###string ofToBinary(&value)
_inlined_description: _
Converts a string value to a string of only 1s and 0s.
The corresponding string of 1s and 0s corresponds to the way value is stored in memory.
Parameters:
value The string to convert to a binary string.
Returns: a binary string.
_description: _
Converts a string value to a string of only 1s and 0s corresponding to the way value is stored in memory.
###string ofToBinary(*value)
_inlined_description: _
Converts a c-style string to a string of only 1s and 0s.
The corresponding string of 1s and 0s corresponds to the way value is stored in memory.
Parameters:
value The c-style string to convert to a binary string.
Returns: a binary string.
_description: _
Converts any C-style string value to a string of only 1s and 0s corresponding to the way value is stored in memory.
###bool ofToBool(&boolString)
_inlined_description: _
Convert a string to a boolean.
Converts a std::string representation of a boolean (e.g., "TRUE") to an
actual bool using a case-insensitive comparison against the words "true"
and "false".
Parameters:
boolString The string representation of the boolean.
Returns: the boolean represented by the string or 0 on failure.
_description: _
Converts a string representation boolString (e.g., "TRUE") to an actual bool using a case-insensitive comparison against the words "true" and "false".
###char ofToChar(&charString)
_inlined_description: _
Convert a string representation of a char to a actual char.
Converts a string representation of a single char (e.g., "c") to an
actual char.
\note Multi-byte chars and multi-char strings are not supported.
Parameters:
charString The char string to convert.
Returns: The string as a char or 0 on failure.
_description: _
Converts a string representation of a single char (e.g., " c ") to an actual char.
###string ofToDataPath(&path, absolute = false)
_inlined_description: _
Make a path relative to the location of the data/ folder.
This funtion returns path unchanged if ofDisableDataPath() was called first.
By default, a relative path is returned. Users requiring absolute paths for (e.g. for non-openFrameworks functions), can specify that an absolute path be returned.
Parameters:
path The path to make relative to the data/ folder.
absolute Set to true to return an absolute path.
Returns: the new path, unless paths were disabled with ofDisableDataPath().
_description: _
openFrameworks now treats all files in the data/ folder as being at the same level as your app. When a file is loaded using openFrameworks classes (like ofVideoPlayer) the file path is run through this function to turn it into a relative path for the executible. As windows, mac and linux all have different relative paths, it is important to use this function if you have written your own class or addon for openFrameworks and you wish to be able to load files from the data/ folder.
The optional parameter makeAbsolute, if set to true (false by default) returns the generated path as an absolute path starting from the root of your filesystem instead of from the folder your application is run from.
###double ofToDouble(&doubleString)
_inlined_description: _
Convert a string to a double.
Converts a std::string representation of a double (e.g., "3.14") to an
actual double.
Parameters:
doubleString The string representation of the double.
Returns: the double represented by the string or 0 on failure.
_description: _
###float ofToFloat(&floatString)
_inlined_description: _
Convert a string to a float.
Converts a std::string representation of a float (e.g., "3.14") to an
actual float.
Parameters:
floatString string representation of the float.
Returns: the float represented by the string or 0 on failure.
_description: _
Converts a string representation floatString (e.g., "3.14") to an actual float.
###string ofToHex(&value)
_inlined_description: _
Converts any value to its equivalent hexadecimal representation.
The hexadecimal representation corresponds to the way a number is stored in memory.
\tparam T The data type of the value to convert to a hexadecimal string.
Parameters:
value The value to convert to a hexadecimal string.
Returns: the hexadecimal string representation of the value.
_description: _
Converts any value to its equivalent hexadecimal representation corresponding to the way it is stored in memory.
###string ofToHex(&value)
_inlined_description: _
Convert a string to a hexadecimal string.
Converts a string (e.g., "abc") to its equivalent hexadecimal
representation (e.g., "616263").
Parameters:
value The value to convert to a hexadecimal string.
Returns: a hexadecimal string.
_description: _
Converts a string (e.g., "abc") to its equivalent hexadecimal representation (e.g., "616263").
###string ofToHex(*value)
_inlined_description: _
Convert a c-style string to a hexadecimal string.
Converts a string (e.g., "abc") to its equivalent hexadecimal
representation (e.g., "616263").
Parameters:
value The value to convert to a hexadecimal string.
Returns: a hexadecimal string.
_description: _
Converts a c-style string (e.g., "abc") to its equivalent hexadecimal representation (e.g., "616263").
###int ofToInt(&intString)
_inlined_description: _
\section Number Conversion Convert a string to an integer.
Converts a std::string representation of an int (e.g., "3") to an actual
int.
Parameters:
intString The string representation of the integer.
Returns: the integer represented by the string or 0 on failure.
_description: _
Converts a string representation of an int (e.g., "2012") to an actual int.
###int64_t ofToInt64(&intString)
_inlined_description: _
Convert a string to a int64_t.
Converts a std::string representation of a long integer
(e.g., "9223372036854775807") to an actual int64_t.
Parameters:
intString The string representation of the long integer.
Returns: the long integer represented by the string or 0 on failure.
_description: _
###string ofToLower(&src, &locale)
_inlined_description: _
Converts all characters in a string to lowercase.
This function expects a UTF-8 encoded multi-byte string to be passed. Resulting strings will be returned as UTF-8 encoded multi-byte strings.
std::string enthusiasticGreeting = "HELLO, WORLD!";
std::string politeGreeting = ofToLower(enthusiasticGreeting);
ofLog() << politeGreeting; // Returns "hello, world!"
Parameters:
src The UTF-8 encoded string to convert to lowercase.
Returns: the UTF-8 encoded string as all lowercase characters.
_description: _
Converts all characters in the string src to lowercase.
###string ofToString(&value)
_inlined_description: _
\section String Conversion Convert a value to a string.
ofToString does its best to convert any value to a string. If the data type implements a stream << operator, then it will be converted.
Example:
std::string str = "framerate is ";
str += ofToString(ofGetFrameRate()) + " fps";
// The string now containes something like "framerate is 60 fps".
\tparam T The data type of the value to convert to a string.
Parameters:
value The value to convert to a string.
Returns: A string representing the value or an empty string on failure.
_description: _
###string ofToString(&value, precision)
_inlined_description: _
Convert a value to a string with a specific precision.
Like sprintf "%4f" format, in this example precision=4
\tparam T The data type of the value to convert to a string.
Parameters:
value The value to convert to a string.
precision The precision to use when converting to a string.
Returns: The string representation of the value.
_description: _
###string ofToString(&value, precision, width, fill)
_inlined_description: _
Convert a value to a string with a specific precision, width and filll
Like sprintf "%04.2d" or "%04.2f" format, in this example precision=2, width=4, fill='0'
\tparam T The data type of the value to convert to a string.
Parameters:
value The value to convert to a string.
precision The precision to use when converting to a string.
width The width of the value to use when converting to a string.
fill The character to use when padding the converted string.
Returns: The string representation of the value.
_description: _
###string ofToString(&value, width, fill)
_inlined_description: _
Convert a value to a string with a specific width and fill
Like sprintf "% 4d" or "% 4f" format, in this example width=4, fill=' '
\tparam T The data type of the value to convert to a string.
Parameters:
value The value to convert to a string.
width The width of the value to use when converting to a string.
fill The character to use when padding the converted string.
Returns: The string representation of the value.
_description: _
###string ofToString(&values)
_inlined_description: _
Convert a vector of values to a comma-delimited string.
This method will take any vector of values and output a list of the values as a comma-delimited string.
\tparam T The data type held by the vector.
Parameters:
values The vector of values to be converted to a string.
Returns: a comma-delimited string representation of the intput values.
_description: _
Converts a vector of values to a single string representation.
vector<int> vec;
vec.push_back(1);
vec.push_back(2);
vec.push_back(3);
cout << ofToString(vec) << endl; // prints "{1, 2, 3}"
###string ofToUpper(&src, &locale)
_inlined_description: _
Converts all characters in the string to uppercase.
This function expects a UTF-8 encoded multi-byte string to be passed. Resulting strings will be returned as UTF-8 encoded multi-byte strings.
std::string politeGreeting = "Hello, World!";
std::string enthusiasticGreeting = ofToUpper(politeGreeting);
ofLog() << enthusiasticGreeting; // Returns "HELLO, WORLD!"
Parameters:
src The UTF-8 encoded string to convert to uppercase.
Returns: the UTF-8 encoded string as all uppercase characters.
_description: _
Converts all characters in the string src to uppercase.
string politeGreeting = "Hello, World!";
string enthusiasticGreeting = ofToUpper(politeGreeting);
ofLog() << enthusiasticGreeting; // returns "HELLO, WORLD!"
###string ofTrim(&src, &locale)
_inlined_description: _
_description: _
###string ofTrimBack(&src, &locale)
_inlined_description: _
_description: _
###string ofTrimFront(&src, &locale)
_inlined_description: _
_description: _
###void ofUTF8Append(&str, utf8)
_inlined_description: _
_description: _
###void ofUTF8Erase(&str, start, len)
_inlined_description: _
_description: _
###void ofUTF8Insert(&str, pos, utf8)
_inlined_description: _
_description: _
###size_t ofUTF8Length(&str)
_inlined_description: _
_description: _
###string ofUTF8Substring(&str, start, len)
_inlined_description: _
_description: _
###string ofUTF8ToString(utf8)
_inlined_description: _
_description: _
###string ofVAArgsToString(*format)
_inlined_description: _
Convert a variable length argument to a string.
Parameters:
format a printf-style format string.
Returns: A string representation of the argument list.
_description: _
###string ofVAArgsToString(*format, args)
_inlined_description: _
Convert a variable length argument to a string.
Parameters:
format A printf-style format string.
args A variable argument list.
Returns: A string representation of the argument list.
_description: _