-
Notifications
You must be signed in to change notification settings - Fork 3
/
bge.types.BL_Shader.html
580 lines (535 loc) · 35.8 KB
/
bge.types.BL_Shader.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
<!DOCTYPE html>
<html class="writer-html5" lang="en" >
<head>
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.18.1: http://docutils.sourceforge.net/" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>BL_Shader(EXP_PyObjectPlus) — Blender Python API</title>
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="_static/css/theme_overrides.css" type="text/css" />
<link rel="stylesheet" href="_static/css/version_switch.css" type="text/css" />
<link rel="shortcut icon" href="_static/favicon.ico"/>
<link rel="canonical" href="https://upbge.org/docs/latest/api/bge.types.BL_Shader.html" />
<!--[if lt IE 9]>
<script src="_static/js/html5shiv.min.js"></script>
<![endif]-->
<script src="_static/jquery.js?v=5d32c60e"></script>
<script src="_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
<script src="_static/documentation_options.js?v=715c20a1"></script>
<script src="_static/doctools.js?v=888ff710"></script>
<script src="_static/sphinx_highlight.js?v=dc90522c"></script>
<script src="_static/js/version_switch.js?v=fa006b38"></script>
<script src="_static/js/theme.js"></script>
<link rel="search" type="application/opensearchdescription+xml"
title="Search within Blender Python API"
href="_static/opensearch.xml"/>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="BL_Texture(EXP_Value)" href="bge.types.BL_Texture.html" />
<link rel="prev" title="BL_ArmatureObject(KX_GameObject)" href="bge.types.BL_ArmatureObject.html" />
</head>
<body class="wy-body-for-nav">
<div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search" >
<a href="index.html" class="icon icon-home">
UPBGE 0.3+ + Blender 4.0.0 Alpha Python API
<img src="_static/upbge_logo.png" class="logo" alt="Logo"/>
</a>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
<input type="text" name="q" placeholder="Search docs" aria-label="Search docs" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
</div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
<p class="caption" role="heading"><span class="caption-text">Application Modules</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="bpy.context.html">Context Access (bpy.context)</a></li>
<li class="toctree-l1"><a class="reference internal" href="bpy.data.html">Data Access (bpy.data)</a></li>
<li class="toctree-l1"><a class="reference internal" href="bpy.msgbus.html">Message Bus (bpy.msgbus)</a></li>
<li class="toctree-l1"><a class="reference internal" href="bpy.ops.html">Operators (bpy.ops)</a></li>
<li class="toctree-l1"><a class="reference internal" href="bpy.types.html">Types (bpy.types)</a></li>
<li class="toctree-l1"><a class="reference internal" href="bpy.utils.html">Utilities (bpy.utils)</a></li>
<li class="toctree-l1"><a class="reference internal" href="bpy.path.html">Path Utilities (bpy.path)</a></li>
<li class="toctree-l1"><a class="reference internal" href="bpy.app.html">Application Data (bpy.app)</a></li>
<li class="toctree-l1"><a class="reference internal" href="bpy.props.html">Property Definitions (bpy.props)</a></li>
</ul>
<p class="caption" role="heading"><span class="caption-text">Game Engine Modules</span></p>
<ul class="current">
<li class="toctree-l1 current"><a class="reference internal" href="bge.types.html">Game Types (bge.types)</a></li>
<li class="toctree-l1"><a class="reference internal" href="bge.logic.html">Game Logic (bge.logic)</a></li>
<li class="toctree-l1"><a class="reference internal" href="bge.render.html">Rasterizer (bge.render)</a></li>
<li class="toctree-l1"><a class="reference internal" href="bge.texture.html">Video Texture (bge.texture)</a></li>
<li class="toctree-l1"><a class="reference internal" href="bge.texture.html#ffmpeg-video-and-image-status">FFmpeg Video and Image Status</a></li>
<li class="toctree-l1"><a class="reference internal" href="bge.texture.html#image-blending-modes">Image Blending Modes</a></li>
<li class="toctree-l1"><a class="reference internal" href="bge.events.html">Game Keys (bge.events)</a></li>
<li class="toctree-l1"><a class="reference internal" href="bge.constraints.html">Physics Constraints (bge.constraints)</a></li>
<li class="toctree-l1"><a class="reference internal" href="bge.app.html">Application Data (bge.app)</a></li>
<li class="toctree-l1"><a class="reference internal" href="bgui.html">Game GUI (bgui)</a></li>
</ul>
<p class="caption" role="heading"><span class="caption-text">Standalone Modules</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="aud.html">Audio System (aud)</a></li>
<li class="toctree-l1"><a class="reference internal" href="bgl.html">OpenGL Wrapper (bgl)</a></li>
<li class="toctree-l1"><a class="reference internal" href="bl_math.html">Additional Math Functions (bl_math)</a></li>
<li class="toctree-l1"><a class="reference internal" href="blf.html">Font Drawing (blf)</a></li>
<li class="toctree-l1"><a class="reference internal" href="bmesh.html">BMesh Module (bmesh)</a></li>
<li class="toctree-l1"><a class="reference internal" href="bpy_extras.html">Extra Utilities (bpy_extras)</a></li>
<li class="toctree-l1"><a class="reference internal" href="freestyle.html">Freestyle Module (freestyle)</a></li>
<li class="toctree-l1"><a class="reference internal" href="gpu.html">GPU Module (gpu)</a></li>
<li class="toctree-l1"><a class="reference internal" href="gpu_extras.html">GPU Utilities (gpu_extras)</a></li>
<li class="toctree-l1"><a class="reference internal" href="idprop.types.html">ID Property Access (idprop.types)</a></li>
<li class="toctree-l1"><a class="reference internal" href="imbuf.html">Image Buffer (imbuf)</a></li>
<li class="toctree-l1"><a class="reference internal" href="mathutils.html">Math Types & Utilities (mathutils)</a></li>
</ul>
</div>
</div>
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="index.html">UPBGE 0.3+ + Blender 4.0.0 Alpha Python API</a>
</nav>
<div class="wy-nav-content">
<div class="rst-content">
<div role="navigation" aria-label="Page navigation">
<ul class="wy-breadcrumbs">
<li><a href="index.html" class="icon icon-home" aria-label="Home"></a></li>
<li class="breadcrumb-item"><a href="bge.types.html">Game Types (bge.types)</a></li>
<li class="breadcrumb-item active">BL_Shader(EXP_PyObjectPlus)</li>
<li class="wy-breadcrumbs-aside">
</li>
</ul>
<hr/>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
<section id="bl-shader-exp-pyobjectplus">
<h1>BL_Shader(EXP_PyObjectPlus)<a class="headerlink" href="#bl-shader-exp-pyobjectplus" title="Link to this heading"></a></h1>
<p>base class — <a class="reference internal" href="bge.types.EXP_PyObjectPlus.html#bge.types.EXP_PyObjectPlus" title="bge.types.EXP_PyObjectPlus"><code class="xref py py-class docutils literal notranslate"><span class="pre">EXP_PyObjectPlus</span></code></a></p>
<dl class="py class">
<dt class="sig sig-object py" id="bge.types.BL_Shader">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">bge.types.</span></span><span class="sig-name descname"><span class="pre">BL_Shader</span></span><a class="headerlink" href="#bge.types.BL_Shader" title="Link to this definition"></a></dt>
<dd><p>BL_Shader is a class used to compile and use custom shaders scripts.
This header set the <code class="docutils literal notranslate"><span class="pre">#version</span></code> directive, so the user must not define his own <cite>#version</cite>.
Since 0.3.0, this class is only used with custom 2D filters.</p>
<dl class="py attribute">
<dt class="sig sig-object py" id="bge.types.BL_Shader.enabled">
<span class="sig-name descname"><span class="pre">enabled</span></span><a class="headerlink" href="#bge.types.BL_Shader.enabled" title="Link to this definition"></a></dt>
<dd><p>Set shader enabled to use.</p>
<dl class="field-list simple">
<dt class="field-odd">Type<span class="colon">:</span></dt>
<dd class="field-odd"><p>boolean</p>
</dd>
</dl>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="bge.types.BL_Shader.objectCallbacks">
<span class="sig-name descname"><span class="pre">objectCallbacks</span></span><a class="headerlink" href="#bge.types.BL_Shader.objectCallbacks" title="Link to this definition"></a></dt>
<dd></dd></dl>
<div class="deprecated">
<p><span class="versionmodified deprecated">Deprecated since version 0.3.0: </span>The list of python callbacks executed when the shader is used to render an object.
All the functions can expect as argument the object currently rendered.</p>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="k">def</span> <span class="nf">callback</span><span class="p">(</span><span class="nb">object</span><span class="p">):</span>
<span class="nb">print</span><span class="p">(</span><span class="s2">"render object </span><span class="si">%r</span><span class="s2">"</span> <span class="o">%</span> <span class="nb">object</span><span class="o">.</span><span class="n">name</span><span class="p">)</span>
</pre></div>
</div>
<dl class="field-list simple">
<dt class="field-odd">type<span class="colon">:</span></dt>
<dd class="field-odd"><p>list of functions and/or methods</p>
</dd>
</dl>
</div>
<dl class="py attribute">
<dt class="sig sig-object py" id="bge.types.BL_Shader.bindCallbacks">
<span class="sig-name descname"><span class="pre">bindCallbacks</span></span><a class="headerlink" href="#bge.types.BL_Shader.bindCallbacks" title="Link to this definition"></a></dt>
<dd></dd></dl>
<div class="deprecated">
<p><span class="versionmodified deprecated">Deprecated since version 0.3.0: </span>The list of python callbacks executed when the shader is begin used to render.</p>
<dl class="field-list simple">
<dt class="field-odd">type<span class="colon">:</span></dt>
<dd class="field-odd"><p>list of functions and/or methods</p>
</dd>
</dl>
</div>
<dl class="py method">
<dt class="sig sig-object py" id="bge.types.BL_Shader.setUniformfv">
<span class="sig-name descname"><span class="pre">setUniformfv</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">fList</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#bge.types.BL_Shader.setUniformfv" title="Link to this definition"></a></dt>
<dd><p>Set a uniform with a list of float values</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>name</strong> (<em>string</em>) – the uniform name</p></li>
<li><p><strong>fList</strong> (<em>list</em><em>[</em><em>float</em><em>]</em>) – a list (2, 3 or 4 elements) of float values</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="bge.types.BL_Shader.delSource">
<span class="sig-name descname"><span class="pre">delSource</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#bge.types.BL_Shader.delSource" title="Link to this definition"></a></dt>
<dd></dd></dl>
<div class="deprecated">
<p><span class="versionmodified deprecated">Deprecated since version 0.3.0: </span>Clear the shader. Use this method before the source is changed with <a class="reference internal" href="#bge.types.BL_Shader.setSource" title="bge.types.BL_Shader.setSource"><code class="xref py py-data docutils literal notranslate"><span class="pre">setSource</span></code></a>.</p>
</div>
<dl class="py method">
<dt class="sig sig-object py" id="bge.types.BL_Shader.getFragmentProg">
<span class="sig-name descname"><span class="pre">getFragmentProg</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#bge.types.BL_Shader.getFragmentProg" title="Link to this definition"></a></dt>
<dd><p>Returns the fragment program.</p>
<dl class="field-list simple">
<dt class="field-odd">Returns<span class="colon">:</span></dt>
<dd class="field-odd"><p>The fragment program.</p>
</dd>
<dt class="field-even">Return type<span class="colon">:</span></dt>
<dd class="field-even"><p>string</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="bge.types.BL_Shader.getVertexProg">
<span class="sig-name descname"><span class="pre">getVertexProg</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#bge.types.BL_Shader.getVertexProg" title="Link to this definition"></a></dt>
<dd><p>Get the vertex program.</p>
<dl class="field-list simple">
<dt class="field-odd">Returns<span class="colon">:</span></dt>
<dd class="field-odd"><p>The vertex program.</p>
</dd>
<dt class="field-even">Return type<span class="colon">:</span></dt>
<dd class="field-even"><p>string</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="bge.types.BL_Shader.isValid">
<span class="sig-name descname"><span class="pre">isValid</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#bge.types.BL_Shader.isValid" title="Link to this definition"></a></dt>
<dd><p>Check if the shader is valid.</p>
<dl class="field-list simple">
<dt class="field-odd">Returns<span class="colon">:</span></dt>
<dd class="field-odd"><p>True if the shader is valid</p>
</dd>
<dt class="field-even">Return type<span class="colon">:</span></dt>
<dd class="field-even"><p>boolean</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="bge.types.BL_Shader.setAttrib">
<span class="sig-name descname"><span class="pre">setAttrib</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">enum</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#bge.types.BL_Shader.setAttrib" title="Link to this definition"></a></dt>
<dd></dd></dl>
<div class="deprecated">
<p><span class="versionmodified deprecated">Deprecated since version 0.3.0: </span>Set attribute location. (The parameter is ignored a.t.m. and the value of “tangent” is always used.)</p>
<dl class="field-list simple">
<dt class="field-odd">arg enum<span class="colon">:</span></dt>
<dd class="field-odd"><p>attribute location value</p>
</dd>
<dt class="field-even">type enum<span class="colon">:</span></dt>
<dd class="field-even"><p>integer</p>
</dd>
</dl>
</div>
<dl class="py method">
<dt class="sig sig-object py" id="bge.types.BL_Shader.setSampler">
<span class="sig-name descname"><span class="pre">setSampler</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">index</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#bge.types.BL_Shader.setSampler" title="Link to this definition"></a></dt>
<dd><p>Set uniform texture sample index.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>name</strong> (<em>string</em>) – Uniform name</p></li>
<li><p><strong>index</strong> (<em>integer</em>) – Texture sample index.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="bge.types.BL_Shader.setSource">
<span class="sig-name descname"><span class="pre">setSource</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">vertexProgram</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">fragmentProgram</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">apply</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#bge.types.BL_Shader.setSource" title="Link to this definition"></a></dt>
<dd></dd></dl>
<div class="deprecated">
<p><span class="versionmodified deprecated">Deprecated since version 0.3.0: </span>Set the vertex and fragment programs</p>
<dl class="field-list simple">
<dt class="field-odd">arg vertexProgram<span class="colon">:</span></dt>
<dd class="field-odd"><p>Vertex program</p>
</dd>
<dt class="field-even">type vertexProgram<span class="colon">:</span></dt>
<dd class="field-even"><p>string</p>
</dd>
<dt class="field-odd">arg fragmentProgram<span class="colon">:</span></dt>
<dd class="field-odd"><p>Fragment program</p>
</dd>
<dt class="field-even">type fragmentProgram<span class="colon">:</span></dt>
<dd class="field-even"><p>string</p>
</dd>
<dt class="field-odd">arg apply<span class="colon">:</span></dt>
<dd class="field-odd"><p>Enable the shader.</p>
</dd>
<dt class="field-even">type apply<span class="colon">:</span></dt>
<dd class="field-even"><p>boolean</p>
</dd>
</dl>
</div>
<dl class="py method">
<dt class="sig sig-object py" id="bge.types.BL_Shader.setSourceList">
<span class="sig-name descname"><span class="pre">setSourceList</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">sources</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">apply</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#bge.types.BL_Shader.setSourceList" title="Link to this definition"></a></dt>
<dd></dd></dl>
<div class="deprecated">
<p><span class="versionmodified deprecated">Deprecated since version 0.3.0: </span>Set the vertex, fragment and geometry shader programs.</p>
<dl class="field-list">
<dt class="field-odd">arg sources<span class="colon">:</span></dt>
<dd class="field-odd"><p>Dictionary of all programs. The keys <code class="xref py py-data docutils literal notranslate"><span class="pre">vertex</span></code>, <code class="xref py py-data docutils literal notranslate"><span class="pre">fragment</span></code> and <code class="xref py py-data docutils literal notranslate"><span class="pre">geometry</span></code> represent shader programs of the same name.
<code class="xref py py-data docutils literal notranslate"><span class="pre">geometry</span></code> is an optional program.
This dictionary can be similar to:</p>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="n">sources</span> <span class="o">=</span> <span class="p">{</span>
<span class="s2">"vertex"</span> <span class="p">:</span> <span class="n">vertexProgram</span><span class="p">,</span>
<span class="s2">"fragment"</span> <span class="p">:</span> <span class="n">fragmentProgram</span><span class="p">,</span>
<span class="s2">"geometry"</span> <span class="p">:</span> <span class="n">geometryProgram</span>
<span class="p">}</span>
</pre></div>
</div>
</dd>
<dt class="field-even">type sources<span class="colon">:</span></dt>
<dd class="field-even"><p>dict</p>
</dd>
<dt class="field-odd">arg apply<span class="colon">:</span></dt>
<dd class="field-odd"><p>Enable the shader.</p>
</dd>
<dt class="field-even">type apply<span class="colon">:</span></dt>
<dd class="field-even"><p>boolean</p>
</dd>
</dl>
</div>
<dl class="py method">
<dt class="sig sig-object py" id="bge.types.BL_Shader.setUniform1f">
<span class="sig-name descname"><span class="pre">setUniform1f</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">fx</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#bge.types.BL_Shader.setUniform1f" title="Link to this definition"></a></dt>
<dd><p>Set a uniform with 1 float value.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>name</strong> (<em>string</em>) – the uniform name</p></li>
<li><p><strong>fx</strong> (<em>float</em>) – Uniform value</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="bge.types.BL_Shader.setUniform1i">
<span class="sig-name descname"><span class="pre">setUniform1i</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">ix</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#bge.types.BL_Shader.setUniform1i" title="Link to this definition"></a></dt>
<dd><p>Set a uniform with an integer value.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>name</strong> (<em>string</em>) – the uniform name</p></li>
<li><p><strong>ix</strong> (<em>integer</em>) – the uniform value</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="bge.types.BL_Shader.setUniform2f">
<span class="sig-name descname"><span class="pre">setUniform2f</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">fx</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">fy</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#bge.types.BL_Shader.setUniform2f" title="Link to this definition"></a></dt>
<dd><p>Set a uniform with 2 float values</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>name</strong> (<em>string</em>) – the uniform name</p></li>
<li><p><strong>fx</strong> (<em>float</em>) – first float value</p></li>
<li><p><strong>fy</strong> (<em>float</em>) – second float value</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="bge.types.BL_Shader.setUniform2i">
<span class="sig-name descname"><span class="pre">setUniform2i</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">ix</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">iy</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#bge.types.BL_Shader.setUniform2i" title="Link to this definition"></a></dt>
<dd><p>Set a uniform with 2 integer values</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>name</strong> (<em>string</em>) – the uniform name</p></li>
<li><p><strong>ix</strong> (<em>integer</em>) – first integer value</p></li>
<li><p><strong>iy</strong> (<em>integer</em>) – second integer value</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="bge.types.BL_Shader.setUniform3f">
<span class="sig-name descname"><span class="pre">setUniform3f</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">fx</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">fy</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">fz</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#bge.types.BL_Shader.setUniform3f" title="Link to this definition"></a></dt>
<dd><p>Set a uniform with 3 float values.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>name</strong> (<em>string</em>) – the uniform name</p></li>
<li><p><strong>fx</strong> (<em>float</em>) – first float value</p></li>
<li><p><strong>fy</strong> (<em>float</em>) – second float value</p></li>
<li><p><strong>fz</strong> (<em>float</em>) – third float value</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="bge.types.BL_Shader.setUniform3i">
<span class="sig-name descname"><span class="pre">setUniform3i</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">ix</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">iy</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">iz</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#bge.types.BL_Shader.setUniform3i" title="Link to this definition"></a></dt>
<dd><p>Set a uniform with 3 integer values</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>name</strong> (<em>string</em>) – the uniform name</p></li>
<li><p><strong>ix</strong> (<em>integer</em>) – first integer value</p></li>
<li><p><strong>iy</strong> (<em>integer</em>) – second integer value</p></li>
<li><p><strong>iz</strong> (<em>integer</em>) – third integer value</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="bge.types.BL_Shader.setUniform4f">
<span class="sig-name descname"><span class="pre">setUniform4f</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">fx</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">fy</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">fz</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">fw</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#bge.types.BL_Shader.setUniform4f" title="Link to this definition"></a></dt>
<dd><p>Set a uniform with 4 float values.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>name</strong> (<em>string</em>) – the uniform name</p></li>
<li><p><strong>fx</strong> (<em>float</em>) – first float value</p></li>
<li><p><strong>fy</strong> (<em>float</em>) – second float value</p></li>
<li><p><strong>fz</strong> (<em>float</em>) – third float value</p></li>
<li><p><strong>fw</strong> (<em>float</em>) – fourth float value</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="bge.types.BL_Shader.setUniform4i">
<span class="sig-name descname"><span class="pre">setUniform4i</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">ix</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">iy</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">iz</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">iw</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#bge.types.BL_Shader.setUniform4i" title="Link to this definition"></a></dt>
<dd><p>Set a uniform with 4 integer values</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>name</strong> (<em>string</em>) – the uniform name</p></li>
<li><p><strong>ix</strong> (<em>integer</em>) – first integer value</p></li>
<li><p><strong>iy</strong> (<em>integer</em>) – second integer value</p></li>
<li><p><strong>iz</strong> (<em>integer</em>) – third integer value</p></li>
<li><p><strong>iw</strong> (<em>integer</em>) – fourth integer value</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="bge.types.BL_Shader.setUniformDef">
<span class="sig-name descname"><span class="pre">setUniformDef</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">type</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#bge.types.BL_Shader.setUniformDef" title="Link to this definition"></a></dt>
<dd><p>Define a new uniform</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>name</strong> (<em>string</em>) – the uniform name</p></li>
<li><p><strong>type</strong> (<em>integer</em>) – uniform type, one of <a class="reference internal" href="bge.logic.html#shader-defined-uniform"><span class="std std-ref">these constants</span></a></p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="bge.types.BL_Shader.setUniformMatrix3">
<span class="sig-name descname"><span class="pre">setUniformMatrix3</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">mat</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">transpose</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#bge.types.BL_Shader.setUniformMatrix3" title="Link to this definition"></a></dt>
<dd><p>Set a uniform with a 3x3 matrix value</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>name</strong> (<em>string</em>) – the uniform name</p></li>
<li><p><strong>mat</strong> (<em>3x3 matrix</em>) – A 3x3 matrix [[f, f, f], [f, f, f], [f, f, f]]</p></li>
<li><p><strong>transpose</strong> (<em>boolean</em>) – set to True to transpose the matrix</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="bge.types.BL_Shader.setUniformMatrix4">
<span class="sig-name descname"><span class="pre">setUniformMatrix4</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">mat</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">transpose</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#bge.types.BL_Shader.setUniformMatrix4" title="Link to this definition"></a></dt>
<dd><p>Set a uniform with a 4x4 matrix value</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>name</strong> (<em>string</em>) – the uniform name</p></li>
<li><p><strong>mat</strong> (<em>4x4 matrix</em>) – A 4x4 matrix [[f, f, f, f], [f, f, f, f], [f, f, f, f], [f, f, f, f]]</p></li>
<li><p><strong>transpose</strong> (<em>boolean</em>) – set to True to transpose the matrix</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="bge.types.BL_Shader.setUniformiv">
<span class="sig-name descname"><span class="pre">setUniformiv</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">iList</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#bge.types.BL_Shader.setUniformiv" title="Link to this definition"></a></dt>
<dd><p>Set a uniform with a list of integer values</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>name</strong> (<em>string</em>) – the uniform name</p></li>
<li><p><strong>iList</strong> (<em>list</em><em>[</em><em>integer</em><em>]</em>) – a list (2, 3 or 4 elements) of integer values</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="bge.types.BL_Shader.setUniformEyef">
<span class="sig-name descname"><span class="pre">setUniformEyef</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#bge.types.BL_Shader.setUniformEyef" title="Link to this definition"></a></dt>
<dd></dd></dl>
<div class="deprecated">
<p><span class="versionmodified deprecated">Deprecated since version 0.3.0: </span>Set a uniform with a float value that reflects the eye being render in stereo mode:
0.0 for the left eye, 0.5 for the right eye. In non stereo mode, the value of the uniform
is fixed to 0.0. The typical use of this uniform is in stereo mode to sample stereo textures
containing the left and right eye images in a top-bottom order.</p>
<dl class="field-list simple">
<dt class="field-odd">arg name<span class="colon">:</span></dt>
<dd class="field-odd"><p>the uniform name</p>
</dd>
<dt class="field-even">type name<span class="colon">:</span></dt>
<dd class="field-even"><p>string</p>
</dd>
</dl>
</div>
<dl class="py method">
<dt class="sig sig-object py" id="bge.types.BL_Shader.validate">
<span class="sig-name descname"><span class="pre">validate</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#bge.types.BL_Shader.validate" title="Link to this definition"></a></dt>
<dd><p>Validate the shader object.</p>
</dd></dl>
</dd></dl>
</section>
</div>
</div>
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
<a href="bge.types.BL_ArmatureObject.html" class="btn btn-neutral float-left" title="BL_ArmatureObject(KX_GameObject)" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
<a href="bge.types.BL_Texture.html" class="btn btn-neutral float-right" title="BL_Texture(EXP_Value)" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
</div>
<hr/>
<div role="contentinfo">
<p>© Copyright Blender Authors.
<span class="commit">Revision <code><a href=https://projects.blender.org/blender/blender/commit/1dff62ca3acd>1dff62ca3acd</a> - 10/09/2023</code>.
</span></p>
</div>
</footer>
</div>
</div>
</section>
</div>
<div class="rst-versions" data-toggle="rst-versions" role="note" aria-label="document versions">
<ul id="versionwrap" role="presentation">
<li role="presentation">
<span id="version-popover" class="version-btn" tabindex="0" role="button" aria-label="versions selector" aria-haspopup="true" aria-controls="version-vsnlist" aria-disabled="true">
4.0
</span>
<div class="version-dialog" aria-hidden="true">
<div class="version-arrow" aria-hidden="true"></div>
<div class="version-title">Versions</div>
<ul id="version-vsnlist" class="version-list" role="menu" aria-labelledby="version-popover" aria-hidden="true">
<li role="presentation">Loading...</li>
</ul>
</div>
</li>
</ul>
</div>
<script>
jQuery(function () {
SphinxRtdTheme.Navigation.enable(false);
});
</script>
</body>
</html>