Material¶

class in InfEngine.core

Description¶

Pythonic wrapper around C++ InfMaterial.

description

Material defines the visual appearance of rendered geometry, controlling shading, color, textures, and render state. Each Material references a Shader program and provides a set of properties (uniforms) that feed into that shader.

Create materials with the factory methods Material.create_lit() for physically-based rendering or Material.create_unlit() for flat shading with no lighting calculations. Set uniform values through typed methods: set_color() for RGBA colors, set_float() for numeric parameters, set_texture_guid() for texture maps, and set_vector3() / set_vector4() for vector values.

Render state — such as culling mode, blend mode, depth testing, and surface type — is configured through dedicated properties. Materials are assigned to a MeshRenderer to take effect.

Constructors¶

Signature	Description
`Material.__init__(native: InfMaterial) → None`	Wrap an existing C++ InfMaterial.

constructors

Properties¶

Name	Type	Description
native	`InfMaterial`	The underlying C++ InfMaterial object. (read-only)
name	`str`	The display name of the material.
guid	`str`	The globally unique identifier for this material. (read-only)
render_queue	`int`	The render queue priority for draw order sorting.
shader_name	`str`	The name of the shader program used by this material.
vert_shader_name	`str`	The vertex shader name override.
frag_shader_name	`str`	The fragment shader name override.
is_builtin	`bool`	Whether this is a built-in engine material. (read-only)
render_state_overrides	`int`	Bitmask of render state overrides applied to this material.
cull_mode	`int`	The face culling mode (0=None, 1=Front, 2=Back).
depth_write_enable	`bool`	Whether depth buffer writing is enabled.
depth_test_enable	`bool`	Whether depth testing is enabled.
depth_compare_op	`int`	The depth comparison operator.
blend_enable	`bool`	Whether alpha blending is enabled.
surface_type	`str`	The surface type ('opaque' or 'transparent').
alpha_clip_enabled	`bool`	Whether alpha clipping (cutout) is enabled.
alpha_clip_threshold	`float`	The alpha value threshold for clipping.

properties

Public Methods¶

Method	Description
`dispose() → None`	Release the underlying native material resources.
`set_shader(shader_name: str) → None`	Set the shader used by this material.
`set_float(name: str, value: float) → None`	Set a float uniform property on the material.
`set_int(name: str, value: int) → None`	Set an integer uniform property on the material.
`set_color(name: str, r: float, g: float, b: float, a: float = ...) → None`	Set a color uniform property on the material.
`set_vector2(name: str, x: float, y: float) → None`	Set a 2D vector uniform property on the material.
`set_vector3(name: str, x: float, y: float, z: float) → None`	Set a 3D vector uniform property on the material.
`set_vector4(name: str, x: float, y: float, z: float, w: float) → None`	Set a 4D vector uniform property on the material.
`set_texture_guid(name: str, texture_guid: str) → None`	Assign a texture to a sampler slot by GUID.
`clear_texture(name: str) → None`	Remove the texture assigned to a sampler slot.
`get_float(name: str, default: float = ...) → float`	Get a float uniform property value.
`get_int(name: str, default: int = ...) → int`	Get an integer uniform property value.
`get_color(name: str) → Tuple[float, float, float, float]`	Get a color property as an (R, G, B, A) tuple.
`get_vector2(name: str) → Tuple[float, float]`	Get a 2D vector property as an (X, Y) tuple.
`get_vector3(name: str) → Tuple[float, float, float]`	Get a 3D vector property as an (X, Y, Z) tuple.
`get_vector4(name: str) → Tuple[float, float, float, float]`	Get a 4D vector property as an (X, Y, Z, W) tuple.
`get_texture(name: str) → Optional[str]`	Get the GUID of the texture assigned to a sampler slot.
`has_property(name: str) → bool`	Check whether a shader property exists on this material.
`get_property(name: str) → Any`	Get a shader property value by name.
`get_all_properties() → dict`	Get all shader properties as a dictionary.
`to_dict() → dict`	Serialize the material to a dictionary.
`save(file_path: str) → bool`	Save the material to a file.

public_methods

Static Methods¶

Method	Description
`static Material.create_lit(name: str = ...) → Material`	Create a new material with the default lit (PBR) shader.
`static Material.create_unlit(name: str = ...) → Material`	Create a new material with the unlit shader.
`static Material.from_native(native: InfMaterial) → Material`	Wrap an existing C++ InfMaterial instance.
`static Material.load(file_path: str) → Optional[Material]`	Load a material from a file path.
`static Material.get(name: str) → Optional[Material]`	Get a cached material by name.

static_methods

Operators¶

Method	Returns
`__repr__() → str`	`str`
`__eq__(other: object) → bool`	`bool`
`__hash__() → int`	`int`

operators

Example¶

example

from InfEngine import InfComponent
from InfEngine.resources import Material

class MaterialDemo(InfComponent):
    def start(self):
        # Create a lit (PBR) material
        mat = Material.create_lit()
        mat.set_color("_BaseColor", 1.0, 0.3, 0.3, 1.0)  # red tint
        mat.set_float("_Metallic", 0.0)
        mat.set_float("_Roughness", 0.4)

        # Apply to the renderer
        renderer = self.game_object.get_cpp_component("MeshRenderer")
        if renderer:
            renderer.render_material = mat

        # Create an unlit material for UI-like elements
        unlit = Material.create_unlit()
        unlit.set_color("_BaseColor", 0.0, 1.0, 0.0, 1.0)