BansheeEngine/Source/RenderBeast/Include/BsSamplerOverrides.h

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

#include "BsRenderBeastPrerequisites.h"

namespace BansheeEngine
{
	/** @addtogroup RenderBeast
	 *  @{
	 */

	/**	Contains data about an overridden sampler states for a single pass stage. */
	struct StageSamplerOverrides
	{
		UINT32* stateOverrides;
		UINT32 numStates;
	};

	/**	Contains data about an overridden sampler states for a single pass. */
	struct PassSamplerOverrides
	{
		StageSamplerOverrides* stages;
		UINT32 numStages;
	};

	/** Contains data about a single overriden sampler state. */
	struct SamplerOverride
	{
		UINT32 paramIdx;
		UINT64 originalStateHash;
		SPtr<SamplerStateCore> state;
	};

	/**	Contains data about an overridden sampler states in the entire material. */
	struct MaterialSamplerOverrides
	{
		PassSamplerOverrides* passes;
		SamplerOverride* overrides;
		UINT32 numPasses;
		UINT32 numOverrides;
		UINT32 refCount;
	};

	/** Key used for uniquely identifying a sampler override entry. */
	struct SamplerOverrideKey
	{
		SamplerOverrideKey(const SPtr<MaterialCore>& material, UINT32 techniqueIdx)
			:material(material), techniqueIdx(techniqueIdx)
		{ }

		bool operator== (const SamplerOverrideKey& rhs) const
		{ 
			return material == rhs.material && techniqueIdx == rhs.techniqueIdx;
		}

		bool operator!= (const SamplerOverrideKey& rhs) const 
		{ 
			return !(*this == rhs); 
		}

		SPtr<MaterialCore> material;
		UINT32 techniqueIdx;
	};

	/**	Helper class for generating sampler overrides. */
	class BS_BSRND_EXPORT SamplerOverrideUtility
	{
	public:
		/**
		 * Generates a set of sampler overrides for the specified set of GPU program parameters. Overrides are generates
		 * according to the provided render options. 
		 */
		static MaterialSamplerOverrides* generateSamplerOverrides(const SPtr<ShaderCore>& shader,
			const SPtr<MaterialParamsCore>& params, 
			const SPtr<GpuParamsSetCore>& paramsSet,
			const SPtr<RenderBeastOptions>& options);

		/**	Destroys sampler overrides previously generated with generateSamplerOverrides(). */
		static void destroySamplerOverrides(MaterialSamplerOverrides* overrides);

		/**
		 * Checks if the provided sampler state requires an override, in case the render options have requirements not
		 * fulfilled by current sampler state (for example filtering type).
		 */
		static bool checkNeedsOverride(const SPtr<SamplerStateCore>& samplerState, 
			const SPtr<RenderBeastOptions>& options);

		/**
		 * Generates a new sampler state override using the provided state as the basis. Overridden properties are taken
		 * from the provided render options.
		 */
		static SPtr<SamplerStateCore> generateSamplerOverride(const SPtr<SamplerStateCore>& samplerState, 
			const SPtr<RenderBeastOptions>& options);
	};

	/** @} */
}

/** @cond STDLIB */

namespace std
{
	/** Hash value generator for SamplerOverrideKey. */
	template<>
	struct hash<BansheeEngine::SamplerOverrideKey>
	{
		size_t operator()(const BansheeEngine::SamplerOverrideKey& key) const
		{
			size_t hash = 0;
			BansheeEngine::hash_combine(hash, key.material);
			BansheeEngine::hash_combine(hash, key.techniqueIdx);

			return hash;
		}
	};
}

/** @endcond */