Source/WebCore/Modules/webgpu/WHLSL/WHLSLPrepare.h

/*
 * Copyright (C) 2019 Apple Inc. All rights reserved.
 *
 * 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.
 *
 * THIS SOFTWARE IS PROVIDED BY APPLE INC. AND ITS 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 APPLE INC. OR ITS 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.
 */

#pragma once

#if ENABLE(WEBGPU)

#include "WHLSLError.h"
#include "WHLSLMangledNames.h"
#include "WHLSLPipelineDescriptor.h"
#include <wtf/UniqueRef.h>
#include <wtf/text/StringBuilder.h>
#include <wtf/text/WTFString.h>

namespace WebCore {

namespace WHLSL {

// Hide the contents of the ShaderModule. Clients of the compiler shouldn't care what's inside it.
struct ShaderModule;

}

}

namespace std {

template<> struct default_delete<WebCore::WHLSL::ShaderModule> {
    void operator()(WebCore::WHLSL::ShaderModule*) const;
};

}

namespace WebCore {

namespace WHLSL {

constexpr bool dumpMetalCompileTimes = false;

UniqueRef<ShaderModule> createShaderModule(const String& whlslSource);

struct RenderPrepareResult {
    StringBuilder metalSource;
    Metal::MangledFunctionName mangledVertexEntryPointName;
    Metal::MangledFunctionName mangledFragmentEntryPointName;
};
Expected<RenderPrepareResult, String> prepare(const ShaderModule& vertexShaderModule, const ShaderModule* fragmentShaderModule, RenderPipelineDescriptor&);

struct ComputeDimensions {
    unsigned width;
    unsigned height;
    unsigned depth;
};

struct ComputePrepareResult {
    StringBuilder metalSource;
    Metal::MangledFunctionName mangledEntryPointName;
    ComputeDimensions computeDimensions;
};
Expected<ComputePrepareResult, String> prepare(const ShaderModule&, ComputePipelineDescriptor&);

} // namespace WHLSL

} // namespace WebCore

#endif // ENABLE(WEBGPU)