Skip to content

GraphicsProperties API

Version: 1.0.0

Status: ⚫⚪⚪

GraphicsProperties interface for Thunder framework.

(Defined with IGraphicsProperties in IDisplayInfo.h)

Table of Contents

Introduction

Scope

This document describes purpose and functionality of the GraphicsProperties interface (version 1.0.0). It includes detailed specification about its properties provided.

Case Sensitivity

All identifiers of the interfaces described in this document are case-sensitive. Thus, unless stated otherwise, all keywords, entities, properties, relations and actions should be treated as such.

Acronyms, Abbreviations and Terms

The table below provides and overview of acronyms used in this document and their definitions.

Acronym Description
API Application Programming Interface
HTTP Hypertext Transfer Protocol
JSON JavaScript Object Notation; a data interchange format
JSON-RPC A remote procedure call protocol encoded in JSON

The table below provides and overview of terms and abbreviations used in this document and their definitions.

Term Description
callsign The name given to an instance of a plugin. One plugin can be instantiated multiple times, but each instance the instance name, callsign, must be unique.

References

Ref ID Description
HTTP HTTP specification
JSON-RPC JSON-RPC 2.0 specification
JSON JSON specification
Thunder Thunder API Reference

Description

GraphicsProperties JSON-RPC interface.

This interface uses legacy lowercase naming convention. With the next major release the naming convention will change to camelCase.

Properties

The following properties are provided by the GraphicsProperties interface:

GraphicsProperties interface properties:

Property R/W Description
totalgpuram read-only Total GPU DRAM memory (in bytes)
freegpuram read-only Free GPU DRAM memory (in bytes)

totalgpuram property

Provides access to the total GPU DRAM memory (in bytes).

This property is read-only.

Value

Name Type M/O Description
(property) integer mandatory Total GPU DRAM memory (in bytes)

Example

Get Request

{
  "jsonrpc": "2.0",
  "id": 42,
  "method": "<callsign>.1.totalgpuram"
}

Get Response

{
  "jsonrpc": "2.0",
  "id": 42,
  "result": 0
}

freegpuram property

Provides access to the free GPU DRAM memory (in bytes).

This property is read-only.

Value

Name Type M/O Description
(property) integer mandatory Free GPU DRAM memory (in bytes)

Example

Get Request

{
  "jsonrpc": "2.0",
  "id": 42,
  "method": "<callsign>.1.freegpuram"
}

Get Response

{
  "jsonrpc": "2.0",
  "id": 42,
  "result": 0
}