Code/Engine/RendererCore/RenderContext/RenderContext.h - dev - redgpu/ezEngine

Code/Engine/RendererCore/RenderContext/RenderContext.h
345 строк15 KB
Jan Krassnigg
Fixed #1954: Added CVar to change the default texture filtering mode (#1957)
08 июн 2026, 12:57
08 июн 2026, 12:578e163d9
#pragma once

#include <Foundation/Containers/Map.h>
#include <RendererCore/Declarations.h>
#include <RendererCore/Meshes/MeshBufferResource.h>
#include <RendererCore/Pipeline/ViewData.h>
#include <RendererCore/RenderContext/BindGroupBuilder.h>
#include <RendererCore/RenderContext/Implementation/RenderContextStructs.h>
#include <RendererCore/Shader/ConstantBufferStorage.h>
#include <RendererCore/Shader/ShaderStageBinary.h>
#include <RendererCore/ShaderCompiler/PermutationGenerator.h>
#include <RendererFoundation/CommandEncoder/CommandEncoder.h>
#include <RendererFoundation/Device/Device.h>
#include <RendererFoundation/Shader/BindGroup.h>
#include <RendererFoundation/Shader/ShaderUtils.h>

#include <RendererCore/../../../Data/Base/Shaders/Common/GlobalConstants.h>

struct ezRenderWorldRenderEvent;

//////////////////////////////////////////////////////////////////////////
// ezRenderContext
//////////////////////////////////////////////////////////////////////////

class EZ_RENDERERCORE_DLL ezRenderContext
{
private:
  ezRenderContext(ezGALCommandEncoder* pCommandEncoder);
  ~ezRenderContext();
  friend class ezMemoryUtils;

  static ezRenderContext* s_pDefaultInstance;
  static ezGALCommandEncoder* s_pCommandEncoder;
  static ezHybridArray<ezRenderContext*, 4> s_Instances;

public:
  static ezRenderContext* GetDefaultInstance();
  static ezRenderContext* CreateInstance(ezGALCommandEncoder* pCommandEncoder);
  static void DestroyInstance(ezRenderContext* pRenderer);

public:
  struct Statistics
  {
    Statistics();
    void Reset();

    ezUInt32 m_uiFailedDrawcalls;
    ezUInt32 m_uiModifiedBindGroup[EZ_GAL_MAX_BIND_GROUPS] = {0};
    ezUInt32 m_uiLayoutChanged[EZ_GAL_MAX_BIND_GROUPS] = {0};
  };

  Statistics GetAndResetStatistics();

  void BeginRendering(const ezGALRenderingSetup& renderingSetup, const ezRectFloat& viewport, const char* szName = "", bool bStereoRendering = false);
  void EndRendering();

  void BeginCompute(const char* szName = "");
  void EndCompute();

  // Helper class to automatically end rendering or compute on scope exit
  template <int ScopeType>
  class CommandEncoderScope
  {
    EZ_DISALLOW_COPY_AND_ASSIGN(CommandEncoderScope);

  public:
    EZ_ALWAYS_INLINE ~CommandEncoderScope()
    {
      if constexpr (ScopeType == 0)
        m_RenderContext.EndRendering();
      else
        m_RenderContext.EndCompute();

      if (m_pCommandsScope != nullptr)
      {
        ezGALDevice::GetDefaultDevice()->EndCommands(m_pCommandsScope);
      }
    }

    EZ_ALWAYS_INLINE ezGALCommandEncoder* operator->() { return m_pGALCommandEncoder; }
    EZ_ALWAYS_INLINE operator const ezGALCommandEncoder*() { return m_pGALCommandEncoder; }

  private:
    friend class ezRenderContext;

    EZ_ALWAYS_INLINE CommandEncoderScope(ezRenderContext& renderContext, ezGALCommandEncoder* pCommandsScope)
      : m_RenderContext(renderContext)
      , m_pCommandsScope(pCommandsScope)
    {
      m_pGALCommandEncoder = renderContext.GetCommandEncoder();
    }

    ezRenderContext& m_RenderContext;
    ezGALCommandEncoder* m_pCommandsScope;
    ezGALCommandEncoder* m_pGALCommandEncoder;
  };

  using RenderingScope = CommandEncoderScope<0>;
  EZ_ALWAYS_INLINE static RenderingScope BeginRenderingScope(const ezRenderViewContext& viewContext, const ezGALRenderingSetup& renderingSetup, const char* szName = "", bool bStereoRendering = false)
  {
    viewContext.m_pRenderContext->BeginRendering(renderingSetup, viewContext.m_pViewData->m_ViewPortRect, szName, bStereoRendering);
    return RenderingScope(*viewContext.m_pRenderContext, nullptr);
  }

