rendering_engine::Material Class Reference

Represents a material instance with parameter values, texture bindings, and rendering configuration. More...

#include <material.hpp>

Public Member Functions
	Material (IRenderer *renderer, MaterialSettings matSettings)
	Constructs a new Material instance.
const MaterialSettings	GetMaterialSettings () const
	Returns the material's static settings (domain, blend mode, shading model, etc.).
void	InitializeRenderResources ()
	Initializes backend-specific GPU resources associated with this material.
void	ReleaseRenderResources ()
	Releases any GPU resources associated with this material.
PackedMaterialData	PackMaterialParameters ()
	Packs the current float/vector parameters into a binary buffer and layout metadata.
std::vector< std::string >	GetTextures () const
	Returns the list of texture names used by this material.
IMaterialRenderResources *	GetMaterialRenderResources () const
	Returns the backend-specific GPU handle of the material.
void	SetFloat (const std::string &name, float value)
	Sets a float parameter for the material.
void	SetVec3 (const std::string &name, glm::vec3 value)
	Sets a vec3 parameter for the material.
void	SetVec4 (const std::string &name, glm::vec4 value)
	Sets a vec4 parameter for the material.
void	AddTexture (const std::string &textureName)
	Adds a texture name to the material's list of used textures.

Detailed Description

Represents a material instance with parameter values, texture bindings, and rendering configuration.

This class encapsulates both the CPU-side representation of a material (its parameters and textures), and a pointer to its backend-specific GPU resource handle.

Definition at line 29 of file material.hpp.

Constructor & Destructor Documentation

Material()

rendering_engine::Material::Material ( IRenderer * renderer, MaterialSettings matSettings )

explicit

Constructs a new Material instance.

Parameters

renderer	Pointer to the rendering engine interface.
matSettings	Settings that define the material behavior.

Definition at line 10 of file material.cpp.

    :
    mRenderer(renderer),
    mMaterialSettings(matSettings),
    mGpuHandle(nullptr)
{}

Member Function Documentation

AddTexture()

void rendering_engine::Material::AddTexture

(

const std::string &

textureName

)

Adds a texture name to the material's list of used textures.

Parameters

textureName

Name of the texture (e.g., texture ID or resource name).

Definition at line 96 of file material.cpp.

{
    mTextures.push_back(textureName);
}

GetMaterialRenderResources()

IMaterialRenderResources * rendering_engine::Material::GetMaterialRenderResources

(

)

const

Returns the backend-specific GPU handle of the material.

Definition at line 76 of file material.cpp.

{
    return mGpuHandle.get();
}

GetMaterialSettings()

const MaterialSettings rendering_engine::Material::GetMaterialSettings

(

)

const

Returns the material's static settings (domain, blend mode, shading model, etc.).

Definition at line 16 of file material.cpp.

{
    return mMaterialSettings;
}

GetTextures()

std::vector< std::string > rendering_engine::Material::GetTextures

(

)

const

Returns the list of texture names used by this material.

Definition at line 71 of file material.cpp.

{
    return mTextures;
}

InitializeRenderResources()

void rendering_engine::Material::InitializeRenderResources

(

)

Initializes backend-specific GPU resources associated with this material.

Must be called after construction and before rendering.

Definition at line 20 of file material.cpp.

{
    mGpuHandle = std::unique_ptr<IMaterialRenderResources>(mRenderer->ProvideMaterialRenderResources());
    mGpuHandle->Initialize(this);
}

PackMaterialParameters()

PackedMaterialData rendering_engine::Material::PackMaterialParameters

(

)

Packs the current float/vector parameters into a binary buffer and layout metadata.

This buffer can be uploaded to the GPU as a uniform buffer or push constants.

Returns

PackedMaterialData Struct containing binary data and parameter layout info.

Definition at line 31 of file material.cpp.

{
    PackedMaterialData result;
    size_t currentOffset = 0;
 
    // floats
    for (const auto& [name, value] : mFloatParameters) 
    {
        size_t alignment = std140_align(MaterialParameterLayoutEntry::Type::Float);
        currentOffset = (currentOffset + alignment - 1) & ~(alignment - 1);
        result.layout.push_back({ name, currentOffset, 4, MaterialParameterLayoutEntry::Type::Float });
        result.buffer.resize(currentOffset + 4);
        std::memcpy(result.buffer.data() + currentOffset, &value, 4);
        currentOffset += 4;
    }
    // vec3
    for (const auto& [name, value] : mVec3Parameters) 
    {
        size_t alignment = std140_align(MaterialParameterLayoutEntry::Type::Vec3);
        currentOffset = (currentOffset + alignment - 1) & ~(alignment - 1);
        result.layout.push_back({ name, currentOffset, 12, MaterialParameterLayoutEntry::Type::Vec3 });
        result.buffer.resize(currentOffset + 16); // 16 bytes for std140 vec3
        std::memcpy(result.buffer.data() + currentOffset, &value, 12);
        // pad last 4 bytes with zero
        std::memset(result.buffer.data() + currentOffset + 12, 0, 4);
        currentOffset += 16;
    }
    // vec4
    for (const auto& [name, value] : mVec4Parameters) 
    {
        size_t alignment = std140_align(MaterialParameterLayoutEntry::Type::Vec4);
        currentOffset = (currentOffset + alignment - 1) & ~(alignment - 1);
        result.layout.push_back({ name, currentOffset, 16, MaterialParameterLayoutEntry::Type::Vec4 });
        result.buffer.resize(currentOffset + 16);
        std::memcpy(result.buffer.data() + currentOffset, &value, 16);
        currentOffset += 16;
    }
    return result;
}

ReleaseRenderResources()

void rendering_engine::Material::ReleaseRenderResources

(

)

Releases any GPU resources associated with this material.

Definition at line 25 of file material.cpp.

{
    mGpuHandle->Shutdown();
    mGpuHandle.release();
    mGpuHandle = nullptr;
}

SetFloat()

void rendering_engine::Material::SetFloat	(	const std::string &	name,
		float	value )

Sets a float parameter for the material.

Parameters

name	Name of the parameter.
value	Float value to set.

Definition at line 81 of file material.cpp.

{
    mFloatParameters[name] = value;
}

SetVec3()

void rendering_engine::Material::SetVec3	(	const std::string &	name,
		glm::vec3	value )

Sets a vec3 parameter for the material.

Parameters

name	Name of the parameter.
value	glm::vec3 value to set.

Definition at line 86 of file material.cpp.

{
    mVec3Parameters[name] = value;
}

SetVec4()

void rendering_engine::Material::SetVec4	(	const std::string &	name,
		glm::vec4	value )

Sets a vec4 parameter for the material.

Parameters

name	Name of the parameter.
value	glm::vec4 value to set.

Definition at line 91 of file material.cpp.

{
    mVec4Parameters[name] = value;
}

---

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

• material.hpp
• material.cpp