Module: Kuesa Qt 3D API
Kuesa::Qt3D::MetallicRoughnessEffect is a Qt3DRender::QEffect for Kuesa::Qt3D::MetallicRoughnessMaterial. It provides several properties used to configure the material effect. This is done using a custom shader graph and activating/deactivating different set of nodes of the graph depending on the effect configuration. More...
#include <Kuesa/Qt3D/api/materials/metallicroughnesseffect.h>
Inherits from Kuesa::Qt3D::GLTF2MaterialEffect, Qt3DRender::QEffect
Public Slots
Public Signals
Public Functions
Public Properties
Additional inherited members
Public Slots inherited from Kuesa::Qt3D::GLTF2MaterialEffect
Public Signals inherited from Kuesa::Qt3D::GLTF2MaterialEffect
Public Functions inherited from Kuesa::Qt3D::GLTF2MaterialEffect
Public Properties inherited from Kuesa::Qt3D::GLTF2MaterialEffect
Detailed Description
| class Kuesa::Qt3D::MetallicRoughnessEffect;
|
Kuesa::Qt3D::MetallicRoughnessEffect is a Qt3DRender::QEffect for Kuesa::Qt3D::MetallicRoughnessMaterial. It provides several properties used to configure the material effect. This is done using a custom shader graph and activating/deactivating different set of nodes of the graph depending on the effect configuration.
Since: Kuesa 2.0
Note: Kuesa::Qt3D::MetallicRoughnessEffect is used to configure the effect for a material, but property values must be provided through Kuesa::Qt3D::MetallicRoughnessMaterial. Therefore, this effect must be added to a Kuesa.MetallicRoughnessMaterial.
Public Slots Documentation
slot setBaseColorMapEnabled
| void setBaseColorMapEnabled(
bool enabled
)
|
| void setMetalRoughMapEnabled(
bool enabled
)
|
slot setNormalMapEnabled
| void setNormalMapEnabled(
bool enabled
)
|
slot setAmbientOcclusionMapEnabled
| void setAmbientOcclusionMapEnabled(
bool enabled
)
|
slot setEmissiveMapEnabled
| void setEmissiveMapEnabled(
bool enabled
)
|
slot setBrdfLUT
| void setBrdfLUT(
Qt3DRender::QAbstractTexture * brdfLUT
)
|
slot setClearCoatEnabled
| void setClearCoatEnabled(
bool enabled
)
|
slot setClearCoatTextureEnabled
| void setClearCoatTextureEnabled(
bool enabled
)
|
slot setClearCoatNormalTextureEnabled
| void setClearCoatNormalTextureEnabled(
bool enabled
)
|
slot setClearCoatRoughnessTextureEnabled
| void setClearCoatRoughnessTextureEnabled(
bool enabled
)
|
Public Signals Documentation
signal baseColorMapEnabledChanged
| void baseColorMapEnabledChanged(
bool enabled
)
|
| void metalRoughMapEnabledChanged(
bool enabled
)
|
signal normalMapEnabledChanged
| void normalMapEnabledChanged(
bool enabled
)
|
signal ambientOcclusionMapEnabledChanged
| void ambientOcclusionMapEnabledChanged(
bool enabled
)
|
signal emissiveMapEnabledChanged
| void emissiveMapEnabledChanged(
bool enabled
)
|
signal brdfLUTChanged
| void brdfLUTChanged(
Qt3DRender::QAbstractTexture * brdfLUT
)
|
signal clearCoatEnabledChanged
| void clearCoatEnabledChanged(
bool enabled
)
|
signal clearCoatTextureEnabledChanged
| void clearCoatTextureEnabledChanged(
bool enabled
)
|
signal clearCoatNormalTextureEnabledChanged
| void clearCoatNormalTextureEnabledChanged(
bool enabled
)
|
signal clearCoatRoughnessTextureEnabledChanged
| void clearCoatRoughnessTextureEnabledChanged(
bool enabled
)
|
Public Functions Documentation
| explicit MetallicRoughnessEffect(
Qt3DCore::QNode * parent =nullptr
)
|
| ~MetallicRoughnessEffect()
|
function isBaseColorMapEnabled
| bool isBaseColorMapEnabled() const
|
| bool isMetalRoughMapEnabled() const
|
function isNormalMapEnabled
| bool isNormalMapEnabled() const
|
function isAmbientOcclusionMapEnabled
| bool isAmbientOcclusionMapEnabled() const
|
function isEmissiveMapEnabled
| bool isEmissiveMapEnabled() const
|
function brdfLUT
| Qt3DRender::QAbstractTexture * brdfLUT() const
|
function isClearCoatEnabled
| bool isClearCoatEnabled() const
|
function isClearCoatTextureEnabled
| bool isClearCoatTextureEnabled() const
|
function isClearCoatNormalTextureEnabled
| bool isClearCoatNormalTextureEnabled() const
|
function isClearCoatRoughnessTextureEnabled
| bool isClearCoatRoughnessTextureEnabled() const
|
Public Property Documentation
property baseColorMapEnabled
| bool baseColorMapEnabled;
|
True to enable the effect support to specify base color propery with textures
| bool metalRoughMapEnabled;
|
True to enable the effect support to specify metalness and roughness properties with textures
property normalMapEnabled
True to enable the effect support for normal maps
property ambientOcclusionMapEnabled
| bool ambientOcclusionMapEnabled;
|
True to enbale the effect support for ambient occlusion texture
property emissiveMapEnabled
True to enable the effect support to specify emissive property with txtures
property brdfLUT
| Qt3DRender::QAbstractTexture * brdfLUT;
|
Since: Kuesa 2.0
brdfLUT references a texture containing lookup tables for the split sum approximation in the PBR rendering. This is used internally by the material.
When creating an instance of Kuesa::Qt3D::MetallicRoughnessMaterial, users should assign a texture to this property of the effect. A shared instance can be retrieved from the Kuesa::Qt3D::TextureCollection using the name "_kuesa_brdfLUT"
property clearCoatEnabled
property clearCoatTextureEnabled
| bool clearCoatTextureEnabled;
|
property clearCoatNormalTextureEnabled
| bool clearCoatNormalTextureEnabled;
|
property clearCoatRoughnessTextureEnabled
| bool clearCoatRoughnessTextureEnabled;
|
Updated on 2023-07-03 at 11:02:09 +0000