public/lib/escher/third_party/granite/vk/shader_utils.h

/* Copyright (c) 2017 Hans-Kristian Arntzen
 *
 * 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.
 */

// Based on the following files from the Granite rendering engine:
// - vulkan/shader.cpp

#ifndef LIB_ESCHER_THIRD_PARTY_GRANITE_VK_SHADER_UTILS_H_
#define LIB_ESCHER_THIRD_PARTY_GRANITE_VK_SHADER_UTILS_H_

#include <array>

#include "lib/escher/util/enum_count.h"
#include "lib/escher/vk/shader_module.h"
#include "lib/escher/vk/shader_stage.h"

namespace escher {
namespace impl {

// Reflect on the provided SPIR-V to generate a ShaderModuleResourceLayout,
// which can be used by clients to automate some aspects of pipeline
// generation.
struct ShaderModuleResourceLayout;
void GenerateShaderModuleResourceLayoutFromSpirv(
    std::vector<uint32_t> spirv, ShaderStage stage,
    ShaderModuleResourceLayout* layout_out);

// Generate a PipelineLayoutSpec using each non-null ShaderStage's
// ShaderModuleResourceLayout.
struct PipelineLayoutSpec;
void GeneratePipelineLayoutSpec(
    const std::array<ShaderModulePtr, EnumCount<ShaderStage>()>& shader_modules,
    PipelineLayoutSpec* spec_out);

}  // namespace impl
}  // namespace escher

#endif  // LIB_ESCHER_THIRD_PARTY_GRANITE_VK_SHADER_UTILS_H_