SYS_Platform.h File Reference

#include "SYS_API.h"
#include "SYS_Types.h"
#include <string>

Include dependency graph for SYS_Platform.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes
struct	SYS_CPUModel

Enumerations
enum	SYS_CPUBrand {   SYS_CPUBrand::Unknown = -1, SYS_CPUBrand::Intel, SYS_CPUBrand::Amd, SYS_CPUBrand::Apple,   SYS_CPUBrand::Arm }

Functions
SYS_API void	SYSgetProcessor (int &majortype, int &flags)
SYS_API bool	SYShasMinimumProcessor ()
	Determine if we satisfy minimum processor requirements. More...
SYS_API int	SYSgetProcessorCount ()
SYS_API const char *	SYSgetOsProc ()
	Find the name of the operating system that Houdini was compiled for. More...
SYS_API std::string	SYSgetRuntimeOSLabel ()
	Return a "nice" name of the current operating system. More...
SYS_API const char *	SYSgetPlatformSpec ()
	Find the exact OS, 32-bit or 64-bit build, compiler version. More...
SYS_API exint	SYSgetMemorySize ()
	Returns the amount of installed memory (not VM). More...
SYS_API std::string	SYSgetCPUBrandString ()
SYS_API SYS_CPUBrand	SYSgetCPUBrand ()
	Returns CPU manufacturer. More...
SYS_API SYS_CPUModel	SYSgetCPUModel ()
	Returns the CPU model information. More...
SYS_API bool	SYSisMBSD ()
SYS_API bool	SYSisLinux ()
SYS_API bool	SYSisWindows ()
SYS_API void	SYSgetMACAddresses (unsigned char *&addresses, int &num_addresses)
SYS_API bool	SYSgetMACAddress (unsigned char mac_address[6])
SYS_API bool	SYSgetMACAddressAsInteger (int64 &mac_address)

Enumeration Type Documentation

enum SYS_CPUBrand

strong

Enumerator
Unknown
Intel
Amd
Apple
Arm

Definition at line 66 of file SYS_Platform.h.

Function Documentation

SYS_API SYS_CPUBrand SYSgetCPUBrand

(

)

Returns CPU manufacturer.

SYS_API std::string SYSgetCPUBrandString

(

)

Returns string representing the manufacturerer's name.

Warning

The format of this string is OS specific! Use SYSgetCPUBrand() if you need to programatically switch on the processor manufacturer.

SYS_API SYS_CPUModel SYSgetCPUModel

(

)

Returns the CPU model information.

SYS_API bool SYSgetMACAddress

(

unsigned char

mac_address[6]

)

Return a single MAC address that we treat as the main MAC address for this machine. Returns false if no MAC address could be determined.

SYS_API bool SYSgetMACAddressAsInteger

(

int64 &

mac_address

)

SYS_API void SYSgetMACAddresses	(	unsigned char *&	addresses,
		int &	num_addresses
	)

Return the MAC addresses for all the deviced on this system. The caller is responsible to delete [] the addresses if num_addresses > 0.

SYS_API exint SYSgetMemorySize

(

)

Returns the amount of installed memory (not VM).

SYS_API const char* SYSgetOsProc

(

)

Find the name of the operating system that Houdini was compiled for.

SYS_API const char* SYSgetPlatformSpec

(

)

Find the exact OS, 32-bit or 64-bit build, compiler version.

SYS_API void SYSgetProcessor	(	int &	majortype,
		int &	flags
	)

Get processor information about the CPU that Houdini is running on. Please see SYS_ProcessorDefines.h for CPU information

SYS_API int SYSgetProcessorCount

(

)

Returns the number of processors available for the process, taking into account affinity masks.

NOTE: Unless you have a good reason to call this directly, you probably want to call UT_Thread::getNumProcessors(), instead, because that takes into account users opting to limit the thread count, and caches the number for fast querying.

SYS_API std::string SYSgetRuntimeOSLabel

(

)

Return a "nice" name of the current operating system.

SYS_API bool SYShasMinimumProcessor

(

)

Determine if we satisfy minimum processor requirements.

SYS_API bool SYSisLinux

(

)

SYS_API bool SYSisMBSD

(

)

Just a handy, quick, and fast function to test the platform for which the code is being compiled.

SYS_API bool SYSisWindows

(

)