bge.texture doc, needed whitespace to format correctly.

doc/python_api/rst/bge.texture.rst

@@ -45,61 +45,77 @@ When the texture object is deleted, the new texture is deleted and the old textu
    FFmpeg video source
 
    .. attribute:: status
+
       video status
 
    .. attribute:: range
+
       replay range
 
    .. attribute:: repeat
+
       repeat count, -1 for infinite repeat
 
       :type: int
 
    .. attribute:: framerate
+
       frame rate
 
       :type: float
 
    .. attribute:: valid
+
       Tells if an image is available
 
       :type: bool
 
    .. attribute:: image
+
       image data
 
    .. attribute:: size
+
       image size
 
    .. attribute:: scale
+
       fast scale of image (near neighbour)
 
    .. attribute:: flip
+
       flip image vertically
 
    .. attribute:: filter
+
       pixel filter
 
    .. attribute:: preseek
+
       number of frames of preseek
 
       :type: int
 
    .. attribute:: deinterlace
+
       deinterlace image
 
       :type: bool
 
    .. method:: play()
+
       Play (restart) video
 
    .. method:: pause()
+
       pause video
 
    .. method:: stop()
+
       stop video (play will replay it from start)
 
    .. method:: refresh()
+
       Refresh video - get its status
 
 .. class:: ImageFFmpeg(file)
@@ -107,32 +123,41 @@ When the texture object is deleted, the new texture is deleted and the old textu
    FFmpeg image source
 
    .. attribute:: status
+
       video status
 
    .. attribute:: valid
+
       Tells if an image is available
 
       :type: bool
 
    .. attribute:: image
+
       image data
 
    .. attribute:: size
+
       image size
 
    .. attribute:: scale
+
       fast scale of image (near neighbour)
 
    .. attribute:: flip
+
       flip image vertically
 
    .. attribute:: filter
+
       pixel filter
 
    .. method:: refresh()
+
       Refresh image, i.e. load it
 
    .. method:: reload([newname])
+
       Reload image, i.e. reopen it
 
 .. class:: ImageBuff()
@@ -140,27 +165,35 @@ When the texture object is deleted, the new texture is deleted and the old textu
    Image source from image buffer
 
    .. attribute:: filter
+
       pixel filter
 
    .. attribute:: flip
+
       flip image vertically
 
    .. attribute:: image
+
       image data
 
    .. method:: load(imageBuffer, width, height)
+
       Load image from buffer
 
    .. method:: plot(imageBuffer, width, height, positionX, positionY)
+
       update image buffer
 
    .. attribute:: scale
+
       fast scale of image (near neighbour)
 
    .. attribute:: size
+
       image size
 
    .. attribute:: valid
+
       bool to tell if an image is available
 
 .. class:: ImageMirror(scene)
@@ -168,39 +201,51 @@ When the texture object is deleted, the new texture is deleted and the old textu
    Image source from mirror
 
    .. attribute:: alpha
+
       use alpha in texture
 
    .. attribute:: background
+
       background color
 
    .. attribute:: capsize
+
       size of render area
 
    .. attribute:: clip
+
       clipping distance
 
    .. attribute:: filter
+
       pixel filter
 
    .. attribute:: flip
+
       flip image vertically
 
    .. attribute:: image
+
       image data
 
    .. method:: refresh(imageMirror)
+
       Refresh image - invalidate its current content
 
    .. attribute:: scale
+
       fast scale of image (near neighbour)
 
    .. attribute:: size
+
       image size
 
    .. attribute:: valid
+
       bool to tell if an image is available
 
    .. attribute:: whole
+
       use whole viewport to render
 
 .. class:: ImageMix()
@@ -208,33 +253,44 @@ When the texture object is deleted, the new texture is deleted and the old textu
    Image mixer
 
    .. attribute:: filter
+
       pixel filter
 
    .. attribute:: flip
+
       flip image vertically
 
    .. method:: getSource(imageMix)
+
       get image source
 
    .. method:: getWeight(imageMix)
+
       get image source weight
 
+
    .. attribute:: image
+
       image data
 
    .. method:: refresh(imageMix)
+
       Refresh image - invalidate its current content
 
    .. attribute:: scale
+
       fast scale of image (near neighbour)
 
    .. method:: setSource(imageMix)
+
       set image source
 
    .. method:: setWeight(imageMix)
+
       set image source weight
 
    .. attribute:: valid
+
       bool to tell if an image is available
 
 .. class:: ImageRender(scene, camera)
@@ -242,36 +298,47 @@ When the texture object is deleted, the new texture is deleted and the old textu
    Image source from render
 
    .. attribute:: alpha
+
       use alpha in texture
 
    .. attribute:: background
