BansheeEngine/Examples/Source/CustomMaterials/Main.cpp

// Framework includes
#include "BsApplication.h"
#include "Resources/BsResources.h"
#include "Resources/BsBuiltinResources.h"
#include "Material/BsMaterial.h"
#include "Components/BsCCamera.h"
#include "Components/BsCRenderable.h"
#include "Components/BsCSkybox.h"
#include "Components/BsCLight.h"
#include "GUI/BsCGUIWidget.h"
#include "GUI/BsGUIPanel.h"
#include "GUI/BsGUILayoutY.h"
#include "GUI/BsGUILabel.h"
#include "RenderAPI/BsRenderAPI.h"
#include "RenderAPI/BsRenderWindow.h"
#include "Scene/BsSceneObject.h"
#include "Renderer/BsRenderer.h"
#include "Material/BsShader.h"

// Example includes
#include "BsCameraFlyer.h"
#include "BsObjectRotator.h"
#include "BsExampleFramework.h"

////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
// This example renders an object using a variety of custom materials, showing you how you can customize the rendering of
// your objects if the built-in materials are not adequate. The example is structuraly very similar to the 
// PhysicallyBasedShading example, with the addition of custom materials. The most important part of this example are in
// fact the shaders that it uses, so make sure to also study the BSL code of the shaders we import below.
//
// The example first loads necessary resources, including a mesh and textures to use for rendering. Then it imports a set
// of custom shaders and creates a set of materials based on those shaders. It then proceeds to register the relevant keys 
// used for controling the camera and the rendered object, as well as a key to switch between different materials. It then
// sets up the 3D scene using the mesh, textures, and the initial material, as well as a camera, along with CameraFlyer and
// ObjectRotator components that allow the user to fly around the scene and rotate the 3D model. Finally it hooks up a 
// callback that switches between the materials when the user presses the relevant key, and adds a bit of GUI to let the
// user know which key to press.
////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
namespace bs
{
	UINT32 windowResWidth = 1280;
	UINT32 windowResHeight = 720;

	/** Container for all resources used by the example. */
	struct Assets
	{
		HMesh sphere;
		HTexture exampleAlbedoTex;
		HTexture exampleNormalsTex;
		HTexture exampleRoughnessTex;
		HTexture exampleMetalnessTex;
		HTexture skyTex;

		HMaterial standardMaterial;
		HMaterial vertexMaterial;
		HMaterial deferredSurfaceMaterial;
		HMaterial forwardMaterial;

		HShader deferredLightingShader;
	};

	Assets gAssets;

	/** Helper method that creates a material from the provided shader, and assigns the relevant PBR textures. */
	HMaterial createPBRMaterial(const HShader& shader, const Assets& assets)
	{
		HMaterial material = Material::create(shader);

		material->setTexture("gAlbedoTex", assets.exampleAlbedoTex);
		material->setTexture("gNormalTex", assets.exampleNormalsTex);
		material->setTexture("gRoughnessTex", assets.exampleRoughnessTex);
		material->setTexture("gMetalnessTex", assets.exampleMetalnessTex);

		return material;
	}

	/** Load the resources we'll be using throughout the example. */
	Assets loadAssets()
	{
		Assets assets;

		// Load a 3D model
		assets.sphere = ExampleFramework::loadMesh(ExampleMesh::Pistol, 10.0f);

		// Load PBR textures for the 3D model
		assets.exampleAlbedoTex = ExampleFramework::loadTexture(ExampleTexture::PistolAlbedo);
		assets.exampleNormalsTex = ExampleFramework::loadTexture(ExampleTexture::PistolNormal, false);
		assets.exampleRoughnessTex = ExampleFramework::loadTexture(ExampleTexture::PistolRoughness, false);
		assets.exampleMetalnessTex = ExampleFramework::loadTexture(ExampleTexture::PistolMetalness, false);

		// Create a set of materials we'll be using for rendering the object
		//// Create a standard PBR material
		HShader standardShader = gBuiltinResources().getBuiltinShader(BuiltinShader::Standard);
		assets.standardMaterial = createPBRMaterial(standardShader, assets);

		//// Create a material that overrides the vertex transform of the rendered model. This creates a wobble in the model
		//// geometry, but doesn't otherwise change the lighting properties (i.e. it still uses the PBR lighting model).
		HShader vertexShader = ExampleFramework::loadShader(ExampleShader::CustomVertex);
		assets.vertexMaterial = createPBRMaterial(vertexShader, assets);

		//// Create a material that overrides the surface data that gets used by the lighting evaluation. The material
		//// ignores the albedo texture provided, and instead uses a noise function to generate the albedo values.
		HShader deferredSurfaceShader = ExampleFramework::loadShader(ExampleShader::CustomDeferredSurface);
		assets.deferredSurfaceMaterial = createPBRMaterial(deferredSurfaceShader, assets);

		//// Create a material that overrides the lighting calculation by implementing a custom BRDF function, in this case
		//// using a basic Lambert BRDF. Note that lighting calculations for the deferred pipeline are done globally, so
		//// this material is created and used differently than others in this example. Instead of being assigned to 
		//// Renderable it is instead applied globally and will affect all objects using the deferred pipeline.
		assets.deferredLightingShader = ExampleFramework::loadShader(ExampleShader::CustomDeferredLighting);

		//// Creates a material that uses the forward rendering pipeline, while all previous materials have used the
		//// deferred rendering pipeline. Forward rendering is required when the shader is used for rendering transparent
		//// geometry, as this is not supported by the deferred pipeline. Forward rendering shader contains both the surface
		//// and lighting portions in a single shader (unlike with deferred). This custom shader overrides both, using a
		//// noise function for generating the surface albedo, and overriding the PBR BRDF with a basic Lambert BRDF.
		HShader forwardSurfaceAndLighting = ExampleFramework::loadShader(ExampleShader::CustomForward);
		assets.forwardMaterial = createPBRMaterial(forwardSurfaceAndLighting, assets);

		// Load an environment map
		assets.skyTex = ExampleFramework::loadTexture(ExampleTexture::EnvironmentPaperMill, false, true, true);

		return assets;
	}

