Cleanup: API docs (whitespace/line length)
authorCampbell Barton <ideasman42@gmail.com>
Sun, 12 Jun 2016 00:05:35 +0000 (10:05 +1000)
committerCampbell Barton <ideasman42@gmail.com>
Sun, 12 Jun 2016 00:05:35 +0000 (10:05 +1000)
doc/python_api/rst/bge.events.rst
doc/python_api/rst/bge.texture.rst
doc/python_api/rst/bge_types/bge.types.SCA_PythonJoystick.rst
doc/python_api/rst/include__bmesh.rst
doc/python_api/rst/info_quickstart.rst

index 8dbded6a3fec9ac38165dd3595dad8b104a71c9b..42135926fdabfff666ce8bf90c542a274387a301 100644 (file)
@@ -12,53 +12,53 @@ This module holds key constants for the SCA_KeyboardSensor.
 
 .. code-block:: python
 
-       # Set a connected keyboard sensor to accept F1
-       import bge
-
-       co = bge.logic.getCurrentController()
-       # 'Keyboard' is a keyboard sensor
-       sensor = co.sensors["Keyboard"]
-       sensor.key = bge.events.F1KEY
-
-.. code-block:: python
-
-       # Do the all keys thing
-       import bge
-
-       co = bge.logic.getCurrentController()
-       # 'Keyboard' is a keyboard sensor
-       sensor = co.sensors["Keyboard"]
-
-       for key,status in sensor.events:
-               # key[0] == bge.events.keycode, key[1] = status
-               if status == bge.logic.KX_INPUT_JUST_ACTIVATED:
-                       if key == bge.events.WKEY:
-                               # Activate Forward!
-                       if key == bge.events.SKEY:
-                               # Activate Backward!
-                       if key == bge.events.AKEY:
-                               # Activate Left!
-                       if key == bge.events.DKEY:
-                               # Activate Right!
-
-.. code-block:: python
-
-       # The all keys thing without a keyboard sensor (but you will
-       # need an always sensor with pulse mode on)
-       import bge
-
-       # Just shortening names here
-       keyboard = bge.logic.keyboard
-       JUST_ACTIVATED = bge.logic.KX_INPUT_JUST_ACTIVATED
-
-       if keyboard.events[bge.events.WKEY] == JUST_ACTIVATED:
-               print("Activate Forward!")
-       if keyboard.events[bge.events.SKEY] == JUST_ACTIVATED:
-               print("Activate Backward!")
-       if keyboard.events[bge.events.AKEY] == JUST_ACTIVATED:
-               print("Activate Left!")
-       if keyboard.events[bge.events.DKEY] == JUST_ACTIVATED:
-               print("Activate Right!")
+   # Set a connected keyboard sensor to accept F1
+   import bge
+
+   co = bge.logic.getCurrentController()
+   # 'Keyboard' is a keyboard sensor
+   sensor = co.sensors["Keyboard"]
+   sensor.key = bge.events.F1KEY
+
+   code-block:: python
+
+   # Do the all keys thing
+   import bge
+
+   co = bge.logic.getCurrentController()
+   # 'Keyboard' is a keyboard sensor
+   sensor = co.sensors["Keyboard"]
+
+   for key,status in sensor.events:
+       # key[0] == bge.events.keycode, key[1] = status
+       if status == bge.logic.KX_INPUT_JUST_ACTIVATED:
+               if key == bge.events.WKEY:
+                       # Activate Forward!
+               if key == bge.events.SKEY:
+                       # Activate Backward!
+               if key == bge.events.AKEY:
+                       # Activate Left!
+               if key == bge.events.DKEY:
+                       # Activate Right!
+
+   code-block:: python
+
+   # The all keys thing without a keyboard sensor (but you will
+   # need an always sensor with pulse mode on)
+   import bge
+
+   # Just shortening names here
+   keyboard = bge.logic.keyboard
+   JUST_ACTIVATED = bge.logic.KX_INPUT_JUST_ACTIVATED
+
+   if keyboard.events[bge.events.WKEY] == JUST_ACTIVATED:
+       print("Activate Forward!")
+   if keyboard.events[bge.events.SKEY] == JUST_ACTIVATED:
+       print("Activate Backward!")
+   if keyboard.events[bge.events.AKEY] == JUST_ACTIVATED:
+       print("Activate Left!")
+   if keyboard.events[bge.events.DKEY] == JUST_ACTIVATED:
+       print("Activate Right!")
 
 
 *********
