ph::SingleFrameRenderSession Class Reference

#include <SingleFrameRenderSession.h>

Inheritance diagram for ph::SingleFrameRenderSession:

Public Member Functions
void	applyToContext (CoreCookingContext &ctx) const override
	Apply settings to the context.
std::vector< std::shared_ptr< CoreSdlResource > >	gatherResources (const SceneDescription &scene) const override
	Gather resources for this render session.
void	setTopLevelAcceleratorType (EAccelerator accelerator)
const std::string &	getVisualizerName () const
const std::string &	getObserverName () const
const std::string &	getSampleSourceName () const
EAccelerator	getTopLevelAcceleratorType () const
	PH_DEFINE_SDL_CLASS (TSdlOwnerClass< SingleFrameRenderSession >)
Public Member Functions inherited from ph::RenderSession
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
ISdlResource &	operator= (const ISdlResource &rhs)=default
ISdlResource &	operator= (ISdlResource &&rhs)=default
virtual const SdlClass *	getDynamicSdlClass () 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
TSdlResourceBase &	operator= (const TSdlResourceBase &rhs)=default
TSdlResourceBase &	operator= (TSdlResourceBase &&rhs)=default
Protected Member Functions inherited from ph::SdlResourceBase
	SdlResourceBase ()
	SdlResourceBase (const SdlResourceBase &other)
	SdlResourceBase (SdlResourceBase &&other)=default
SdlResourceBase &	operator= (const SdlResourceBase &rhs)
SdlResourceBase &	operator= (SdlResourceBase &&rhs)=default
Protected Member Functions inherited from ph::ISdlResource
	ISdlResource ()=default

Member Function Documentation

applyToContext()

void ph::SingleFrameRenderSession::applyToContext ( CoreCookingContext & ctx ) const

overridevirtual

Apply settings to the context.

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

Implements ph::RenderSession.

gatherResources()

std::vector< std::shared_ptr< CoreSdlResource > > ph::SingleFrameRenderSession::gatherResources ( const SceneDescription & scene ) const

overridevirtual

Gather resources for this render session.

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

Implements ph::RenderSession.

getObserverName()

const std::string & ph::SingleFrameRenderSession::getObserverName ( ) const

inline

getSampleSourceName()

const std::string & ph::SingleFrameRenderSession::getSampleSourceName ( ) const

inline

getTopLevelAcceleratorType()

EAccelerator ph::SingleFrameRenderSession::getTopLevelAcceleratorType ( ) const

inline

getVisualizerName()

const std::string & ph::SingleFrameRenderSession::getVisualizerName ( ) const

inline

PH_DEFINE_SDL_CLASS()

ph::SingleFrameRenderSession::PH_DEFINE_SDL_CLASS ( TSdlOwnerClass< SingleFrameRenderSession > )

inline

setTopLevelAcceleratorType()

void ph::SingleFrameRenderSession::setTopLevelAcceleratorType ( EAccelerator accelerator )

inline

---

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

• Source/EngineEnv/Session/SingleFrameRenderSession.h
• Source/EngineEnv/Session/SingleFrameRenderSession.cpp