  using ComputeScope = CommandEncoderScope<1>;
  EZ_ALWAYS_INLINE static ComputeScope BeginComputeScope(const ezRenderViewContext& viewContext, const char* szName = "")
  {
    viewContext.m_pRenderContext->BeginCompute(szName);
    return ComputeScope(*viewContext.m_pRenderContext, nullptr);
  }

  EZ_ALWAYS_INLINE ezGALCommandEncoder* GetCommandEncoder()
  {
    EZ_ASSERT_DEBUG(m_pGALCommandEncoder != nullptr, "Outside of BeginCommands / EndCommands scope of the device");
    return m_pGALCommandEncoder;
  }

  // Member Functions
  void SetShaderPermutationVariable(const char* szName, const ezTempHashedString& sValue);
  void SetShaderPermutationVariable(const ezHashedString& sName, const ezHashedString& sValue);

  void BindMaterial(const ezMaterialResourceHandle& hMaterial);

  ezBindGroupBuilder& GetBindGroup(ezUInt32 uiBindGroup = 0);
  void ResetBindGroup(ezUInt32 uiBindGroup);
  void ResetBindGroups();

  /// \brief Sets push constants to the given data block.
  /// Note that for platforms that don't support push constants, this is emulated via a constant buffer. Thus, a slot name must be provided as well which matches the name of the BEGIN_PUSH_CONSTANTS block in the shader.
  /// \param sSlotName Name of the BEGIN_PUSH_CONSTANTS block in the shader.
  /// \param data Data of the push constants. If more than 128 bytes, ezGALDeviceCapabilities::m_uiMaxPushConstantsSize should be checked to ensure the data block is not too big for the platform.
  void SetPushConstants(ezTempHashedString sSlotName, ezArrayPtr<const ezUInt8> data);

  /// Templated version of SetPushConstants.
  /// \tparam T Type of the push constants struct.
  /// \param sSlotName Name of the BEGIN_PUSH_CONSTANTS block in the shader.
  /// \param constants Instance of type T that contains the push constants.
  template <typename T>
  EZ_ALWAYS_INLINE void SetPushConstants(ezTempHashedString sSlotName, const T& constants)
  {
    SetPushConstants(sSlotName, ezArrayPtr<const ezUInt8>(reinterpret_cast<const ezUInt8*>(&constants), sizeof(T)));
  }

  /// \brief Sets the currently active shader on the given render context.
  ///
  /// This function has no effect until the next draw or dispatch call on the context.
  void BindShader(const ezShaderResourceHandle& hShader, ezBitflags<ezShaderBindFlags> flags = ezShaderBindFlags::Default);
  void SetBlendState(ezGALBlendStateHandle hBlendState);
  void SetDepthStencilState(ezGALDepthStencilStateHandle hDepthStencilState);
  void SetRasterizerState(ezGALRasterizerStateHandle hRasterizerState);
  void SetStencilRefValue(ezUInt8 uiStencilRefValue);

  void BindMeshBuffer(const ezMeshBufferResourceHandle& hMeshBuffer, ezGALBufferHandle hDataOffsetsBuffer = {}, ezUInt32 uiFirstDataOffset = 0);
  void BindMeshBuffer(const ezDynamicMeshBufferResourceHandle& hDynamicMeshBuffer, ezGALBufferHandle hDataOffsetsBuffer = {}, ezUInt32 uiFirstDataOffset = 0);
  void BindMeshBuffer(ezArrayPtr<const ezGALBufferHandle> vertexBuffers, ezGALBufferHandle hIndexBuffer, ezArrayPtr<const ezGALVertexAttribute> vertexAttributes, ezGALPrimitiveTopology::Enum topology, ezUInt32 uiPrimitiveCount, ezGALBufferHandle hDataOffsetsBuffer = {}, ezUInt32 uiFirstDataOffset = 0);
  EZ_ALWAYS_INLINE void BindNullMeshBuffer(ezGALPrimitiveTopology::Enum topology, ezUInt32 uiPrimitiveCount, ezGALBufferHandle hDataOffsetsBuffer = {}, ezUInt32 uiFirstDataOffset = 0)
  {
    BindMeshBuffer({}, {}, {}, topology, uiPrimitiveCount, hDataOffsetsBuffer, uiFirstDataOffset);
  }

  void BindVertexBuffer(ezGALBufferHandle hVertexBuffer, ezUInt32 uiSlot, ezEnum<ezGALVertexBindingRate> rate = ezGALVertexBindingRate::Vertex, ezUInt32 uiOffset = 0);
  void SetVertexAttributes(ezArrayPtr<ezGALVertexAttribute> vertexAttributes);

  ezResult DrawMeshBuffer(ezUInt32 uiPrimitiveCount = 0xFFFFFFFF, ezUInt32 uiFirstPrimitive = 0, ezUInt32 uiInstanceCount = 1);

