Skip to main content

MaterialShaderPropertiesOverride Struct

Configuration container for overriding specific material properties. More...

Declaration​

struct helios::rendering::material::MaterialShaderPropertiesOverride { ... }

Public Member Functions Index​

voidwriteUniformValues (helios::rendering::shader::UniformValueMap &uniformValueMap) const noexcept

Writes this MaterialShaderPropertiesOverride's values into the given map. More...

Public Member Attributes Index​

std::optional< helios::math::vec4f >baseColor

Optional base color override for the material. More...

std::optional< float >roughness

Optional roughness override for the material (range [0, 1]). More...

Description​

Configuration container for overriding specific material properties.

This struct holds optional data values that can be used to override the default properties defined in MaterialShaderProperties used by a Material. Only properties for which a value is present will be applied as overrides.

This struct is mutable by design. Changing its values will impact all MaterialInstances using **this** instance.

Definition at line 29 of file MaterialShaderPropertiesOverride.ixx.

Public Member Functions​

writeUniformValues()​

void helios::rendering::material::MaterialShaderPropertiesOverride::writeUniformValues (helios::rendering::shader::UniformValueMap & uniformValueMap)
 inline noexcept

Writes this MaterialShaderPropertiesOverride's values into the given map.

This method is typically called **after** the Material's base properties were written into the map.

Parameters
uniformValueMap

Target map receiving the uniform values.

Definition at line 50 of file MaterialShaderPropertiesOverride.ixx.

50 void writeUniformValues(helios::rendering::shader::UniformValueMap& uniformValueMap) const noexcept {
51
52 if (baseColor) {
53 uniformValueMap.set(helios::rendering::shader::UniformSemantics::MaterialBaseColor, *baseColor);
54 }
55
56 if (roughness) {
57 uniformValueMap.set(helios::rendering::shader::UniformSemantics::MaterialRoughness, *roughness);
58 }
59 }

References baseColor, helios::rendering::shader::MaterialBaseColor, helios::rendering::shader::MaterialRoughness and roughness.

Public Member Attributes​

baseColor​

std::optional<helios::math::vec4f> helios::rendering::material::MaterialShaderPropertiesOverride::baseColor

Optional base color override for the material.

Definition at line 35 of file MaterialShaderPropertiesOverride.ixx.

35 std::optional<helios::math::vec4f> baseColor;

Referenced by writeUniformValues.

roughness​

std::optional<float> helios::rendering::material::MaterialShaderPropertiesOverride::roughness

Optional roughness override for the material (range [0, 1]).

Definition at line 40 of file MaterialShaderPropertiesOverride.ixx.

40 std::optional<float> roughness;

Referenced by writeUniformValues.

The documentation for this struct was generated from the following file:

Generated via doxygen2docusaurus 2.0.0 by Doxygen 1.15.0.