renderdoc/qrenderdoc/Code/CommonPipelineState.h

/******************************************************************************
 * The MIT License (MIT)
 *
 * Copyright (c) 2016 Baldur Karlsson
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 * THE SOFTWARE.
 ******************************************************************************/

#pragma once

#include <QDebug>
#include <QMap>
#include <QString>
#include <QVector>
#include "renderdoc_replay.h"

struct BoundResource
{
  BoundResource()
  {
    Id = ResourceId();
    HighestMip = -1;
    FirstSlice = -1;
    typeHint = eCompType_None;
  }
  BoundResource(ResourceId id)
  {
    Id = id;
    HighestMip = -1;
    FirstSlice = -1;
    typeHint = eCompType_None;
  }

  ResourceId Id;
  int HighestMip;
  int FirstSlice;
  FormatComponentType typeHint;
};

struct BoundVBuffer
{
  ResourceId Buffer;
  uint64_t ByteOffset;
  uint32_t ByteStride;
};

struct VertexInputAttribute
{
  QString Name;
  int VertexBuffer;
  uint32_t RelativeByteOffset;
  bool PerInstance;
  int InstanceRate;
  ResourceFormat Format;
  PixelValue GenericValue;
  bool Used;
};

struct Viewport
{
  float x, y, width, height;
};

class CommonPipelineState
{
public:
  CommonPipelineState() {}
  void SetStates(APIProperties props, D3D11PipelineState *d3d11, D3D12PipelineState *d3d12,
                 GLPipelineState *gl, VulkanPipelineState *vk)
  {
    m_APIProps = props;
    m_D3D11 = d3d11;
    m_D3D12 = d3d12;
    m_GL = gl;
    m_Vulkan = vk;
  }

  GraphicsAPI DefaultType = eGraphicsAPI_D3D11;

  bool LogLoaded()
  {
    return m_D3D11 != NULL || m_D3D12 != NULL || m_GL != NULL || m_Vulkan != NULL;
  }

  bool IsLogD3D11()
  {
    return LogLoaded() && m_APIProps.pipelineType == eGraphicsAPI_D3D11 && m_D3D11 != NULL;
  }

  bool IsLogD3D12()
  {
    return LogLoaded() && m_APIProps.pipelineType == eGraphicsAPI_D3D12 && m_D3D12 != NULL;
  }

  bool IsLogGL()
  {
    return LogLoaded() && m_APIProps.pipelineType == eGraphicsAPI_OpenGL && m_GL != NULL;
  }

  bool IsLogVK()
  {
    return LogLoaded() && m_APIProps.pipelineType == eGraphicsAPI_Vulkan && m_Vulkan != NULL;
  }

  // add a bunch of generic properties that people can check to save having to see which pipeline
  // state
  // is valid and look at the appropriate part of it
  bool IsTessellationEnabled()
  {
    if(LogLoaded())
    {
      if(IsLogD3D11())
        return m_D3D11 != NULL && m_D3D11->m_HS.Shader != ResourceId();

      if(IsLogD3D12())
        return m_D3D12 != NULL && m_D3D12->m_HS.Shader != ResourceId();

      if(IsLogGL())
        return m_GL != NULL && m_GL->m_TES.Shader != ResourceId();

      if(IsLogVK())
        return m_Vulkan != NULL && m_Vulkan->TES.Shader != ResourceId();
    }

    return false;
  }

  bool SupportsResourceArrays() { return LogLoaded() && IsLogVK(); }
  bool SupportsBarriers() { return LogLoaded() && (IsLogVK() || IsLogD3D12()); }
  // whether or not the PostVS data is aligned in the typical fashion
  // ie. vectors not crossing float4 boundaries). APIs that use stream-out
  // or transform feedback have tightly packed data, but APIs that rewrite
  // shaders to dump data might have these alignment requirements
  bool HasAlignedPostVSData() { return LogLoaded() && IsLogVK(); }
  QString GetImageLayout(ResourceId id);
  QString Abbrev(ShaderStageType stage);
  QString OutputAbbrev();

