Photon Engine 2.0.0-beta
A physically based renderer.
Loading...
Searching...
No Matches
ph::RenderSession Class Referenceabstract

#include <RenderSession.h>

Inheritance diagram for ph::RenderSession:
ph::Option ph::TSdlResourceBase< ESdlTypeCategory::Ref_Option > ph::SdlResourceBase ph::ISdlResource ph::SingleFrameRenderSession

Public Member Functions

virtual void applyToContext (CoreCookingContext &ctx) const =0
 Apply settings to the context.
 
virtual std::vector< std::shared_ptr< CoreSdlResource > > gatherResources (const SceneDescription &scene) const =0
 Gather resources for this render session.
 
uint32 numWorkers () const
 
 PH_DEFINE_SDL_CLASS (TSdlOwnerClass< RenderSession >)
 
- Public Member Functions inherited from ph::Option
 Option ()=default
 
 PH_DEFINE_SDL_CLASS (TSdlOwnerClass< Option >)
 
- Public Member Functions inherited from ph::TSdlResourceBase< ESdlTypeCategory::Ref_Option >
ESdlTypeCategory getDynamicCategory () const override
 
- Public Member Functions inherited from ph::SdlResourceBase
SdlResourceId getId () const override
 Get the unique ID of this resource. The returned ID is guaranteed to be unique in the current process. Newly created resource cannot have an ID that has been used by a previous resource, even if the previous resource has ended its life cycle. See SdlResourceId.h for some utilities.
 
- Public Member Functions inherited from ph::ISdlResource
 ISdlResource (const ISdlResource &other)=default
 
 ISdlResource (ISdlResource &&other)=default
 
virtual ~ISdlResource ()=default
 
ISdlResourceoperator= (const ISdlResource &rhs)=default
 
ISdlResourceoperator= (ISdlResource &&rhs)=default
 
virtual const SdlClassgetDynamicSdlClass () const
 Get runtime SDL class of the resource.
 
virtual bool isInlinable () const
 

Additional Inherited Members

- Static Public Attributes inherited from ph::TSdlResourceBase< ESdlTypeCategory::Ref_Option >
static constexpr ESdlTypeCategory CATEGORY
 Static category information of the resource. This static category information is required by ISdlResource. See its documentation for more details.
 
- Protected Member Functions inherited from ph::TSdlResourceBase< ESdlTypeCategory::Ref_Option >
 TSdlResourceBase ()=default
 
 TSdlResourceBase (const TSdlResourceBase &other)=default
 
 TSdlResourceBase (TSdlResourceBase &&other)=default
 
TSdlResourceBaseoperator= (const TSdlResourceBase &rhs)=default
 
TSdlResourceBaseoperator= (TSdlResourceBase &&rhs)=default
 
- Protected Member Functions inherited from ph::SdlResourceBase
 SdlResourceBase ()
 
 SdlResourceBase (const SdlResourceBase &other)
 
 SdlResourceBase (SdlResourceBase &&other)=default
 
SdlResourceBaseoperator= (const SdlResourceBase &rhs)
 
SdlResourceBaseoperator= (SdlResourceBase &&rhs)=default
 
- Protected Member Functions inherited from ph::ISdlResource
 ISdlResource ()=default
 

Member Function Documentation

◆ applyToContext()

void ph::RenderSession::applyToContext ( CoreCookingContext & ctx) const
pure virtual

Apply settings to the context.

Derived classes should call the base applyToContext(CoreCookingContext&) in order to not miss out settings from base class.

Implemented in ph::SingleFrameRenderSession.

◆ gatherResources()

std::vector< std::shared_ptr< CoreSdlResource > > ph::RenderSession::gatherResources ( const SceneDescription & scene) const
pure virtual

Gather resources for this render session.

Similar to applyToContext(CoreCookingContext&), calling base gatherResources(const SceneDescription&) in derived classes is recommended.

Implemented in ph::SingleFrameRenderSession.

◆ numWorkers()

uint32 ph::RenderSession::numWorkers ( ) const
inline

◆ PH_DEFINE_SDL_CLASS()

ph::RenderSession::PH_DEFINE_SDL_CLASS ( TSdlOwnerClass< RenderSession > )
inline

The documentation for this class was generated from the following files: