UnrealEngineUWP/Engine/Source/Developer/MaterialBaking/Public/MaterialBakingStructures.h

// Copyright Epic Games, Inc. All Rights Reserved.

#pragma once

#include "Math/IntPoint.h"
#include "SceneTypes.h"
#include "LightMap.h"
#include "MaterialPropertyEx.h"

class UMaterialInterface;
struct FMeshDescription;

/** Structure containing information about the material which is being baked out */
struct FMaterialData
{
	FMaterialData()
		: Material(nullptr)
		, bPerformBorderSmear(true)
		, bTangentSpaceNormal(false)
	{}

	/** Material to bake out */
	UMaterialInterface* Material;
	/** Properties and the texture size at which they should be baked out */
	TMap<EMaterialProperty, FIntPoint> PropertySizes;
	/** Whether to smear borders after baking */
	bool bPerformBorderSmear;
	/** Whether to transform normals from world-space to tangent-space (does nothing if material already uses tangent-space normals) */
	bool bTangentSpaceNormal;
};

/** Structure containing extended information about the material and properties which is being baked out */
struct FMaterialDataEx
{
	FMaterialDataEx()
		: Material(nullptr)
		, bPerformBorderSmear(true)
		, bTangentSpaceNormal(false)
	{}

	/** Material to bake out */
	UMaterialInterface* Material;
	/** Extended properties and the texture size at which they should be baked out */
	TMap<FMaterialPropertyEx, FIntPoint> PropertySizes;
	/** Whether to smear borders after baking */
	bool bPerformBorderSmear;
	/** Whether to transform normals from world-space to tangent-space (does nothing if material already uses tangent-space normals) */
	bool bTangentSpaceNormal;
};

struct FMeshData
{
	FMeshData()
		: MeshDescription(nullptr), Mesh(nullptr), bMirrored(false), VertexColorHash(0), TextureCoordinateIndex(0), LightMapIndex(0), LightMap(nullptr), LightmapResourceCluster(nullptr)
	{}

	/** Ptr to raw mesh data to use for baking out the material data, if nullptr a standard quad is used */
	const FMeshDescription* MeshDescription;

	/** Ptr to original static mesh this mesh data came from */
	const UStaticMesh* Mesh;

	/** Transform determinant used to detect mirroring */
	bool bMirrored;

	/** A hash of the vertex color buffer for the rawmesh */
	uint32 VertexColorHash;

	/** Material indices to test the Raw Mesh data against, ensuring we only bake out triangles which use the currently baked out material */
	TArray<int32> MaterialIndices;

	/** Set of custom texture coordinates which ensure that the material is baked out with unique/non-overlapping positions */
	TArray<FVector2D> CustomTextureCoordinates;

	/** Box which's space contains the UV coordinates used to bake out the material */
	FBox2D TextureCoordinateBox;
	
	/** Specific texture coordinate index to use as texture coordinates to bake out the material (is overruled if CustomTextureCoordinates contains any data) */
	int32 TextureCoordinateIndex;

	/** Light map index used to retrieve the light-map UVs from RawMesh */
	int32 LightMapIndex;

	/** Reference to the lightmap texture part of the level in the currently being baked out mesh instance data is resident */
	FLightMapRef LightMap;

	/** Pointer to the LightmapResourceCluster to be passed on the the LightCacheInterface when baking */
	const FLightmapResourceCluster* LightmapResourceCluster;
};

/** Structure containing data being processed while baking out materials*/
struct FBakeOutput
{
	FBakeOutput()
		: EmissiveScale(1.0f)
	{}

	/** Contains the resulting texture data for baking out a material's property */
	TMap<EMaterialProperty, TArray<FColor>> PropertyData;

	/** Contains the resulting texture size for baking out a material's property */
	TMap<EMaterialProperty, FIntPoint> PropertySizes;

	/** Contains the resulting HDR texture data for baking out a material's property, may be empty */
	TMap<EMaterialProperty, TArray<FFloat16Color>> HDRPropertyData;

	/** Scale used to allow having wide ranges of emissive values in the source materials, the final proxy material will use this value to scale the emissive texture's pixel values */
	float EmissiveScale;
};

/** Structure containing extended data being processed while baking out materials*/
struct FBakeOutputEx
{
	FBakeOutputEx()
		: EmissiveScale(1.0f)
	{}

	/** Contains the resulting texture data for baking out a extened material's property */
	TMap<FMaterialPropertyEx, TArray<FColor>> PropertyData;

	/** Contains the resulting texture size for baking out a extened material's property */
	TMap<FMaterialPropertyEx, FIntPoint> PropertySizes;

	/** Contains the resulting HDR texture data for baking out a material's property, may be empty */
	TMap<FMaterialPropertyEx, TArray<FFloat16Color>> HDRPropertyData;

	/** Scale used to allow having wide ranges of emissive values in the source materials, the final proxy material will use this value to scale the emissive texture's pixel values */
	float EmissiveScale;
};