src/dawn/native/RenderPipeline.h

// Copyright 2017 The Dawn & Tint Authors
//
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions are met:
//
// 1. Redistributions of source code must retain the above copyright notice, this
//    list of conditions and the following disclaimer.
//
// 2. Redistributions in binary form must reproduce the above copyright notice,
//    this list of conditions and the following disclaimer in the documentation
//    and/or other materials provided with the distribution.
//
// 3. Neither the name of the copyright holder nor the names of its
//    contributors may be used to endorse or promote products derived from
//    this software without specific prior written permission.
//
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
// AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
// IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
// DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
// FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
// DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
// SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
// CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
// OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

#ifndef SRC_DAWN_NATIVE_RENDERPIPELINE_H_
#define SRC_DAWN_NATIVE_RENDERPIPELINE_H_

#include <array>
#include <bitset>
#include <vector>

#include "src/dawn/common/ContentLessObjectCacheable.h"
#include "src/dawn/native/AttachmentState.h"
#include "src/dawn/native/Forward.h"
#include "src/dawn/native/ImmediatesLayout.h"
#include "src/dawn/native/IntegerTypes.h"
#include "src/dawn/native/Pipeline.h"
#include "src/dawn/native/dawn_platform.h"

namespace dawn::native {

enum class VertexFormatBaseType {
    Float,
    Uint,
    Sint,
};

struct VertexFormatInfo {
    uint32_t byteSize = 0;
    uint32_t componentCount = 0;
    VertexFormatBaseType baseType = VertexFormatBaseType::Float;
};

const VertexFormatInfo& GetVertexFormatInfo(wgpu::VertexFormat format);

class DeviceBase;

MaybeError ValidateRenderPipelineDescriptor(DeviceBase* device,
                                            const RenderPipelineDescriptor* descriptor);

std::vector<StageAndDescriptor> GetRenderStagesAndSetPlaceholderShader(
    DeviceBase* device,
    const RenderPipelineDescriptor* descriptor);

size_t IndexFormatSize(wgpu::IndexFormat format);

bool IsStripPrimitiveTopology(wgpu::PrimitiveTopology primitiveTopology);

struct VertexAttributeInfo {
    wgpu::VertexFormat format = static_cast<wgpu::VertexFormat>(0);
    uint64_t offset = 0;
    VertexAttributeLocation shaderLocation;
    VertexBufferSlot vertexBufferSlot;
};

struct VertexBufferInfo {
    uint64_t arrayStride = 0;
    wgpu::VertexStepMode stepMode = wgpu::VertexStepMode::Undefined;
    uint16_t usedBytesInStride = 0;
    // As indicated in the spec, the lastStride is max(attribute.offset +
    // sizeof(attribute.format)) for each attribute in the buffer[slot]
    uint64_t lastStride = 0;
};

class RenderPipelineBase : public PipelineBase,
                           public ContentLessObjectCacheable<RenderPipelineBase> {
  public:
    RenderPipelineBase(DeviceBase* device, const UnpackedPtr<RenderPipelineDescriptor>& descriptor);
    ~RenderPipelineBase() override;

    static Ref<RenderPipelineBase> MakeError(DeviceBase* device, StringView label);

    ObjectType GetType() const override;

    const RenderPipelineBase* AsRenderPipeline() const override { return this; }
    RenderPipelineBase* AsRenderPipeline() override { return this; }

    // Vertex getters
    const VertexAttributeMask& GetAttributeLocationsUsed() const;
    const VertexAttributeInfo& GetAttribute(VertexAttributeLocation location) const;
    const VertexBufferMask& GetVertexBuffersUsed() const;
    const VertexBufferMask& GetVertexBuffersUsedAsVertexBuffer() const;
    const VertexBufferMask& GetVertexBuffersUsedAsInstanceBuffer() const;
    const VertexBufferInfo& GetVertexBuffer(VertexBufferSlot slot) const;
    VertexBufferSlot GetVertexBufferCount() const;

    // Color attachment getters
    const ColorTargetState* GetColorTargetState(ColorAttachmentIndex attachmentSlot) const;
    ColorAttachmentMask GetColorAttachmentsMask() const;
    wgpu::TextureFormat GetColorAttachmentFormat(ColorAttachmentIndex attachment) const;

    // Primitive getters
    wgpu::PrimitiveTopology GetPrimitiveTopology() const;
    wgpu::IndexFormat GetStripIndexFormat() const;
    wgpu::CullMode GetCullMode() const;
    wgpu::FrontFace GetFrontFace() const;

    // Depth-stencil getters
    const DepthStencilState* GetDepthStencilState() const;
    bool HasDepthStencilAttachment() const;
    bool UsesStencil() const;
    wgpu::TextureFormat GetDepthStencilFormat() const;
    bool IsDepthBiasEnabled() const;
    int32_t GetDepthBias() const;
    float GetDepthBiasSlopeScale() const;
    float GetDepthBiasClamp() const;
    bool HasUnclippedDepth() const;

    // Multisample getters
    uint32_t GetSampleCount() const;
    uint32_t GetSampleMask() const;
    bool IsAlphaToCoverageEnabled() const;
    bool UseSampleRateShading() const;

    // Shader builtin getters
    bool WritesDepth() const;
    bool WritesStencil() const;
    bool UsesFragDepth() const;
    bool UsesFragPosition() const;
    bool UsesSampleIndex() const;
    bool UsesVertexIndex() const;
    bool UsesInstanceIndex() const;
    bool UsesFramebufferFetch() const;

    const AttachmentState* GetAttachmentState() const;

    // Functions necessary for the unordered_set<RenderPipelineBase*>-based cache.
    size_t ComputeContentHash() override;

    struct EqualityFunc {
        bool operator()(const RenderPipelineBase* a, const RenderPipelineBase* b) const;
    };

    static constexpr wgpu::TextureFormat kImplicitPLSSlotFormat = wgpu::TextureFormat::R32Uint;

  protected:
    void DestroyImpl(DestroyReason reason) override;

  private:
    RenderPipelineBase(DeviceBase* device, ObjectBase::ErrorTag tag, StringView label);

    MaybeError InitializeWithShaders() final;
    // Overridden by backends to perform their initialization steps.
    virtual MaybeError InitializeImpl() = 0;

    // Vertex state
    VertexBufferSlot mVertexBufferCount = {};
    VertexAttributeMask mAttributeLocationsUsed;
    PerVertexAttribute<VertexAttributeInfo> mAttributeInfos;
    VertexBufferMask mVertexBuffersUsed;
    VertexBufferMask mVertexBuffersUsedAsVertexBuffer;
    VertexBufferMask mVertexBuffersUsedAsInstanceBuffer;
    PerVertexBuffer<VertexBufferInfo> mVertexBufferInfos;

    // Attachments
    Ref<AttachmentState> mAttachmentState;
    PerColorAttachment<ColorTargetState> mTargets;
    PerColorAttachment<BlendState> mTargetBlend;

    // Other state
    PrimitiveState mPrimitive = {};
    DepthStencilState mDepthStencil = {};
    MultisampleState mMultisample = {};
    bool mWritesDepth = false;
    bool mWritesStencil = false;
    bool mUsesFragDepth = false;
    bool mUsesFragPosition = false;
    bool mUseSampleRateShading = false;
    bool mUsesSampleIndex = false;
    bool mUsesVertexIndex = false;
    bool mUsesInstanceIndex = false;
    bool mUsesFramebufferFetch = false;
};

}  // namespace dawn::native

#endif  // SRC_DAWN_NATIVE_RENDERPIPELINE_H_