IRaptorBakeBackend
A bake backend, run from the Render dropdown.
| Namespace | Assembly | Kind | Stability |
|---|---|---|---|
Raptor.EditorTools | Raptor.Editor | interface | preview, since 0.1.0 |
The Render field, the Ray-traced preview's pause and the sky watcher read Running and Progress from RaptorBakeBackends.Active.
public interface IRaptorBakeBackendProperties
Caps
RaptorBakeCaps Caps { get; }The features this backend currently supports.
Id
string Id { get; }A stable id, also used as the registry key (for example "Bakery").
IsAvailable
bool IsAvailable { get; }Whether the backend can bake in this project (its baker is installed).
Label
string Label { get; }A short display name.
Progress
float Progress { get; }Progress of the current pass, from 0 to 1, while Running; otherwise 0.
Running
bool Running { get; }Whether a render is in progress. True from Start until the render and its after-steps finish.
Methods
BlockReason
string BlockReason()Returns why a render cannot start now, or null if it can.
Returns: The reason, or null.
Start
void Start()Starts a render with the current Render settings. Checks BlockReason first.
Summary
string Summary(string blockReason)Returns the Render dropdown's status text: progress while running, otherwise blockReason if set, otherwise what a render would cover and the last result.
| Parameter | Type | Description |
|---|---|---|
blockReason | string | The value BlockReason returned. |
Returns: The text.
Related types
- RaptorBakeBackends: The bake backend registry.
- RaptorBakeCaps: What a bake backend can do.