Class RenderAPI

Provides access to ct::RenderAPI from the simulation thread. All the commands get queued on the core thread queue for the calling thread.

Note

Sim thread only.

Hierarchy

FrameworkObject
- RenderAPI

Index

Constructors

Accessors

deviceCount videoOutputsInformation

Methods

calculateResourcesMemoryUsage getCapabilities getMemoryUsageAsJSON

Constructors

`Protected`constructor

new RenderAPI(isInternalConstructor?): RenderAPI
Parameters
- OptionalisInternalConstructor: boolean
Returns RenderAPI
Overrides FrameworkObject.constructor

Accessors

`Static`deviceCount

get deviceCount(): number
Returns the number of devices supported by this render API.

Returns number

`Static`videoOutputsInformation

get videoOutputsInformation(): VideoOutputsInformation
Returns information about available output devices and their video modes.

Returns VideoOutputsInformation
Note
Thread safe.

Methods

`Static`calculateResourcesMemoryUsage

calculateResourcesMemoryUsage(): AsyncOp<GroupedGPUResourceMemoryUsageReport, void>
Generates a report of GPU memory usage based on every GPU resource alive.

Returns AsyncOp<GroupedGPUResourceMemoryUsageReport, void>

`Static`getCapabilities

getCapabilities(deviceIndex?): RenderAPICapabilities
Gets the capabilities of a specific GPU.
Parameters
- OptionaldeviceIndex: number
  Index of the device to get the capabilities for.
Returns RenderAPICapabilities
Note
Thread safe.

`Static`getMemoryUsageAsJSON

getMemoryUsageAsJSON(): AsyncOp<JsonObject, void>
Generates a report of GPU memory usage.

Returns AsyncOp<JsonObject, void>