-
Notifications
You must be signed in to change notification settings - Fork 4
/
bge.render.html
799 lines (728 loc) · 54.6 KB
/
bge.render.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
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
<!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>Rasterizer (bge.render) — 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.render.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="Video Texture (bge.texture)" href="bge.texture.html" />
<link rel="prev" title="Game Logic (bge.logic)" href="bge.logic.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"><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 current"><a class="current reference internal" href="#">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 active">Rasterizer (bge.render)</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="rasterizer-bge-render">
<h1>Rasterizer (bge.render)<a class="headerlink" href="#rasterizer-bge-render" title="Link to this heading"></a></h1>
<section id="module-bge.render">
<span id="intro"></span><h2>Intro<a class="headerlink" href="#module-bge.render" title="Link to this heading"></a></h2>
<p>Example of using a <a class="reference internal" href="bge.types.SCA_MouseSensor.html#bge.types.SCA_MouseSensor" title="bge.types.SCA_MouseSensor"><code class="xref py py-class docutils literal notranslate"><span class="pre">bge.types.SCA_MouseSensor</span></code></a>,
and two <a class="reference internal" href="bge.types.SCA_ObjectActuator.html#bge.types.SCA_ObjectActuator" title="bge.types.SCA_ObjectActuator"><code class="xref py py-class docutils literal notranslate"><span class="pre">bge.types.SCA_ObjectActuator</span></code></a> to implement MouseLook:</p>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>This can also be achieved with the <a class="reference internal" href="bge.types.SCA_MouseActuator.html#bge.types.SCA_MouseActuator" title="bge.types.SCA_MouseActuator"><code class="xref py py-class docutils literal notranslate"><span class="pre">bge.types.SCA_MouseActuator</span></code></a>.</p>
</div>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="c1"># To use a mouse movement sensor "Mouse" and a</span>
<span class="c1"># motion actuator to mouse look:</span>
<span class="kn">import</span> <span class="nn">bge</span>
<span class="c1"># scale sets the speed of motion</span>
<span class="n">scale</span> <span class="o">=</span> <span class="mf">1.0</span><span class="p">,</span> <span class="mf">0.5</span>
<span class="n">co</span> <span class="o">=</span> <span class="n">bge</span><span class="o">.</span><span class="n">logic</span><span class="o">.</span><span class="n">getCurrentController</span><span class="p">()</span>
<span class="n">obj</span> <span class="o">=</span> <span class="n">co</span><span class="o">.</span><span class="n">owner</span>
<span class="n">mouse</span> <span class="o">=</span> <span class="n">co</span><span class="o">.</span><span class="n">sensors</span><span class="p">[</span><span class="s2">"Mouse"</span><span class="p">]</span>
<span class="n">lmotion</span> <span class="o">=</span> <span class="n">co</span><span class="o">.</span><span class="n">actuators</span><span class="p">[</span><span class="s2">"LMove"</span><span class="p">]</span>
<span class="n">wmotion</span> <span class="o">=</span> <span class="n">co</span><span class="o">.</span><span class="n">actuators</span><span class="p">[</span><span class="s2">"WMove"</span><span class="p">]</span>
<span class="c1"># Transform the mouse coordinates to see how far the mouse has moved.</span>
<span class="k">def</span> <span class="nf">mousePos</span><span class="p">():</span>
<span class="n">x</span> <span class="o">=</span> <span class="p">(</span><span class="n">bge</span><span class="o">.</span><span class="n">render</span><span class="o">.</span><span class="n">getWindowWidth</span><span class="p">()</span> <span class="o">/</span> <span class="mi">2</span> <span class="o">-</span> <span class="n">mouse</span><span class="o">.</span><span class="n">position</span><span class="p">[</span><span class="mi">0</span><span class="p">])</span> <span class="o">*</span> <span class="n">scale</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span>
<span class="n">y</span> <span class="o">=</span> <span class="p">(</span><span class="n">bge</span><span class="o">.</span><span class="n">render</span><span class="o">.</span><span class="n">getWindowHeight</span><span class="p">()</span> <span class="o">/</span> <span class="mi">2</span> <span class="o">-</span> <span class="n">mouse</span><span class="o">.</span><span class="n">position</span><span class="p">[</span><span class="mi">1</span><span class="p">])</span> <span class="o">*</span> <span class="n">scale</span><span class="p">[</span><span class="mi">1</span><span class="p">]</span>
<span class="k">return</span> <span class="p">(</span><span class="n">x</span><span class="p">,</span> <span class="n">y</span><span class="p">)</span>
<span class="n">pos</span> <span class="o">=</span> <span class="n">mousePos</span><span class="p">()</span>
<span class="c1"># Set the amount of motion: X is applied in world coordinates...</span>
<span class="n">wmotion</span><span class="o">.</span><span class="n">useLocalTorque</span> <span class="o">=</span> <span class="kc">False</span>
<span class="n">wmotion</span><span class="o">.</span><span class="n">torque</span> <span class="o">=</span> <span class="p">((</span><span class="mf">0.0</span><span class="p">,</span> <span class="mf">0.0</span><span class="p">,</span> <span class="n">pos</span><span class="p">[</span><span class="mi">0</span><span class="p">]))</span>
<span class="c1"># ...Y is applied in local coordinates</span>
<span class="n">lmotion</span><span class="o">.</span><span class="n">useLocalTorque</span> <span class="o">=</span> <span class="kc">True</span>
<span class="n">lmotion</span><span class="o">.</span><span class="n">torque</span> <span class="o">=</span> <span class="p">((</span><span class="o">-</span><span class="n">pos</span><span class="p">[</span><span class="mi">1</span><span class="p">],</span> <span class="mf">0.0</span><span class="p">,</span> <span class="mf">0.0</span><span class="p">))</span>
<span class="c1"># Activate both actuators</span>
<span class="n">co</span><span class="o">.</span><span class="n">activate</span><span class="p">(</span><span class="n">lmotion</span><span class="p">)</span>
<span class="n">co</span><span class="o">.</span><span class="n">activate</span><span class="p">(</span><span class="n">wmotion</span><span class="p">)</span>
<span class="c1"># Centre the mouse</span>
<span class="n">bge</span><span class="o">.</span><span class="n">render</span><span class="o">.</span><span class="n">setMousePosition</span><span class="p">(</span><span class="nb">int</span><span class="p">(</span><span class="n">bge</span><span class="o">.</span><span class="n">render</span><span class="o">.</span><span class="n">getWindowWidth</span><span class="p">()</span> <span class="o">/</span> <span class="mi">2</span><span class="p">),</span> <span class="nb">int</span><span class="p">(</span><span class="n">bge</span><span class="o">.</span><span class="n">render</span><span class="o">.</span><span class="n">getWindowHeight</span><span class="p">()</span> <span class="o">/</span> <span class="mi">2</span><span class="p">))</span>
</pre></div>
</div>
</section>
<section id="constants">
<h2>Constants<a class="headerlink" href="#constants" title="Link to this heading"></a></h2>
<dl class="py data">
<dt class="sig sig-object py" id="bge.render.KX_TEXFACE_MATERIAL">
<span class="sig-prename descclassname"><span class="pre">bge.render.</span></span><span class="sig-name descname"><span class="pre">KX_TEXFACE_MATERIAL</span></span><a class="headerlink" href="#bge.render.KX_TEXFACE_MATERIAL" title="Link to this definition"></a></dt>
<dd><div class="deprecated">
<p><span class="versionmodified deprecated">Deprecated since version 0.2.2.</span></p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Type<span class="colon">:</span></dt>
<dd class="field-odd"><p>integer</p>
</dd>
</dl>
</dd></dl>
<dl class="py data">
<dt class="sig sig-object py" id="bge.render.KX_BLENDER_MULTITEX_MATERIAL">
<span class="sig-prename descclassname"><span class="pre">bge.render.</span></span><span class="sig-name descname"><span class="pre">KX_BLENDER_MULTITEX_MATERIAL</span></span><a class="headerlink" href="#bge.render.KX_BLENDER_MULTITEX_MATERIAL" title="Link to this definition"></a></dt>
<dd><div class="deprecated">
<p><span class="versionmodified deprecated">Deprecated since version 0.2.2.</span></p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Type<span class="colon">:</span></dt>
<dd class="field-odd"><p>integer</p>
</dd>
</dl>
</dd></dl>
<dl class="py data">
<dt class="sig sig-object py" id="bge.render.KX_BLENDER_GLSL_MATERIAL">
<span class="sig-prename descclassname"><span class="pre">bge.render.</span></span><span class="sig-name descname"><span class="pre">KX_BLENDER_GLSL_MATERIAL</span></span><a class="headerlink" href="#bge.render.KX_BLENDER_GLSL_MATERIAL" title="Link to this definition"></a></dt>
<dd><div class="deprecated">
<p><span class="versionmodified deprecated">Deprecated since version 0.2.2.</span></p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Type<span class="colon">:</span></dt>
<dd class="field-odd"><p>integer</p>
</dd>
</dl>
</dd></dl>
<dl class="py data">
<dt class="sig sig-object py" id="bge.render.VSYNC_OFF">
<span class="sig-prename descclassname"><span class="pre">bge.render.</span></span><span class="sig-name descname"><span class="pre">VSYNC_OFF</span></span><a class="headerlink" href="#bge.render.VSYNC_OFF" title="Link to this definition"></a></dt>
<dd><p>Disables vsync</p>
<dl class="field-list simple">
<dt class="field-odd">Type<span class="colon">:</span></dt>
<dd class="field-odd"><p>integer</p>
</dd>
</dl>
</dd></dl>
<dl class="py data">
<dt class="sig sig-object py" id="bge.render.VSYNC_ON">
<span class="sig-prename descclassname"><span class="pre">bge.render.</span></span><span class="sig-name descname"><span class="pre">VSYNC_ON</span></span><a class="headerlink" href="#bge.render.VSYNC_ON" title="Link to this definition"></a></dt>
<dd><p>Enables vsync</p>
<dl class="field-list simple">
<dt class="field-odd">Type<span class="colon">:</span></dt>
<dd class="field-odd"><p>integer</p>
</dd>
</dl>
</dd></dl>
<dl class="py data">
<dt class="sig sig-object py" id="bge.render.VSYNC_ADAPTIVE">
<span class="sig-prename descclassname"><span class="pre">bge.render.</span></span><span class="sig-name descname"><span class="pre">VSYNC_ADAPTIVE</span></span><a class="headerlink" href="#bge.render.VSYNC_ADAPTIVE" title="Link to this definition"></a></dt>
<dd><p>Enables adaptive vsync if supported.
Adaptive vsync enables vsync if the framerate is above the monitors refresh rate.
Otherwise, vsync is disabled if the framerate is too low.</p>
<dl class="field-list simple">
<dt class="field-odd">Type<span class="colon">:</span></dt>
<dd class="field-odd"><p>integer</p>
</dd>
</dl>
</dd></dl>
<dl class="py data">
<dt class="sig sig-object py" id="bge.render.LEFT_EYE">
<span class="sig-prename descclassname"><span class="pre">bge.render.</span></span><span class="sig-name descname"><span class="pre">LEFT_EYE</span></span><a class="headerlink" href="#bge.render.LEFT_EYE" title="Link to this definition"></a></dt>
<dd><div class="deprecated">
<p><span class="versionmodified deprecated">Deprecated since version 0.3.0.</span></p>
</div>
<p>Left eye being used during stereoscopic rendering.</p>
<dl class="field-list simple">
<dt class="field-odd">Type<span class="colon">:</span></dt>
<dd class="field-odd"><p>integer</p>
</dd>
</dl>
</dd></dl>
<dl class="py data">
<dt class="sig sig-object py" id="bge.render.RIGHT_EYE">
<span class="sig-prename descclassname"><span class="pre">bge.render.</span></span><span class="sig-name descname"><span class="pre">RIGHT_EYE</span></span><a class="headerlink" href="#bge.render.RIGHT_EYE" title="Link to this definition"></a></dt>
<dd><div class="deprecated">
<p><span class="versionmodified deprecated">Deprecated since version 0.3.0.</span></p>
</div>
<p>Right eye being used during stereoscopic rendering.</p>
<dl class="field-list simple">
<dt class="field-odd">Type<span class="colon">:</span></dt>
<dd class="field-odd"><p>integer</p>
</dd>
</dl>
</dd></dl>
<dl class="py data">
<dt class="sig sig-object py" id="bge.render.RAS_MIPMAP_NONE">
<span class="sig-prename descclassname"><span class="pre">bge.render.</span></span><span class="sig-name descname"><span class="pre">RAS_MIPMAP_NONE</span></span><a class="headerlink" href="#bge.render.RAS_MIPMAP_NONE" title="Link to this definition"></a></dt>
<dd><div class="deprecated">
<p><span class="versionmodified deprecated">Deprecated since version 0.3.0.</span></p>
</div>
<p>Disables Mipmap filtering.</p>
<dl class="field-list simple">
<dt class="field-odd">Type<span class="colon">:</span></dt>
<dd class="field-odd"><p>integer</p>
</dd>
</dl>
</dd></dl>
<dl class="py data">
<dt class="sig sig-object py" id="bge.render.RAS_MIPMAP_NEAREST">
<span class="sig-prename descclassname"><span class="pre">bge.render.</span></span><span class="sig-name descname"><span class="pre">RAS_MIPMAP_NEAREST</span></span><a class="headerlink" href="#bge.render.RAS_MIPMAP_NEAREST" title="Link to this definition"></a></dt>
<dd><div class="deprecated">
<p><span class="versionmodified deprecated">Deprecated since version 0.3.0.</span></p>
</div>
<p>Applies mipmap filtering with nearest neighbour interpolation.</p>
<dl class="field-list simple">
<dt class="field-odd">Type<span class="colon">:</span></dt>
<dd class="field-odd"><p>integer</p>
</dd>
</dl>
</dd></dl>
<dl class="py data">
<dt class="sig sig-object py" id="bge.render.RAS_MIPMAP_LINEAR">
<span class="sig-prename descclassname"><span class="pre">bge.render.</span></span><span class="sig-name descname"><span class="pre">RAS_MIPMAP_LINEAR</span></span><a class="headerlink" href="#bge.render.RAS_MIPMAP_LINEAR" title="Link to this definition"></a></dt>
<dd><div class="deprecated">
<p><span class="versionmodified deprecated">Deprecated since version 0.3.0.</span></p>
</div>
<p>Applies mipmap filtering with nearest linear interpolation.</p>
<dl class="field-list simple">
<dt class="field-odd">Type<span class="colon">:</span></dt>
<dd class="field-odd"><p>integer</p>
</dd>
</dl>
</dd></dl>
</section>
<section id="functions">
<h2>Functions<a class="headerlink" href="#functions" title="Link to this heading"></a></h2>
<dl class="py function">
<dt class="sig sig-object py" id="bge.render.getWindowWidth">
<span class="sig-prename descclassname"><span class="pre">bge.render.</span></span><span class="sig-name descname"><span class="pre">getWindowWidth</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#bge.render.getWindowWidth" title="Link to this definition"></a></dt>
<dd><p>Gets the width of the window (in pixels)</p>
<dl class="field-list simple">
<dt class="field-odd">Return type<span class="colon">:</span></dt>
<dd class="field-odd"><p>integer</p>
</dd>
</dl>
</dd></dl>
<dl class="py function">
<dt class="sig sig-object py" id="bge.render.getWindowHeight">
<span class="sig-prename descclassname"><span class="pre">bge.render.</span></span><span class="sig-name descname"><span class="pre">getWindowHeight</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#bge.render.getWindowHeight" title="Link to this definition"></a></dt>
<dd><p>Gets the height of the window (in pixels)</p>
<dl class="field-list simple">
<dt class="field-odd">Return type<span class="colon">:</span></dt>
<dd class="field-odd"><p>integer</p>
</dd>
</dl>
</dd></dl>
<dl class="py function">
<dt class="sig sig-object py" id="bge.render.setWindowSize">
<span class="sig-prename descclassname"><span class="pre">bge.render.</span></span><span class="sig-name descname"><span class="pre">setWindowSize</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">width</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">height</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#bge.render.setWindowSize" title="Link to this definition"></a></dt>
<dd><p>Set the width and height of the window (in pixels). This also works for fullscreen applications.</p>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>Only works in the standalone player, not the Blender-embedded player.</p>
</div>
<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>width</strong> (<em>integer</em>) – width in pixels</p></li>
<li><p><strong>height</strong> (<em>integer</em>) – height in pixels</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py function">
<dt class="sig sig-object py" id="bge.render.setFullScreen">
<span class="sig-prename descclassname"><span class="pre">bge.render.</span></span><span class="sig-name descname"><span class="pre">setFullScreen</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">enable</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#bge.render.setFullScreen" title="Link to this definition"></a></dt>
<dd><p>Set whether or not the window should be fullscreen.</p>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>Only works in the standalone player, not the Blender-embedded player.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>enable</strong> (<em>bool</em>) – <code class="docutils literal notranslate"><span class="pre">True</span></code> to set full screen, <code class="docutils literal notranslate"><span class="pre">False</span></code> to set windowed.</p>
</dd>
</dl>
</dd></dl>
<dl class="py function">
<dt class="sig sig-object py" id="bge.render.getFullScreen">
<span class="sig-prename descclassname"><span class="pre">bge.render.</span></span><span class="sig-name descname"><span class="pre">getFullScreen</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#bge.render.getFullScreen" title="Link to this definition"></a></dt>
<dd><p>Returns whether or not the window is fullscreen.</p>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>Only works in the standalone player, not the Blender-embedded player; there it always returns False.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Return type<span class="colon">:</span></dt>
<dd class="field-odd"><p>bool</p>
</dd>
</dl>
</dd></dl>
<dl class="py function">
<dt class="sig sig-object py" id="bge.render.getDisplayDimensions">
<span class="sig-prename descclassname"><span class="pre">bge.render.</span></span><span class="sig-name descname"><span class="pre">getDisplayDimensions</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#bge.render.getDisplayDimensions" title="Link to this definition"></a></dt>
<dd><p>Get the display dimensions, in pixels, of the display (e.g., the
monitor). Can return the size of the entire view, so the
combination of all monitors; for example, <code class="docutils literal notranslate"><span class="pre">(3840,</span> <span class="pre">1080)</span></code> for two
side-by-side 1080p monitors.</p>
<dl class="field-list simple">
<dt class="field-odd">Return type<span class="colon">:</span></dt>
<dd class="field-odd"><p>tuple (width, height)</p>
</dd>
</dl>
</dd></dl>
<dl class="py function">
<dt class="sig sig-object py" id="bge.render.makeScreenshot">
<span class="sig-prename descclassname"><span class="pre">bge.render.</span></span><span class="sig-name descname"><span class="pre">makeScreenshot</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">filename</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#bge.render.makeScreenshot" title="Link to this definition"></a></dt>
<dd><p>Writes an image file with the displayed image at the frame end.</p>
<p>The image is written to <em>‘filename’</em>.
The path may be absolute (eg. <code class="docutils literal notranslate"><span class="pre">/home/foo/image</span></code>) or relative when started with
<code class="docutils literal notranslate"><span class="pre">//</span></code> (eg. <code class="docutils literal notranslate"><span class="pre">//image</span></code>). Note that absolute paths are not portable between platforms.
If the filename contains a <code class="docutils literal notranslate"><span class="pre">#</span></code>,
it will be replaced by an incremental index so that screenshots can be taken multiple
times without overwriting the previous ones (eg. <code class="docutils literal notranslate"><span class="pre">image-#</span></code>).</p>
<p>Settings for the image are taken from the render settings (file format and respective settings,
gamma and colospace conversion, etc).
The image resolution matches the framebuffer, meaning, the window size and aspect ratio.
When running from the standalone player, instead of the embedded player, only PNG files are supported.
Additional color conversions are also not supported.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>filename</strong> (<em>string</em>) – path and name of the file to write</p>
</dd>
</dl>
</dd></dl>
<dl class="py function">
<dt class="sig sig-object py" id="bge.render.enableVisibility">
<span class="sig-prename descclassname"><span class="pre">bge.render.</span></span><span class="sig-name descname"><span class="pre">enableVisibility</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">visible</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#bge.render.enableVisibility" title="Link to this definition"></a></dt>
<dd><div class="deprecated">
<p><span class="versionmodified deprecated">Deprecated since version 0.0.1: </span>Doesn’t do anything.</p>
</div>
</dd></dl>
<dl class="py function">
<dt class="sig sig-object py" id="bge.render.showMouse">
<span class="sig-prename descclassname"><span class="pre">bge.render.</span></span><span class="sig-name descname"><span class="pre">showMouse</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">visible</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#bge.render.showMouse" title="Link to this definition"></a></dt>
<dd><p>Enables or disables the operating system mouse cursor.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>visible</strong> (<em>boolean</em>) – </p>
</dd>
</dl>
</dd></dl>
<dl class="py function">
<dt class="sig sig-object py" id="bge.render.setMousePosition">
<span class="sig-prename descclassname"><span class="pre">bge.render.</span></span><span class="sig-name descname"><span class="pre">setMousePosition</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">x</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">y</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#bge.render.setMousePosition" title="Link to this definition"></a></dt>
<dd><p>Sets the mouse cursor position.</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>x</strong> (<em>integer</em>) – X-coordinate in screen pixel coordinates.</p></li>
<li><p><strong>y</strong> (<em>integer</em>) – Y-coordinate in screen pixel coordinates.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py function">
<dt class="sig sig-object py" id="bge.render.setBackgroundColor">
<span class="sig-prename descclassname"><span class="pre">bge.render.</span></span><span class="sig-name descname"><span class="pre">setBackgroundColor</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">rgba</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#bge.render.setBackgroundColor" title="Link to this definition"></a></dt>
<dd><div class="deprecated">
<p><span class="versionmodified deprecated">Deprecated since version 0.2.2: </span>Use <a class="reference internal" href="bge.texture.html#bge.texture.ImageRender.horizon" title="bge.texture.ImageRender.horizon"><code class="xref py py-attr docutils literal notranslate"><span class="pre">bge.texture.ImageRender.horizon</span></code></a> or <a class="reference internal" href="bge.texture.html#bge.texture.ImageRender.zenith" title="bge.texture.ImageRender.zenith"><code class="xref py py-attr docutils literal notranslate"><span class="pre">bge.texture.ImageRender.zenith</span></code></a> instead.</p>
</div>
</dd></dl>
<dl class="py function">
<dt class="sig sig-object py" id="bge.render.setEyeSeparation">
<span class="sig-prename descclassname"><span class="pre">bge.render.</span></span><span class="sig-name descname"><span class="pre">setEyeSeparation</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">eyesep</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#bge.render.setEyeSeparation" title="Link to this definition"></a></dt>
<dd><div class="deprecated">
<p><span class="versionmodified deprecated">Deprecated since version 0.3.0.</span></p>
</div>
<p>Sets the eye separation for stereo mode. Usually Focal Length/30 provides a comfortable value.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>eyesep</strong> (<em>float</em>) – The distance between the left and right eye.</p>
</dd>
</dl>
</dd></dl>
<dl class="py function">
<dt class="sig sig-object py" id="bge.render.getEyeSeparation">
<span class="sig-prename descclassname"><span class="pre">bge.render.</span></span><span class="sig-name descname"><span class="pre">getEyeSeparation</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#bge.render.getEyeSeparation" title="Link to this definition"></a></dt>
<dd><div class="deprecated">
<p><span class="versionmodified deprecated">Deprecated since version 0.3.0.</span></p>
</div>
<p>Gets the current eye separation for stereo mode.</p>
<dl class="field-list simple">
<dt class="field-odd">Return type<span class="colon">:</span></dt>
<dd class="field-odd"><p>float</p>
</dd>
</dl>
</dd></dl>
<dl class="py function">
<dt class="sig sig-object py" id="bge.render.setFocalLength">
<span class="sig-prename descclassname"><span class="pre">bge.render.</span></span><span class="sig-name descname"><span class="pre">setFocalLength</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">focallength</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#bge.render.setFocalLength" title="Link to this definition"></a></dt>
<dd><div class="deprecated">
<p><span class="versionmodified deprecated">Deprecated since version 0.3.0.</span></p>
</div>
<p>Sets the focal length for stereo mode. It uses the current camera focal length as initial value.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>focallength</strong> (<em>float</em>) – The focal length.</p>
</dd>
</dl>
</dd></dl>
<dl class="py function">
<dt class="sig sig-object py" id="bge.render.getFocalLength">
<span class="sig-prename descclassname"><span class="pre">bge.render.</span></span><span class="sig-name descname"><span class="pre">getFocalLength</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#bge.render.getFocalLength" title="Link to this definition"></a></dt>
<dd><div class="deprecated">
<p><span class="versionmodified deprecated">Deprecated since version 0.3.0.</span></p>
</div>
<p>Gets the current focal length for stereo mode.</p>
<dl class="field-list simple">
<dt class="field-odd">Return type<span class="colon">:</span></dt>
<dd class="field-odd"><p>float</p>
</dd>
</dl>
</dd></dl>
<dl class="py function">
<dt class="sig sig-object py" id="bge.render.getStereoEye">
<span class="sig-prename descclassname"><span class="pre">bge.render.</span></span><span class="sig-name descname"><span class="pre">getStereoEye</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#bge.render.getStereoEye" title="Link to this definition"></a></dt>
<dd><div class="deprecated">
<p><span class="versionmodified deprecated">Deprecated since version 0.3.0.</span></p>
</div>
<p>Gets the current stereoscopy eye being rendered.
This function is mainly used in a <a class="reference internal" href="bge.types.KX_Scene.html#bge.types.KX_Scene.pre_draw" title="bge.types.KX_Scene.pre_draw"><code class="xref py py-attr docutils literal notranslate"><span class="pre">bge.types.KX_Scene.pre_draw</span></code></a> callback
function to customize the camera projection matrices for each
stereoscopic eye.</p>
<dl class="field-list simple">
<dt class="field-odd">Returns<span class="colon">:</span></dt>
<dd class="field-odd"><p>One of <a class="reference internal" href="#bge.render.LEFT_EYE" title="bge.render.LEFT_EYE"><code class="xref py py-data docutils literal notranslate"><span class="pre">LEFT_EYE</span></code></a>, <a class="reference internal" href="#bge.render.RIGHT_EYE" title="bge.render.RIGHT_EYE"><code class="xref py py-data docutils literal notranslate"><span class="pre">RIGHT_EYE</span></code></a>.</p>
</dd>
<dt class="field-even">Return type<span class="colon">:</span></dt>
<dd class="field-even"><p><a class="reference internal" href="#bge.render.LEFT_EYE" title="bge.render.LEFT_EYE">LEFT_EYE</a>, <a class="reference internal" href="#bge.render.RIGHT_EYE" title="bge.render.RIGHT_EYE">RIGHT_EYE</a></p>
</dd>
</dl>
</dd></dl>
<dl class="py function">
<dt class="sig sig-object py" id="bge.render.setMaterialMode">
<span class="sig-prename descclassname"><span class="pre">bge.render.</span></span><span class="sig-name descname"><span class="pre">setMaterialMode</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">mode</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#bge.render.setMaterialMode" title="Link to this definition"></a></dt>
<dd><div class="deprecated">
<p><span class="versionmodified deprecated">Deprecated since version 0.2.2.</span></p>
</div>
</dd></dl>
<dl class="py function">
<dt class="sig sig-object py" id="bge.render.getMaterialMode">
<span class="sig-prename descclassname"><span class="pre">bge.render.</span></span><span class="sig-name descname"><span class="pre">getMaterialMode</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">mode</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#bge.render.getMaterialMode" title="Link to this definition"></a></dt>
<dd><div class="deprecated">
<p><span class="versionmodified deprecated">Deprecated since version 0.2.2.</span></p>
</div>
</dd></dl>
<dl class="py function">
<dt class="sig sig-object py" id="bge.render.setGLSLMaterialSetting">
<span class="sig-prename descclassname"><span class="pre">bge.render.</span></span><span class="sig-name descname"><span class="pre">setGLSLMaterialSetting</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">setting</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">enable</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#bge.render.setGLSLMaterialSetting" title="Link to this definition"></a></dt>
<dd><div class="deprecated">
<p><span class="versionmodified deprecated">Deprecated since version 0.3.0.</span></p>
</div>
</dd></dl>
<dl class="py function">
<dt class="sig sig-object py" id="bge.render.getGLSLMaterialSetting">
<span class="sig-prename descclassname"><span class="pre">bge.render.</span></span><span class="sig-name descname"><span class="pre">getGLSLMaterialSetting</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">setting</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#bge.render.getGLSLMaterialSetting" title="Link to this definition"></a></dt>
<dd><div class="deprecated">
<p><span class="versionmodified deprecated">Deprecated since version 0.3.0.</span></p>
</div>
</dd></dl>
<dl class="py function">
<dt class="sig sig-object py" id="bge.render.setAnisotropicFiltering">
<span class="sig-prename descclassname"><span class="pre">bge.render.</span></span><span class="sig-name descname"><span class="pre">setAnisotropicFiltering</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">level</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#bge.render.setAnisotropicFiltering" title="Link to this definition"></a></dt>
<dd><div class="deprecated">
<p><span class="versionmodified deprecated">Deprecated since version 0.3.0.</span></p>
</div>
<p>Set the anisotropic filtering level for textures.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>level</strong> (<em>integer</em><em> (</em><em>must be one</em><em> of </em><em>1</em><em>, </em><em>2</em><em>, </em><em>4</em><em>, </em><em>8</em><em>, </em><em>16</em><em>)</em>) – The new anisotropic filtering level to use</p>
</dd>
</dl>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>Changing this value can cause all textures to be recreated, which can be slow.</p>
</div>
</dd></dl>
<dl class="py function">
<dt class="sig sig-object py" id="bge.render.getAnisotropicFiltering">
<span class="sig-prename descclassname"><span class="pre">bge.render.</span></span><span class="sig-name descname"><span class="pre">getAnisotropicFiltering</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#bge.render.getAnisotropicFiltering" title="Link to this definition"></a></dt>
<dd><div class="deprecated">
<p><span class="versionmodified deprecated">Deprecated since version 0.3.0.</span></p>
</div>
<p>Get the anisotropic filtering level used for textures.</p>
<dl class="field-list simple">
<dt class="field-odd">Return type<span class="colon">:</span></dt>
<dd class="field-odd"><p>integer (one of 1, 2, 4, 8, 16)</p>
</dd>
</dl>
</dd></dl>
<dl class="py function">
<dt class="sig sig-object py" id="bge.render.setMipmapping">
<span class="sig-prename descclassname"><span class="pre">bge.render.</span></span><span class="sig-name descname"><span class="pre">setMipmapping</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">value</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#bge.render.setMipmapping" title="Link to this definition"></a></dt>
<dd><div class="deprecated">
<p><span class="versionmodified deprecated">Deprecated since version 0.3.0.</span></p>
</div>
<p>Change how to use mipmapping.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>value</strong> (<em>integer</em>) – One of <a class="reference internal" href="#bge.render.RAS_MIPMAP_NONE" title="bge.render.RAS_MIPMAP_NONE"><code class="xref py py-data docutils literal notranslate"><span class="pre">RAS_MIPMAP_NONE</span></code></a>, <a class="reference internal" href="#bge.render.RAS_MIPMAP_NEAREST" title="bge.render.RAS_MIPMAP_NEAREST"><code class="xref py py-data docutils literal notranslate"><span class="pre">RAS_MIPMAP_NEAREST</span></code></a>, <a class="reference internal" href="#bge.render.RAS_MIPMAP_LINEAR" title="bge.render.RAS_MIPMAP_LINEAR"><code class="xref py py-data docutils literal notranslate"><span class="pre">RAS_MIPMAP_LINEAR</span></code></a></p>
</dd>
</dl>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>Changing this value can cause all textures to be recreated, which can be slow.</p>
</div>
</dd></dl>
<dl class="py function">
<dt class="sig sig-object py" id="bge.render.getMipmapping">
<span class="sig-prename descclassname"><span class="pre">bge.render.</span></span><span class="sig-name descname"><span class="pre">getMipmapping</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#bge.render.getMipmapping" title="Link to this definition"></a></dt>
<dd><div class="deprecated">
<p><span class="versionmodified deprecated">Deprecated since version 0.3.0.</span></p>
</div>
<p>Get the current mipmapping setting.</p>
<dl class="field-list simple">
<dt class="field-odd">Returns<span class="colon">:</span></dt>
<dd class="field-odd"><p>One of <a class="reference internal" href="#bge.render.RAS_MIPMAP_NONE" title="bge.render.RAS_MIPMAP_NONE"><code class="xref py py-data docutils literal notranslate"><span class="pre">RAS_MIPMAP_NONE</span></code></a>, <a class="reference internal" href="#bge.render.RAS_MIPMAP_NEAREST" title="bge.render.RAS_MIPMAP_NEAREST"><code class="xref py py-data docutils literal notranslate"><span class="pre">RAS_MIPMAP_NEAREST</span></code></a>, <a class="reference internal" href="#bge.render.RAS_MIPMAP_LINEAR" title="bge.render.RAS_MIPMAP_LINEAR"><code class="xref py py-data docutils literal notranslate"><span class="pre">RAS_MIPMAP_LINEAR</span></code></a></p>
</dd>
<dt class="field-even">Return type<span class="colon">:</span></dt>
<dd class="field-even"><p>integer</p>
</dd>
</dl>
</dd></dl>
<dl class="py function">
<dt class="sig sig-object py" id="bge.render.drawLine">
<span class="sig-prename descclassname"><span class="pre">bge.render.</span></span><span class="sig-name descname"><span class="pre">drawLine</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">fromVec</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">toVec</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">color</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#bge.render.drawLine" title="Link to this definition"></a></dt>
<dd><p>Draw a line in the 3D scene.</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>fromVec</strong> (<em>list</em><em> [</em><em>x</em><em>, </em><em>y</em><em>, </em><em>z</em><em>]</em>) – the origin of the line</p></li>
<li><p><strong>toVec</strong> (<em>list</em><em> [</em><em>x</em><em>, </em><em>y</em><em>, </em><em>z</em><em>]</em>) – the end of the line</p></li>
<li><p><strong>color</strong> (<em>list</em><em> [</em><em>r</em><em>, </em><em>g</em><em>, </em><em>b</em><em>, </em><em>a</em><em>]</em>) – the color of the line</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py function">
<dt class="sig sig-object py" id="bge.render.enableMotionBlur">
<span class="sig-prename descclassname"><span class="pre">bge.render.</span></span><span class="sig-name descname"><span class="pre">enableMotionBlur</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">factor</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#bge.render.enableMotionBlur" title="Link to this definition"></a></dt>
<dd><div class="deprecated">
<p><span class="versionmodified deprecated">Deprecated since version 0.3.0.</span></p>
</div>
<p>Enable the motion blur effect.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>factor</strong> (<em>float</em><em> [</em><em>0.0 - 1.0</em><em>]</em>) – the amount of motion blur to display.</p>
</dd>
</dl>
</dd></dl>
<dl class="py function">
<dt class="sig sig-object py" id="bge.render.disableMotionBlur">
<span class="sig-prename descclassname"><span class="pre">bge.render.</span></span><span class="sig-name descname"><span class="pre">disableMotionBlur</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#bge.render.disableMotionBlur" title="Link to this definition"></a></dt>
<dd><div class="deprecated">
<p><span class="versionmodified deprecated">Deprecated since version 0.3.0.</span></p>
</div>
<p>Disable the motion blur effect.</p>
</dd></dl>
<dl class="py function">
<dt class="sig sig-object py" id="bge.render.showFramerate">
<span class="sig-prename descclassname"><span class="pre">bge.render.</span></span><span class="sig-name descname"><span class="pre">showFramerate</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">enable</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#bge.render.showFramerate" title="Link to this definition"></a></dt>
<dd><p>Show or hide the framerate.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>enable</strong> (<em>boolean</em>) – </p>
</dd>
</dl>
</dd></dl>
<dl class="py function">
<dt class="sig sig-object py" id="bge.render.showProfile">
<span class="sig-prename descclassname"><span class="pre">bge.render.</span></span><span class="sig-name descname"><span class="pre">showProfile</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">enable</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#bge.render.showProfile" title="Link to this definition"></a></dt>
<dd><p>Show or hide the profile.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>enable</strong> (<em>boolean</em>) – </p>
</dd>
</dl>
</dd></dl>
<dl class="py function">
<dt class="sig sig-object py" id="bge.render.showProperties">
<span class="sig-prename descclassname"><span class="pre">bge.render.</span></span><span class="sig-name descname"><span class="pre">showProperties</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">enable</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#bge.render.showProperties" title="Link to this definition"></a></dt>
<dd><p>Show or hide the debug properties.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>enable</strong> (<em>boolean</em>) – </p>
</dd>
</dl>
</dd></dl>
<dl class="py function">
<dt class="sig sig-object py" id="bge.render.autoDebugList">
<span class="sig-prename descclassname"><span class="pre">bge.render.</span></span><span class="sig-name descname"><span class="pre">autoDebugList</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">enable</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#bge.render.autoDebugList" title="Link to this definition"></a></dt>
<dd><p>Enable or disable auto adding debug properties to the debug list.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>enable</strong> (<em>boolean</em>) – </p>
</dd>
</dl>
</dd></dl>
<dl class="py function">
<dt class="sig sig-object py" id="bge.render.clearDebugList">
<span class="sig-prename descclassname"><span class="pre">bge.render.</span></span><span class="sig-name descname"><span class="pre">clearDebugList</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#bge.render.clearDebugList" title="Link to this definition"></a></dt>
<dd><p>Clears the debug property list.</p>
</dd></dl>
<dl class="py function">
<dt class="sig sig-object py" id="bge.render.setVsync">
<span class="sig-prename descclassname"><span class="pre">bge.render.</span></span><span class="sig-name descname"><span class="pre">setVsync</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">value</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#bge.render.setVsync" title="Link to this definition"></a></dt>
<dd><p>Set the vsync value</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>value</strong> (<em>integer</em>) – One of <a class="reference internal" href="#bge.render.VSYNC_OFF" title="bge.render.VSYNC_OFF"><code class="xref py py-data docutils literal notranslate"><span class="pre">VSYNC_OFF</span></code></a>, <a class="reference internal" href="#bge.render.VSYNC_ON" title="bge.render.VSYNC_ON"><code class="xref py py-data docutils literal notranslate"><span class="pre">VSYNC_ON</span></code></a>, <a class="reference internal" href="#bge.render.VSYNC_ADAPTIVE" title="bge.render.VSYNC_ADAPTIVE"><code class="xref py py-data docutils literal notranslate"><span class="pre">VSYNC_ADAPTIVE</span></code></a></p>
</dd>
</dl>
</dd></dl>
<dl class="py function">
<dt class="sig sig-object py" id="bge.render.getVsync">
<span class="sig-prename descclassname"><span class="pre">bge.render.</span></span><span class="sig-name descname"><span class="pre">getVsync</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#bge.render.getVsync" title="Link to this definition"></a></dt>
<dd><p>Get the current vsync value</p>
<dl class="field-list simple">
<dt class="field-odd">Returns<span class="colon">:</span></dt>
<dd class="field-odd"><p>One of <a class="reference internal" href="#bge.render.VSYNC_OFF" title="bge.render.VSYNC_OFF"><code class="xref py py-data docutils literal notranslate"><span class="pre">VSYNC_OFF</span></code></a>, <a class="reference internal" href="#bge.render.VSYNC_ON" title="bge.render.VSYNC_ON"><code class="xref py py-data docutils literal notranslate"><span class="pre">VSYNC_ON</span></code></a>, <a class="reference internal" href="#bge.render.VSYNC_ADAPTIVE" title="bge.render.VSYNC_ADAPTIVE"><code class="xref py py-data docutils literal notranslate"><span class="pre">VSYNC_ADAPTIVE</span></code></a></p>
</dd>
<dt class="field-even">Return type<span class="colon">:</span></dt>
<dd class="field-even"><p>integer</p>
</dd>
</dl>
</dd></dl>
</section>
</section>
</div>
</div>
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
<a href="bge.logic.html" class="btn btn-neutral float-left" title="Game Logic (bge.logic)" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
<a href="bge.texture.html" class="btn btn-neutral float-right" title="Video Texture (bge.texture)" 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/4fd142408b81>4fd142408b81</a> - 12/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>