BansheeEngine/CamelotCore/Include/CmDepthStencilState.h

#pragma once

#include "CmPrerequisites.h"
#include "CmCommonEnums.h"
#include "CmResource.h"

namespace CamelotFramework
{
	struct CM_EXPORT DEPTH_STENCIL_STATE_DESC
	{
		DEPTH_STENCIL_STATE_DESC()
			: depthReadEnable(true)
			, depthWriteEnable(true)
			, depthComparisonFunc(CMPF_LESS)
			, stencilEnable(false)
			, stencilReadMask(0xFF)
			, stencilWriteMask(0xFF)
			, frontStencilFailOp(SOP_KEEP)
			, frontStencilZFailOp(SOP_KEEP)
			, frontStencilPassOp(SOP_KEEP)
			, frontStencilComparisonFunc(CMPF_ALWAYS_PASS)
			, backStencilFailOp(SOP_KEEP)
			, backStencilZFailOp(SOP_KEEP)
			, backStencilPassOp(SOP_KEEP)
			, backStencilComparisonFunc(CMPF_ALWAYS_PASS)
		{ }

		bool depthReadEnable;
		bool depthWriteEnable;
		CompareFunction depthComparisonFunc;

		bool stencilEnable;
		UINT8 stencilReadMask;
		UINT8 stencilWriteMask;

		StencilOperation frontStencilFailOp;
		StencilOperation frontStencilZFailOp;
		StencilOperation frontStencilPassOp;
		CompareFunction frontStencilComparisonFunc;

		StencilOperation backStencilFailOp;
		StencilOperation backStencilZFailOp;
		StencilOperation backStencilPassOp;
		CompareFunction backStencilComparisonFunc;
	};

	CM_ALLOW_MEMCPY_SERIALIZATION(DEPTH_STENCIL_STATE_DESC);

	// TODO Low priority - Write doc explaining various states
	class CM_EXPORT DepthStencilState : public Resource
	{
	public:
		virtual ~DepthStencilState() {}

		bool getDepthReadEnable() const { return mData.depthReadEnable; }
		bool getDepthWriteEnable() const { return mData.depthWriteEnable; }
		CompareFunction getDepthComparisonFunc() const { return mData.depthComparisonFunc; }

		bool getStencilEnable() const { return mData.stencilEnable; }
		UINT8 getStencilReadMask() const { return mData.stencilReadMask; }
		UINT8 getStencilWriteMask() const { return mData.stencilWriteMask; }

		StencilOperation getStencilFrontFailOp() const { return mData.frontStencilFailOp; }
		StencilOperation getStencilFrontZFailOp() const { return mData.frontStencilZFailOp; }
		StencilOperation getStencilFrontPassOp() const { return mData.frontStencilPassOp; }
		CompareFunction getStencilFrontCompFunc() const { return mData.frontStencilComparisonFunc; }

		StencilOperation getStencilBackFailOp() const { return mData.backStencilFailOp; }
		StencilOperation getStencilBackZFailOp() const { return mData.backStencilZFailOp; }
		StencilOperation getStencilBackPassOp() const { return mData.backStencilPassOp; }
		CompareFunction getStencilBackCompFunc() const { return mData.backStencilComparisonFunc; }

		static HDepthStencilState create(const DEPTH_STENCIL_STATE_DESC& desc);

		/**
		 * @brief	Returns the default depth stencil state;
		 */
		static const DepthStencilStatePtr& getDefault();
	protected:
		friend class RenderStateManager;

		virtual void initialize(const DEPTH_STENCIL_STATE_DESC& desc);

		DEPTH_STENCIL_STATE_DESC mData;

		/************************************************************************/
		/* 								RTTI		                     		*/
		/************************************************************************/

	public:
		friend class DepthStencilStateRTTI;
		static RTTITypeBase* getRTTIStatic();
		virtual RTTITypeBase* getRTTI() const;	
	};
}