CeresEngine::ShaderCompiler::IncludeHandler Class Reference

Interface for handling new include streams. More...

#include <CeresEngine/Material/ShaderCompiler/IncludeHandler.hpp>

Public Member Functions
	IncludeHandler ()
virtual	~IncludeHandler ()
virtual UPtr< std::istream >	include (const String &includeName, bool useSearchPathsFirst)
	Returns an input stream for the specified filename.
Vector< String > &	getSearchPaths ()
	Returns the list of search paths.
const Vector< String > &	getSearchPaths () const
	Returns the constant list of search paths.

Private Attributes
OpaqueData *	mData = nullptr

Detailed Description

Interface for handling new include streams.

Remarks

The default implementation will read the files from an std::ifstream.

Constructor & Destructor Documentation

IncludeHandler()

CeresEngine::ShaderCompiler::IncludeHandler::IncludeHandler

(

)

~IncludeHandler()

virtual CeresEngine::ShaderCompiler::IncludeHandler::~IncludeHandler ( )

virtual

Member Function Documentation

getSearchPaths() [1/2]

Vector< String > & CeresEngine::ShaderCompiler::IncludeHandler::getSearchPaths

(

)

Returns the list of search paths.

getSearchPaths() [2/2]

const Vector< String > & CeresEngine::ShaderCompiler::IncludeHandler::getSearchPaths

(

)

const

Returns the constant list of search paths.

include()

virtual UPtr< std::istream > CeresEngine::ShaderCompiler::IncludeHandler::include ( const String &  includeName, bool  useSearchPathsFirst  )

virtual

Returns an input stream for the specified filename.

Parameters

[in]	includeName	Specifies the include filename.
[in]	useSearchPathsFirst	Specifies whether to first use the search paths to find the file.

Returns

Unique pointer to the new input stream.

Member Data Documentation

mData

OpaqueData* CeresEngine::ShaderCompiler::IncludeHandler::mData = nullptr

private

---

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

• /Users/Rogiel/Developer/CeresEngine/Engine/Sources/CeresEngine/Material/ShaderCompiler/IncludeHandler.hpp