/* * Copyright (C) 2018 The Android Open Source Project * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License. */ #include "common/arguments.h" #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include using namespace filament::math; using namespace filament; using namespace filamat; using namespace utils; static std::vector g_filenames; static std::map g_materialInstances; static std::unique_ptr g_meshSet; static const Material* g_material; static Entity g_light; constexpr int MAP_COUNT = 7; constexpr int MAP_COLOR = 0; constexpr int MAP_AO = 1; constexpr int MAP_ROUGHNESS = 2; constexpr int MAP_METALLIC = 3; constexpr int MAP_NORMAL = 4; constexpr int MAP_BENT_NORMAL = 5; constexpr int MAP_HEIGHT = 6; struct PbrMap { const char* suffix; const char* parameterName; bool sRGB; Texture* texture; }; static std::array g_maps = { PbrMap { "color", "baseColorMap", true, nullptr }, PbrMap { "ao", "aoMap", false, nullptr }, PbrMap { "roughness", "roughnessMap", false, nullptr }, PbrMap { "metallic", "metallicMap", false, nullptr }, PbrMap { "normal", "normalMap", false, nullptr }, PbrMap { "bentNormal", "bentNormalMap", false, nullptr }, PbrMap { "height", "heightMap", false, nullptr }, }; static Config g_config; static struct PbrConfig { std::string materialDir; bool clearCoat = false; bool anisotropy = false; } g_pbrConfig; static void printUsage(char* name) { std::string const exec_name(Path(name).getName()); std::string usage( "SAMPLE_PBR is an example of loading PBR assets with base color + packed metallic/roughness\n" "Usage:\n" " SAMPLE_PBR [options] \n" "Options:\n" " --help, -h\n" " Prints this message\n\n" "API_USAGE" " --ibl=, -i \n" " Applies an IBL generated by cmgen's deploy option\n\n" " --split-view, -v\n" " Splits the window into 4 views\n\n" " --scale=[number], -s [number]\n" " Applies uniform scale\n\n" " --material=, -m \n" " Directory containing the textures named _*.png where * is:\n" " - AO\n" " - Color\n" " - Metallic\n" " - Normal\n" " - BentNormal\n" " - Roughness\n" " - Height\n" " All textures are optional" "\n" " --clear-coat, -c\n" " Add a clear coat layer to the material\n\n" " --anisotropy, -A\n" " Enable anisotropy on the material\n\n" ); const std::string from("SAMPLE_PBR"); for (size_t pos = usage.find(from); pos != std::string::npos; pos = usage.find(from, pos)) { usage.replace(pos, from.length(), exec_name); } const std::string apiUsage("API_USAGE"); for (size_t pos = usage.find(apiUsage); pos != std::string::npos; pos = usage.find(apiUsage, pos)) { usage.replace(pos, apiUsage.length(), samples::getBackendAPIArgumentsUsage()); } std::cout << usage; } static int handleCommandLineArgments(int argc, char* argv[], Config* config) { static constexpr const char* OPTSTR = "ha:i:vs:m:cA"; static const struct option OPTIONS[] = { { "help", no_argument, nullptr, 'h' }, { "api", required_argument, nullptr, 'a' }, { "ibl", required_argument, nullptr, 'i' }, { "split-view", no_argument, nullptr, 'v' }, { "scale", required_argument, nullptr, 's' }, { "material", required_argument, nullptr, 'm' }, { "clear-coat", no_argument, nullptr, 'c' }, { "anisotropy", no_argument, nullptr, 'A' }, { nullptr, 0, nullptr, 0 } // termination of the option list }; int opt; int option_index = 0; while ((opt = getopt_long(argc, argv, OPTSTR, OPTIONS, &option_index)) >= 0) { std::string const arg(optarg ? optarg : ""); switch (opt) { default: case 'h': printUsage(argv[0]); exit(0); case 'a': config->backend = samples::parseArgumentsForBackend(arg); break; case 'i': config->iblDirectory = arg; break; case 's': try { config->scale = std::stof(arg); } catch (std::invalid_argument& e) { // keep scale of 1.0 } catch (std::out_of_range& e) { // keep scale of 1.0 } break; case 'v': config->splitView = true; break; case 'm': g_pbrConfig.materialDir = arg; break; case 'c': g_pbrConfig.clearCoat = true; break; case 'A': g_pbrConfig.anisotropy = true; break; } } return optind; } static void cleanup(Engine* engine, View*, Scene*) { for (auto& item : g_materialInstances) { auto materialInstance = item.second; engine->destroy(materialInstance); } g_meshSet.reset(nullptr); engine->destroy(g_material); for (const auto& map : g_maps) { engine->destroy(map.texture); } EntityManager& em = EntityManager::get(); engine->destroy(g_light); em.destroy(g_light); } bool loadTexture(Engine* engine, const std::string& filePath, Texture** map, bool sRGB = true) { if (!filePath.empty()) { Path const path(filePath); if (path.exists()) { int w, h, n; unsigned char* data = stbi_load(path.getAbsolutePath().c_str(), &w, &h, &n, 3); if (data != nullptr) { *map = Texture::Builder() .width(uint32_t(w)) .height(uint32_t(h)) .levels(0xff) .format(sRGB ? Texture::InternalFormat::SRGB8 : Texture::InternalFormat::RGB8) .usage(Texture::Usage::DEFAULT | Texture::Usage::GEN_MIPMAPPABLE) .build(*engine); Texture::PixelBufferDescriptor buffer(data, size_t(w * h * 3), Texture::Format::RGB, Texture::Type::UBYTE, (Texture::PixelBufferDescriptor::Callback) &stbi_image_free); (*map)->setImage(*engine, 0, std::move(buffer)); (*map)->generateMipmaps(*engine); return true; } else { std::cout << "The texture " << path << " could not be loaded" << std::endl; } } } return false; } static void setup(Engine* engine, View* view, Scene* scene) { Path const path(g_pbrConfig.materialDir); std::string const name(path.getName()); view->setAmbientOcclusionOptions({ .radius = 0.01f, .bilateralThreshold = 0.005f, .quality = View::QualityLevel::ULTRA, .lowPassFilter = View::QualityLevel::MEDIUM, .upsampling = View::QualityLevel::HIGH, .enabled = true }); bool hasUV = false; for (auto& map: g_maps) { if (!loadTexture(engine, path.concat(name + "_" + map.suffix + ".png"), &map.texture, map.sRGB)) { if (!loadTexture(engine, path.concat(std::string(map.suffix) + ".png"), &map.texture, map.sRGB)) { std::cout << "The texture " << map.suffix << " does not exist" << std::endl; } } if (map.texture != nullptr) hasUV = true; } bool const hasBaseColorMap = g_maps[MAP_COLOR].texture != nullptr; bool const hasMetallicMap = g_maps[MAP_METALLIC].texture != nullptr; bool const hasRoughnessMap = g_maps[MAP_ROUGHNESS].texture != nullptr; bool const hasAOMap = g_maps[MAP_AO].texture != nullptr; bool const hasNormalMap = g_maps[MAP_NORMAL].texture != nullptr; bool const hasBentNormalMap = g_maps[MAP_BENT_NORMAL].texture != nullptr; bool const hasHeightMap = g_maps[MAP_HEIGHT].texture != nullptr; std::string shader = R"SHADER( void material(inout MaterialInputs material) { )SHADER"; if (hasUV) { shader += R"SHADER( vec2 uv0 = getUV0(); )SHADER"; } if (hasHeightMap) { // Parallax Occlusion Mapping shader += R"SHADER( vec2 uvDx = dFdx(uv0); vec2 uvDy = dFdy(uv0); mat3 tangentFromWorld = transpose(getWorldTangentFrame()); vec3 v = tangentFromWorld * getWorldViewVector(); float minLayers = 8.0; float maxLayers = 48.0; float numLayers = mix(maxLayers, minLayers, dot(getWorldGeometricNormalVector(), getWorldViewVector())); float heightScale = 0.05; float layerDepth = 1.0 / numLayers; float currLayerDepth = 0.0; vec2 deltaUV = v.xy * heightScale / (v.z * numLayers); vec2 currUV = uv0; float height = 1.0 - textureGrad(materialParams_heightMap, currUV, uvDx, uvDy).r; for (int i = 0; i < int(numLayers); i++) { currLayerDepth += layerDepth; currUV -= deltaUV; height = 1.0 - textureGrad(materialParams_heightMap, currUV, uvDx, uvDy).r; if (height < currLayerDepth) { break; } } vec2 prevUV = currUV + deltaUV; float nextDepth = height - currLayerDepth; float prevDepth = 1.0 - textureGrad(materialParams_heightMap, prevUV, uvDx, uvDy).r - currLayerDepth + layerDepth; uv0 = mix(currUV, prevUV, nextDepth / (nextDepth - prevDepth)); )SHADER"; } if (hasNormalMap) { shader += R"SHADER( material.normal = texture(materialParams_normalMap, uv0).xyz * 2.0 - 1.0; material.normal.y *= -1.0; )SHADER"; } if (hasBentNormalMap) { shader += R"SHADER( material.bentNormal = texture(materialParams_bentNormalMap, uv0).xyz * 2.0 - 1.0; material.bentNormal.y *= -1.0; )SHADER"; } shader += R"SHADER( prepareMaterial(material); )SHADER"; if (hasBaseColorMap) { shader += R"SHADER( material.baseColor.rgb = texture(materialParams_baseColorMap, uv0).rgb; )SHADER"; } else { shader += R"SHADER( material.baseColor.rgb = float3(0.5); )SHADER"; } if (hasMetallicMap) { shader += R"SHADER( material.metallic = texture(materialParams_metallicMap, uv0).r; )SHADER"; } else { shader += R"SHADER( material.metallic = 0.0; )SHADER"; } if (hasRoughnessMap) { shader += R"SHADER( material.roughness = texture(materialParams_roughnessMap, uv0).r; )SHADER"; } else { shader += R"SHADER( material.roughness = 0.4; )SHADER"; } if (hasAOMap) { shader += R"SHADER( material.ambientOcclusion = texture(materialParams_aoMap, uv0).r; )SHADER"; } else { shader += R"SHADER( material.ambientOcclusion = 1.0; )SHADER"; } if (g_pbrConfig.clearCoat) { shader += R"SHADER( material.clearCoat = 1.0; )SHADER"; } if (g_pbrConfig.anisotropy) { shader += R"SHADER( material.anisotropy = 0.7; )SHADER"; } shader += "}\n"; MaterialBuilder::init(); MaterialBuilder builder; builder .name("DefaultMaterial") .targetApi(MaterialBuilder::TargetApi::ALL) #ifndef NDEBUG .optimization(MaterialBuilderBase::Optimization::NONE) .generateDebugInfo(true) #endif .material(shader.c_str()) .multiBounceAmbientOcclusion(true) .specularAmbientOcclusion(MaterialBuilder::SpecularAmbientOcclusion::BENT_NORMALS) .shading(Shading::LIT); if (hasUV) { builder.require(VertexAttribute::UV0); } for (auto& map: g_maps) { if (map.texture != nullptr) { builder.parameter(map.parameterName, MaterialBuilder::SamplerType::SAMPLER_2D); } } Package const pkg = builder.build(engine->getJobSystem()); g_material = Material::Builder().package(pkg.getData(), pkg.getSize()).build(*engine); g_materialInstances["DefaultMaterial"] = g_material->createInstance(); TextureSampler sampler(TextureSampler::MinFilter::LINEAR_MIPMAP_LINEAR, TextureSampler::MagFilter::LINEAR, TextureSampler::WrapMode::REPEAT); sampler.setAnisotropy(8.0f); for (auto& map: g_maps) { if (map.texture != nullptr) { g_materialInstances["DefaultMaterial"]->setParameter( map.parameterName, map.texture, sampler); } } g_meshSet = std::make_unique(*engine); for (auto& filename : g_filenames) { g_meshSet->addFromFile(filename, g_materialInstances, true); } auto& rcm = engine->getRenderableManager(); auto& tcm = engine->getTransformManager(); for (auto renderable : g_meshSet->getRenderables()) { if (rcm.hasComponent(renderable)) { auto ti = tcm.getInstance(renderable); tcm.setTransform(ti, mat4f{ mat3f(g_config.scale), float3(0.0f, 0.0f, -4.0f) } * tcm.getWorldTransform(ti)); rcm.setReceiveShadows(rcm.getInstance(renderable), true); rcm.setCastShadows(rcm.getInstance(renderable), true); scene->addEntity(renderable); } } g_light = EntityManager::get().create(); LightManager::Builder(LightManager::Type::SUN) .color(Color::toLinear({0.98f, 0.92f, 0.89f})) .intensity(110000) .direction({0.6, -1, -0.8}) .castShadows(true) .build(*engine, g_light); scene->addEntity(g_light); } static void preRender(filament::Engine*, filament::View*, filament::Scene*, filament::Renderer* renderer) { // Without an IBL, we must clear the swapchain to black before each frame. renderer->setClearOptions({ .clearColor = { 0.5f, 0.5f, 0.5f, 1.0f }, .clear = !FilamentApp::get().getIBL() }); } int main(int argc, char* argv[]) { int const option_index = handleCommandLineArgments(argc, argv, &g_config); int const num_args = argc - option_index; if (num_args < 1) { printUsage(argv[0]); return 1; } for (int i = option_index; i < argc; i++) { utils::Path const filename = argv[i]; if (!filename.exists()) { std::cerr << "file " << argv[i] << " not found!" << std::endl; return 1; } g_filenames.push_back(filename); } g_config.title = "PBR"; FilamentApp& filamentApp = FilamentApp::get(); filamentApp.run(g_config, setup, cleanup, FilamentApp::ImGuiCallback(), preRender); return 0; }