  Viewport GetViewport(int index);
  ShaderBindpointMapping GetBindpointMapping(ShaderStageType stage);
  ShaderReflection *GetShaderReflection(ShaderStageType stage);
  QString GetShaderEntryPoint(ShaderStageType stage);
  ResourceId GetShader(ShaderStageType stage);
  QString GetShaderName(ShaderStageType stage);
  void GetIBuffer(ResourceId &buf, uint64_t &ByteOffset);
  bool IsStripRestartEnabled();
  uint32_t GetStripRestartIndex(uint32_t indexByteWidth);
  QVector<BoundVBuffer> GetVBuffers();
  QVector<VertexInputAttribute> GetVertexInputs();
  void GetConstantBuffer(ShaderStageType stage, uint32_t BufIdx, uint32_t ArrayIdx, ResourceId &buf,
                         uint64_t &ByteOffset, uint64_t &ByteSize);
  QMap<BindpointMap, QVector<BoundResource>> GetReadOnlyResources(ShaderStageType stage);
  QMap<BindpointMap, QVector<BoundResource>> GetReadWriteResources(ShaderStageType stage);
  BoundResource GetDepthTarget();
  QVector<BoundResource> GetOutputTargets();

private:
  D3D11PipelineState *m_D3D11 = NULL;
  D3D12PipelineState *m_D3D12 = NULL;
  GLPipelineState *m_GL = NULL;
  VulkanPipelineState *m_Vulkan = NULL;
  APIProperties m_APIProps;

  const D3D11PipelineState::ShaderStage &GetD3D11Stage(ShaderStageType stage)
  {
    if(stage == eShaderStage_Vertex)
      return m_D3D11->m_VS;
    if(stage == eShaderStage_Domain)
      return m_D3D11->m_DS;
    if(stage == eShaderStage_Hull)
      return m_D3D11->m_HS;
    if(stage == eShaderStage_Geometry)
      return m_D3D11->m_GS;
    if(stage == eShaderStage_Pixel)
      return m_D3D11->m_PS;
    if(stage == eShaderStage_Compute)
      return m_D3D11->m_CS;

    qCritical() << "Error - invalid stage " << (int)stage;
    return m_D3D11->m_CS;
  }

  const D3D12PipelineState::ShaderStage &GetD3D12Stage(ShaderStageType stage)
  {
    if(stage == eShaderStage_Vertex)
      return m_D3D12->m_VS;
    if(stage == eShaderStage_Domain)
      return m_D3D12->m_DS;
    if(stage == eShaderStage_Hull)
      return m_D3D12->m_HS;
    if(stage == eShaderStage_Geometry)
      return m_D3D12->m_GS;
    if(stage == eShaderStage_Pixel)
      return m_D3D12->m_PS;
    if(stage == eShaderStage_Compute)
      return m_D3D12->m_CS;

    qCritical() << "Error - invalid stage " << (int)stage;
    return m_D3D12->m_CS;
  }

  const GLPipelineState::ShaderStage &GetGLStage(ShaderStageType stage)
  {
    if(stage == eShaderStage_Vertex)
      return m_GL->m_VS;
    if(stage == eShaderStage_Tess_Control)
      return m_GL->m_TCS;
    if(stage == eShaderStage_Tess_Eval)
      return m_GL->m_TES;
    if(stage == eShaderStage_Geometry)
      return m_GL->m_GS;
    if(stage == eShaderStage_Fragment)
      return m_GL->m_FS;
    if(stage == eShaderStage_Compute)
      return m_GL->m_CS;

    qCritical() << "Error - invalid stage " << (int)stage;
    return m_GL->m_CS;
  }

  const VulkanPipelineState::ShaderStage &GetVulkanStage(ShaderStageType stage)
  {
    if(stage == eShaderStage_Vertex)
      return m_Vulkan->VS;
    if(stage == eShaderStage_Tess_Control)
      return m_Vulkan->TCS;
    if(stage == eShaderStage_Tess_Eval)
      return m_Vulkan->TES;
    if(stage == eShaderStage_Geometry)
      return m_Vulkan->GS;
    if(stage == eShaderStage_Fragment)
      return m_Vulkan->FS;
    if(stage == eShaderStage_Compute)
      return m_Vulkan->CS;

    qCritical() << "Error - invalid stage " << (int)stage;
    return m_Vulkan->CS;
  }
};