index 9d6166b2502449670d4dce9ada619429faf2caf0..0c049a50fd4929274ff2eabcff05af4a9172f984 100644 (file)
@@ -8,13 +8,16 @@ Introduction
 
 The bge.texture module allows you to manipulate textures during the game.
 
-Several sources for texture are possible: video files, image files, video capture, memory buffer, camera render or a mix of that.
+Several sources for texture are possible: video files, image files, video capture, memory buffer,
+camera render or a mix of that.
 
 The video and image files can be loaded from the internet using an URL instead of a file name.
 
-In addition, you can apply filters on the images before sending them to the GPU, allowing video effect: blue screen, color band, gray, normal map.
+In addition, you can apply filters on the images before sending them to the GPU, allowing video effect:
+blue screen, color band, gray, normal map.
 
-bge.texture uses FFmpeg to load images and videos. All the formats and codecs that FFmpeg supports are supported by this module, including but not limited to:
+bge.texture uses FFmpeg to load images and videos.
+All the formats and codecs that FFmpeg supports are supported by this module, including but not limited to:
 
 * AVI
 * Ogg
@@ -39,14 +42,14 @@ When the texture object is deleted, the new texture is deleted and the old textu
 .. include:: ../examples/bge.texture.py
    :start-line: 1
    :end-line: 5
-   
+
 .. literalinclude:: ../examples/bge.texture.py
    :lines: 7-
 
 .. include:: ../examples/bge.texture.1.py
    :start-line: 1
    :end-line: 6
-   
+
 .. literalinclude:: ../examples/bge.texture.1.py
    :lines: 8-
 
@@ -58,6 +61,7 @@ When the texture object is deleted, the new texture is deleted and the old textu
 .. literalinclude:: ../examples/bge.texture.2.py
    :lines: 8-
 
+
 *************
 Video classes
 *************
@@ -65,7 +69,7 @@ Video classes
 .. class:: VideoFFmpeg(file, capture=-1, rate=25.0, width=0, height=0)
 
    FFmpeg video source.
-      
+
    :arg file: Path to the video to load; if capture >= 0 on Windows, this parameter will not be used.
    :type file: str
    :arg capture: Capture device number; if >= 0, the corresponding webcam will be used. (optional)
@@ -80,14 +84,14 @@ Video classes
    .. attribute:: status
 
       Video status. (readonly)
-      
+
       :type: int
       :value: see `FFmpeg Video and Image Status`_.
 
    .. attribute:: range
 
       Replay range.
-      
+
       :type: sequence of two floats
 
    .. attribute:: repeat
@@ -111,33 +115,33 @@ Video classes
    .. attribute:: image
 
       Image data. (readonly)
-      
+
       :type: :class:`~bgl.Buffer` or None
 
    .. attribute:: size
 
       Image size. (readonly)
-      
+
       :type: tuple of two ints
 
    .. attribute:: scale
 
       Fast scale of image (near neighbour).
-      
+
       :type: bool
 
    .. attribute:: flip
 
       Flip image vertically.
-      
+
       :type: bool
 
    .. attribute:: filter
 
       Pixel filter.
-      
+
       :type: one of...
-      
+
          * :class:`FilterBGR24`
          * :class:`FilterBlueScreen`
          * :class:`FilterColor`
@@ -162,21 +166,21 @@ Video classes
    .. method:: play()
 
       Play (restart) video.
-      
+
       :return: Whether the video was ready or stopped.
       :rtype: bool
 
    .. method:: pause()
 
       Pause video.
-      
+
       :return: Whether the video was playing.
       :rtype: bool
 
    .. method:: stop()
 
       Stop video (play will replay it from start).
-      
+
       :return: Whether the video was playing.
       :rtype: bool
 
@@ -196,6 +200,7 @@ Video classes
       :return: see `FFmpeg Video and Image Status`_.
       :rtype: int
 
+
 *************
 Image classes
 *************
@@ -203,14 +208,14 @@ Image classes
 .. class:: ImageFFmpeg(file)
 
    FFmpeg image source.
-      
+
    :arg file: Path to the image to load.
    :type file: str
 
    .. attribute:: status
 
       Image status. (readonly)
-      
+
       :type: int
       :value: see `FFmpeg Video and Image Status`_.
 
@@ -223,33 +228,33 @@ Image classes
    .. attribute:: image
 
       Image data. (readonly)
-      
+
       :type: :class:`~bgl.Buffer` or None
 
    .. attribute:: size
 
       Image size. (readonly)
-      
+
       :type: tuple of two ints
 
    .. attribute:: scale
 
       Fast scale of image (near neighbour).
-      
+
       :type: bool
 
    .. attribute:: flip
 
       Flip image vertically.
-      
+
       :type: bool
 
    .. attribute:: filter
 
       Pixel filter.
-      
+
       :type: one of...
-      
+
          * :class:`FilterBGR24`
          * :class:`FilterBlueScreen`
          * :class:`FilterColor`
@@ -275,14 +280,14 @@ Image classes
    .. method:: reload(newname=None)
 
       Reload image, i.e. reopen it.
-      
+
       :arg newname: Path to a new image. (optional)
       :type newname: str
 
 .. class:: ImageBuff(width, height, color=0, scale=False)
 
    Image source from image buffer.
-   
+
    :arg width: Width of the image.
    :type width: int
    :arg height: Height of the image.
@@ -296,9 +301,9 @@ Image classes
    .. attribute:: filter
 
       Pixel filter.
-      
+
       :type: one of...
-      
+
          * :class:`FilterBGR24`
          * :class:`FilterBlueScreen`
          * :class:`FilterColor`
@@ -311,19 +316,19 @@ Image classes
    .. attribute:: flip
 
       Flip image vertically.
-      
+
       :type: bool
 
    .. attribute:: image
 
       Image data. (readonly)
-      
+
       :type: :class:`~bgl.Buffer` or None
 
    .. method:: load(imageBuffer, width, height)
 
       Load image from buffer.
-      
+
       :arg imageBuffer: Buffer to load the image from.
       :type imageBuffer: :class:`~bgl.Buffer` or Python object implementing the buffer protocol (f.ex. bytes)
       :arg width: Width of the image to load.
@@ -334,9 +339,10 @@ Image classes
    .. method:: plot(imageBuffer, width, height, positionX, positionY, mode=IMB_BLEND_COPY)
 
       Update image buffer.
-      
+
       :arg imageBuffer: Buffer to load the new data from.
-      :type imageBuffer: :class:`~bgl.Buffer`, :class:`ImageBuff` or Python object implementing the buffer protocol (f.ex. bytes)
+      :type imageBuffer: :class:`~bgl.Buffer`, :class:`ImageBuff`
+         or Python object implementing the buffer protocol (f.ex. bytes)
       :arg width: Width of the data to load.
       :type width: int
       :arg height: Height of the data to load.
@@ -347,18 +353,18 @@ Image classes
       :type positionY: int
       :arg mode: Drawing mode, see `Image Blending Modes`_.
       :type mode: int
-      
+
 
    .. attribute:: scale
 
       Fast scale of image (near neighbour).
-      
+
       :type: bool
 
    .. attribute:: size
 
       Image size. (readonly)
-      
+
       :type: tuple of two ints
 
    .. attribute:: valid
@@ -370,10 +376,11 @@ Image classes
 .. class:: ImageMirror(scene, observer, mirror, material=0)
 
    Image source from mirror.
-   
+
    :arg scene: Scene in which the image has to be taken.
    :type scene: :class:`~bge.types.KX_Scene`
-   :arg observer: Reference object for the mirror (the object from which the mirror has to be looked at, for example a camera).
+   :arg observer: Reference object for the mirror
+      (the object from which the mirror has to be looked at, for example a camera).
    :type observer: :class:`~bge.types.KX_GameObject`
    :arg mirror: Object holding the mirror.
    :type mirror: :class:`~bge.types.KX_GameObject`
