Cr8-xyz/blender
1
0
Fork 0
Code Issues Pull Requests Actions 1 Packages Projects Releases Wiki Activity

some corrections to bge.texture docs

Browse Source
This commit is contained in:
Campbell Barton
2011-07-07 19:23:51 +00:00
parent 99736f373c
commit af27622a87
2 changed files with 379 additions and 377 deletions
Download Patch File Download Diff File Expand all files Collapse all files

16
doc/python_api/rst/bge.texture.rst
View File

@@ -389,7 +389,7 @@ When the texture object is deleted, the new texture is deleted and the old textu
.. class:: FilterRGB24()
Returns a new input filter object to be used with :class:'ImageBuff' object when the image passed
Returns a new input filter object to be used with :class:`ImageBuff` object when the image passed
to the ImageBuff.load() function has the 3-bytes pixel format BGR.
.. class:: FilterRGBA32()
@@ -406,13 +406,13 @@ When the texture object is deleted, the new texture is deleted and the old textu
Returns a :class:`~bgl.buffer` corresponding to the current image stored in a texture source object.
:arg image: Image source object.
:type image: object of type :class:'VideoFFmpeg', :class:'ImageFFmpeg', :class:'ImageBuff', :class:'ImageMix', :class:'ImageRender', :class:'ImageMirror' or :class:'ImageViewport'
:type image: object of type :class:`VideoFFmpeg`, :class:`ImageFFmpeg`, :class:`ImageBuff`, :class:`ImageMix`, :class:`ImageRender`, :class:`ImageMirror` or :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,
| 0 to force a fixed 0 color channel and 1 to force a fixed 255 color channel.
| Example: "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.
| The default mode is "RGBA".
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.
Example: "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.
The default mode is "RGBA".
:type mode: string
:rtype: :class:`~bgl.buffer`
@@ -421,7 +421,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.
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
by name. name is a string representing a texture name with IM prefix if you want to

6
doc/python_api/sphinx_doc_gen.py
View File

@@ -77,9 +77,9 @@ else:
"bpy.types", # supports filtering
"bpy.ops", # supports filtering
"bpy_extras",
"bge",
# "bge",
"aud",
#"bgl",
"bgl",
"blf",
"mathutils",
"mathutils.geometry",
@@ -1048,6 +1048,7 @@ def rna2sphinx(BASEPATH):
fw(" bge.types.rst\n\n")
fw(" bge.logic.rst\n\n")
fw(" bge.render.rst\n\n")
fw(" bge.texture.rst\n\n")
fw(" bge.events.rst\n\n")
# rna generated change log
@@ -1182,6 +1183,7 @@ def rna2sphinx(BASEPATH):
shutil.copy2(os.path.join(BASEPATH, "..", "rst", "bge.types.rst"), BASEPATH)
shutil.copy2(os.path.join(BASEPATH, "..", "rst", "bge.logic.rst"), BASEPATH)
shutil.copy2(os.path.join(BASEPATH, "..", "rst", "bge.render.rst"), BASEPATH)
shutil.copy2(os.path.join(BASEPATH, "..", "rst", "bge.texture.rst"), BASEPATH)
shutil.copy2(os.path.join(BASEPATH, "..", "rst", "bge.events.rst"), BASEPATH)
shutil.copy2(os.path.join(BASEPATH, "..", "rst", "change_log.rst"), BASEPATH)