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

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),
    mParameterLayout(matSettings.parameterLayout)
{}

~Material()

rendering_engine::Material::~Material

(

)

Definition at line 17 of file material.cpp.

{
    if (mGpuHandle)
        ReleaseRenderResources();
}

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 112 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 87 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 22 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 82 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 26 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 39 of file material.cpp.

{
    PackedMaterialData result;
 
    if (!mParameterLayout)
        return result;
 
    // Preallocate full buffer size
    size_t totalSize = 0;
    for (const auto& e : *mParameterLayout)
        totalSize = std::max(totalSize, e.offset + e.size);
 
    result.buffer.resize(totalSize);
    result.layout = *mParameterLayout;
 
    for (const auto& entry : *mParameterLayout)
    {
        uint8_t* dst = result.buffer.data() + entry.offset;
 
        switch (entry.type)
        {
            case MaterialParameterLayoutEntry::Type::Float:
                std::memcpy(dst, &mFloatParameters[entry.name], 4);
                break;
 
            case MaterialParameterLayoutEntry::Type::Vec2:
                std::memcpy(dst, &mVec2Parameters[entry.name], 8);
                break;
 
            case MaterialParameterLayoutEntry::Type::Vec3:
                std::memcpy(dst, &mVec3Parameters[entry.name], 12);
                std::memset(dst + 12, 0, 4); // std140 padding
                break;
 
            case MaterialParameterLayoutEntry::Type::Vec4:
                std::memcpy(dst, &mVec4Parameters[entry.name], 16);
                break;
        }
    }
 
    return result;
}

ReleaseRenderResources()

void rendering_engine::Material::ReleaseRenderResources

(

)

Releases any GPU resources associated with this material.

Definition at line 31 of file material.cpp.

{
    if (!mGpuHandle)
        return;
 
    mGpuHandle->Shutdown();
    mGpuHandle.reset();
}

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 92 of file material.cpp.

{
    mFloatParameters[name] = value;
}

SetVec2()

void rendering_engine::Material::SetVec2	(	const std::string &	name,
		glm::vec2	value
	)

Sets a vec3 parameter for the material.

Parameters

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

Definition at line 97 of file material.cpp.

{
    mVec2Parameters[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 102 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 107 of file material.cpp.

{
    mVec4Parameters[name] = value;
}

---

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

• material.hpp
• material.cpp