@@ -383,33 +390,33 @@ Image classes
    .. attribute:: alpha
 
       Use alpha in texture.
-      
+
       :type: bool
 
    .. attribute:: background
 
       Background color.
-      
+
       :type: int or float list [r, g, b, a] in [0.0, 255.0]
 
    .. attribute:: capsize
 
       Size of render area.
-      
+
       :type: sequence of two ints
 
    .. attribute:: clip
 
       Clipping distance.
-      
+
       :type: float in [0.01, 5000.0]
 
    .. attribute:: filter
 
       Pixel filter.
-      
+
       :type: one of...
-      
+
          * :class:`FilterBGR24`
          * :class:`FilterBlueScreen`
          * :class:`FilterColor`
@@ -422,13 +429,13 @@ Image classes
    .. attribute:: flip
 
       Flip image vertically.
-      
+
       :type: bool
 
    .. attribute:: image
 
       Image data. (readonly)
-      
+
       :type: :class:`~bgl.Buffer` or None
 
    .. method:: refresh(buffer=None, format="RGBA")
@@ -447,13 +454,13 @@ Image classes
    .. attribute:: scale
 
       Fast scale of image (near neighbour).
-      
+
       :type: bool
 
    .. attribute:: size
 
       Image size (readonly).
-      
+
       :type: tuple of two ints
 
    .. attribute:: valid
@@ -465,7 +472,7 @@ Image classes
    .. attribute:: whole
 
       Use whole viewport to render.
-      
+
       :type: bool
 
 .. class:: ImageMix
@@ -475,9 +482,9 @@ Image classes
    .. attribute:: filter
 
       Pixel filter.
-      
+
       :type: one of...
-      
+
          * :class:`FilterBGR24`
          * :class:`FilterBlueScreen`
          * :class:`FilterColor`
@@ -490,19 +497,19 @@ Image classes
    .. attribute:: flip
 
       Flip image vertically.
-      
+
       :type: bool
 
    .. method:: getSource(id)
 
       Get image source.
-      
+
       :arg id: Identifier of the source to get.
       :type id: str
-      
+
       :return: Image source.
       :rtype: one of...
-      
+
          * :class:`VideoFFmpeg`
          * :class:`ImageFFmpeg`
          * :class:`ImageBuff`
@@ -514,22 +521,23 @@ Image classes
    .. method:: getWeight(id)
 
       Get image source weight.
-      
+
       :arg id: Identifier of the source.
       :type id: str
-      
+
       :return: Weight of the source.
       :rtype: int
 
    .. attribute:: image
 
       Image data. (readonly)
-      
+
       :type: :class:`~bgl.Buffer` or None
 
    .. method:: refresh(buffer=None, format="RGBA")
 
-      Refresh image - calculate and copy the image to an external buffer (optional) then invalidate its current content.
+      Refresh image - calculate and copy the image to an external buffer (optional)
+      then invalidate its current content.
 
       :arg buffer: An optional object that implements the buffer protocol.
          If specified, the image is calculated and copied to the buffer,
@@ -542,23 +550,23 @@ Image classes
    .. attribute:: scale
 
       Fast scale of image (near neighbour).
-      
+
       :type: bool
-      
+
    .. attribute:: size
 
       Image size. (readonly)
-      
+
       :type: tuple of two ints
 
    .. method:: setSource(id, image)
 
       Set image source - all sources must have the same size.
-      
+
       :arg id: Identifier of the source to set.
       :type id: str
       :arg image: Image source of type...
-      
+
          * :class:`VideoFFmpeg`
          * :class:`ImageFFmpeg`
          * :class:`ImageBuff`
@@ -570,7 +578,7 @@ Image classes
    .. method:: setWeight(id, weight)
 
       Set image source weight - the sum of the weights should be 256 to get full color intensity in the output.
-      
+
       :arg id: Identifier of the source.
       :type id: str
       :arg weight: Weight of the source.
@@ -598,27 +606,27 @@ Image classes
    .. attribute:: alpha
 
       Use alpha in texture.
-      
+
       :type: bool
 
    .. attribute:: background
 
       Background color.
