Nirtcpp 2.0.0
Nirtcpp is a high-performance c++ graphics engine.
nirt::IOSOperator Class Referenceabstract

The Operating system operator provides operation system specific methods and information. More...

#include <nirtcpp/IOSOperator.hpp>

Inheritance diagram for nirt::IOSOperator:
Inheritance graph
Collaboration diagram for nirt::IOSOperator:
Collaboration graph

Public Member Functions

virtual const core::stringcgetOperatingSystemVersion () const =0
 Get the current operation system version as string.
 
NIRT_DEPRECATED const wchar_t * getOperationSystemVersion () const
 Get the current operation system version as string. More...
 
virtual void copyToClipboard (const c8 *text) const =0
 Copies text to the clipboard.
 
virtual const c8getTextFromClipboard () const =0
 Get text from the clipboard. More...
 
virtual bool getProcessorSpeedMHz (u32 *MHz) const =0
 Get the processor speed in megahertz. More...
 
virtual bool getSystemMemory (u32 *totalBytes, u32 *availableBytes) const =0
 Get the total and available system RAM. More...
 
- Public Member Functions inherited from nirt::IReferenceCounted
 IReferenceCounted ()
 Constructor.
 
virtual ~IReferenceCounted ()
 Destructor.
 
void grab () const
 Grabs the object. Increments the reference counter by one. More...
 
bool drop () const
 Drops the object. Decrements the reference counter by one. More...
 
s32 getReferenceCount () const
 Get the reference count. More...
 
const c8getDebugName () const
 Returns the debug name of the object. More...
 

Additional Inherited Members

- Protected Member Functions inherited from nirt::IReferenceCounted
void setDebugName (const c8 *newName)
 Sets the debug name of the object. More...
 

Detailed Description

The Operating system operator provides operation system specific methods and information.

Member Function Documentation

◆ getOperationSystemVersion()

NIRT_DEPRECATED const wchar_t * nirt::IOSOperator::getOperationSystemVersion ( ) const
inline

Get the current operation system version as string.

Deprecated:
Use getOperatingSystemVersion instead. This method will be removed in Nirtcpp 1.9.

◆ getProcessorSpeedMHz()

virtual bool nirt::IOSOperator::getProcessorSpeedMHz ( u32 MHz) const
pure virtual

Get the processor speed in megahertz.

Parameters
MHzThe integer variable to store the speed in.
Returns
True if successful, false if not

◆ getSystemMemory()

virtual bool nirt::IOSOperator::getSystemMemory ( u32 totalBytes,
u32 availableBytes 
) const
pure virtual

Get the total and available system RAM.

Parameters
totalByteswill contain the total system memory in Kilobytes (1024 B)
availableByteswill contain the available memory in Kilobytes (1024 B)
Returns
True if successful, false if not

◆ getTextFromClipboard()

virtual const c8 * nirt::IOSOperator::getTextFromClipboard ( ) const
pure virtual

Get text from the clipboard.

Returns
Returns 0 if no string is in there.

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