<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html>
<html lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<!-- qparameter.cpp -->
<title>QParameter Class | Qt 3D 5.12.2</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 >QParameter</td></tr></table><table class="buildversion"><tr>
<td id="buildversion" width="100%" align="right"><a href="qt3d-index.html">Qt 5.12.2 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">QParameter Class</h1>
<span class="small-subtitle">(<a href="qt3drender-qparameter.html">Qt3DRender::QParameter</a>)<br/></span>
<!-- $$$QParameter-brief -->
<p>Provides storage for a name and value pair. This maps to a shader uniform. <a href="#details">More...</a></p>
<!-- @@@QParameter -->
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> Header:</td><td class="memItemRight bottomAlign"> <span class="preprocessor">#include <Qt3DRender/QParameter></span>
</td></tr><tr><td class="memItemLeft rightAlign topAlign"> qmake:</td><td class="memItemRight bottomAlign"> QT += 3drender</td></tr><tr><td class="memItemLeft rightAlign topAlign"> Instantiated By:</td><td class="memItemRight bottomAlign"> <a href="qml-qt3d-render-parameter.html">Parameter</a></td></tr><tr><td class="memItemLeft rightAlign topAlign"> Inherits:</td><td class="memItemRight bottomAlign"> <a href="qt3dcore-qnode.html">Qt3DCore::QNode</a></td></tr></table></div><ul>
<li><a href="qt3drender-qparameter-members.html">List of all members, including inherited members</a></li>
</ul>
<a name="properties"></a>
<h2 id="properties">Properties</h2>
<ul>
<li class="fn"><b><a href="qt3drender-qparameter.html#name-prop">name</a></b> : QString</li>
<li class="fn"><b><a href="qt3drender-qparameter.html#value-prop">value</a></b> : QVariant</li>
</ul>
<ul>
<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="qt3drender-qparameter.html#QParameter">QParameter</a></b>(Qt3DCore::QNode *<i>parent</i> = nullptr)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> </td><td class="memItemRight bottomAlign"><b><a href="qt3drender-qparameter.html#QParameter-1">QParameter</a></b>(const QString &<i>name</i>, const QVariant &<i>value</i>, Qt3DCore::QNode *<i>parent</i> = nullptr)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> </td><td class="memItemRight bottomAlign"><b><a href="qt3drender-qparameter.html#QParameter-2">QParameter</a></b>(const QString &<i>name</i>, Qt3DRender::QAbstractTexture *<i>texture</i>, Qt3DCore::QNode *<i>parent</i> = nullptr)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QString </td><td class="memItemRight bottomAlign"><b><a href="qt3drender-qparameter.html#name-prop">name</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QVariant </td><td class="memItemRight bottomAlign"><b><a href="qt3drender-qparameter.html#value-prop">value</a></b>() const</td></tr>
</table></div>
<ul>
<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="qt3drender-qparameter.html#name-prop">setName</a></b>(const QString &<i>name</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qt3drender-qparameter.html#value-prop">setValue</a></b>(const QVariant &<i>dv</i>)</td></tr>
</table></div>
<ul>
<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="qt3drender-qparameter.html#name-prop">nameChanged</a></b>(const QString &<i>name</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qt3drender-qparameter.html#value-prop">valueChanged</a></b>(const QVariant &<i>value</i>)</td></tr>
</table></div>
<ul>
<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="qt3drender-qparameter.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>
<!-- $$$QParameter-description -->
<div class="descr">
<h2 id="details">Detailed Description</h2>
<p>Provides storage for a name and value pair. This maps to a shader uniform.</p>
<p>A <a href="qt3drender-qparameter.html">QParameter</a> can be referenced by a <a href="qt3drender-qrenderpass.html">QRenderPass</a>, <a href="qt3drender-qtechnique.html">QTechnique</a>, <a href="qt3drender-qeffect.html">QEffect</a>, <a href="qt3drender-qmaterial.html">QMaterial</a>, <a href="qt3drender-qtechniquefilter.html">QTechniqueFilter</a>, <a href="qt3drender-qrenderpassfilter.html">QRenderPassFilter</a>. At runtime, depending on which shader is selected for a given step of the rendering, the value contained in a <a href="qt3drender-qparameter.html">QParameter</a> will be converted and uploaded if the shader contains a uniform with a name matching that of the <a href="qt3drender-qparameter.html">QParameter</a>.</p>
<pre class="cpp">
<span class="type"><a href="qt3drender-qparameter.html#QParameter">QParameter</a></span> <span class="operator">*</span>param <span class="operator">=</span> <span class="keyword">new</span> <span class="type"><a href="qt3drender-qparameter.html#QParameter">QParameter</a></span>();
param<span class="operator">-</span><span class="operator">></span>setName(<span class="type">QStringLiteral</span>(<span class="string">"diffuseColor"</span>));
param<span class="operator">-</span><span class="operator">></span>setValue(<span class="type">QColor</span><span class="operator">::</span>fromRgbF(<span class="number">0.0f</span><span class="operator">,</span> <span class="number">0.0f</span><span class="operator">,</span> <span class="number">1.0f</span><span class="operator">,</span> <span class="number">1.0f</span>));
<span class="comment">// Alternatively you can create and set a QParameter this way</span>
<span class="type"><a href="qt3drender-qparameter.html#QParameter">QParameter</a></span> <span class="operator">*</span>param2 <span class="operator">=</span> <span class="keyword">new</span> <span class="type"><a href="qt3drender-qparameter.html#QParameter">QParameter</a></span>(<span class="type">QStringLiteral</span>(<span class="string">"diffuseColor"</span>)<span class="operator">,</span> <span class="type">QColor</span><span class="operator">::</span>fromRgbF(<span class="number">0.0f</span><span class="operator">,</span> <span class="number">0.0f</span><span class="operator">,</span> <span class="number">1.0f</span><span class="operator">,</span> <span class="number">1.0f</span>));
<span class="comment">// Such QParameters will work with the following GLSL uniform shader declarations</span>
<span class="comment">// uniform vec4 diffuseColor;</span>
<span class="comment">// uniform vec3 diffuseColor;</span>
<span class="comment">// uniform vec2 diffuseColor;</span>
<span class="comment">// uniform float diffuseColor;</span>
</pre>
<p><b>Note: </b>some care must be taken to ensure the value wrapped by a <a href="qt3drender-qparameter.html">QParameter</a> can actually be converted to what the real uniform expect. Giving a value stored as an int where the actual shader uniform is of type float could result in undefined behaviors.</p><p><b>Note: </b>when the targeted uniform is an array, the name should be the name of the uniform with [0] appended to it.</p><pre class="cpp">
<span class="type"><a href="qt3drender-qparameter.html#QParameter">QParameter</a></span> <span class="operator">*</span>param <span class="operator">=</span> <span class="keyword">new</span> <span class="type"><a href="qt3drender-qparameter.html#QParameter">QParameter</a></span>();
<span class="type">QVariantList</span> values <span class="operator">=</span> <span class="type">QVariantList</span>() <span class="operator"><</span><span class="operator"><</span> <span class="number">0.0f</span> <span class="operator"><</span><span class="operator"><</span> <span class="number">1.0f</span> <span class="operator"><</span><span class="operator"><</span> <span class="number">2.0f</span> <span class="operator"><</span><span class="operator"><</span> <span class="number">3.0f</span> <span class="operator"><</span><span class="operator"><</span> <span class="number">4.0f</span> <span class="operator"><</span><span class="operator"><</span> <span class="number">883.0f</span> <span class="operator"><</span><span class="operator"><</span> <span class="number">1340.0f</span> <span class="operator"><</span><span class="operator"><</span> <span class="number">1584.0f</span>;
param<span class="operator">-</span><span class="operator">></span>setName(<span class="type">QStringLiteral</span>(<span class="string">"diffuseValues[0]"</span>));
param<span class="operator">-</span><span class="operator">></span>setValue(values);
<span class="comment">// Matching GLSL shader uniform declaration</span>
<span class="comment">// uniform float diffuseValues[8];</span>
</pre>
<p>When it comes to texture support, the <a href="qt3drender-qparameter.html">QParameter</a> value should be set to the appropriate <a href="qt3drender-qabstracttexture.html">QAbstractTexture</a> subclass that matches the sampler type of the shader uniform.</p>
<pre class="cpp">
QTexture2D <span class="operator">*</span>texture <span class="operator">=</span> <span class="keyword">new</span> QTexture2D();
<span class="operator">.</span><span class="operator">.</span><span class="operator">.</span>
<span class="type"><a href="qt3drender-qparameter.html#QParameter">QParameter</a></span> <span class="operator">*</span>param <span class="operator">=</span> <span class="keyword">new</span> <span class="type"><a href="qt3drender-qparameter.html#QParameter">QParameter</a></span>();
param<span class="operator">-</span><span class="operator">></span>setName(<span class="type">QStringLiteral</span>(<span class="string">"diffuseTexture"</span>));
param<span class="operator">-</span><span class="operator">></span>setValue(<span class="type">QVariant</span><span class="operator">::</span>fromValue(texture));
<span class="comment">// Works with the following GLSL uniform shader declaration</span>
<span class="comment">// uniform sampler2D diffuseTexture</span>
</pre>
</div>
<p><b>See also </b><a href="qt3drender-qabstracttexture.html">QAbstractTexture</a>.</p>
<!-- @@@QParameter -->
<div class="prop">
<h2>Property Documentation</h2>
<!-- $$$name-prop$$$name$$$setNameconstQString&$$$nameChangedconstQString& -->
<h3 class="fn" id="name-prop"><a name="name-prop"></a><span class="name">name</span> : <span class="type">QString</span></h3>
<p>Specifies the name of the parameter</p>
<p><b>Access functions:</b></p>
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft topAlign rightAlign"> QString </td><td class="memItemRight bottomAlign"><span class="name"><b>name</b></span>() const</td></tr>
<tr><td class="memItemLeft topAlign rightAlign"> void </td><td class="memItemRight bottomAlign"><span class="name"><b>setName</b></span>(const QString &<i>name</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>nameChanged</b></span>(const QString &<i>name</i>)</td></tr>
</table></div>
<!-- @@@name -->
<!-- $$$value-prop$$$value$$$setValueconstQVariant&$$$valueChangedconstQVariant& -->
<h3 class="fn" id="value-prop"><a name="value-prop"></a><span class="name">value</span> : <span class="type">QVariant</span></h3>
<p>Specifies the value of the parameter</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>value</b></span>() const</td></tr>
<tr><td class="memItemLeft topAlign rightAlign"> void </td><td class="memItemRight bottomAlign"><span class="name"><b>setValue</b></span>(const QVariant &<i>dv</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>valueChanged</b></span>(const QVariant &<i>value</i>)</td></tr>
</table></div>
<!-- @@@value -->
</div>
<div class="func">
<h2>Member Function Documentation</h2>
<!-- $$$QParameter[overload1]$$$QParameterQt3DCore::QNode* -->
<h3 class="fn" id="QParameter"><a name="QParameter"></a>QParameter::<span class="name">QParameter</span>(<span class="type"><a href="qt3dcore-qnode.html">Qt3DCore::QNode</a></span> *<i>parent</i> = nullptr)</h3>
<p>Default constructs an instance of QParameter.</p><!-- @@@QParameter -->
<!-- $$$QParameter$$$QParameterconstQString&constQVariant&Qt3DCore::QNode* -->
<h3 class="fn" id="QParameter-1"><a name="QParameter-1"></a>QParameter::<span class="name">QParameter</span>(const <span class="type">QString</span> &<i>name</i>, const <span class="type">QVariant</span> &<i>value</i>, <span class="type"><a href="qt3dcore-qnode.html">Qt3DCore::QNode</a></span> *<i>parent</i> = nullptr)</h3>
<p>Default constructs an instance of QParameter.</p><!-- @@@QParameter -->
<!-- $$$QParameter$$$QParameterconstQString&Qt3DRender::QAbstractTexture*Qt3DCore::QNode* -->
<h3 class="fn" id="QParameter-2"><a name="QParameter-2"></a>QParameter::<span class="name">QParameter</span>(const <span class="type">QString</span> &<i>name</i>, <span class="type"><a href="qt3drender-qabstracttexture.html">Qt3DRender::QAbstractTexture</a></span> *<i>texture</i>, <span class="type"><a href="qt3dcore-qnode.html">Qt3DCore::QNode</a></span> *<i>parent</i> = nullptr)</h3>
<p>Default constructs an instance of QParameter.</p><!-- @@@QParameter -->
</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>
distrib
>
Mageia
>
7
>
armv7hl
>
media
>
core-release
>
by-pkgid
>
c936229ef0138f42857f36beadbeda30
>
files
>
1037