-      
+
       :type: int or float list [r, g, b, a] in [0.0, 255.0]
 
    .. attribute:: capsize
 
       Size of render area.
-      
+
       :type: sequence of two ints
 
    .. attribute:: filter
 
       Pixel filter.
-      
+
       :type: one of...
-      
+
          * :class:`FilterBGR24`
          * :class:`FilterBlueScreen`
          * :class:`FilterColor`
@@ -631,7 +639,7 @@ Image classes
    .. attribute:: flip
 
       Flip image vertically.
-      
+
       :type: bool
 
    .. attribute:: image
@@ -643,13 +651,13 @@ Image classes
    .. attribute:: scale
 
       Fast scale of image (near neighbour).
-      
+
       :type: bool
 
    .. attribute:: size
 
       Image size. (readonly)
-      
+
       :type: tuple of two ints
 
    .. attribute:: valid
@@ -661,20 +669,20 @@ Image classes
    .. attribute:: whole
 
       Use whole viewport to render.
-      
+
       :type: bool
 
    .. attribute:: depth
 
       Use depth component of render as array of float - not suitable for texture source,
       should only be used with bge.texture.imageToArray(mode='F').
-      
+
       :type: bool
 
    .. attribute:: zbuff
 
       Use depth component of render as grey scale color -  suitable for texture source.
-      
+
       :type: bool
 
    .. method:: render()
@@ -720,21 +728,21 @@ Image classes
    .. attribute:: alpha
 
       Use alpha in texture.
-      
+
       :type: bool
 
    .. attribute:: capsize
 
       Size of viewport area being captured.
-      
+
       :type: sequence of two ints
 
    .. attribute:: filter
 
       Pixel filter.
-      
+
       :type: one of...
-      
+
          * :class:`FilterBGR24`
          * :class:`FilterBlueScreen`
          * :class:`FilterColor`
@@ -747,19 +755,19 @@ Image classes
    .. attribute:: flip
 
       Flip image vertically.
-      
+
       :type: bool
 
    .. attribute:: image
 
       Image data. (readonly)
-      
+
       :type: :class:`~bgl.Buffer` or None
 
    .. attribute:: position
 
       Upper left corner of the captured area.
-      
+
       :type: sequence of two ints
 
    .. method:: refresh(buffer=None, format="RGBA")
@@ -779,13 +787,13 @@ Image classes
    .. attribute:: scale
 
       Fast scale of image (near neighbour).
-      
+
       :type: bool
 
    .. attribute:: size
 
       Image size. (readonly)
-      
+
       :type: tuple of two ints
 
    .. attribute:: valid
@@ -797,20 +805,20 @@ Image classes
    .. attribute:: whole
 
       Use whole viewport to capture.
-      
+
       :type: bool
 
    .. attribute:: depth
 
       Use depth component of viewport as array of float - not suitable for texture source,
-      should only be used with bge.texture.imageToArray(mode='F').
-      
+      should only be used with ``bge.texture.imageToArray(mode='F')``.
+
       :type: bool
 
    .. attribute:: zbuff
 
-      Use depth component of viewport as grey scale color -  suitable for texture source.
-      
+      Use depth component of viewport as grey scale color - suitable for texture source.
+
       :type: bool
 
 .. class:: VideoDeckLink(format, capture=0)
@@ -991,6 +999,7 @@ Image classes
       :return: True if the capture could be stopped, False otherwise.
       :rtype: bool
 
+
 ***************
 Texture classes
 ***************
@@ -998,7 +1007,7 @@ Texture classes
 .. class:: Texture(gameObj, materialID=0, textureID=0, textureObj=None)
 
    Texture object.
-   
+
    :arg gameObj: Game object to be created a video texture on.
    :type gameObj: :class:`~bge.types.KX_GameObject`
    :arg materialID: Material ID. (optional)
@@ -1011,7 +1020,7 @@ Texture classes
    .. attribute:: bindId
 
       OpenGL Bind Name. (readonly)
-      
+
       :type: int
 
    .. method:: close()
@@ -1021,26 +1030,26 @@ Texture classes
    .. attribute:: mipmap
 
       Mipmap texture.
-      
+
       :type: bool
 
