RenderSession executes a rendering based on the RenderConfig provided.
More...
#include <luxcore.h>
RenderSession executes a rendering based on the RenderConfig provided.
Definition at line 1051 of file luxcore.h.
| virtual luxcore::RenderSession::~RenderSession |
( |
| ) |
|
|
virtual |
| virtual void luxcore::RenderSession::BeginSceneEdit |
( |
| ) |
|
|
pure virtual |
Stops the rendering and allows to edit the Scene.
| static RenderSession* luxcore::RenderSession::Create |
( |
const RenderConfig * |
config, |
|
|
const std::string & |
startStateFileName, |
|
|
const std::string & |
startFilmFileName |
|
) |
| |
|
static |
Creates a new RenderSession using the provided RenderConfig.
- Parameters
-
| config | is the RenderConfig used to create the rendering session. The RenderConfig is not deleted by the destructor. |
| startStateFileName | is the file name of a RenderState to use to resume rendering. |
| startFilmFileName | is the file name of a Film to use to resume rendering. |
| virtual void luxcore::RenderSession::EndSceneEdit |
( |
| ) |
|
|
pure virtual |
Ends the Scene editing and start the rendering again.
| virtual Film& luxcore::RenderSession::GetFilm |
( |
| ) |
|
|
pure virtual |
Returns a reference to a Film with the output of the rendering.
- Returns
- the reference to the Film.
| virtual const RenderConfig& luxcore::RenderSession::GetRenderConfig |
( |
| ) |
const |
|
pure virtual |
Returns a reference to the RenderingConfig used to create this RenderSession.
- Returns
- a reference to the RenderingConfig.
| virtual RenderState* luxcore::RenderSession::GetRenderState |
( |
| ) |
|
|
pure virtual |
Returns a pointer to the current RenderState. The session must be paused.
- Returns
- a pointer to the RenderState.
Returns a list of statistics related to the ongoing rendering. The returned Properties is granted to have content only after the first call to the UpdateStats method.
- Returns
- a Properties container with the statistics.
| virtual bool luxcore::RenderSession::HasDone |
( |
| ) |
const |
|
pure virtual |
It can be used to check if the rendering is over.
| virtual bool luxcore::RenderSession::IsInPause |
( |
| ) |
const |
|
pure virtual |
It can be used to check if the session is in scene editing mode.
| virtual bool luxcore::RenderSession::IsInSceneEdit |
( |
| ) |
const |
|
pure virtual |
It can be used to check if the session is in scene editing mode.
| virtual bool luxcore::RenderSession::IsStarted |
( |
| ) |
const |
|
pure virtual |
It can be used to check if the session has been started.
Dynamic edit the definition of RenderConfig properties.
- Parameters
-
| props | are the Properties with the definition of: film.imagepipeline(s).* (including radiance channel scales), film.outputs.*, film.width or film.height. |
| virtual void luxcore::RenderSession::Pause |
( |
| ) |
|
|
pure virtual |
| virtual void luxcore::RenderSession::Resume |
( |
| ) |
|
|
pure virtual |
| virtual void luxcore::RenderSession::SaveResumeFile |
( |
const std::string & |
fileName | ) |
|
|
pure virtual |
Save all the rendering related information (the LuxCore RenderConfig, Scene, RenderState and Film) in a file for a later restart. The resume file extension must be ".rsm".
- Parameters
-
| fileName | is the binary file used to save. |
| virtual void luxcore::RenderSession::Start |
( |
| ) |
|
|
pure virtual |
| virtual void luxcore::RenderSession::Stop |
( |
| ) |
|
|
pure virtual |
| virtual void luxcore::RenderSession::UpdateStats |
( |
| ) |
|
|
pure virtual |
Updates the statistics. This function perform also all periodic checks and tasks (like saving the film outputs, etc.).
| virtual void luxcore::RenderSession::WaitForDone |
( |
| ) |
const |
|
pure virtual |
Used to wait for the end of the rendering.
| virtual void luxcore::RenderSession::WaitNewFrame |
( |
| ) |
|
|
pure virtual |
Used to wait for the next frame with real-time render engines like RTPATHOCL. It does nothing with other render engines.
The documentation for this class was generated from the following file:
1.8.6 
