Home -> PlatformBindings -> RendererPlugin

Declaration

class RendererPlugin : public IRendererPlugin;

Description

The RendererPlugin class is the concrete owning renderer plugin object used by applications after a plugin has been loaded. It exposes renderer identity, target API information, the plugin module handle shared by copies of the object, and the method used to create a graphics device enumerator.

The object can be filled directly by calling the exported GetRendererPlugin function after checking GetCobaltAPIVersion, or indirectly through RenderPluginEnumerator. Copies share ownership of the loaded plugin module.

ImportantImportant

When CreateGraphicsDeviceEnumerator is called, keep the RendererPlugin object alive for as long as the enumerator, devices, or renderers created from that plugin are in use.

Members

Data access methods

Name Description
Public member GetApiFamily
Returns the renderer API family.
Public member GetTargetApiVersion
Returns the renderer target API version.
Public member GetName
Returns the stable renderer name.
Public member GetDisplayName
Returns the human-readable renderer display name.
Public member SetModuleHandle
Stores an owning module handle for the renderer plugin library.

Allocation methods

Name Description
Public member CreateGraphicsDeviceEnumerator
Creates a graphics device enumerator while preserving module ownership through the RendererPlugin object.

See also