-   .. method:: refresh(refresh_source=True, ts=-1.0)
+   .. method:: refresh(refresh_source=True, timestamp=-1.0)
 
       Refresh texture from source.
-      
+
       :arg refresh_source: Whether to also refresh the image source of the texture.
       :type refresh_source: bool
-      :arg ts: If the texture controls a VideoFFmpeg object:
-               timestamp (in seconds from the start of the movie) of the frame to be loaded; this can be
-               used for video-sound synchonization by passing :attr:`~bge.types.KX_SoundActuator.time` to it. (optional)
-      :type ts: float
+      :arg timestamp: If the texture controls a VideoFFmpeg object:
+         timestamp (in seconds from the start of the movie) of the frame to be loaded; this can be
+         used for video-sound synchonization by passing :attr:`~bge.types.KX_SoundActuator.time` to it. (optional)
+      :type timestamp: float
 
    .. attribute:: source
 
       Source of texture.
-      
+
       :type: one of...
-      
+
          * :class:`VideoFFmpeg`
          * :class:`VideoDeckLink`
          * :class:`ImageFFmpeg`
@@ -1177,42 +1186,41 @@ Texture classes
 Filter classes
 **************
 
-
 .. class:: FilterBGR24
 
    Source filter BGR24.
 
 .. class:: FilterBlueScreen
 
-   Filter for Blue Screen. The RGB channels of the color are left unchanged, while the output alpha is obtained as follows:
-   
-   * if the square of the euclidian distance between the RGB color and the filter's reference color is smaller than the filter's lower limit,
+   Filter for Blue Screen.
+   The RGB channels of the color are left unchanged, while the output alpha is obtained as follows:
+
+   - if the square of the euclidian distance between the RGB color
+     and the filter's reference color is smaller than the filter's lower limit,
      the output alpha is set to 0;
-   
-   * if that square is bigger than the filter's upper limit, the output alpha is set to 255;
-   
-   * otherwise the output alpha is linarly extrapoled between 0 and 255 in the interval of the limits.
+   - if that square is bigger than the filter's upper limit, the output alpha is set to 255;
+   - otherwise the output alpha is linarly extrapoled between 0 and 255 in the interval of the limits.
 
    .. attribute:: color
 
       Reference color.
-      
+
       :type: sequence of three ints
       :default: (0, 0, 255)
 
    .. attribute:: limits
 
       Reference color limits.
-      
+
       :type: sequence of two ints
       :default: (64, 64)
 
    .. attribute:: previous
 
       Previous pixel filter.
-      
+
       :type: one of...
-      
+
          * :class:`FilterBGR24`
          * :class:`FilterBlueScreen`
          * :class:`FilterColor`
@@ -1224,22 +1232,23 @@ Filter classes
 
 .. class:: FilterColor
 
-   Filter for color calculations. The output color is obtained by multiplying the reduced 4x4 matrix with the input color
+   Filter for color calculations.
+   The output color is obtained by multiplying the reduced 4x4 matrix with the input color
    and adding the remaining column to the result.
 
    .. attribute:: matrix
 
       Matrix [4][5] for color calculation.
-      
+
       :type: sequence of four sequences of five ints
       :default: ((256, 0, 0, 0, 0), (0, 256, 0, 0, 0), (0, 0, 256, 0, 0), (0, 0, 0, 256, 0))
 
    .. attribute:: previous
 
       Previous pixel filter.
-      
+
       :type: one of...
-      
+
          * :class:`FilterBGR24`
          * :class:`FilterBlueScreen`
          * :class:`FilterColor`
@@ -1251,14 +1260,15 @@ Filter classes
 
 .. class:: FilterGray
 
-   Filter for gray scale effect. Proportions of R, G and B contributions in the output gray scale are 28:151:77.
+   Filter for gray scale effect.
+   Proportions of R, G and B contributions in the output gray scale are 28:151:77.
 
    .. attribute:: previous
 
       Previous pixel filter.
-      
+
       :type: one of...
-      
+
          * :class:`FilterBGR24`
          * :class:`FilterBlueScreen`
          * :class:`FilterColor`
@@ -1271,26 +1281,26 @@ Filter classes
 .. class:: FilterLevel
 
    Filter for levels calculations. Each output color component is obtained as follows:
