Class Material
Defined in File Material.h
Inheritance Relationships
Derived Types
public csp::systems::AlphaVideoMaterial(Class AlphaVideoMaterial)public csp::systems::GLTFMaterial(Class GLTFMaterial)
Class Documentation
-
class Material
Base class for a material.
Subclassed by csp::systems::AlphaVideoMaterial, csp::systems::GLTFMaterial
Public Functions
-
const csp::common::String &GetName() const
Gets the user-defined name of the material.
- Returns
const common::String& : Returns the material name.
-
const csp::systems::EShaderType GetShaderType() const
Gets the shader type of the material.
- Returns
csp::systems::EShaderType : Returns the shader type.
-
const int GetVersion() const
Gets the version of the material.
- Returns
int : Returns the version of the material.
-
const csp::common::String &GetMaterialCollectionId() const
Gets the collection id for the material.
- Returns
const csp::common::String& : Returns the collection id.
-
const csp::common::String &GetMaterialId() const
Gets the id for the material.
- Returns
const csp::common::String& : Returns the material id.
-
Material(const csp::common::String &Name, const csp::common::String &MaterialCollectionId, const csp::common::String &MaterialId)
Constructs a material bound to an AssetCollection and Asset.
- Parameters
Name – const csp::common::String& : The name of the material.
MaterialCollectionId – const csp::common::String& : The asset collection which references the associated material asset.
MaterialId – const csp::common::String& : The asset where the material info is stored.
-
Material(const csp::common::String &Name, const csp::common::String &MaterialCollectionId, const csp::common::String &MaterialId, EShaderType Type, const int Version)
Constructs a versioned material bound to an AssetCollection and Asset.
- Parameters
Name – const csp::common::String& : The name of the material.
MaterialCollectionId – const csp::common::String& : The asset collection which references the associated material asset.
MaterialId – const csp::common::String& : The asset where the material info is stored.
Type – EShaderType : The material shader type.
Version – const int : The material version.
-
virtual ~Material() = default
-
Material() = default
Protected Functions
-
const csp::common::String &GetName() const