UnrealEngineUWP/Engine/Source/Developer/VulkanShaderFormat/Private/VulkanBackend.h

// Copyright 1998-2019 Epic Games, Inc. All Rights Reserved.

#pragma once

#include "CoreMinimal.h"
#include "hlslcc.h"
#include "LanguageSpec.h"
#include "VulkanCommon.h"

class FVulkanLanguageSpec : public ILanguageSpec
{
protected:
	bool bShareSamplers;

public:
	FVulkanLanguageSpec(bool bInShareSamplers)
		: bShareSamplers(bInShareSamplers)
	{}

	virtual bool SupportsDeterminantIntrinsic() const override
	{
		return true;
	}

	virtual bool SupportsTransposeIntrinsic() const override
	{
		return true;
	}

	virtual bool SupportsIntegerModulo() const override
	{
		return true;
	}

	virtual bool SupportsMatrixConversions() const override { return true; }

	virtual void SetupLanguageIntrinsics(_mesa_glsl_parse_state* State, exec_list* ir) override;

	virtual bool AllowsSharingSamplers() const override { return bShareSamplers; }

	virtual bool RequiresNegateDDY() const override { return false; }
};

class ir_variable;

// Generates Vulkan compliant code from IR tokens
#ifdef __GNUC__
#pragma GCC visibility push(default)
#endif // __GNUC__

struct FVulkanBindingTable
{
	struct FBinding
	{
		FBinding();
		FBinding(const char* InName, int32 InVirtualIndex, EVulkanBindingType::EType InType, int8 InSubType);

		char		Name[256];
		int32		VirtualIndex = -1;
		EVulkanBindingType::EType	Type;
		int8		SubType;	// HLSL CC subtype, PACKED_TYPENAME_HIGHP and etc
	};

	TArray<FString> InputAttachments;

	FVulkanBindingTable(EHlslShaderFrequency ShaderStage) : Stage(ShaderStage) {}

	int32 RegisterBinding(const char* InName, const char* BlockName, EVulkanBindingType::EType Type);

	int32 GetInputAttachmentIndex(const FString& Name)
	{
		for (int32 Index = 0; Index < InputAttachments.Num(); ++Index)
		{
			if (InputAttachments[Index] == Name)
			{
				return Index;
			}
		}

		check(0);
		return -1;
	}

	const TArray<FBinding>& GetBindings() const
	{
		check(bSorted);
		return Bindings;
	}

	void SortBindings();
	void PrintBindingTableDefines(char** OutBuffer) const;

	int32 GetRealBindingIndex(int32 InVirtualIndex) const
	{
		for (int32 Index = 0; Index < Bindings.Num(); ++Index)
		{
			if (Bindings[Index].VirtualIndex == InVirtualIndex)
			{
				return Index;
			}
		}

		return -1;
	}

private:
	// Previous implementation supported bindings only for textures.
	// However, layout(binding=%d) must be also used for uniform buffers.

	EHlslShaderFrequency Stage;
	TArray<FBinding> Bindings;

	bool bSorted = false;

	friend class FGenerateVulkanVisitor;
};

struct FVulkanCodeBackend : public FCodeBackend
{
	FVulkanCodeBackend(	unsigned int InHlslCompileFlags,
						FVulkanBindingTable& InBindingTable,
						EHlslCompileTarget InTarget) :
		FCodeBackend(InHlslCompileFlags, InTarget),
		BindingTable(InBindingTable)
	{
	}

	virtual char* GenerateCode(struct exec_list* ir, struct _mesa_glsl_parse_state* ParseState, EHlslShaderFrequency Frequency) override;

	// Return false if there were restrictions that made compilation fail
	virtual bool ApplyAndVerifyPlatformRestrictions(exec_list* Instructions, _mesa_glsl_parse_state* ParseState, EHlslShaderFrequency Frequency) override;

	/**
	* Generate a GLSL main() function that calls the entry point and handles
	* reading and writing all input and output semantics.
	* @param Frequency - The shader frequency.
	* @param EntryPoint - The name of the shader entry point.
	* @param Instructions - IR code.
	* @param ParseState - Parse state.
	*/
	virtual bool GenerateMain(EHlslShaderFrequency Frequency, const char* EntryPoint, exec_list* Instructions, _mesa_glsl_parse_state* ParseState) override;

	void FixIntrinsics(_mesa_glsl_parse_state* ParseState, exec_list* ir);

	void GenShaderPatchConstantFunctionInputs(_mesa_glsl_parse_state* ParseState, ir_variable* OutputPatchVar, exec_list &PostCallInstructions);

	void CallPatchConstantFunction(_mesa_glsl_parse_state* ParseState, ir_variable* OutputPatchVar, ir_function_signature* PatchConstantSig, exec_list& DeclInstructions, exec_list &PostCallInstructions);

	ir_function_signature* FindPatchConstantFunction(exec_list* Instructions, _mesa_glsl_parse_state* ParseState);

	FVulkanBindingTable& BindingTable;
};

// Intrinsic name
#define VULKAN_SUBPASS_FETCH				"VulkanSubpassFetch"
// Generated attachment name
#define VULKAN_SUBPASS_FETCH_VAR			"GENERATED_SubpassFetchAttachment"
#define VULKAN_SUBPASS_FETCH_VAR_W			TEXT("GENERATED_SubpassFetchAttachment")

// Intrinsic name
#define VULKAN_SUBPASS_DEPTH_FETCH			"VulkanSubpassDepthFetch"
// Generated attachment name
#define VULKAN_SUBPASS_DEPTH_FETCH_VAR		"GENERATED_SubpassDepthFetchAttachment"
#define VULKAN_SUBPASS_DEPTH_FETCH_VAR_W	TEXT("GENERATED_SubpassDepthFetchAttachment")

#ifdef __GNUC__
#pragma GCC visibility pop
#endif // __GNUC__