BansheeEngine/BansheeD3D11RenderAPI/Include/BsD3D11HLSLParamParser.h

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

#include "BsD3D11Prerequisites.h"
#include "BsVertexDeclaration.h"

namespace BansheeEngine
{
	/**
	 * @brief	Handles parsing of GPU program microcode and extracting constant and input parameter data.
	 */
	class D3D11HLSLParamParser
	{
	public:
		/**
		 * @brief	Parses the provided microcode and outputs constant parameter descriptions, and optionally for
		 *			vertex GPU programs a set of input parameters.
		 *
		 * @param	microcode	Compiled GPU program microcode to parse.
		 * @param	desc		Output object that will contain parameter descriptions.
		 * @param	inputParams	Output object that will contain a set of program input parameters. Can be null if not required.
		 *						Only relevant for vertex programs.
		 */
		void parse(ID3DBlob* microcode, GpuParamDesc& desc, List<VertexElement>* inputParams);

	private:
		/**
		 * @brief	Parses the provided constant buffer retrieving information about all of its members and storing
		 *			them in the provided GPU params description object.
		 */
		void parseBuffer(ID3D11ShaderReflectionConstantBuffer* bufferReflection, GpuParamDesc& desc);

		/**
		 * @brief	Parses the resource description structure and stores it in the provided GPU params description object.
		 */
		void parseResource(D3D11_SHADER_INPUT_BIND_DESC& resourceDesc, GpuParamDesc& desc);

		/**
		 * @brief	Parses a variable with the specified type and variable description. Adds the variable in the provided
		 *			GPU params description object and assigns it to the provided param block.
		 */
		void parseVariable(D3D11_SHADER_TYPE_DESC& varTypeDesc, D3D11_SHADER_VARIABLE_DESC& varDesc, GpuParamDesc& desc, GpuParamBlockDesc& paramBlock);
	};
}