	HRenderable gRenderable;
	HGUIWidget gGUI;
	UINT32 gMaterialIdx = 0;

	/** Set up the 3D object used by the example, and the camera to view the world through. */
	void setUp3DScene(const Assets& assets)
	{
		/************************************************************************/
		/* 									RENDERABLE                  		*/
		/************************************************************************/

		// Now we create a scene object that has a position, orientation, scale and optionally components to govern its 
		// logic. In this particular case we are creating a SceneObject with a Renderable component which will render a
		// mesh at the position of the scene object with the provided material.

		// Create new scene object at (0, 0, 0)
		HSceneObject pistolSO = SceneObject::create("Pistol");
		
		// Attach the Renderable component and hook up the mesh we loaded, and the material we created.
		gRenderable = pistolSO->addComponent<CRenderable>();
		gRenderable->setMesh(assets.sphere);
		gRenderable->setMaterial(assets.standardMaterial);

		// Add a rotator component so we can rotate the object during runtime
		pistolSO->addComponent<ObjectRotator>();

		/************************************************************************/
		/* 									LIGHT		                  		*/
		/************************************************************************/

		// Add a light so we can actually see the object
		HSceneObject lightSO = SceneObject::create("Light");

		HLight light = lightSO->addComponent<CLight>();
		light->setIntensity(100.0f);

		lightSO->setPosition(Vector3(1.0f, 0.5f, 0.0f));

		/************************************************************************/
		/* 									SKYBOX                       		*/
		/************************************************************************/

		// Add a skybox texture for sky reflections
		HSceneObject skyboxSO = SceneObject::create("Skybox");

		HSkybox skybox = skyboxSO->addComponent<CSkybox>();
		skybox->setTexture(assets.skyTex);

		/************************************************************************/
		/* 									CAMERA	                     		*/
		/************************************************************************/

		// In order something to render on screen we need at least one camera.

		// Like before, we create a new scene object at (0, 0, 0).
		HSceneObject sceneCameraSO = SceneObject::create("SceneCamera");

		// Get the primary render window we need for creating the camera. 
		SPtr<RenderWindow> window = gApplication().getPrimaryWindow();

		// Add a Camera component that will output whatever it sees into that window 
		// (You could also use a render texture or another window you created).
		HCamera sceneCamera = sceneCameraSO->addComponent<CCamera>();
		sceneCamera->getViewport()->setTarget(window);

		// Set up camera component properties

		// Set closest distance that is visible. Anything below that is clipped.
		sceneCamera->setNearClipDistance(0.005f);

		// Set farthest distance that is visible. Anything above that is clipped.
		sceneCamera->setFarClipDistance(1000);

		// Set aspect ratio depending on the current resolution
		sceneCamera->setAspectRatio(windowResWidth / (float)windowResHeight);

		// Add a CameraFlyer component that allows us to move the camera. See CameraFlyer for more information.
		sceneCameraSO->addComponent<CameraFlyer>();

		// Position and orient the camera scene object
		sceneCameraSO->setPosition(Vector3(2.0f, 1.0f, 2.0f));
		sceneCameraSO->lookAt(Vector3(-0.4f, 0, 0));

		/************************************************************************/
		/* 									GUI		                     		*/
		/************************************************************************/

		// Add a GUIWidget component we will use for rendering the GUI
		HSceneObject guiSO = SceneObject::create("GUI");
		gGUI = guiSO->addComponent<CGUIWidget>(sceneCamera);
	}
	