  ezResult Dispatch(ezUInt32 uiThreadGroupCountX, ezUInt32 uiThreadGroupCountY = 1, ezUInt32 uiThreadGroupCountZ = 1);

  ezResult ApplyContextStates(bool bForce = false);

  ezGlobalConstants& WriteGlobalConstants();
  const ezGlobalConstants& ReadGlobalConstants() const;
  void SetGlobalAndWorldTimeConstants(ezTime worldTime);

  /// \brief Sets the texture filtering quality for all quality-adjustable samplers.
  ///
  /// The default quality is Anisotropic4x and is controlled via the Rendering.TextureQuality CVar.
  /// Changing quality triggers immediate recreation of all affected sampler states.
  /// Pass bForce = true to force recreation even if the quality value did not change.
  void SetDefaultTextureQuality(ezGALTextureQuality::Enum quality, bool bForce = false);

  /// \brief Returns the texture filter mode that is used by default for textures.
  ezGALTextureQuality::Enum GetDefaultTextureQuality() const { return m_DefaultTextureQuality; }

  /// \brief Set async shader loading. During runtime all shaders should be preloaded so this is off by default.
  void SetAllowAsyncShaderLoading(bool bAllow);

  /// \brief Returns async shader loading. During runtime all shaders should be preloaded so this is off by default.
  bool GetAllowAsyncShaderLoading();


  // Static Functions
public:
  // Constant buffer storage handling
  template <typename T>
  EZ_ALWAYS_INLINE static ezConstantBufferStorageHandle CreateConstantBufferStorage()
  {
    return CreateConstantBufferStorage(sizeof(T));
  }

  template <typename T>
  EZ_FORCE_INLINE static ezConstantBufferStorageHandle CreateConstantBufferStorage(ezConstantBufferStorage<T>*& out_pStorage)
  {
    ezConstantBufferStorageBase* pStorage;
    ezConstantBufferStorageHandle hStorage = CreateConstantBufferStorage(sizeof(T), pStorage);
    out_pStorage = static_cast<ezConstantBufferStorage<T>*>(pStorage);
    return hStorage;
  }

  EZ_FORCE_INLINE static ezConstantBufferStorageHandle CreateConstantBufferStorage(ezUInt32 uiSizeInBytes)
  {
    ezConstantBufferStorageBase* pStorage;
    return CreateConstantBufferStorage(uiSizeInBytes, pStorage);
  }

  static ezConstantBufferStorageHandle CreateConstantBufferStorage(ezUInt32 uiSizeInBytes, ezConstantBufferStorageBase*& out_pStorage);
  static void DeleteConstantBufferStorage(ezConstantBufferStorageHandle& inout_hStorage);

  template <typename T>
  EZ_FORCE_INLINE static bool TryGetConstantBufferStorage(ezConstantBufferStorageHandle hStorage, ezConstantBufferStorage<T>*& out_pStorage)
  {
    ezConstantBufferStorageBase* pStorage = nullptr;
    bool bResult = TryGetConstantBufferStorage(hStorage, pStorage);
    out_pStorage = static_cast<ezConstantBufferStorage<T>*>(pStorage);
    return bResult;
  }

  static bool TryGetConstantBufferStorage(ezConstantBufferStorageHandle hStorage, ezConstantBufferStorageBase*& out_pStorage);
  static void MarktConstantBufferStorageModified(ezConstantBufferStorageBase* pDirtyStorage);

  template <typename T>
  EZ_FORCE_INLINE static T* GetConstantBufferData(ezConstantBufferStorageHandle hStorage)
  {
    ezConstantBufferStorage<T>* pStorage = nullptr;
    if (TryGetConstantBufferStorage(hStorage, pStorage))
    {
      return &(pStorage->GetDataForWriting());
    }

    return nullptr;
  }

  // Default sampler state
  static ezGALSamplerStateCreationDescription GetDefaultSamplerState(ezBitflags<ezDefaultSamplerFlags> flags);

private:
  EZ_MAKE_SUBSYSTEM_STARTUP_FRIEND(RendererCore, RendererContext);

  void ResetContextState();
  static void LoadBuiltinShader(ezShaderUtils::ezBuiltinShaderType type, ezShaderUtils::ezBuiltinShader& out_shader);
  static void RegisterImmutableSamplers();
  static void OnEngineStartup();
  static void OnEngineShutdown();
  static void GALStaticDeviceEventHandler(const ezGALDeviceEvent& e);

private:
  Statistics m_Statistics;
  ezBitflags<ezRenderContextFlags> m_StateFlags;

  // Material
  ezMaterialResourceHandle m_hNewMaterial;
  ezMaterialResourceHandle m_hMaterial;
  const ezMaterialResource* m_pMaterial = nullptr;      ///< Must never be accessed, just used as key to ezMaterialManager::GetMaterialBindGroup
  const ezGALBindGroup* m_pMaterialBindGroup = nullptr; ///< Only stored here to assert is we generate a layout missmatch.

