Material Class Reference

Represent a surface material, including textures describing the surface parameters. More...

#include <Material.hpp>

Public Types
enum	Type : int {   None = 0 , Regular , Parallax , Clearcoat ,   Anisotropic , Sheen , Iridescent , Subsurface ,   Emissive , Transparent , TransparentIrid }
	Type of shading/effects. More...

Public Member Functions
	Material ()=default
	Material (Type type)
void	addTexture (const Texture *infos)
void	addParameter (const glm::vec4 &param)
const std::vector< const Texture * > &	textures () const
const std::vector< glm::vec4 > &	parameters () const
const Type &	type () const
bool	twoSided () const
bool	masked () const
const std::string &	name () const
bool	decode (const KeyValues &params, Storage options)
virtual KeyValues	encode () const
virtual	~Material ()=default
	Material (const Material &)=delete
Material &	operator= (const Material &)=delete
	Material (Material &&)=default
Material &	operator= (Material &&)=default

Protected Attributes
std::vector< const Texture * >	_textures
	Textures used by the material.
std::vector< glm::vec4 >	_parameters
	Parameters used by the material.
std::string	_name
	The material name.
Type	_material = Type::None
	The material type.
bool	_twoSided = false
	Should faces of objects be visible from the two sides.
bool	_masked = false
	The material uses alpha cutout.

Detailed Description

Represent a surface material, including textures describing the surface parameters.

Different predefined materials can be used, with predefined parameters stored in ordered textures.

Regular: GGX material, dielectric or conductor.

• Texture 0: Albedo, alpha cutout (RGBA8)
• Texture 1: Normal map (RGB8)
• Texture 2: Roughness, metalness, ambient occlusion (RGB8)

Parallax: GGX material with parallax occlusion mapping.

• Texture 0: Albedo, alpha cutout (RGBA8)
• Texture 1: Normal map (RGB8)
• Texture 2: Roughness, metalness, ambient occlusion (RGB8)
• Texture 3: Depth (R8)

Clearcoat: GGX material with an additional dielectric transparent layer overlayed top.

• Texture 0: Albedo, alpha cutout (RGBA8)
• Texture 1: Normal map (RGB8)
• Texture 2: Roughness, metalness, ambient occlusion (RGB8)
• Texture 3: Clear coat strength, clear coat roughness (RG8)

Anisotropic: GGX material with anisotropic specular behavior.

• Texture 0: Albedo, alpha cutout (RGBA8)
• Texture 1: Normal map (RGB8)
• Texture 2: Roughness, metalness, ambient occlusion (RGB8)
• Texture 3: Anisotropy direction (2D unit vector), anisotropy strength (scaled to [-1,1] parameterization) (RGB8)

Sheen: Cloth-like material, assumed to be a dielectric.

• Texture 0: Albedo, alpha cutout (RGBA8)
• Texture 1: Normal map (RGB8)
• Texture 2: Roughness, sheen strength, ambient occlusion (RGB8)
• Texture 3: Sheen color, sheen roughness (RGBA8)

Iridescent: GGX material with thin-film interferences on the surface.

• Texture 0: Albedo, alpha cutout (RGBA8)
• Texture 1: Normal map (RGB8)
• Texture 2: Roughness, metalness, ambient occlusion (RGB8)
• Texture 3: Thin film refraction index (scaled to [1.2,2.4]), thin film thickness (scaled to [300nm,800nm]) (RG8)

Subsurface: Dieletric GGX material with subsurface scattering/transmission.

• Texture 0: Albedo, alpha cutout (RGBA8)
• Texture 1: Normal map (RGB8)
• Texture 2: Roughness, metalness, ambient occlusion, thickness (RGBA8)
• Texture 3: Subsurface color, subsurface roughness (RGBA8)

Emissive: light emitting material, assume to be optionally covered by a transparent dielectric

• Texture 0: Emissive color, alpha cutout (RGBA32)
• Texture 1: Normal map (RGB8)
• Texture 2: Roughness (R8)

Transparent: transparent object with a dieletric surface

• Texture 0: Albedo, opacity (RGBA8)
• Texture 1: Normal map (RGB8)
• Texture 2: Roughness, unused, ambient occlusion (RGB8)

TransparentIrid: transparent object with a dieletric surface and thin film interferences

• Texture 0: Albedo, opacity (RGBA8)
• Texture 1: Normal map (RGB8)
• Texture 2: Roughness, unused, ambient occlusion (RGB8)
• Texture 3: Thin film refraction index (scaled to [1.2,2.4]), thin film thickness (scaled to [300nm,800nm]) (RG8)

None: any parameters can be specified depending on the shader used in the renderer code.

Member Enumeration Documentation

Type

enum Material::Type : int

Type of shading/effects.

Enumerator
None	Any type of shading.
Regular	PBR shading.
Parallax	PBR with parallax mapping.
Clearcoat	PBR shading with an additional clear coat specular layer.
Anisotropic	PBR shading with an anisotropic BRDF.
Sheen	PBR shading with a sheen BRDF.
Iridescent	PBR shading with iridescent Fresnel.
Subsurface	PBR shading with subsurface scattering.
Emissive	Emissive objects (no diffuse shading).
Transparent	Transparent object.
TransparentIrid	Transparent object with iridescent Fresnel.

Constructor & Destructor Documentation

Material() [1/4]

Material::Material ( )

default

Constructor

Material() [2/4]

Material::Material

(

Type

type

)

Construct a new material.

Parameters

type	the type of shading and effects associated with this material

~Material()

virtual Material::~Material ( )

virtualdefault

Destructor.

Material() [3/4]

Material::Material ( const Material &  )

delete

Copy constructor.

Material() [4/4]

Material::Material ( Material &&  )

default

Move constructor.

Member Function Documentation

addParameter()

void Material::addParameter

(

const glm::vec4 &

param

)

Register a new parameter.

Parameters

param

the values to add

addTexture()

void Material::addTexture

(

const Texture *

infos

)

Register a texture.

Parameters

infos

the texture infos to add

decode()

bool Material::decode	(	const KeyValues &	params,
		Storage	options
	)

Setup a material parameters from a list of key-value tuples. The following keywords will be searched for:

type: materialtype
twosided: bool
masked: bool
textures:
    - texturetype: ...
    - ...
parameters:
   - R,G,B,A
   - ...

Parameters

params	the parameters tuple
options	data loading and storage options

Returns

decoding status

encode()

KeyValues Material::encode ( ) const

virtual

Generate a key-values representation of the material. See decode for the keywords and layout.

Returns

a tuple representing the material.

masked()

bool Material::masked ( ) const

inline

Should an alpha clip mask be applied when rendering the surface (for leaves or chains for instance).

Returns

a boolean denoting if masking should be applied

name()

const std::string & Material::name ( ) const

inline

Returns

the name of the material

operator=() [1/2]

Material & Material::operator= ( const Material &  )

delete

Copy assignment.

Returns

a reference to the material assigned to

operator=() [2/2]

Material & Material::operator= ( Material &&  )

default

Move assignment.

Returns

a reference to the material assigned to

parameters()

const std::vector< glm::vec4 > & Material::parameters ( ) const

inline

Parameters array getter.

Returns

a vector containing the parameters associated to the material

textures()

const std::vector< const Texture * > & Material::textures ( ) const

inline

Textures array getter.

Returns

a vector containing the textures associated to the material

twoSided()

bool Material::twoSided ( ) const

inline

Is the surface from both sides.

Returns

a boolean denoting if the surface has two sides

type()

const Type & Material::type ( ) const

inline

Type getter.

Returns

the type of material

Note

This can be used in different way by different applications.

---

The documentation for this class was generated from the following files:

• src/engine/scene/Material.hpp
• src/engine/scene/Material.cpp