+
       background color
 
    .. attribute:: capsize
+
       size of render area
 
    .. attribute:: filter
+
       pixel filter
 
    .. attribute:: flip
+
       flip image vertically
 
    .. attribute:: image
+
       image data
 
    .. method:: refresh(imageRender)
+
       Refresh image - invalidate its current content
 
    .. attribute:: scale
+
       fast scale of image (near neighbour)
 
    .. attribute:: size
+
       image size
 
    .. attribute:: valid
+
       bool to tell if an image is available
 
    .. attribute:: whole
+
       use whole viewport to render
 
 .. class:: ImageViewport()
@@ -279,36 +346,47 @@ When the texture object is deleted, the new texture is deleted and the old textu
    Image source from viewport
 
    .. attribute:: alpha
+
       use alpha in texture
 
    .. attribute:: capsize
+
       size of viewport area being captured
 
    .. attribute:: filter
+
       pixel filter
 
    .. attribute:: flip
+
       flip image vertically
 
    .. attribute:: image
+
       image data
 
    .. attribute:: position
+
       upper left corner of captured area
 
    .. method:: refresh(imageViewport)
+
       Refresh image - invalidate its current content
 
    .. attribute:: scale
+
       fast scale of image (near neighbour)
 
    .. attribute:: size
+
       image size
 
    .. attribute:: valid
+
       bool to tell if an image is available
 
    .. attribute:: whole
+
       use whole viewport to capture
 
 .. class:: Texture(gameObj)
@@ -316,18 +394,23 @@ When the texture object is deleted, the new texture is deleted and the old textu
    Texture objects
 
    .. attribute:: bindId
+
       OpenGL Bind Name
 
    .. method:: close(texture)
+
       Close dynamic texture and restore original
 
    .. attribute:: mipmap
+
       mipmap texture
 
    .. method:: refresh(texture)
+
       Refresh texture from source
 
    .. attribute:: source
+
       source of texture
 
 .. class:: FilterBGR24()
@@ -339,12 +422,15 @@ When the texture object is deleted, the new texture is deleted and the old textu
    Filter for Blue Screen objects
 
    .. attribute:: color
+
       blue screen color
 
    .. attribute:: limits
+
       blue screen color limits
 
    .. attribute:: previous
+
       previous pixel filter
 
 .. class:: FilterColor()
@@ -352,9 +438,11 @@ When the texture object is deleted, the new texture is deleted and the old textu
    Filter for color calculations
 
    .. attribute:: matrix
+
       matrix [4][5] for color calculation
 
    .. attribute:: previous
+
       previous pixel filter
 
 .. class:: FilterGray()
@@ -362,6 +450,7 @@ When the texture object is deleted, the new texture is deleted and the old textu
    Filter for gray scale effect
 
    .. attribute:: previous
+
       previous pixel filter
 
 .. class:: FilterLevel()
@@ -369,9 +458,11 @@ When the texture object is deleted, the new texture is deleted and the old textu
    Filter for levels calculations
 
    .. attribute:: levels
+
       levels matrix [4] (min, max)
 
    .. attribute:: previous
+
       previous pixel filter
 
 .. class:: FilterNormal()
@@ -379,12 +470,15 @@ When the texture object is deleted, the new texture is deleted and the old textu
    Filter for Blue Screen objects
 
    .. attribute:: colorIdx
+
       index of color used to calculate normal (0 - red, 1 - green, 2 - blue)
 
    .. attribute:: depth
+
       depth of relief
 
    .. attribute:: previous
+
       previous pixel filter
 
 .. class:: FilterRGB24()
@@ -397,12 +491,14 @@ When the texture object is deleted, the new texture is deleted and the old textu
    Source filter RGBA32 objects
 
 .. function:: getLastError()
+
    Last error that occurred in a bge.texture function.
 
    :return: the description of the last error occurred in a bge.texture function.
    :rtype: string
 
 .. function:: imageToArray(image,mode)
+
    Returns a :class:`~bgl.buffer` corresponding to the current image stored in a texture source object.
 
    :arg image: Image source object.
@@ -421,6 +517,7 @@ When the texture object is deleted, the new texture is deleted and the old textu
       parameter.
 
 .. function materialID(object,name)
+
    Returns a numeric value that can be used in :class:`Texture` to create a dynamic texture.
 
    The value corresponds to an internal material number that uses the texture identified
@@ -442,6 +539,7 @@ When the texture object is deleted, the new texture is deleted and the old textu
    :rtype: integer
 
 .. function setLogFile(filename)
+
    Sets the name of a text file in which runtime error messages will be written, in addition to the printing
    of the messages on the Python console. Only the runtime errors specific to the VideoTexture module
    are written in that file, ordinary runtime time errors are not written.