BansheeEngine/BansheeCore/Include/BsShaderManager.h

//********************************** Banshee Engine (www.banshee3d.com) **************************************************//
//**************** Copyright (c) 2016 Marko Pintera ([email protected]). All rights reserved. **********************//
#pragma once

#include "BsCorePrerequisites.h"
#include "BsModule.h"

namespace BansheeEngine
{
	/** @cond INTERNAL */
	/** @addtogroup Material
	 *  @{
	 */

	/**
	 * Interface that provides a method for finding a shader include resource based on the name of the include that was 
	 * provided in a shader file.
	 */
	class BS_CORE_EXPORT IShaderIncludeHandler
	{
	public:
		virtual ~IShaderIncludeHandler() { }

		/** Attempts to find a shader include resource based on its name. */
		virtual HShaderInclude findInclude(const String& name) const = 0;
	};

	/**
	 * Implements shader include finding by converting the shader include name into a path that the resource will be loaded 
	 * from.
	 */
	class BS_CORE_EXPORT DefaultShaderIncludeHandler : public IShaderIncludeHandler
	{
	public:
		/** @copydoc IShaderIncludeHandler::findInclude */
		virtual HShaderInclude findInclude(const String& name) const override;
	};

	/**	A global manager that handles various shader specific operations. */
	class BS_CORE_EXPORT ShaderManager : public Module <ShaderManager>
	{
	public:
		ShaderManager(const ShaderIncludeHandlerPtr& handler) { mIncludeHandler = handler; }

		/**
		 * Attempts to find a shader include based on the include name.
		 *
		 * @note	
		 * The name is usually a path to the resource relative to the working folder, but can be other things depending on 
		 * active handler.
		 */
		HShaderInclude findInclude(const String& name) const;

		/** Changes the active include handler that determines how is a shader include name mapped to the actual resource. */
		void setIncludeHandler(const ShaderIncludeHandlerPtr& handler) { mIncludeHandler = handler; }

	private:
		ShaderIncludeHandlerPtr mIncludeHandler;
	};

	/** @} */
	/** @endcond */
}