  // Shader Resource
  ezShaderResourceHandle m_hActiveShader;
  ezHashTable<ezHashedString, ezHashedString> m_PermutationVariables;

  // Shader Permutation
  ezShaderPermutationResourceHandle m_hActiveShaderPermutation;
  ezString m_sActiveShader;
  ezGALShaderHandle m_hActiveGALShader;
  const ezGALShader* m_pActiveGALShader = nullptr;
  ezBitflags<ezShaderBindFlags> m_ShaderBindFlags;

  // Vertex / Index Buffer
  ezGALBufferHandle m_hVertexBuffers[EZ_GAL_MAX_VERTEX_BUFFER_COUNT];
  ezUInt32 m_VertexBufferStrides[EZ_GAL_MAX_VERTEX_BUFFER_COUNT] = {};
  ezUInt32 m_VertexBufferOffsets[EZ_GAL_MAX_VERTEX_BUFFER_COUNT] = {};
  ezEnum<ezGALVertexBindingRate> m_VertexBufferBindingRates[EZ_GAL_MAX_VERTEX_BUFFER_COUNT];
  ezGALBufferHandle m_hIndexBuffer;
  ezSmallArray<ezGALVertexAttribute, 16> m_VertexAttributes;

  ezUInt32 m_uiMeshBufferPrimitiveCount;
  ezEnum<ezGALTextureQuality> m_DefaultTextureQuality;
  bool m_bAllowAsyncShaderLoading;
  bool m_bStereoRendering = false;

  ezUInt8 m_uiUserStencilRefValue = 0;
  ezUInt8 m_uiShaderStencilRefValue = 0;
  bool m_bUseUserStencilRefValue = false;

  ezGALGraphicsPipelineCreationDescription m_GraphicsPipeline;
  ezGALComputePipelineCreationDescription m_ComputePipeline;
  ezBindGroupBuilder m_BindGroupBuilders[EZ_GAL_MAX_BIND_GROUPS];
  ezGALBindGroupCreationDescription m_BindGroups[EZ_GAL_MAX_BIND_GROUPS];
  bool m_bDirtyBindGroups[EZ_GAL_MAX_BIND_GROUPS] = {};

  ezConstantBufferStorageHandle m_hGlobalConstantBufferStorage;
  ezConstantBufferStorageHandle m_hPushConstantsStorage;

  struct ShaderVertexDecl
  {
    ezGALShaderHandle m_hShader;
    ezUInt32 m_uiVertexAttributesHash;

    EZ_FORCE_INLINE bool operator<(const ShaderVertexDecl& rhs) const
    {
      if (m_hShader < rhs.m_hShader)
        return true;
      if (rhs.m_hShader < m_hShader)
        return false;
      return m_uiVertexAttributesHash < rhs.m_uiVertexAttributesHash;
    }

    EZ_FORCE_INLINE bool operator==(const ShaderVertexDecl& rhs) const
    {
      return (m_hShader == rhs.m_hShader && m_uiVertexAttributesHash == rhs.m_uiVertexAttributesHash);
    }
  };

  static ezResult BuildVertexDeclaration(ezGALShaderHandle hShader, ezArrayPtr<ezUInt32> vertexBufferStrides, ezArrayPtr<ezEnum<ezGALVertexBindingRate>> vertexBufferBindingRates, ezArrayPtr<ezGALVertexAttribute> vertexAttributes, ezGALVertexDeclarationHandle& out_Declaration);

  static ezMap<ShaderVertexDecl, ezGALVertexDeclarationHandle> s_GALVertexDeclarations;

  static ezMutex s_ConstantBufferStorageMutex;
  static ezIdTable<ezConstantBufferStorageId, ezConstantBufferStorageBase*> s_ConstantBufferStorageTable;
  static ezMap<ezUInt32, ezDynamicArray<ezConstantBufferStorageBase*>> s_FreeConstantBufferStorage;
  static ezSet<ezConstantBufferStorageBase*> s_DirtyConstantBuffers;

private: // Per Renderer States
  ezGALCommandEncoder* m_pGALCommandEncoder = nullptr;
  ezEventSubscriptionID m_GALdeviceEventsId = 0;
  bool m_bRendering = false;
  bool m_bCompute = false;

  // Member Functions
  void UploadConstants();

  void SetShaderPermutationVariableInternal(const ezHashedString& sName, const ezHashedString& sValue);
  void BindShaderInternal(const ezShaderResourceHandle& hShader, ezBitflags<ezShaderBindFlags> flags);
  ezResult ApplyShaderState();
  void ApplyMaterialState();
  ezResult ApplyBindGroup(const ezGALShader* pShader, ezUInt32 uiBindGroup);
};