Home -> PlatformBindings -> IRendererPlugin
Declaration
class IRendererPlugin;Description
The IRendererPlugin interface is filled by renderer plugins when their exported GetRendererPlugin function is called. It records the renderer API family, target API version, names shown to applications, and the allocator used to create a graphics device enumerator.
Direct plugin loaders should call GetCobaltAPIVersion and verify API compatibility before passing an IRendererPlugin object to GetRendererPlugin.
Applications normally work with the concrete RendererPlugin object. Renderer plugin implementations write to the object through the IRendererPlugin interface.
Important
A renderer plugin can expose more than one renderer implementation. Call GetRendererPlugin with increasing index values until it returns false.
Enumerations
| Name | Description | |
|---|---|---|
 |
ApiFamily |
Identifies the graphics API family implemented by a renderer plugin.
|
Structures
| Name | Description | |
|---|---|---|
 |
ApiVersion |
Reports the target graphics API version implemented by a renderer plugin.
|
Typedefs
| Name | Description | |
|---|---|---|
 |
AllocatorPointer |
Function pointer type used by a renderer plugin to allocate a graphics device enumerator.
|
|
GetRendererPluginFunctionType |
Function type of the exported renderer plugin information function.
|
Members
Data access methods
| Name | Description | |
|---|---|---|
 |
SetApiFamily |
Sets the renderer API family.
|
|
SetTargetApiVersion |
Sets the target graphics API version.
|
|
SetName |
Sets the stable renderer name.
|
|
SetDisplayName |
Sets the human-readable renderer display name.
|
Allocation methods
| Name | Description | |
|---|---|---|
|
SetAllocationFunction |
Sets the allocator used to create a graphics device enumerator.
|