-
Notifications
You must be signed in to change notification settings - Fork 4
/
bge.types.KX_2DFilter.html
284 lines (256 loc) · 21.7 KB
/
bge.types.KX_2DFilter.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
<!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>KX_2DFilter(BL_Shader) — 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.KX_2DFilter.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="KX_2DFilterOffScreen(EXP_Value)" href="bge.types.KX_2DFilterFrameBuffer.html" />
<link rel="prev" title="EXP_Value(EXP_PyObjectPlus)" href="bge.types.EXP_Value.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">KX_2DFilter(BL_Shader)</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="kx-2dfilter-bl-shader">
<h1>KX_2DFilter(BL_Shader)<a class="headerlink" href="#kx-2dfilter-bl-shader" title="Link to this heading"></a></h1>
<p>base class — <a class="reference internal" href="bge.types.BL_Shader.html#bge.types.BL_Shader" title="bge.types.BL_Shader"><code class="xref py py-class docutils literal notranslate"><span class="pre">BL_Shader</span></code></a></p>
<dl class="py class">
<dt class="sig sig-object py" id="bge.types.KX_2DFilter">
<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">KX_2DFilter</span></span><a class="headerlink" href="#bge.types.KX_2DFilter" title="Link to this definition"></a></dt>
<dd><p>2D filter shader object. Can be alternated with <a class="reference internal" href="bge.types.BL_Shader.html#bge.types.BL_Shader" title="bge.types.BL_Shader"><code class="xref py py-class docutils literal notranslate"><span class="pre">BL_Shader</span></code></a>’s functions.</p>
<div class="admonition warning">
<p class="admonition-title">Warning</p>
<p>The vertex shader must not apply modelview and projection transformation. It should be similar to:</p>
<div class="highlight-glsl notranslate"><div class="highlight"><pre><span></span><span class="k">in</span><span class="w"> </span><span class="kt">vec4</span><span class="w"> </span><span class="n">pos</span><span class="p">;</span>
<span class="k">in</span><span class="w"> </span><span class="kt">vec2</span><span class="w"> </span><span class="n">texCoord</span><span class="p">;</span>
<span class="k">out</span><span class="w"> </span><span class="kt">vec4</span><span class="w"> </span><span class="n">bgl_TexCoord</span><span class="p">;</span>
<span class="kt">void</span><span class="w"> </span><span class="n">main</span><span class="p">(</span><span class="kt">void</span><span class="p">)</span>
<span class="p">{</span>
<span class="w"> </span><span class="nb">gl_Position</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="n">pos</span><span class="p">;</span>
<span class="w"> </span><span class="n">bgl_TexCoord</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="kt">vec4</span><span class="p">(</span><span class="n">texCoord</span><span class="p">,</span><span class="w"> </span><span class="mf">0.0</span><span class="p">,</span><span class="w"> </span><span class="mf">0.0</span><span class="p">);</span>
<span class="p">}</span>
</pre></div>
</div>
</div>
<dl class="py attribute">
<dt class="sig sig-object py" id="bge.types.KX_2DFilter.mipmap">
<span class="sig-name descname"><span class="pre">mipmap</span></span><a class="headerlink" href="#bge.types.KX_2DFilter.mipmap" title="Link to this definition"></a></dt>
<dd><p>Request mipmap generation of the render <cite>bgl_RenderedTexture</cite> texture. Accessing mipmapping level is similar to:</p>
<div class="highlight-glsl notranslate"><div class="highlight"><pre><span></span><span class="k">uniform</span><span class="w"> </span><span class="kt">sampler2D</span><span class="w"> </span><span class="n">bgl_RenderedTexture</span><span class="p">;</span>
<span class="k">in</span><span class="w"> </span><span class="kt">vec4</span><span class="w"> </span><span class="n">bgl_TexCoord</span><span class="p">;</span>
<span class="k">out</span><span class="w"> </span><span class="kt">vec4</span><span class="w"> </span><span class="n">fragColor</span><span class="p">;</span>
<span class="kt">void</span><span class="w"> </span><span class="n">main</span><span class="p">()</span>
<span class="p">{</span>
<span class="w"> </span><span class="kt">float</span><span class="w"> </span><span class="n">level</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="mf">2.0</span><span class="p">;</span><span class="w"> </span><span class="c1">// mipmap level</span>
<span class="w"> </span><span class="n">fragColor</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="n">textureLod</span><span class="p">(</span><span class="n">bgl_RenderedTexture</span><span class="p">,</span><span class="w"> </span><span class="n">bgl_TexCoord</span><span class="p">.</span><span class="n">xy</span><span class="p">,</span><span class="w"> </span><span class="n">level</span><span class="p">);</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>boolean</p>
</dd>
</dl>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="bge.types.KX_2DFilter.offScreen">
<span class="sig-name descname"><span class="pre">offScreen</span></span><a class="headerlink" href="#bge.types.KX_2DFilter.offScreen" title="Link to this definition"></a></dt>
<dd><p>The custom off screen (framebuffer in 0.3.0) the filter render to (read-only).</p>
<dl class="field-list simple">
<dt class="field-odd">Type<span class="colon">:</span></dt>
<dd class="field-odd"><p><a class="reference internal" href="bge.types.KX_2DFilterFrameBuffer.html#bge.types.KX_2DFilterFrameBuffer" title="bge.types.KX_2DFilterFrameBuffer"><code class="xref py py-class docutils literal notranslate"><span class="pre">KX_2DFilterFrameBuffer</span></code></a> or None</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="bge.types.KX_2DFilter.setTexture">
<span class="sig-name descname"><span class="pre">setTexture</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">index</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">bindCode</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">samplerName</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">''</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#bge.types.KX_2DFilter.setTexture" title="Link to this definition"></a></dt>
<dd><p>Set specified texture bind code <code class="xref py py-data docutils literal notranslate"><span class="pre">bindCode</span></code> in specified slot <code class="xref py py-data docutils literal notranslate"><span class="pre">index</span></code>. Any call to <a class="reference internal" href="#bge.types.KX_2DFilter.setTexture" title="bge.types.KX_2DFilter.setTexture"><code class="xref py py-data docutils literal notranslate"><span class="pre">setTexture</span></code></a>
should be followed by a call to <a class="reference internal" href="bge.types.BL_Shader.html#bge.types.BL_Shader.setSampler" title="bge.types.BL_Shader.setSampler"><code class="xref py py-data docutils literal notranslate"><span class="pre">BL_Shader.setSampler</span></code></a> with the same <code class="xref py py-data docutils literal notranslate"><span class="pre">index</span></code> if <code class="xref py py-data docutils literal notranslate"><span class="pre">sampleName</span></code> is not specified.</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>index</strong> (<em>integer</em>) – The texture slot.</p></li>
<li><p><strong>bindCode</strong> (<em>integer</em>) – The texture bind code/Id.</p></li>
<li><p><strong>samplerName</strong> (<em>string</em>) – The shader sampler name set to <code class="xref py py-data docutils literal notranslate"><span class="pre">index</span></code> if <code class="xref py py-data docutils literal notranslate"><span class="pre">samplerName</span></code> is passed in the function. (optional)</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="bge.types.KX_2DFilter.setCubeMap">
<span class="sig-name descname"><span class="pre">setCubeMap</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">index</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">bindCode</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">samplerName</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">''</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#bge.types.KX_2DFilter.setCubeMap" title="Link to this definition"></a></dt>
<dd><p>Set specified cube map texture bind code <code class="xref py py-data docutils literal notranslate"><span class="pre">bindCode</span></code> in specified slot <code class="xref py py-data docutils literal notranslate"><span class="pre">index</span></code>. Any call to <a class="reference internal" href="#bge.types.KX_2DFilter.setCubeMap" title="bge.types.KX_2DFilter.setCubeMap"><code class="xref py py-data docutils literal notranslate"><span class="pre">setCubeMap</span></code></a>
should be followed by a call to <a class="reference internal" href="bge.types.BL_Shader.html#bge.types.BL_Shader.setSampler" title="bge.types.BL_Shader.setSampler"><code class="xref py py-data docutils literal notranslate"><span class="pre">BL_Shader.setSampler</span></code></a> with the same <code class="xref py py-data docutils literal notranslate"><span class="pre">index</span></code> if <code class="xref py py-data docutils literal notranslate"><span class="pre">sampleName</span></code> is not specified.</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>index</strong> (<em>integer</em>) – The texture slot.</p></li>
<li><p><strong>bindCode</strong> (<em>integer</em>) – The cube map texture bind code/Id.</p></li>
<li><p><strong>samplerName</strong> (<em>string</em>) – The shader sampler name set to <code class="xref py py-data docutils literal notranslate"><span class="pre">index</span></code> if <code class="xref py py-data docutils literal notranslate"><span class="pre">samplerName</span></code> is passed in the function. (optional)</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="bge.types.KX_2DFilter.addOffScreen">
<span class="sig-name descname"><span class="pre">addOffScreen</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">slots</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">width</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">height</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">mipmap</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#bge.types.KX_2DFilter.addOffScreen" title="Link to this definition"></a></dt>
<dd><p>Register a custom off screen (framebuffer in 0.3.0) to render the filter to.</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>slots</strong> (<em>integer</em>) – The number of color texture attached to the off screen, between 0 and 8 excluded.</p></li>
<li><p><strong>width</strong> (<em>integer</em>) – In 0.3.0, always canvas width (optional).</p></li>
<li><p><strong>height</strong> (<em>integer</em>) – In 0.3.0, always canvas height (optional).</p></li>
<li><p><strong>mipmap</strong> (<em>boolean</em>) – True if the color texture generate mipmap at the end of the filter rendering (optional).</p></li>
</ul>
</dd>
</dl>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>If the off screen is created using a dynamic size (<cite>width</cite> and <cite>height</cite> to -1) its bind codes will be unavailable before
the next render of the filter and the it can change when the viewport is resized.</p>
</div>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="bge.types.KX_2DFilter.removeOffScreen">
<span class="sig-name descname"><span class="pre">removeOffScreen</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#bge.types.KX_2DFilter.removeOffScreen" title="Link to this definition"></a></dt>
<dd><p>Unregister the custom off screen (framebuffer in 0.3.0) the filter render to.</p>
</dd></dl>
</dd></dl>
</section>
</div>
</div>
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
<a href="bge.types.EXP_Value.html" class="btn btn-neutral float-left" title="EXP_Value(EXP_PyObjectPlus)" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
<a href="bge.types.KX_2DFilterFrameBuffer.html" class="btn btn-neutral float-right" title="KX_2DFilterOffScreen(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/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>