Commit Graph

323 Commits

Author SHA1 Message Date
cce9c43295 correct api doc examples and a typo 2012-01-05 05:43:35 +00:00
9a0bf1ffa4 Correct use of your vs you're in py api docs 2012-01-04 03:22:37 +00:00
3c480e85e3 update the api changelog 2.60 --> 2.61 2011-12-22 21:44:52 +00:00
9aaa67cc4c corrections for docs 2011-11-28 17:19:25 +00:00
2345efc6c5 Patch #29336: renaming UV (Texture) Layer to UV Map in the user interface,
by Gaia Clary.

Rationale: the name was confusing and not always used consistently, and this
map itself is not something that can be layered, rather the map can be used
as texture coordinates in some layered setup.

The original intent was to indicate this contained more than just UV's, but
the game engine settings have already been moved out, and apparently users
didn't really get this from the name anyway.
2011-11-23 17:25:25 +00:00
c6c6a3578b tab -> spaces 2011-11-18 04:55:43 +00:00
e9be8b4a0a document py gotchas
- dont assume you get the data names you ask for
- beware of collisions with library names
- beware of py modules calling sys.exit
2011-11-18 04:48:27 +00:00
f8d0c8b11e patch [#29049] Minor phrasing and grammar patch 2011-10-28 01:10:46 +00:00
cc1ed7cbc5 fix/update for credits script and bad formatting in sphinx docs. 2011-10-17 13:54:47 +00:00
2dc6ca49b3 py docs:
added python doc section on script performance and a note on relative file paths in the gotcha's page.
also added script for spell checking py comments.
2011-10-17 10:43:55 +00:00
67c15da97d docs / clenup (no functional code changes)
- added API examples for mathutils.Color/Euler/Quaternion/Matrix.
- corrected own bad spelling matricies --> matrices.
- minor pep8 edits.
- update CMake ignore file list.
2011-10-17 02:20:53 +00:00
6d5891e7ea fix bad URL in bgl doc 2011-10-16 15:01:13 +00:00
c40b976ea8 py docs - gpu module wasn't included in docs.
also added convenience target to build sphinx api docs:
 make doc_py
2011-10-13 06:59:09 +00:00
14dd4d19ed update generated api changelog for edits since 2.59 2011-10-05 22:43:00 +00:00
78968a0fc9 fix for mistake in api changelog script with function names. 2011-10-02 23:53:41 +00:00
a80520804a add '2.58 to 2.59' to changelog (should have done this for 2.59 release) and texface changes for 2.59 -> 2.60. 2011-10-02 23:47:05 +00:00
447a60b7c4 svn merge -rHEAD:40523 doc/python_api/rst/change_log.rst
revert changes for texface, will apply manually after.
2011-10-02 23:23:45 +00:00
Dalai Felinto
11a0e00819 BGE Material settings renaming Back Culling to Backface Culling and make it on by default
under suggestion of Mitchell Stokes (Moguri)
2011-09-26 06:39:19 +00:00
Dalai Felinto
51555877b0 manual update on changelog (python API)
Change as suggested by Campbell.
I'm not sure if this is the way to do for enums, I will check with him later
2011-09-24 23:50:00 +00:00
Dalai Felinto
e5b98f7a2f Python API changelog r37840-40524 (HEAD)
updating the doc.

I'm also including the latest API dump with it. This helps to keep track of the revisions to update and the next person updating doesnt need to build an old Blender for that (as I just had to).

I updated the sphinx_changelog_gen.py with this info as well.
I'll update changelog.rst manually next. I'm not so sure how to indicate that the properties were replaced instead of only removed.
2011-09-24 22:40:56 +00:00
5ba213a424 move utf8 string.c functions into their own file, also add python tip for printing operators. 2011-09-15 08:07:42 +00:00
1e6dbb1a4d added section about editmode switching to gotchas 2011-09-10 23:06:44 +00:00
e883de2739 spelling corrections from Philippe Casteleyn 2011-09-10 14:28:13 +00:00
01744abd81 GPU: add gpu python module with export_shader() function to export GLSL shader.
shader = gpu.export_shader(scene,material) 

Returns the GLSL shader that blender generates to produce the visual effect
of material in scene for the purpose of reusing the shader in an external engine.
This function is meant to be used in a material exporter so that the GLSL
shader can be exported entirely. The return value is a dictionary containing the
shader source code and all associated data. 

The full documentation is under sphinx.

Warning: there has been an API between the patch and this commit:
uniform['lamp'] and uniform['image'] now return python reference to 
ID block instead of ID name as before. The X3D exporter that uses this
function must be adapted.
2011-09-09 11:55:38 +00:00
4eb9b9e4f1 bpy api - add new page for best-practice (so Thomas has something to point to when kicking devs for writing shoddy UI layouts) 2011-09-08 23:59:47 +00:00
49547241d6 correction to docs. 2011-09-08 10:15:27 +00:00
290ad64a22 finished tips and tricks section of blender/python api docs, now included in generated docs. 2011-09-08 01:26:23 +00:00
520778163d interface + naming improvements to vertex wright modifier
- WeightVG -> Vertex Weight
- mapping_mode -> falloff_type
- nicer layout for VertexWeightModifiers add/remove options
2011-09-07 07:46:26 +00:00
fa32395b33 more minor doc fixes 2011-09-06 00:41:28 +00:00
67712c10c4 fix for doc building after pepper merge, also WIP tips/tricks. 2011-09-06 00:12:34 +00:00
4280e0a04f BGE animations: adding a missing comma. 2011-09-02 03:57:37 +00:00
255a81c3bf wip doc for py api tips and tricks. 2011-09-01 07:07:18 +00:00
1ad8ed8a60 BGE animations: Updating some constant names. They were still the originally proposed names instead of the ones that are actually used now. 2011-08-31 23:46:31 +00:00
812d5d2e5c BGE Animations: The return type for KX_GameObject.getActionFrame() was an integer when it should have been a float. I've fixed this and converted the tabs in the new BGE animation docs to space. I have also added more info on return types for KX_GameObject.getActionFrame() and KX_GameObject.isPlayingAction(). 2011-08-31 22:32:14 +00:00
f63d049adc BGE: Adding two new functions to bge.render to allow users to change the anisotropic filtering level used by textures:
* setAnisotropicFiltering(level)
  * getAnisotropicFiltering()
2011-08-31 05:51:51 +00:00
43ab8e8624 * Merge trunk up to r39790.
* Subversion bump (also for init_userdef_do_versions).
* Minor fix for compilation without ffmpeg.
2011-08-30 08:22:03 +00:00
909d74d124 - use python convention for headings
- use implicit examples rather than .. code-block::
2011-08-27 08:09:12 +00:00
2e8771e987 bpy Gotcha's section on bones by Bassam Kurdali, with some edit.
added some examples & notes too.
2011-08-27 07:05:04 +00:00
a9dea3afe9 correct missing bpy doc references. 2011-08-26 18:48:48 +00:00
f10f4f570d added a section to gotcha's python bpy docs about unicode encoding problems. 2011-08-26 18:32:23 +00:00
e9ca846018 document some of the pitfalls in the blender python api (taken from frequent mails and bug reports) 2011-08-26 04:00:55 +00:00
50a9454e0f move wiki api intro and overview docs into the api reference docs.
Updated docs since some parts still were from beta still.
2011-08-25 04:25:33 +00:00
ef18ec335f svn merge -r39145:39286 https://svn.blender.org/svnroot/bf-blender/trunk/blender 2011-08-11 05:04:01 +00:00
da6bc69ca9 fix [#28191] Exception when enabling a script for a newer Blender build 2011-08-09 14:16:22 +00:00
08e184f302 note to address issue raised by report [#28190]. 2011-08-09 13:50:27 +00:00
daab78bc61 Merging trunk up to r39145. 2011-08-07 15:25:06 +00:00
Dalai Felinto
f3c40df5e3 rst API doc fixes: literalincluding bge.texture and bge.constraints examples + bgl fixes 2011-08-04 09:47:40 +00:00
4e8e502c02 Merging trunk up to r38932. 2011-08-02 12:16:06 +00:00
f4293067c1 py api: sphinx doc corrections, pep8 cleanup and style edits, also added __all__ to some modules which were missing it. 2011-07-31 03:15:37 +00:00
Dalai Felinto
dfc661565a patch [#27909] Added constants in bge.constraints by Solano Felicio (solano) + some changes in rst
I named all the BGE modules with their actual names (e.g. Rasterizer, Video Texture, ...). so in the API index.html page they look more like the other Blender modules.
I did the same for the bgl module.

For bge.constraints this patch exposes the constants values for debug mode and createConstraints (they were hardcoded innts before).

+ making all the "todo" and #comments into rst comments (.. comments)
Thanks Solano, it's great to get help to those tasks :)
2011-07-30 23:16:22 +00:00