![]() |
pCon.planner Plugin SDK
Version 8.9
|
Interface for the render callback to supervise render progress. More...
Inherited by X3g::Plugin::ManagedRenderCallbackAdapter.
Public Member Functions | |
void | SetFramebuffer (array< unsigned char >^pBuffer, int pWidth, int pHeight, PixelFormat pFormat) |
Notifies about new framebuffer. More... | |
void | UpdateFrame () |
Notifies that an entire frame has been updated. More... | |
void | FinishedRendering (bool pError) |
Notifies that the rendering is finished. More... | |
void | StartRenderTask (int pNumSteps, int pTask, int pTaskCount) |
Notifies about a new Render task and sets the limits for the UpdateTaskProgress() progress. More... | |
void | UpdateTaskProgress (int long pStep) |
Notifies about the current progress of the rendering. More... | |
bool | RequestRestart () |
Restart was requested. More... | |
Interface for the render callback to supervise render progress.
Create your own class that inherits from IRenderCallback and register it to the property called Callback of your desired Renderer.
void X3g::Plugin::IRenderCallback::FinishedRendering | ( | bool | pError) |
Notifies that the rendering is finished.
pError | Indicates that an error happened. |
bool X3g::Plugin::IRenderCallback::RequestRestart | ( | ) |
Restart was requested.
This function will be polled before changing render settings.
void X3g::Plugin::IRenderCallback::SetFramebuffer | ( | array< unsigned char >^ | pBuffer, |
int | pWidth, | ||
int | pHeight, | ||
PixelFormat | pFormat | ||
) |
Notifies about new framebuffer.
Pixel formats RGBA32 and RGBA128F have pre-multiplied alpha.
void X3g::Plugin::IRenderCallback::StartRenderTask | ( | int | pNumSteps, |
int | pTask, | ||
int | pTaskCount | ||
) |
Notifies about a new Render task and sets the limits for the UpdateTaskProgress() progress.
pNumSteps | The amount of steps for one task to complete. |
pTask | The number of the started task. |
pTaskCount | The amount of tasks in queue. |
void X3g::Plugin::IRenderCallback::UpdateFrame | ( | ) |
Notifies that an entire frame has been updated.
A frame is one iteration over the entire image.
void X3g::Plugin::IRenderCallback::UpdateTaskProgress | ( | int long | pStep) |
Notifies about the current progress of the rendering.
pStep | Indicates the progress on a scale from 0 to NumSteps representing 0 to 100% progress. The value of NumSteps has been set in StartRenderTask() with the pNumSteps parameter. |