< GeeXLab Reference Guide />

> Back to Reference Guide Index


gh_gml library

Description

gh_gml is the GPU monitoring module. It is available for Windows and monitors NVIDIA GeForce/Quadro and AMD Radeon graphics cards.


Number of functions: 17

  1. gh_gml.geforce_logo_is_illumination_supported (Lua - Python)
  2. gh_gml.geforce_logo_get_illumination (Lua - Python)
  3. gh_gml.geforce_logo_set_illumination (Lua - Python)
  4. gh_gml.get_all_limiting_policies (Lua - Python)
  5. gh_gml.get_clocks (Lua - Python)
  6. gh_gml.get_fan_speed (Lua - Python)
  7. gh_gml.get_gpu_codename (Lua - Python)
  8. gh_gml.get_gpu_config (Lua - Python)
  9. gh_gml.get_gpu_cores (Lua - Python)
  10. gh_gml.get_gpu_driver (Lua - Python)
  11. gh_gml.get_gpu_fullname (Lua - Python)
  12. gh_gml.get_num_gpus (Lua - Python)
  13. gh_gml.get_pci_identifiers (Lua - Python)
  14. gh_gml.get_temperatures (Lua - Python)
  15. gh_gml.get_usages (Lua - Python)
  16. gh_gml.gpu_power_get_current_value (Lua - Python)
  17. gh_gml.gpu_power_get_power_limit (Lua - Python)



geforce_logo_is_illumination_supported

Description

GTX 600/700: checks whether the GeForce GTX LED logo is supported.


Syntax

is_supported = gh_gml.geforce_logo_is_illumination_supported(
 gpu_index
)

Languages

Lua - Python


Parameters


Return Values


Code sample

    
is_supported = gh_gml.geforce_logo_is_illumination_supported(0)
            


geforce_logo_get_illumination

Description

GTX 600/700: gets the current illumination value of the GeForce GTX LED logo.


Syntax

illum_value = gh_gml.geforce_logo_get_illumination(
 gpu_index
)

Languages

Lua - Python


Parameters


Return Values


Code sample

    
illum_value = gh_gml.geforce_logo_get_illumination(0)
            


geforce_logo_set_illumination

Description

GTX 600/700: sets the current illumination value of the GeForce GTX LED logo.


Syntax

gh_gml.geforce_logo_set_illumination(
 gpu_index,
 illum_value
)

Languages

Lua - Python


Parameters


Return Values

This function has no return value(s).


Code sample

    
gh_gml.geforce_logo_set_illumination(0, illum_value)
            


get_all_limiting_policies

Description

Gets all policies that limits the GPU power (NVIDIA GPUs).


Syntax

power, temperature, voltage, overvoltage = gh_gml.get_all_limiting_policies(
 gpu_index
)

Languages

Lua - Python


Parameters


Return Values


Code sample

    
power, temperature, voltage, overvoltage = gh_gml.get_all_limiting_policies(0)
if (temperature == 1) then
  print("Limiting policy: temperature")
end
            


get_clocks

Description

Gets the GPU core and memory clock speeds.


Syntax

core_clock, mem_clock = gh_gml.get_clocks(
 gpu_index
)

Languages

Lua - Python


Parameters


Return Values


Code sample

    
core_clock, mem_clock = gh_gml.get_clocks(0)
            


get_fan_speed

Description

Gets the GPU fan speed.


Syntax

percent, rpm = gh_gml.get_fan_speed(
 gpu_index
)

Languages

Lua - Python


Parameters


Return Values


Code sample

    
percent, rpm = gh_gml.get_fan_speed(0)
            


get_gpu_codename

Description

Gets the GPU codename.


Syntax

name = gh_gml.get_gpu_codename(
 gpu_index
)

Languages

Lua - Python


Parameters


Return Values


Code sample

    
codename = gh_gml.get_gpu_codename(0)
            


get_gpu_config

Description

Gets the GPU config: cores, TMUs and ROPs.


Syntax

cores, tmus, rops = gh_gml.get_gpu_config(
 gpu_index
)

Languages

Lua - Python


Parameters


Return Values


Code sample

    
cores, tmus, rops = gh_gml.get_gpu_config(gpu_index)
            


get_gpu_cores

Description

Gets the shader cores of the GPU.


Syntax

cores = gh_gml.get_gpu_cores(
 gpu_index
)

Languages

Lua - Python


Parameters


Return Values


Code sample

    
cores = gh_gml.get_gpu_cores(0)
            


get_gpu_driver

Description

Gets the GPU driver.


Syntax

name = gh_gml.get_gpu_driver(
 gpu_index
)

Languages

Lua - Python


Parameters


Return Values


Code sample

    
driver_name = gh_gml.get_gpu_driver(0)
            


get_gpu_fullname

Description

Gets the GPU name.


Syntax

name = gh_gml.get_gpu_fullname(
 gpu_index
)

Languages

Lua - Python


Parameters


Return Values


Code sample

    
gpu_name = gh_gml.get_gpu_fullname(0)
            


get_num_gpus

Description

Returns the number of GPUs.


Syntax

num_gpus = gh_gml.get_num_gpus()

Languages

Lua - Python


Parameters

This function has no input parameter(s).


Return Values


Code sample

    
num_gpus = gh_gml.get_num_gpus()
            


get_pci_identifiers

Description

Gets the PCI identifiers of the GPU (device and subdevice IDs).


Syntax

vendor_id, device_id, subvendor_id, subdevice_id = gh_gml.get_pci_identifiers(
 gpu_index
)

Languages

Lua - Python


Parameters


Return Values


Code sample

    
vendor_id, device_id, subvendor_id, subdevice_id = gh_gml.get_pci_identifiers(0)
            


get_temperatures

Description

Gets the GPU core, mem, board and VRM temperatures if available.


Syntax

gpu, mem, pcb, vrm = gh_gml.get_temperatures(
 gpu_index
)

Languages

Lua - Python


Parameters


Return Values


Code sample

    
gpu, mem, pcb, vrm = gh_gml.get_temperatures(0)
            


get_usages

Description

Gets the GPU core and memory usages.


Syntax

core_usage, mem_usage = gh_gml.get_usages(
 gpu_index
)

Languages

Lua - Python


Parameters


Return Values


Code sample

    
core_usage, mem_usage = gh_gml.get_usages(0)
            


gpu_power_get_current_value

Description

GTX 600/700: returns the current GPU power.


Syntax

power = gh_gml.gpu_power_get_current_value(
 gpu_index
)

Languages

Lua - Python


Parameters


Return Values


Code sample

    
power = gh_gml.gpu_power_get_current_value(0)
            


gpu_power_get_power_limit

Description

GTX 600/700: returns the power limit (or power target) of the GPU.


Syntax

power = gh_gml.gpu_power_get_power_limit(
 gpu_index
)

Languages

Lua - Python


Parameters


Return Values


Code sample

    
power_target = gh_gml.gpu_power_get_power_limit(0)
            






GeeXLab Rootard Guide | Downloads | Contact | Newsletter