<?xml version="1.0" encoding="UTF-8"?> <!DOCTYPE html> <html lang="en"> <head> <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> <!-- qmetalroughmaterial.cpp --> <title>QMetalRoughMaterial Class | Qt 3D 5.12.6</title> <link rel="stylesheet" type="text/css" href="style/offline-simple.css" /> <script type="text/javascript"> document.getElementsByTagName("link").item(0).setAttribute("href", "style/offline.css"); // loading style sheet breaks anchors that were jumped to before // so force jumping to anchor again setTimeout(function() { var anchor = location.hash; // need to jump to different anchor first (e.g. none) location.hash = "#"; setTimeout(function() { location.hash = anchor; }, 0); }, 0); </script> </head> <body> <div class="header" id="qtdocheader"> <div class="main"> <div class="main-rounded"> <div class="navigationbar"> <table><tr> <td >Qt 5.12</td><td ><a href="qt3d-index.html">Qt 3D</a></td><td ><a href="qt3d-cpp.html">C++ Classes</a></td><td >QMetalRoughMaterial</td></tr></table><table class="buildversion"><tr> <td id="buildversion" width="100%" align="right"><a href="qt3d-index.html">Qt 5.12.6 Reference Documentation</a></td> </tr></table> </div> </div> <div class="content"> <div class="line"> <div class="content mainContent"> <div class="sidebar"> <div class="toc"> <h3><a name="toc">Contents</a></h3> <ul> <li class="level1"><a href="#properties">Properties</a></li> <li class="level1"><a href="#public-functions">Public Functions</a></li> <li class="level1"><a href="#public-slots">Public Slots</a></li> <li class="level1"><a href="#signals">Signals</a></li> <li class="level1"><a href="#static-public-members">Static Public Members</a></li> <li class="level1"><a href="#details">Detailed Description</a></li> </ul> </div> <div class="sidebar-content" id="sidebar-content"></div></div> <h1 class="title">QMetalRoughMaterial Class</h1> <span class="small-subtitle">(<a href="qt3dextras-qmetalroughmaterial.html">Qt3DExtras::QMetalRoughMaterial</a>)<br/></span> <!-- $$$QMetalRoughMaterial-brief --> <p>The <a href="qt3dextras-qmetalroughmaterial.html">QMetalRoughMaterial</a> provides a default implementation of PBR lighting. <a href="#details">More...</a></p> <!-- @@@QMetalRoughMaterial --> <div class="table"><table class="alignedsummary"> <tr><td class="memItemLeft rightAlign topAlign"> Header:</td><td class="memItemRight bottomAlign"> <span class="preprocessor">#include <QMetalRoughMaterial></span> </td></tr><tr><td class="memItemLeft rightAlign topAlign"> qmake:</td><td class="memItemRight bottomAlign"> QT += 3dextras</td></tr><tr><td class="memItemLeft rightAlign topAlign"> Since:</td><td class="memItemRight bottomAlign"> Qt 5.9</td></tr><tr><td class="memItemLeft rightAlign topAlign"> Instantiated By:</td><td class="memItemRight bottomAlign"> <a href="qml-qt3d-extras-metalroughmaterial.html">MetalRoughMaterial</a></td></tr><tr><td class="memItemLeft rightAlign topAlign"> Inherits:</td><td class="memItemRight bottomAlign"> <a href="qt3drender-qmaterial.html">Qt3DRender::QMaterial</a></td></tr><tr><td class="memItemLeft rightAlign topAlign"> Inherited By:</td><td class="memItemRight bottomAlign"> <p><a href="qt3dextras-qtexturedmetalroughmaterial.html" class="obsolete">Qt3DExtras::QTexturedMetalRoughMaterial</a></p> </td></tr></table></div><ul> <li><a href="qt3dextras-qmetalroughmaterial-members.html">List of all members, including inherited members</a></li> </ul> <a name="properties"></a> <h2 id="properties">Properties</h2> <div class="table"><table class="propsummary"> <tr><td class="topAlign"><ul> <li class="fn"><b><a href="qt3dextras-qmetalroughmaterial.html#ambientOcclusion-prop">ambientOcclusion</a></b> : QVariant</li> <li class="fn"><b><a href="qt3dextras-qmetalroughmaterial.html#baseColor-prop">baseColor</a></b> : QVariant</li> <li class="fn"><b><a href="qt3dextras-qmetalroughmaterial.html#metalness-prop">metalness</a></b> : QVariant</li> </ul></td><td class="topAlign"><ul> <li class="fn"><b><a href="qt3dextras-qmetalroughmaterial.html#normal-prop">normal</a></b> : QVariant</li> <li class="fn"><b><a href="qt3dextras-qmetalroughmaterial.html#roughness-prop">roughness</a></b> : QVariant</li> <li class="fn"><b><a href="qt3dextras-qmetalroughmaterial.html#textureScale-prop">textureScale</a></b> : float</li> </ul> </td></tr> </table></div> <ul> <li class="fn">1 property inherited from <a href="qt3drender-qmaterial.html#properties">Qt3DRender::QMaterial</a></li> <li class="fn">1 property inherited from <a href="qt3dcore-qcomponent.html#properties">Qt3DCore::QComponent</a></li> <li class="fn">3 properties inherited from <a href="qt3dcore-qnode.html#properties">Qt3DCore::QNode</a></li> </ul> <a name="public-functions"></a> <h2 id="public-functions">Public Functions</h2> <div class="table"><table class="alignedsummary"> <tr><td class="memItemLeft rightAlign topAlign"> </td><td class="memItemRight bottomAlign"><b><a href="qt3dextras-qmetalroughmaterial.html#QMetalRoughMaterial">QMetalRoughMaterial</a></b>(Qt3DCore::QNode *<i>parent</i> = nullptr)</td></tr> <tr><td class="memItemLeft rightAlign topAlign"> virtual </td><td class="memItemRight bottomAlign"><b><a href="qt3dextras-qmetalroughmaterial.html#dtor.QMetalRoughMaterial">~QMetalRoughMaterial</a></b>()</td></tr> <tr><td class="memItemLeft rightAlign topAlign"> QVariant </td><td class="memItemRight bottomAlign"><b><a href="qt3dextras-qmetalroughmaterial.html#ambientOcclusion-prop">ambientOcclusion</a></b>() const</td></tr> <tr><td class="memItemLeft rightAlign topAlign"> QVariant </td><td class="memItemRight bottomAlign"><b><a href="qt3dextras-qmetalroughmaterial.html#baseColor-prop">baseColor</a></b>() const</td></tr> <tr><td class="memItemLeft rightAlign topAlign"> QVariant </td><td class="memItemRight bottomAlign"><b><a href="qt3dextras-qmetalroughmaterial.html#metalness-prop">metalness</a></b>() const</td></tr> <tr><td class="memItemLeft rightAlign topAlign"> QVariant </td><td class="memItemRight bottomAlign"><b><a href="qt3dextras-qmetalroughmaterial.html#normal-prop">normal</a></b>() const</td></tr> <tr><td class="memItemLeft rightAlign topAlign"> QVariant </td><td class="memItemRight bottomAlign"><b><a href="qt3dextras-qmetalroughmaterial.html#roughness-prop">roughness</a></b>() const</td></tr> <tr><td class="memItemLeft rightAlign topAlign"> float </td><td class="memItemRight bottomAlign"><b><a href="qt3dextras-qmetalroughmaterial.html#textureScale-prop">textureScale</a></b>() const</td></tr> </table></div> <ul> <li class="fn">4 public functions inherited from <a href="qt3drender-qmaterial.html#public-functions">Qt3DRender::QMaterial</a></li> <li class="fn">2 public functions inherited from <a href="qt3dcore-qcomponent.html#public-functions">Qt3DCore::QComponent</a></li> <li class="fn">13 public functions inherited from <a href="qt3dcore-qnode.html#public-functions">Qt3DCore::QNode</a></li> </ul> <a name="public-slots"></a> <h2 id="public-slots">Public Slots</h2> <div class="table"><table class="alignedsummary"> <tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qt3dextras-qmetalroughmaterial.html#ambientOcclusion-prop">setAmbientOcclusion</a></b>(const QVariant &<i>ambientOcclusion</i>)</td></tr> <tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qt3dextras-qmetalroughmaterial.html#baseColor-prop">setBaseColor</a></b>(const QVariant &<i>baseColor</i>)</td></tr> <tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qt3dextras-qmetalroughmaterial.html#metalness-prop">setMetalness</a></b>(const QVariant &<i>metalness</i>)</td></tr> <tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qt3dextras-qmetalroughmaterial.html#normal-prop">setNormal</a></b>(const QVariant &<i>normal</i>)</td></tr> <tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qt3dextras-qmetalroughmaterial.html#roughness-prop">setRoughness</a></b>(const QVariant &<i>roughness</i>)</td></tr> <tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qt3dextras-qmetalroughmaterial.html#textureScale-prop">setTextureScale</a></b>(float <i>textureScale</i>)</td></tr> </table></div> <ul> <li class="fn">1 public slot inherited from <a href="qt3drender-qmaterial.html#public-slots">Qt3DRender::QMaterial</a></li> <li class="fn">1 public slot inherited from <a href="qt3dcore-qcomponent.html#public-slots">Qt3DCore::QComponent</a></li> <li class="fn">3 public slots inherited from <a href="qt3dcore-qnode.html#public-slots">Qt3DCore::QNode</a></li> </ul> <a name="signals"></a> <h2 id="signals">Signals</h2> <div class="table"><table class="alignedsummary"> <tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qt3dextras-qmetalroughmaterial.html#ambientOcclusion-prop">ambientOcclusionChanged</a></b>(const QVariant &<i>ambientOcclusion</i>)</td></tr> <tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qt3dextras-qmetalroughmaterial.html#baseColor-prop">baseColorChanged</a></b>(const QVariant &<i>baseColor</i>)</td></tr> <tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qt3dextras-qmetalroughmaterial.html#metalness-prop">metalnessChanged</a></b>(const QVariant &<i>metalness</i>)</td></tr> <tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qt3dextras-qmetalroughmaterial.html#normal-prop">normalChanged</a></b>(const QVariant &<i>normal</i>)</td></tr> <tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qt3dextras-qmetalroughmaterial.html#roughness-prop">roughnessChanged</a></b>(const QVariant &<i>roughness</i>)</td></tr> <tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qt3dextras-qmetalroughmaterial.html#textureScale-prop">textureScaleChanged</a></b>(float <i>textureScale</i>)</td></tr> </table></div> <ul> <li class="fn">1 signal inherited from <a href="qt3drender-qmaterial.html#signals">Qt3DRender::QMaterial</a></li> <li class="fn">3 signals inherited from <a href="qt3dcore-qcomponent.html#signals">Qt3DCore::QComponent</a></li> <li class="fn">4 signals inherited from <a href="qt3dcore-qnode.html#signals">Qt3DCore::QNode</a></li> </ul> <a name="static-public-members"></a> <h2 id="static-public-members">Static Public Members</h2> <div class="table"><table class="alignedsummary"> <tr><td class="memItemLeft rightAlign topAlign"> const QMetaObject </td><td class="memItemRight bottomAlign"><b><a href="qt3dextras-qmetalroughmaterial.html#staticMetaObject-var">staticMetaObject</a></b></td></tr> </table></div> <h3>Additional Inherited Members</h3> <ul> <li class="fn">2 protected functions inherited from <a href="qt3dcore-qnode.html#protected-functions">Qt3DCore::QNode</a></li> </ul> <a name="details"></a> <!-- $$$QMetalRoughMaterial-description --> <div class="descr"> <h2 id="details">Detailed Description</h2> <p>The <a href="qt3dextras-qmetalroughmaterial.html">QMetalRoughMaterial</a> provides a default implementation of PBR lighting.</p> <p>This material uses an effect with a single render pass approach and performs per fragment lighting. Techniques are provided for OpenGL 3 and OpenGL ES 3.</p> </div> <!-- @@@QMetalRoughMaterial --> <div class="prop"> <h2>Property Documentation</h2> <!-- $$$ambientOcclusion-prop$$$ambientOcclusion$$$setAmbientOcclusionconstQVariant&$$$ambientOcclusionChangedconstQVariant& --> <h3 class="fn" id="ambientOcclusion-prop"><a name="ambientOcclusion-prop"></a><span class="name">ambientOcclusion</span> : <span class="type">QVariant</span></h3> <p>Holds the current ambient occlusion map texture of the material. This can only be a texture, otherwise it is ignored. By default this map is not set.</p> <p><b>Access functions:</b></p> <div class="table"><table class="alignedsummary"> <tr><td class="memItemLeft topAlign rightAlign"> QVariant </td><td class="memItemRight bottomAlign"><span class="name"><b>ambientOcclusion</b></span>() const</td></tr> <tr><td class="memItemLeft topAlign rightAlign"> void </td><td class="memItemRight bottomAlign"><span class="name"><b>setAmbientOcclusion</b></span>(const QVariant &<i>ambientOcclusion</i>)</td></tr> </table></div> <p><b>Notifier signal:</b></p> <div class="table"><table class="alignedsummary"> <tr><td class="memItemLeft topAlign rightAlign"> void </td><td class="memItemRight bottomAlign"><span class="name"><b>ambientOcclusionChanged</b></span>(const QVariant &<i>ambientOcclusion</i>)</td></tr> </table></div> <!-- @@@ambientOcclusion --> <!-- $$$baseColor-prop$$$baseColor$$$setBaseColorconstQVariant&$$$baseColorChangedconstQVariant& --> <h3 class="fn" id="baseColor-prop"><a name="baseColor-prop"></a><span class="name">baseColor</span> : <span class="type">QVariant</span></h3> <p>Holds the current base color of the material. This can be either a plain color value or a texture. By default the value of this property is "grey".</p> <p><b>Access functions:</b></p> <div class="table"><table class="alignedsummary"> <tr><td class="memItemLeft topAlign rightAlign"> QVariant </td><td class="memItemRight bottomAlign"><span class="name"><b>baseColor</b></span>() const</td></tr> <tr><td class="memItemLeft topAlign rightAlign"> void </td><td class="memItemRight bottomAlign"><span class="name"><b>setBaseColor</b></span>(const QVariant &<i>baseColor</i>)</td></tr> </table></div> <p><b>Notifier signal:</b></p> <div class="table"><table class="alignedsummary"> <tr><td class="memItemLeft topAlign rightAlign"> void </td><td class="memItemRight bottomAlign"><span class="name"><b>baseColorChanged</b></span>(const QVariant &<i>baseColor</i>)</td></tr> </table></div> <!-- @@@baseColor --> <!-- $$$metalness-prop$$$metalness$$$setMetalnessconstQVariant&$$$metalnessChangedconstQVariant& --> <h3 class="fn" id="metalness-prop"><a name="metalness-prop"></a><span class="name">metalness</span> : <span class="type">QVariant</span></h3> <p>Holds the current metalness level of the material, as a value between 0 (purely dielectric, the default) and 1 (purely metallic). This can be either a plain uniform value or a texture. By default the value of this property is 0.</p> <p><b>Access functions:</b></p> <div class="table"><table class="alignedsummary"> <tr><td class="memItemLeft topAlign rightAlign"> QVariant </td><td class="memItemRight bottomAlign"><span class="name"><b>metalness</b></span>() const</td></tr> <tr><td class="memItemLeft topAlign rightAlign"> void </td><td class="memItemRight bottomAlign"><span class="name"><b>setMetalness</b></span>(const QVariant &<i>metalness</i>)</td></tr> </table></div> <p><b>Notifier signal:</b></p> <div class="table"><table class="alignedsummary"> <tr><td class="memItemLeft topAlign rightAlign"> void </td><td class="memItemRight bottomAlign"><span class="name"><b>metalnessChanged</b></span>(const QVariant &<i>metalness</i>)</td></tr> </table></div> <!-- @@@metalness --> <!-- $$$normal-prop$$$normal$$$setNormalconstQVariant&$$$normalChangedconstQVariant& --> <h3 class="fn" id="normal-prop"><a name="normal-prop"></a><span class="name">normal</span> : <span class="type">QVariant</span></h3> <p>Holds the current normal map texture of the material. This can only be a texture, otherwise it is ignored. By default this map is not set.</p> <p><b>Access functions:</b></p> <div class="table"><table class="alignedsummary"> <tr><td class="memItemLeft topAlign rightAlign"> QVariant </td><td class="memItemRight bottomAlign"><span class="name"><b>normal</b></span>() const</td></tr> <tr><td class="memItemLeft topAlign rightAlign"> void </td><td class="memItemRight bottomAlign"><span class="name"><b>setNormal</b></span>(const QVariant &<i>normal</i>)</td></tr> </table></div> <p><b>Notifier signal:</b></p> <div class="table"><table class="alignedsummary"> <tr><td class="memItemLeft topAlign rightAlign"> void </td><td class="memItemRight bottomAlign"><span class="name"><b>normalChanged</b></span>(const QVariant &<i>normal</i>)</td></tr> </table></div> <!-- @@@normal --> <!-- $$$roughness-prop$$$roughness$$$setRoughnessconstQVariant&$$$roughnessChangedconstQVariant& --> <h3 class="fn" id="roughness-prop"><a name="roughness-prop"></a><span class="name">roughness</span> : <span class="type">QVariant</span></h3> <p>Holds the current roughness level of the material. This can be either a plain uniform value or a texture. By default the value of this property is 0.</p> <p><b>Access functions:</b></p> <div class="table"><table class="alignedsummary"> <tr><td class="memItemLeft topAlign rightAlign"> QVariant </td><td class="memItemRight bottomAlign"><span class="name"><b>roughness</b></span>() const</td></tr> <tr><td class="memItemLeft topAlign rightAlign"> void </td><td class="memItemRight bottomAlign"><span class="name"><b>setRoughness</b></span>(const QVariant &<i>roughness</i>)</td></tr> </table></div> <p><b>Notifier signal:</b></p> <div class="table"><table class="alignedsummary"> <tr><td class="memItemLeft topAlign rightAlign"> void </td><td class="memItemRight bottomAlign"><span class="name"><b>roughnessChanged</b></span>(const QVariant &<i>roughness</i>)</td></tr> </table></div> <!-- @@@roughness --> <!-- $$$textureScale-prop$$$textureScale$$$setTextureScalefloat$$$textureScaleChangedfloat --> <h3 class="fn" id="textureScale-prop"><a name="textureScale-prop"></a><span class="name">textureScale</span> : <span class="type">float</span></h3> <p>Holds the current texture scale. It is applied as a multiplier to texture coordinates at render time. Defaults to 1.0.</p> <p>When used in conjunction with QTextureWrapMode::Repeat, textureScale provides a simple way to tile a texture across a surface. For example, a texture scale of <code>4.0</code> would result in 16 (4x4) tiles.</p> <p><b>Access functions:</b></p> <div class="table"><table class="alignedsummary"> <tr><td class="memItemLeft topAlign rightAlign"> float </td><td class="memItemRight bottomAlign"><span class="name"><b>textureScale</b></span>() const</td></tr> <tr><td class="memItemLeft topAlign rightAlign"> void </td><td class="memItemRight bottomAlign"><span class="name"><b>setTextureScale</b></span>(float <i>textureScale</i>)</td></tr> </table></div> <p><b>Notifier signal:</b></p> <div class="table"><table class="alignedsummary"> <tr><td class="memItemLeft topAlign rightAlign"> void </td><td class="memItemRight bottomAlign"><span class="name"><b>textureScaleChanged</b></span>(float <i>textureScale</i>)</td></tr> </table></div> <!-- @@@textureScale --> </div> <div class="func"> <h2>Member Function Documentation</h2> <!-- $$$QMetalRoughMaterial[overload1]$$$QMetalRoughMaterialQt3DCore::QNode* --> <h3 class="fn" id="QMetalRoughMaterial"><a name="QMetalRoughMaterial"></a>QMetalRoughMaterial::<span class="name">QMetalRoughMaterial</span>(<span class="type"><a href="qt3dcore-qnode.html">Qt3DCore::QNode</a></span> *<i>parent</i> = nullptr)</h3> <p>Constructs a new <a href="qt3dextras-qmetalroughmaterial.html">QMetalRoughMaterial</a> instance with parent object <i>parent</i>.</p> <!-- @@@QMetalRoughMaterial --> <!-- $$$~QMetalRoughMaterial[overload1]$$$~QMetalRoughMaterial --> <h3 class="fn" id="dtor.QMetalRoughMaterial"><a name="dtor.QMetalRoughMaterial"></a><code>[virtual] </code>QMetalRoughMaterial::<span class="name">~QMetalRoughMaterial</span>()</h3> <p>Destroys the <a href="qt3dextras-qmetalroughmaterial.html">QMetalRoughMaterial</a> instance.</p> <!-- @@@~QMetalRoughMaterial --> </div> </div> </div> </div> </div> </div> <div class="footer"> <p> <acronym title="Copyright">©</acronym> 2019 The Qt Company Ltd. Documentation contributions included herein are the copyrights of their respective owners.<br/> The documentation provided herein is licensed under the terms of the <a href="http://www.gnu.org/licenses/fdl.html">GNU Free Documentation License version 1.3</a> as published by the Free Software Foundation.<br/> Qt and respective logos are trademarks of The Qt Company Ltd. in Finland and/or other countries worldwide. All other trademarks are property of their respective owners. </p> </div> </body> </html>