Photon Engine 2.0.0-beta
A physically based renderer.
Loading...
Searching...
No Matches
Public Member Functions | List of all members
ph::SdlInputContext Class Referencefinal

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

#include <SdlInputContext.h>

Inheritance diagram for ph::SdlInputContext:
ph::SdlIOContext

Public Member Functions

 SdlInputContext ()
 
 SdlInputContext (const Path *workingDirectory, const SdlClass *srcClass=nullptr, const SdlStruct *srcStruct=nullptr)
 
 SdlInputContext (const ISdlReferenceGroup *srcResources, const ISdlDataPacketGroup *srcDataPackets, const Path *workingDirectory, const SdlClass *srcClass=nullptr, const SdlStruct *srcStruct=nullptr)
 
const ISdlReferenceGroup * getSrcResources () const
 
const ISdlDataPacketGroup * getSrcDataPackets () const
 
- Public Member Functions inherited from ph::SdlIOContext
std::string genPrettySrcInfo () const
 
const Path & getWorkingDirectory () 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 SdlClass * getSrcClass () const
 The SDL class that is involved in the I/O process.
 
const SdlStruct * getSrcStruct () 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
 
SdlIOContext & operator= (const SdlIOContext &rhs)=default
 
SdlIOContext & operator= (SdlIOContext &&rhs)=default
 

Detailed Description

Data that SDL input process can rely on.

Constructor & Destructor Documentation

◆ SdlInputContext() [1/3]

ph::SdlInputContext::SdlInputContext ( )
inline

◆ SdlInputContext() [2/3]

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

◆ SdlInputContext() [3/3]

ph::SdlInputContext::SdlInputContext ( const ISdlReferenceGroup * srcResources,
const ISdlDataPacketGroup * srcDataPackets,
const Path * workingDirectory,
const SdlClass * srcClass = nullptr,
const SdlStruct * srcStruct = nullptr )
inline

Member Function Documentation

◆ getSrcDataPackets()

const ISdlDataPacketGroup * ph::SdlInputContext::getSrcDataPackets ( ) const
inline
Returns
Named data packets that are relevant to the current input.

◆ getSrcResources()

const ISdlReferenceGroup * ph::SdlInputContext::getSrcResources ( ) const
inline
Returns
References that are relevant to the current input.
The documentation for this class was generated from the following file: