Class Material

Represents a physically-based material for rendering surfaces.


						
				class Material
  : dlib.core.ownership.Owner;

Constructors

Name	Description
`this` (owner)	Constructs a new material with default parameters.

Fields

Name	Type	Description
`alphaTestThreshold`	`float`	Alpha test threshold (for masked transparency).
`baseColorFactor`	`dlib.image.color.Color4f`	Base color factor (albedo color). Used if `baseColorTexture` is not specified
`baseColorTexture`	`Texture`	Base color (albedo) texture.
`blendMode`	`int`	Blending mode (opaque, transparent, additive).
`celShading`	`bool`	Enables cel shading (pipeline-specific)
`colorWrite`	`bool`	If `false`, disables writing to the color buffer.
`depthWrite`	`bool`	If `false`, disables writing to the depth buffer.
`emissionEnergy`	`float`	Emission energy multiplier.
`emissionFactor`	`dlib.image.color.Color4f`	Emission factor. Multiplied with `emissionTexture` or used directly if `emissionTexture` is not specified
`emissionTexture`	`Texture`	Emission texture.
`heightFactor`	`float`	Height factor. Used if `heightTexture` is not specified
`heightTexture`	`Texture`	Height map texture (for parallax mapping).
`invertNormalY`	`bool`	If `true`, invert the Y channel of the normal map.
`linearColor`	`bool`	Does the baseColor in linear RGB space (true), or in sRGB (false)
`maskFactor`	`float`	Alpha mask factor (for terrain texturing layer material). Used if `maskTexture` is not specified
`maskTexture`	`Texture`	Alpha mask texture (for terrain texturing layer material).
`metallicFactor`	`float`	Surface metallic factor (0 = dielectric, 1 = metal). Used if `roughnessMetallicTexture` is not specified
`name`	`string`	The material name (for identification).
`normalFactor`	`dlib.math.vector.Vector!(float,3)`	Tangent-space normal vector. Used if `normalTexture` is not specified
`normalTexture`	`Texture`	Tangent-space normal map texture.
`opacity`	`float`	Opacity (alpha value, 0.0 = fully transparent, 1.0 = fully opaque).
`outputColor`	`bool`	If `false`, disables G-buffer color output.
`outputEmission`	`bool`	If `false`, disables G-buffer emission output.
`outputNormal`	`bool`	If `false`, disables G-buffer normal output.
`outputPBR`	`bool`	If `false`, disables G-buffer PBR output.
`parallaxBias`	`float`	Parallax mapping bias.
`parallaxMode`	`int`	Parallax mapping mode.
`parallaxScale`	`float`	Parallax mapping scale.
`rimLight`	`bool`	Enables rim light (pipeline-specific)
`roughnessFactor`	`float`	Surface roughness factor (0 = smooth, 1 = rough). Used if `roughnessMetallicTexture` is not specified
`roughnessMetallicTexture`	`Texture`	Roughness/metallic texture.
`shadeless`	`bool`	If `true`, disables all shading (renderer-specific option).
`shader`	`Shader`	Optional shader used for rendering this material.
`shadowFilter`	`int`	Shadow filtering mode.
`specularity`	`float`	Specularity factor.
`sphericalNormal`	`bool`	If `true`, use spherical normal mapping.
`subsurfaceScattering`	`float`	Subsurface scattering factor.
`sun`	`Light`	Optional main directional light (sun) affecting this material.
`textureMappingMode`	`int`	Texture mapping mode.
`textureTransformation`	`dlib.math.matrix.Matrix!(float,3L)`	Texture transformation matrix.
`useCulling`	`bool`	If `true`, enable backface culling.
`useFog`	`bool`	If `true`, the surface is fogged according to `Environment` object settings
`useShadows`	`bool`	If `true`, the surface receives shadows.
`textureOffsetInternal`	`dlib.math.vector.Vector!(float,2)`	Internal texture offset (for UV translation).
`textureScalingInternal`	`dlib.math.vector.Vector!(float,2)`	Internal texture scaling (for UV scaling).

Methods

Name	Description
`bind` (state)	Binds the material and sets all relevant graphics state for rendering.
`isTransparent` ()	Returns true if the material is transparent (blend mode is not opaque).
`setSprite` (uvSize, uvPosition)	Sets the sprite UV size and position for texture atlases.
`textureOffset` ()	Gets the current texture offset (UV translation).
`textureOffset` (v)	Sets the texture offset (UV translation).
`textureScale` ()	Gets the current texture scaling (UV scaling).
`textureScale` (s)	Sets the texture scaling (UV scaling).
`unbind` (state)	Unbinds the material and restores graphics state.

Description

The Material class encapsulates all parameters and resources needed for PBR, including textures, colors, blending, parallax, shadow filtering, and shader/material flags. Materials are used to control how surfaces are shaded, blended, and rendered in the engine.