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.

Index

Constructors

Accessors

deviceCount videoOutputsInformation

Methods

calculateResourcesMemoryUsage getCapabilities getMemoryUsageAsJSON

Constructors

`Protected`constructor

new RenderAPI(isInternalConstructor?: boolean): 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>

Generates a report of GPU memory usage based on every GPU resource alive.

Returns AsyncOp<GroupedGPUResourceMemoryUsageReport>

`Static`getCapabilities

getCapabilities(deviceIndex?: number): 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>

Generates a report of GPU memory usage.

Returns AsyncOp<JsonObject>