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

Data that SDL output process can rely on. More...

#include <SdlOutputContext.h>

Inheritance diagram for ph::SdlOutputContext:
ph::SdlIOContext

Public Member Functions

 SdlOutputContext ()
 
 SdlOutputContext (const Path *workingDirectory, const SdlClass *srcClass=nullptr, const SdlStruct *srcStruct=nullptr)
 
 SdlOutputContext (const SdlDependencyResolver *dependencyResolver, SdlNamedOutputClauses *namedOutputClauses, const Path *workingDirectory, const SdlClass *srcClass=nullptr, const SdlStruct *srcStruct=nullptr)
 
const SdlDependencyResolvergetDependencyResolver () const
 
SdlNamedOutputClausesgetNamedOutputClauses () const
 
std::string_view getResourceName (const ISdlResource *resource) const
 
- Public Member Functions inherited from ph::SdlIOContext
std::string genPrettySrcInfo () const
 
const PathgetWorkingDirectory () const
 Get working directory of the current I/O session. Do not treat this as the classical definition of working directory (for a process). A SDL working directory may be different for each I/O session, and different to the working directory of the current process.
 
const SdlClassgetSrcClass () const
 The SDL class that is involved in the I/O process.
 
const SdlStructgetSrcStruct () const
 
void setSrcClass (const SdlClass *srcClass)
 
void setSrcStruct (const SdlStruct *srcStruct)
 

Additional Inherited Members

- Protected Member Functions inherited from ph::SdlIOContext
 SdlIOContext ()
 
 SdlIOContext (const Path *workingDirectory, const SdlClass *srcClass=nullptr, const SdlStruct *srcStruct=nullptr)
 
 SdlIOContext (const SdlIOContext &other)=default
 
 SdlIOContext (SdlIOContext &&other)=default
 
SdlIOContextoperator= (const SdlIOContext &rhs)=default
 
SdlIOContextoperator= (SdlIOContext &&rhs)=default
 

Detailed Description

Data that SDL output process can rely on.

Constructor & Destructor Documentation

◆ SdlOutputContext() [1/3]

ph::SdlOutputContext::SdlOutputContext ( )
inline

◆ SdlOutputContext() [2/3]

ph::SdlOutputContext::SdlOutputContext ( const Path * workingDirectory,
const SdlClass * srcClass = nullptr,
const SdlStruct * srcStruct = nullptr )
inlineexplicit

◆ SdlOutputContext() [3/3]

ph::SdlOutputContext::SdlOutputContext ( const SdlDependencyResolver * dependencyResolver,
SdlNamedOutputClauses * namedOutputClauses,
const Path * workingDirectory,
const SdlClass * srcClass = nullptr,
const SdlStruct * srcStruct = nullptr )
inline

Member Function Documentation

◆ getDependencyResolver()

const SdlDependencyResolver * ph::SdlOutputContext::getDependencyResolver ( ) const
inline

◆ getNamedOutputClauses()

SdlNamedOutputClauses * ph::SdlOutputContext::getNamedOutputClauses ( ) const
inline

◆ getResourceName()

std::string_view ph::SdlOutputContext::getResourceName ( const ISdlResource * resource) const
Returns
Resource name if such information exists. May be empty if resource is null or no name information is available.

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