ML Reference
ml::GPUInfo Class Reference

Singleton class that provides hardware specific information. More...

#include <mlGPUInfo.h>

List of all members.

Public Member Functions

unsigned long long getVideoMemorySize () const
 Determines the amount of video memory in bytes that is available to the accelerated renderer of the primary display Returns a value of 0 if failed.
unsigned long long getTextureMemorySize () const
 Determine the amount of texture memory in bytes that is available to the accelerated renderer of the primary display The amount of texture memory is somewhat smaller than the amount of video memory (e.g., framebuffer needs memory too) Returns a value of 0 if failed.

Static Public Member Functions

static GPUInfogetInstance ()
 Returns the single existing object of this class.

Protected Member Functions

 GPUInfo ()
 This constructor must not be called from anywhere else but the getInstance() method (which does call this function if the static pointer to the valid object is not set yet).

Detailed Description

Singleton class that provides hardware specific information.

To get a pointer to a valid object of this type use the getInstance() method.

Definition at line 22 of file mlGPUInfo.h.


Constructor & Destructor Documentation

ml::GPUInfo::GPUInfo ( ) [protected]

This constructor must not be called from anywhere else but the getInstance() method (which does call this function if the static pointer to the valid object is not set yet).


Member Function Documentation

static GPUInfo& ml::GPUInfo::getInstance ( ) [static]

Returns the single existing object of this class.

The concept of this class is based on the Singleton design pattern which ensures there is only one object of this class. (NOT THREADSAFE!)

unsigned long long ml::GPUInfo::getTextureMemorySize ( ) const [inline]

Determine the amount of texture memory in bytes that is available to the accelerated renderer of the primary display The amount of texture memory is somewhat smaller than the amount of video memory (e.g., framebuffer needs memory too) Returns a value of 0 if failed.

Definition at line 52 of file mlGPUInfo.h.

unsigned long long ml::GPUInfo::getVideoMemorySize ( ) const [inline]

Determines the amount of video memory in bytes that is available to the accelerated renderer of the primary display Returns a value of 0 if failed.

Definition at line 45 of file mlGPUInfo.h.


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