	/** Sets up or rebuilds any GUI elements used by the example. */
	void updateGUI()
	{
		GUIPanel* mainPanel = gGUI->getPanel();

		// Clear any existing elements, in case this is not the first time we're calling this function
		mainPanel->clear();

		// Set up strings to display
		String materialNameLookup[] =
		{
			"Standard",
			"Vertex wobble (Deferred)",
			"Surface noise (Deferred)",
			"Lambert BRDF (Deferred)",
			"Surface noise & Lambert BRDF (Forward)"
		};

		HString toggleString("Press Q to toggle between materials");
		HString currentMaterialString("Current material: {0}");

		currentMaterialString.setParameter(0, materialNameLookup[gMaterialIdx]);

		// Create a vertical GUI layout to align the two labels one below each other
		GUILayoutY* vertLayout = GUILayoutY::create();

		// Create a couple of GUI labels displaying the two strings we created above
		vertLayout->addNewElement<GUILabel>(toggleString);
		vertLayout->addNewElement<GUILabel>(currentMaterialString);

		// Register the layout with the main GUI panel, placing the layout in top left corner of the screen by default
		mainPanel->addElement(vertLayout);
	}

	/** Switches the material used for rendering the renderable object. */
	void switchMaterial()
	{
		HMaterial materialLookup[] =
		{
			gAssets.standardMaterial,
			gAssets.vertexMaterial,
			gAssets.deferredSurfaceMaterial,
			gAssets.forwardMaterial
		};

		gMaterialIdx = (gMaterialIdx + 1) % 5;

		// Apply the newly selected material
		switch(gMaterialIdx)
		{
		case 0:
			// Standard material, simply apply to renderable
			gRenderable->setMaterial(gAssets.standardMaterial);
			break;
		case 1:
			// Deferred vertex material, simply apply to renderable
			gRenderable->setMaterial(gAssets.vertexMaterial);
			break;
		case 2:
			// Deferred surface material, simply apply to renderable
			gRenderable->setMaterial(gAssets.deferredSurfaceMaterial);
			break;
		case 3:
			// Deferred lighting material. Apply it globally and reset the surface material back to standard.
			gRenderable->setMaterial(gAssets.standardMaterial);
			ct::gRenderer()->setGlobalShaderOverride(gAssets.deferredLightingShader.getInternalPtr());
			break;
		case 4:
			// Forward surface/lighting material. Simply apply to renderable. Also clear the deferred lighting material
			// override from the last material.
			gRenderable->setMaterial(gAssets.forwardMaterial);

			// Clear previous overrides
			const Vector<SubShader>& subShaders = gAssets.deferredLightingShader->getSubShaders();
			for(auto& entry : subShaders)
				ct::gRenderer()->setGlobalShaderOverride(entry.name, nullptr);

			break;
		}

		// Update GUI with current material name
		updateGUI();
	}

	/** Register relevant mouse/keyboard buttons used for controlling the example. */
	void setupInput()
	{
		// Registers a default set of input controls
		ExampleFramework::setupInputConfig();
	
		static VirtualButton SwitchMaterialButton("SwitchMaterial");

		// Register a key for toggling between different materials
		auto inputConfig = gVirtualInput().getConfiguration();
		inputConfig->registerButton("SwitchMaterial", BC_Q);

		gVirtualInput().onButtonUp.connect(
			[](const VirtualButton& btn, UINT32 deviceIdx)
		{
			if(btn == SwitchMaterialButton)
				switchMaterial();
		});
	}
}

/** Main entry point into the application. */
#if BS_PLATFORM == BS_PLATFORM_WIN32
#include <windows.h>

int CALLBACK WinMain(
	_In_  HINSTANCE hInstance,
	_In_  HINSTANCE hPrevInstance,
	_In_  LPSTR lpCmdLine,
	_In_  int nCmdShow
	)
#else
int main()
#endif
{
	using namespace bs;

	// Initializes the application and creates a window with the specified properties
	VideoMode videoMode(windowResWidth, windowResHeight);
	Application::startUp(videoMode, "Example", false);

	// Register buttons for controlling the example 
	setupInput();

	// Load a model and textures, create materials
	gAssets = loadAssets();

	// Set up the scene with an object to render and a camera
	setUp3DScene(gAssets);

	// Sets up any GUI elements used by the example.
	updateGUI();
	
	// Runs the main loop that does most of the work. This method will exit when user closes the main
	// window or exits in some other way.
	Application::instance().runMainLoop();

	// When done, clean up
	Application::shutDown();

	return 0;
}