← Back to branch summary

~ubuntu-branches/ubuntu/trusty/blender/trusty

« back to all changes in this revision

Viewing changes to doc/python_api/rst/bge_types/bge.types.SCA_2DFilterActuator.rst

  • Committer: Package Import Robot
  • Author(s): Jeremy Bicha
  • Date: 2013-03-06 12:08:47 UTC
  • mfrom: (1.5.1) (14.1.8 experimental)
  • Revision ID: package-import@ubuntu.com-20130306120847-frjfaryb2zrotwcg
Tags: 2.66a-1ubuntu1
https://launchpad.net/bugs/1076930
https://launchpad.net/bugs/1089256
https://launchpad.net/bugs/1052743
https://launchpad.net/bugs/999024
* Resynchronize with Debian (LP: #1076930, #1089256, #1052743, #999024,
  #1122888, #1147084)
* debian/control:
  - Lower build-depends on libavcodec-dev since we're not
    doing the libav9 transition in Ubuntu yet

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/python_api/rst/bge_types/bge.types.SCA_2DFilterActuator.rst
 
1
SCA_2DFilterActuator(SCA_IActuator)
 
2
===================================
 
3
 
 
4
.. module:: bge.types
 
5
 
 
6
base class --- :class:`SCA_IActuator`
 
7
 
 
8
.. class:: SCA_2DFilterActuator(SCA_IActuator)
 
9
 
 
10
   Create, enable and disable 2D filters
 
11
 
 
12
   The following properties don't have an immediate effect.
 
13
   You must active the actuator to get the result.
 
14
   The actuator is not persistent: it automatically stops itself after setting up the filter
 
15
   but the filter remains active. To stop a filter you must activate the actuator with 'type'
 
16
   set to :data:`~bge.logic.RAS_2DFILTER_DISABLED` or :data:`~bge.logic.RAS_2DFILTER_NOFILTER`.
 
17
 
 
18
   .. attribute:: shaderText
 
19
 
 
20
      shader source code for custom shader.
 
21
 
 
22
      :type: string
 
23
 
 
24
   .. attribute:: disableMotionBlur
 
25
 
 
26
      action on motion blur: 0=enable, 1=disable.
 
27
 
 
28
      :type: integer
 
29
 
 
30
   .. attribute:: mode
 
31
 
 
32
      Type of 2D filter, use one of :ref:`these constants <Two-D-FilterActuator-mode>`
 
33
 
 
34
      :type: integer
 
35
 
 
36
   .. attribute:: passNumber
 
37
 
 
38
      order number of filter in the stack of 2D filters. Filters are executed in increasing order of passNb.
 
39
 
 
40
      Only be one filter can be defined per passNb.
 
41
 
 
42
      :type: integer (0-100)
 
43
 
 
44
   .. attribute:: value
 
45
 
 
46
      argument for motion blur filter.
 
47
 
 
48
      :type: float (0.0-100.0)
 
49