-   
+
    * if it is smaller than its corresponding min value, it is set to 0;
-   
+
    * if it is bigger than its corresponding max value, it is set to 255;
-   
+
    * Otherwise it is linearly extrapoled between 0 and 255 in the (min, max) interval.
 
    .. attribute:: levels
 
       Levels matrix [4] (min, max).
-      
+
       :type: sequence of four sequences of two ints
       :default: ((0, 255), (0, 255), (0, 255), (0, 255))
 
    .. attribute:: previous
 
       Previous pixel filter.
-      
+
       :type: one of...
-      
+
          * :class:`FilterBGR24`
          * :class:`FilterBlueScreen`
          * :class:`FilterColor`
@@ -1307,23 +1317,23 @@ Filter classes
    .. attribute:: colorIdx
 
       Index of color used to calculate normal (0 - red, 1 - green, 2 - blue, 3 - alpha).
-      
+
       :type: int in [0, 3]
       :default: 0
 
    .. attribute:: depth
 
       Depth of relief.
-      
+
       :type: float
       :default: 4.0
 
    .. attribute:: previous
 
       Previous pixel filter.
-      
+
       :type: one of...
-      
+
          * :class:`FilterBGR24`
          * :class:`FilterBlueScreen`
          * :class:`FilterColor`
@@ -1367,25 +1377,29 @@ Functions
       * :class:`ImageMix`
       * :class:`ImageRender`
       * :class:`ImageViewport`
-   
+
    :arg mode: Optional argument representing the pixel format.
-              
-      * You can use the characters R, G, B for the 3 color channels, A for the alpha channel,
+
+      - You can use the characters R, G, B for the 3 color channels, A for the alpha channel,
         0 to force a fixed 0 color channel and 1 to force a fixed 255 color channel.
-        
+
         Examples:
-            * "BGR" will return 3 bytes per pixel with the Blue, Green and Red channels in that order.
-            * "RGB1" will return 4 bytes per pixel with the Red, Green, Blue channels in that order and the alpha channel forced to 255.
-      
-      * A special mode "F" allows to return the image as an array of float. This mode should only be used to retrieve
-        the depth buffer of the class:`ImageViewport` and :class:`ImageRender` objects.
+
+        - "BGR" will return 3 bytes per pixel with the
+          Blue, Green and Red channels in that order.
+        - "RGB1" will return 4 bytes per pixel with the 
+          Red, Green, Blue channels in that order and the alpha channel forced to 255.
+
+      - A special mode "F" allows to return the image as an array of float.
+        This mode should only be used to retrieve the depth buffer of the
+        class:`ImageViewport` and :class:`ImageRender` objects.
         The default mode is "RGBA".
-   
+
    :type mode: str
-   
+
    :return: An object representing the image as one dimensional array of bytes of size (pixel_size*width*height),
-            line by line starting from the bottom of the image. The pixel size and format is determined by the mode
-            parameter. For mode 'F', the array is a one dimensional array of float of size (width*height).
+      line by line starting from the bottom of the image. The pixel size and format is determined by the mode
+      parameter. For mode 'F', the array is a one dimensional array of float of size (width*height).
    :rtype: :class:`~bgl.Buffer`
 
 .. function:: materialID(object, name)
@@ -1400,7 +1414,8 @@ Functions
    the texture by material. In that case the material must have a texture channel in first
    position.
 
-   If the object has no material that matches name, it generates a runtime error. Use try/except to catch the exception.
+   If the object has no material that matches name, it generates a runtime error.
+   Use try/except to catch the exception.
 
    Ex: ``bge.texture.materialID(obj, 'IMvideo.png')``
 
@@ -1408,7 +1423,7 @@ Functions
    :type object: :class:`~bge.types.KX_GameObject`
    :arg name: Name of the texture/material you want to make dynamic.
    :type name: str
-   
+
    :return: The internal material number.
    :rtype: int
 
@@ -1420,11 +1435,11 @@ Functions
 
    :arg filename: Name of the error log file.
    :type filename: str
-   
+
    :return: -1 if the parameter name is invalid (not of type string), else 0.
    :rtype: int
 
-   
+
 *********
 Constants
 *********
index 2b97b5939e26e7c3675d966b17c9ebfb59fe84f1..bcec751929db73f9674222da59bd5612a2cc8b1e 100644 (file)
@@ -12,13 +12,13 @@ base class --- :class:`PyObjectPlus`
    .. attribute:: name
 
       The name assigned to the joystick by the operating system. (read-only)
-         
+
       :type: string
 
    .. attribute:: activeButtons
 
       A list of active button values. (read-only)
-         
+
       :type: list
 
    .. attribute:: axisValues
@@ -27,8 +27,10 @@ base class --- :class:`PyObjectPlus`
 
       :type: list of ints.
 
-      Each specifying the value of an axis between -1.0 and 1.0 depending on how far the axis is pushed, 0 for nothing.
-      The first 2 values are used by most joysticks and gamepads for directional control. 3rd and 4th values are only on some joysticks and can be used for arbitary controls.
+      Each specifying the value of an axis between -1.0 and 1.0
+      depending on how far the axis is pushed, 0 for nothing.
+      The first 2 values are used by most joysticks and gamepads for directional control.
+      3rd and 4th values are only on some joysticks and can be used for arbitary controls.
 
       * left:[-1.0, 0.0, ...]
       * right:[1.0, 0.0, ...]
index 070dc34c964d79edd7f0f1e10ba8ee064648d034..805d532ecebf4b2ca3d01b659caad54165f936f3 100644 (file)
@@ -1,7 +1,8 @@
 ..
    This document is appended to the auto generated bmesh api doc to avoid clogging up the C files with details.
    to test this run:
-   ./blender.bin -b -noaudio -P doc/python_api/sphinx_doc_gen.py -- --partial bmesh* ; cd doc/python_api ; sphinx-build sphinx-in sphinx-out ; cd ../../
+   ./blender.bin -b -noaudio -P doc/python_api/sphinx_doc_gen.py -- \
+                 --partial bmesh* ; cd doc/python_api ; sphinx-build sphinx-in sphinx-out ; cd ../../
 
 
 Submodules:
@@ -59,9 +60,9 @@ There are 2 ways to access BMesh data, you can create a new BMesh by converting
 :class:`bpy.types.BlendData.meshes` or by accessing the current edit mode mesh.
 see: :class:`bmesh.types.BMesh.from_mesh` and :mod:`bmesh.from_edit_mesh` respectively.
 
-When explicitly converting from mesh data python **owns** the data, that is to say - that the mesh only exists while
-python holds a reference to it, and the script is responsible for putting it back into a mesh data-block when the edits
-are done.
+When explicitly converting from mesh data python **owns** the data, that is to say -
+that the mesh only exists while python holds a reference to it,
+and the script is responsible for putting it back into a mesh data-block when the edits are done.
 
 Note that unlike :mod:`bpy`, a BMesh does not necessarily correspond to data in the currently open blend file,
 a BMesh can be created, edited and freed without the user ever seeing or having access to it.
index 164196c0ac258c05f7f7d8159b6cf6131bda215e..1beafd06baf52cb42de250f6612e0eba6f6a3b46 100644 (file)
@@ -151,7 +151,7 @@ Data Creation/Removal
 ^^^^^^^^^^^^^^^^^^^^^
 
 Those of you familiar with other Python API's may be surprised that
-new datablocks in the bpy API can't be created by calling the class:
+new data-blocks in the bpy API can't be created by calling the class:
 
    >>> bpy.types.Mesh()
    Traceback (most recent call last):
@@ -393,11 +393,11 @@ so these are accessed as normal Python types.
 Internal Types
 --------------
 
-Used for Blender datablocks and collections: :class:`bpy.types.bpy_struct`
+Used for Blender data-blocks and collections: :class:`bpy.types.bpy_struct`
 
 For data that contains its own attributes groups/meshes/bones/scenes... etc.
 
-There are 2 main types that wrap Blenders data, one for datablocks
+There are 2 main types that wrap Blenders data, one for data-blocks
 (known internally as ``bpy_struct``), another for properties.
 
    >>> bpy.context.object