Fix collision multithreading inconsistency

Multithreading makes collisions be detected in different orders, causing
the clustering step of collision resolution to generate possibly
slightly different results on each run. This commit makes collision
order consistent.

.arcconfig

@@ -1,7 +1,6 @@
 {
 	"project_id" : "Blender",
 	"conduit_uri" : "https://developer.blender.org/",
-	"git.default-relative-commit" : "origin/blender2.8",
-	"arc.land.update.default" : "rebase",
-	"arc.land.onto.default" : "blender2.8"
+	"git.default-relative-commit" : "origin/master",
+	"arc.land.update.default" : "rebase"
 }

.editorconfig

@@ -0,0 +1,44 @@
+# C/C++
+[*.{c,cc,h,hh,inl,glsl}]
+charset = utf-8
+trim_trailing_whitespace = true
+insert_final_newline = true
+indent_style = tab
+indent_size = 4
+max_line_length = 120
+
+# CMake & Text
+[*.{cmake,txt}]
+charset = utf-8
+trim_trailing_whitespace = true
+insert_final_newline = true
+indent_style = tab
+indent_size = 4
+max_line_length = 120
+
+# Python
+[*.py]
+charset = utf-8
+trim_trailing_whitespace = true
+insert_final_newline = true
+indent_style = space
+indent_size = 4
+max_line_length = 120
+
+# Shell
+[*.sh]
+charset = utf-8
+trim_trailing_whitespace = true
+insert_final_newline = true
+indent_style = tab
+indent_size = 4
+max_line_length = 120
+
+# reStructuredText
+[*.rst]
+charset = utf-8
+trim_trailing_whitespace = true
+insert_final_newline = true
+indent_style = space
+indent_size = 3
+max_line_length = 120

.gitmodules

@@ -1,20 +1,20 @@
 [submodule "release/scripts/addons"]
 	path = release/scripts/addons
 	url = ../blender-addons.git
-	branch = blender2.8
 	ignore = all
+	branch = master
 [submodule "release/scripts/addons_contrib"]
 	path = release/scripts/addons_contrib
 	url = ../blender-addons-contrib.git
-	branch = master
 	ignore = all
+	branch = master
 [submodule "release/datafiles/locale"]
 	path = release/datafiles/locale
 	url = ../blender-translations.git
-	branch = master
 	ignore = all
+	branch = master
 [submodule "source/tools"]
 	path = source/tools
 	url = ../blender-dev-tools.git
-	branch = master
 	ignore = all
+	branch = master

CMakeLists.txt

@@ -156,6 +156,7 @@ option_defaults_init(
 	_init_OPENCOLORIO
 	_init_SDL
 	_init_FFTW3
+	_init_GAMEENGINE
 	_init_OPENSUBDIV
 )
 
@@ -225,10 +226,15 @@ option(WITH_FFTW3         "Enable FFTW3 support (Used for smoke, ocean sim, and
 option(WITH_BULLET        "Enable Bullet (Physics Engine)" ON)
 option(WITH_SYSTEM_BULLET "Use the systems bullet library (currently unsupported due to missing features in upstream!)" )
 mark_as_advanced(WITH_SYSTEM_BULLET)
+option(WITH_GAMEENGINE    "Enable Game Engine" ${_init_GAMEENGINE})
+if(APPLE)
+	set(WITH_GAMEENGINE_DECKLINK OFF)
+else()
+	option(WITH_GAMEENGINE_DECKLINK "Support BlackMagicDesign DeckLink cards in the Game Engine" ON)
+endif()
+option(WITH_PLAYER        "Build Player" OFF)
 option(WITH_OPENCOLORIO   "Enable OpenColorIO color management" ${_init_OPENCOLORIO})
 
-option(WITH_CLAY_ENGINE    "Enable Clay engine" ON)
-
 # Compositor
 option(WITH_COMPOSITOR         "Enable the tile based nodal compositor" ON)
 
@@ -310,6 +316,7 @@ option(WITH_IMAGE_TIFF          "Enable LibTIFF Support" ON)
 option(WITH_IMAGE_DDS           "Enable DDS Image Support" ON)
 option(WITH_IMAGE_CINEON        "Enable CINEON and DPX Image Support" ON)
 option(WITH_IMAGE_HDR           "Enable HDR Image Support" ON)
+option(WITH_IMAGE_FRAMESERVER   "Enable image FrameServer Support for rendering" ON)
 
 # Audio/Video format support
 option(WITH_CODEC_AVI           "Enable Blenders own AVI file support (raw/jpeg)" ON)
@@ -372,14 +379,10 @@ if(UNIX AND NOT APPLE)
 endif()
 
 option(WITH_PYTHON_INSTALL       "Copy system python into the blender install folder" ON)
-if(WITH_PYTHON_INSTALL OR (WITH_AUDASPACE AND NOT WITH_SYSTEM_AUDASPACE))
-	set(PYTHON_NUMPY_PATH            "" CACHE PATH "Path to python site-packages or dist-packages containing 'numpy' module")
-	mark_as_advanced(PYTHON_NUMPY_PATH)
-	set(PYTHON_NUMPY_INCLUDE_DIRS ${PYTHON_NUMPY_PATH}/numpy/core/include CACHE PATH "Path to the include directory of the numpy module")
-	mark_as_advanced(PYTHON_NUMPY_INCLUDE_DIRS)
-endif()
 if(WITH_PYTHON_INSTALL)
 	option(WITH_PYTHON_INSTALL_NUMPY "Copy system numpy into the blender install folder"  ON)
+	set(PYTHON_NUMPY_PATH            "" CACHE PATH "Path to python site-packages or dist-packages containing 'numpy' module")
+	mark_as_advanced(PYTHON_NUMPY_PATH)
 
 	if(UNIX AND NOT APPLE)
 		option(WITH_PYTHON_INSTALL_REQUESTS "Copy system requests into the blender install folder" ON)
@@ -441,7 +444,7 @@ mark_as_advanced(WITH_MEM_VALGRIND)
 option(WITH_CXX_GUARDEDALLOC "Enable GuardedAlloc for C++ memory allocation tracking (only enable for development)" OFF)
 mark_as_advanced(WITH_CXX_GUARDEDALLOC)
 
-option(WITH_ASSERT_ABORT "Call abort() when raising an assertion through BLI_assert()" OFF)
+option(WITH_ASSERT_ABORT "Call abort() when raising an assertion through BLI_assert()" ON)
 mark_as_advanced(WITH_ASSERT_ABORT)
 
 option(WITH_BOOST					"Enable features depending on boost" ON)
@@ -460,16 +463,28 @@ endif()
 
 # OpenGL
 
+option(WITH_GLEW_MX             "Support multiple GLEW contexts (experimental)"                                                                     OFF )
 option(WITH_GLEW_ES             "Switches to experimental copy of GLEW that has support for OpenGL ES. (temporary option for development purposes)" OFF)
 option(WITH_GL_EGL              "Use the EGL OpenGL system library instead of the platform specific OpenGL system library (CGL, glX, or WGL)"       OFF)
+option(WITH_GL_PROFILE_COMPAT   "Support using the OpenGL 'compatibility' profile. (deprecated)"                                                    ON )
+option(WITH_GL_PROFILE_CORE     "Support using the OpenGL 3.2+ 'core' profile."                                                                     OFF)
 option(WITH_GL_PROFILE_ES20     "Support using OpenGL ES 2.0. (thru either EGL or the AGL/WGL/XGL 'es20' profile)"                                  OFF)
 
 mark_as_advanced(
+	WITH_GLEW_MX
 	WITH_GLEW_ES
 	WITH_GL_EGL
+	WITH_GL_PROFILE_COMPAT
+	WITH_GL_PROFILE_CORE
 	WITH_GL_PROFILE_ES20
 )
 
+if(WITH_GL_PROFILE_COMPAT)
+	set(WITH_GLU ON)
+else()
+	set(WITH_GLU OFF)
+endif()
+
 if(WIN32)
 	option(WITH_GL_ANGLE "Link with the ANGLE library, an OpenGL ES 2.0 implementation based on Direct3D, instead of the system OpenGL library." OFF)
 	mark_as_advanced(WITH_GL_ANGLE)
@@ -495,10 +510,11 @@ if(APPLE)
 	set(WITH_CXX11 ON)
 elseif(CMAKE_COMPILER_IS_GNUCC AND (NOT "${CMAKE_C_COMPILER_VERSION}" VERSION_LESS "6.0") AND (NOT WITH_CXX11))
 	set(_c11_init ON)
+	set(_cxx11_init ON)
 else()
 	set(_c11_init OFF)
+	set(_cxx11_init OFF)
 endif()
-set(_cxx11_init ON)
 
 option(WITH_C11 "Build with C11 standard enabled, for development use only!" ${_c11_init})
 mark_as_advanced(WITH_C11)
@@ -545,7 +561,8 @@ if(CMAKE_COMPILER_IS_GNUCC OR CMAKE_C_COMPILER_ID MATCHES "Clang")
 			find_library(COMPILER_ASAN_LIBRARY asan ${CMAKE_C_IMPLICIT_LINK_DIRECTORIES})
 		else()
 			find_library( COMPILER_ASAN_LIBRARY NAMES clang_rt.asan-x86_64
-				PATHS 	[HKEY_LOCAL_MACHINE\\SOFTWARE\\Wow6432Node\\LLVM\\LLVM;]/lib/clang/7.0.0/lib/windows
+				PATHS
+				[HKEY_LOCAL_MACHINE\\SOFTWARE\\Wow6432Node\\LLVM\\LLVM;]/lib/clang/7.0.0/lib/windows
 				[HKEY_LOCAL_MACHINE\\SOFTWARE\\Wow6432Node\\LLVM\\LLVM;]/lib/clang/6.0.0/lib/windows
 			)
 		endif()
@@ -608,25 +625,28 @@ endif()
 #-----------------------------------------------------------------------------
 # Check for conflicting/unsupported configurations
 
-if(NOT WITH_BLENDER AND NOT WITH_CYCLES_STANDALONE)
+if(NOT WITH_BLENDER AND NOT WITH_PLAYER AND NOT WITH_CYCLES_STANDALONE)
 	message(FATAL_ERROR
-		"At least one of WITH_BLENDER or WITH_CYCLES_STANDALONE "
-		"must be enabled, nothing to do!"
+		"At least one of WITH_BLENDER or WITH_PLAYER or "
+		"WITH_CYCLES_STANDALONE must be enabled, nothing to do!"
 	)
 endif()
 
-if(NOT WITH_CXX11)
-	if(WITH_AUDASPACE AND NOT WITH_SYSTEM_AUDASPACE)
-		message(FATAL_ERROR "WITH_AUDASPACE requires WITH_CXX11")
-	endif()
+if(NOT WITH_GAMEENGINE AND WITH_PLAYER)
+	message(FATAL_ERROR "WITH_PLAYER requires WITH_GAMEENGINE")
 endif()
 
 if(NOT WITH_AUDASPACE)
 	if(WITH_OPENAL)
-		message(FATAL_ERROR "WITH_OPENAL requires WITH_AUDASPACE")
+		message(WARNING "WITH_OPENAL requires WITH_AUDASPACE which is disabled")
+		set(WITH_OPENAL OFF)
 	endif()
 	if(WITH_JACK)
-		message(FATAL_ERROR "WITH_JACK requires WITH_AUDASPACE")
+		message(WARNING "WITH_JACK requires WITH_AUDASPACE which is disabled")
+		set(WITH_JACK OFF)
+	endif()
+	if(WITH_GAMEENGINE)
+		message(FATAL_ERROR "WITH_GAMEENGINE requires WITH_AUDASPACE")
 	endif()
 endif()
 
@@ -635,6 +655,10 @@ if(NOT WITH_SDL AND WITH_GHOST_SDL)
 endif()
 
 # python module, needs some different options
+if(WITH_PYTHON_MODULE AND WITH_PLAYER)
+	message(FATAL_ERROR "WITH_PYTHON_MODULE requires WITH_PLAYER to be OFF")
+endif()
+
 if(WITH_PYTHON_MODULE AND WITH_PYTHON_INSTALL)
 	message(FATAL_ERROR "WITH_PYTHON_MODULE requires WITH_PYTHON_INSTALL to be OFF")
 endif()
@@ -662,10 +686,15 @@ if(NOT WITH_BOOST)
 	endmacro()
 
 	set_and_warn(WITH_CYCLES         OFF)
+	set_and_warn(WITH_AUDASPACE      OFF)
 	set_and_warn(WITH_INTERNATIONAL  OFF)
 	set_and_warn(WITH_OPENVDB        OFF)
 	set_and_warn(WITH_OPENCOLORIO    OFF)
-elseif(WITH_CYCLES OR WITH_OPENIMAGEIO OR WITH_INTERNATIONAL OR
+
+	set_and_warn(WITH_OPENAL         OFF)  # depends on AUDASPACE
+	set_and_warn(WITH_GAMEENGINE     OFF)  # depends on AUDASPACE
+	set_and_warn(WITH_PLAYER         OFF)  # depends on GAMEENGINE
+elseif(WITH_CYCLES OR WITH_OPENIMAGEIO OR WITH_AUDASPACE OR WITH_INTERNATIONAL OR
        WITH_OPENVDB OR WITH_OPENCOLORIO)
 	# Keep enabled
 else()
@@ -734,9 +763,30 @@ TEST_SHARED_PTR_SUPPORT()
 TEST_UNORDERED_MAP_SUPPORT()
 
 if(WITH_AUDASPACE)
-	if(NOT WITH_SYSTEM_AUDASPACE)
-		set(AUDASPACE_C_INCLUDE_DIRS "${CMAKE_SOURCE_DIR}/extern/audaspace/bindings/C" "${CMAKE_BINARY_DIR}/extern/audaspace")
-		set(AUDASPACE_PY_INCLUDE_DIRS "${CMAKE_SOURCE_DIR}/extern/audaspace/bindings")
+	if(WITH_SYSTEM_AUDASPACE)
+		set(AUDASPACE_DEFINITIONS
+			-DWITH_AUDASPACE
+			-DWITH_SYSTEM_AUDASPACE
+			"-DAUD_DEVICE_H=<AUD_Device.h>"
+			"-DAUD_SPECIAL_H=<AUD_Special.h>"
+			"-DAUD_SOUND_H=<AUD_Sound.h>"
+			"-DAUD_HANDLE_H=<AUD_Handle.h>"
+			"-DAUD_SEQUENCE_H=<AUD_Sequence.h>"
+			"-DAUD_TYPES_H=<AUD_Types.h>"
+			"-DAUD_PYTHON_H=<python/PyAPI.h>"
+		)
+	else()
+		set(AUDASPACE_C_INCLUDE_DIRS "${CMAKE_SOURCE_DIR}/intern/audaspace/intern")
+		set(AUDASPACE_PY_INCLUDE_DIRS "${CMAKE_SOURCE_DIR}/intern/audaspace/intern")
+		set(AUDASPACE_DEFINITIONS
+			-DWITH_AUDASPACE
+			"-DAUD_DEVICE_H=<AUD_C-API.h>"
+			"-DAUD_SPECIAL_H=<AUD_C-API.h>"
+			"-DAUD_SOUND_H=<AUD_C-API.h>"
+			"-DAUD_HANDLE_H=<AUD_C-API.h>"
+			"-DAUD_SEQUENCE_H=<AUD_C-API.h>"
+			"-DAUD_TYPES_H=<AUD_Space.h>"
+		)
 	endif()
 endif()
 
@@ -805,7 +855,8 @@ set(C_WARNINGS)
 set(CXX_WARNINGS)
 
 # for gcc -Wno-blah-blah
-set(CC_REMOVE_STRICT_FLAGS)
+set(C_REMOVE_STRICT_FLAGS)
+set(CXX_REMOVE_STRICT_FLAGS)
 
 # libraries to link the binary with passed to target_link_libraries()
 # known as LLIBS to scons
@@ -1004,11 +1055,19 @@ endif()
 find_package(OpenGL)
 blender_include_dirs_sys("${OPENGL_INCLUDE_DIR}")
 
+if(WITH_GLU)
+	list(APPEND BLENDER_GL_LIBRARIES "${OPENGL_glu_LIBRARY}")
+	list(APPEND GL_DEFINITIONS -DWITH_GLU)
+endif()
+
 if(WITH_SYSTEM_GLES)
 	find_package_wrapper(OpenGLES)
 endif()
 
-if(WITH_GL_PROFILE_ES20)
+if(WITH_GL_PROFILE_COMPAT OR WITH_GL_PROFILE_CORE)
+	list(APPEND BLENDER_GL_LIBRARIES "${OPENGL_gl_LIBRARY}")
+
+elseif(WITH_GL_PROFILE_ES20)
 	if(WITH_SYSTEM_GLES)
 		if(NOT OPENGLES_LIBRARY)
 			message(FATAL_ERROR
@@ -1068,9 +1127,6 @@ if(WITH_GL_PROFILE_ES20)
 
 	endif()
 
-else()
-	list(APPEND BLENDER_GL_LIBRARIES "${OPENGL_gl_LIBRARY}")
-
 endif()
 
 if(WITH_GL_EGL)
@@ -1118,10 +1174,16 @@ if(WITH_GL_EGL)
 
 endif()
 
+if(WITH_GL_PROFILE_COMPAT)
+	list(APPEND GL_DEFINITIONS -DWITH_GL_PROFILE_COMPAT)
+endif()
+
+if(WITH_GL_PROFILE_CORE)
+	list(APPEND GL_DEFINITIONS -DWITH_GL_PROFILE_CORE)
+endif()
+
 if(WITH_GL_PROFILE_ES20)
 	list(APPEND GL_DEFINITIONS -DWITH_GL_PROFILE_ES20)
-else()
-	list(APPEND GL_DEFINITIONS -DWITH_GL_PROFILE_CORE)
 endif()
 
 if(WITH_GL_EGL)
@@ -1158,6 +1220,10 @@ endif()
 #-----------------------------------------------------------------------------
 # Configure GLEW
 
+if(WITH_GLEW_MX)
+	list(APPEND GL_DEFINITIONS -DWITH_GLEW_MX)
+endif()
+
 if(WITH_SYSTEM_GLEW)
 	find_package(GLEW)
 
@@ -1167,7 +1233,11 @@ if(WITH_SYSTEM_GLEW)
 		message(FATAL_ERROR "GLEW is required to build Blender. Install it or disable WITH_SYSTEM_GLEW.")
 	endif()
 
+	if(WITH_GLEW_MX)
+		set(BLENDER_GLEW_LIBRARIES ${GLEW_MX_LIBRARY})
+	else()
 		set(BLENDER_GLEW_LIBRARIES ${GLEW_LIBRARY})
+	endif()
 else()
 	if(WITH_GLEW_ES)
 		set(GLEW_INCLUDE_PATH "${CMAKE_SOURCE_DIR}/extern/glew-es/include")
@@ -1175,11 +1245,12 @@ else()
 		list(APPEND GL_DEFINITIONS -DGLEW_STATIC -DWITH_GLEW_ES)
 
 		# These definitions remove APIs from glew.h, making GLEW smaller, and catching unguarded API usage
-		if(WITH_GL_PROFILE_ES20)
-			list(APPEND GL_DEFINITIONS -DGLEW_ES_ONLY)
-		else()
+		if(NOT WITH_GL_PROFILE_ES20)
 			# No ES functions are needed
 			list(APPEND GL_DEFINITIONS -DGLEW_NO_ES)
+		elseif(NOT (WITH_GL_PROFILE_CORE OR WITH_GL_PROFILE_COMPAT))
+			# ES is enabled, but the other functions are all disabled
+			list(APPEND GL_DEFINITIONS -DGLEW_ES_ONLY)
 		endif()
 
 		if(WITH_GL_PROFILE_ES20)
@@ -1216,7 +1287,9 @@ else()
 
 endif()
 
+if(NOT WITH_GLU)
 	list(APPEND GL_DEFINITIONS -DGLEW_NO_GLU)
+endif()
 
 #-----------------------------------------------------------------------------
 # Configure Bullet
@@ -1410,16 +1483,22 @@ if(CMAKE_COMPILER_IS_GNUCC)
 	endif()
 
 	# flags to undo strict flags
-	ADD_CHECK_C_COMPILER_FLAG(CC_REMOVE_STRICT_FLAGS C_WARN_NO_DEPRECATED_DECLARATIONS -Wno-deprecated-declarations)
-	ADD_CHECK_C_COMPILER_FLAG(CC_REMOVE_STRICT_FLAGS C_WARN_NO_UNUSED_PARAMETER        -Wno-unused-parameter)
-	ADD_CHECK_C_COMPILER_FLAG(CC_REMOVE_STRICT_FLAGS C_WARN_NO_UNUSED_FUNCTION         -Wno-unused-function)
+	ADD_CHECK_C_COMPILER_FLAG(C_REMOVE_STRICT_FLAGS C_WARN_NO_DEPRECATED_DECLARATIONS -Wno-deprecated-declarations)
+	ADD_CHECK_C_COMPILER_FLAG(C_REMOVE_STRICT_FLAGS C_WARN_NO_UNUSED_PARAMETER        -Wno-unused-parameter)
+	ADD_CHECK_C_COMPILER_FLAG(C_REMOVE_STRICT_FLAGS C_WARN_NO_UNUSED_FUNCTION         -Wno-unused-function)
+	ADD_CHECK_C_COMPILER_FLAG(C_REMOVE_STRICT_FLAGS C_WARN_NO_TYPE_LIMITS             -Wno-type-limits)
+	ADD_CHECK_C_COMPILER_FLAG(C_REMOVE_STRICT_FLAGS C_WARN_NO_INT_IN_BOOL_CONTEXT     -Wno-int-in-bool-context)
+	ADD_CHECK_C_COMPILER_FLAG(C_REMOVE_STRICT_FLAGS C_WARN_NO_FORMAT                  -Wno-format)
+	ADD_CHECK_C_COMPILER_FLAG(C_REMOVE_STRICT_FLAGS C_WARN_NO_SWITCH                  -Wno-switch)
+
+	ADD_CHECK_CXX_COMPILER_FLAG(CXX_REMOVE_STRICT_FLAGS CXX_WARN_NO_CLASS_MEMACCESS     -Wno-class-memaccess)
 
 	if(CMAKE_COMPILER_IS_GNUCC AND (NOT "${CMAKE_C_COMPILER_VERSION}" VERSION_LESS "7.0"))
-		ADD_CHECK_C_COMPILER_FLAG(CC_REMOVE_STRICT_FLAGS C_WARN_NO_IMPLICIT_FALLTHROUGH    -Wno-implicit-fallthrough)
+		ADD_CHECK_C_COMPILER_FLAG(C_REMOVE_STRICT_FLAGS C_WARN_NO_IMPLICIT_FALLTHROUGH    -Wno-implicit-fallthrough)
 	endif()
 
 	if(NOT APPLE)
-		ADD_CHECK_C_COMPILER_FLAG(CC_REMOVE_STRICT_FLAGS C_WARN_NO_ERROR_UNUSED_BUT_SET_VARIABLE -Wno-error=unused-but-set-variable)
+		ADD_CHECK_C_COMPILER_FLAG(C_REMOVE_STRICT_FLAGS C_WARN_NO_ERROR_UNUSED_BUT_SET_VARIABLE -Wno-error=unused-but-set-variable)
 	endif()
 
 elseif(CMAKE_C_COMPILER_ID MATCHES "Clang")
@@ -1448,23 +1527,23 @@ elseif(CMAKE_C_COMPILER_ID MATCHES "Clang")
 	# ADD_CHECK_CXX_COMPILER_FLAG(CXX_WARNINGS CXX_WARN_UNUSED_MACROS          -Wunused-macros)
 
 	# flags to undo strict flags
-	ADD_CHECK_C_COMPILER_FLAG(CC_REMOVE_STRICT_FLAGS C_WARN_NO_UNUSED_PARAMETER -Wno-unused-parameter)
-	ADD_CHECK_C_COMPILER_FLAG(CC_REMOVE_STRICT_FLAGS C_WARN_NO_UNUSED_MACROS    -Wno-unused-macros)
+	ADD_CHECK_C_COMPILER_FLAG(C_REMOVE_STRICT_FLAGS C_WARN_NO_UNUSED_PARAMETER -Wno-unused-parameter)
+	ADD_CHECK_C_COMPILER_FLAG(C_REMOVE_STRICT_FLAGS C_WARN_NO_UNUSED_MACROS    -Wno-unused-macros)
 
-	ADD_CHECK_C_COMPILER_FLAG(CC_REMOVE_STRICT_FLAGS C_WARN_NO_MISSING_VARIABLE_DECLARATIONS -Wno-missing-variable-declarations)
-	ADD_CHECK_C_COMPILER_FLAG(CC_REMOVE_STRICT_FLAGS C_WARN_NO_INCOMPAT_PTR_DISCARD_QUAL -Wno-incompatible-pointer-types-discards-qualifiers)
-	ADD_CHECK_C_COMPILER_FLAG(CC_REMOVE_STRICT_FLAGS C_WARN_NO_UNUSED_FUNCTION -Wno-unused-function)
-	ADD_CHECK_C_COMPILER_FLAG(CC_REMOVE_STRICT_FLAGS C_WARN_NO_INT_TO_VOID_POINTER_CAST -Wno-int-to-void-pointer-cast)
-	ADD_CHECK_C_COMPILER_FLAG(CC_REMOVE_STRICT_FLAGS C_WARN_NO_MISSING_PROTOTYPES -Wno-missing-prototypes)
-	ADD_CHECK_C_COMPILER_FLAG(CC_REMOVE_STRICT_FLAGS C_WARN_NO_DUPLICATE_ENUM -Wno-duplicate-enum)
-	ADD_CHECK_C_COMPILER_FLAG(CC_REMOVE_STRICT_FLAGS C_WARN_NO_UNDEF -Wno-undef)
-	ADD_CHECK_C_COMPILER_FLAG(CC_REMOVE_STRICT_FLAGS C_WARN_NO_MISSING_NORETURN -Wno-missing-noreturn)
+	ADD_CHECK_C_COMPILER_FLAG(C_REMOVE_STRICT_FLAGS C_WARN_NO_MISSING_VARIABLE_DECLARATIONS -Wno-missing-variable-declarations)
+	ADD_CHECK_C_COMPILER_FLAG(C_REMOVE_STRICT_FLAGS C_WARN_NO_INCOMPAT_PTR_DISCARD_QUAL -Wno-incompatible-pointer-types-discards-qualifiers)
+	ADD_CHECK_C_COMPILER_FLAG(C_REMOVE_STRICT_FLAGS C_WARN_NO_UNUSED_FUNCTION -Wno-unused-function)
+	ADD_CHECK_C_COMPILER_FLAG(C_REMOVE_STRICT_FLAGS C_WARN_NO_INT_TO_VOID_POINTER_CAST -Wno-int-to-void-pointer-cast)
+	ADD_CHECK_C_COMPILER_FLAG(C_REMOVE_STRICT_FLAGS C_WARN_NO_MISSING_PROTOTYPES -Wno-missing-prototypes)
+	ADD_CHECK_C_COMPILER_FLAG(C_REMOVE_STRICT_FLAGS C_WARN_NO_DUPLICATE_ENUM -Wno-duplicate-enum)
+	ADD_CHECK_C_COMPILER_FLAG(C_REMOVE_STRICT_FLAGS C_WARN_NO_UNDEF -Wno-undef)
+	ADD_CHECK_C_COMPILER_FLAG(C_REMOVE_STRICT_FLAGS C_WARN_NO_MISSING_NORETURN -Wno-missing-noreturn)
 
-	ADD_CHECK_CXX_COMPILER_FLAG(CC_REMOVE_STRICT_FLAGS CXX_WARN_NO_UNUSED_PRIVATE_FIELD -Wno-unused-private-field)
-	ADD_CHECK_CXX_COMPILER_FLAG(CC_REMOVE_STRICT_FLAGS CXX_WARN_NO_CXX11_NARROWING -Wno-c++11-narrowing)
-	ADD_CHECK_CXX_COMPILER_FLAG(CC_REMOVE_STRICT_FLAGS CXX_WARN_NO_NON_VIRTUAL_DTOR -Wno-non-virtual-dtor)
-	ADD_CHECK_CXX_COMPILER_FLAG(CC_REMOVE_STRICT_FLAGS CXX_WARN_NO_UNUSED_MACROS -Wno-unused-macros)
-	ADD_CHECK_CXX_COMPILER_FLAG(CC_REMOVE_STRICT_FLAGS CXX_WARN_NO_REORDER -Wno-reorder)
+	ADD_CHECK_CXX_COMPILER_FLAG(CXX_REMOVE_STRICT_FLAGS CXX_WARN_NO_UNUSED_PRIVATE_FIELD -Wno-unused-private-field)
+	ADD_CHECK_CXX_COMPILER_FLAG(CXX_REMOVE_STRICT_FLAGS CXX_WARN_NO_CXX11_NARROWING -Wno-c++11-narrowing)
+	ADD_CHECK_CXX_COMPILER_FLAG(CXX_REMOVE_STRICT_FLAGS CXX_WARN_NO_NON_VIRTUAL_DTOR -Wno-non-virtual-dtor)
+	ADD_CHECK_CXX_COMPILER_FLAG(CXX_REMOVE_STRICT_FLAGS CXX_WARN_NO_UNUSED_MACROS -Wno-unused-macros)
+	ADD_CHECK_CXX_COMPILER_FLAG(CXX_REMOVE_STRICT_FLAGS CXX_WARN_NO_REORDER -Wno-reorder)
 
 elseif(CMAKE_C_COMPILER_ID MATCHES "Intel")
 
@@ -1522,15 +1601,10 @@ if(WITH_PYTHON)
 		)
 	endif()
 
-	if(WIN32)
+	if(WIN32 OR APPLE)
 		# pass, we have this in an archive to extract
-	elseif((WITH_PYTHON_INSTALL AND WITH_PYTHON_INSTALL_NUMPY) OR (WITH_AUDASPACE AND NOT WITH_SYSTEM_AUDASPACE))
-		if(("${PYTHON_NUMPY_PATH}" STREQUAL "") OR (${PYTHON_NUMPY_PATH} MATCHES NOTFOUND))
+	elseif(WITH_PYTHON_INSTALL AND WITH_PYTHON_INSTALL_NUMPY)
 		find_python_package(numpy)
-			unset(PYTHON_NUMPY_INCLUDE_DIRS CACHE)
-			set(PYTHON_NUMPY_INCLUDE_DIRS ${PYTHON_NUMPY_PATH}/numpy/core/include CACHE PATH "Path to the include directory of the numpy module")
-		        mark_as_advanced(PYTHON_NUMPY_INCLUDE_DIRS)
-		endif()
 	endif()
 
 	if(WIN32 OR APPLE)
@@ -1620,7 +1694,7 @@ if(WITH_GTESTS)
 	include(GTestTesting)
 endif()
 
-if(WITH_BLENDER)
+if(WITH_BLENDER OR WITH_PLAYER)
 	add_subdirectory(intern)
 	add_subdirectory(extern)
 
@@ -1645,6 +1719,13 @@ if(WITH_BLENDER)
 endif()
 
 
+#-----------------------------------------------------------------------------
+# Blender Player
+if(WITH_PLAYER)
+	add_subdirectory(source/blenderplayer)
+endif()
+
+
 #-----------------------------------------------------------------------------
 # Testing
 add_subdirectory(tests)
@@ -1659,6 +1740,9 @@ include(build_files/cmake/packaging.cmake)
 if(WITH_BLENDER)
 	openmp_delayload(blender)
 endif()
+if(WITH_PLAYER)
+	openmp_delayload(blenderplayer)
+endif()
 
 #-----------------------------------------------------------------------------
 # Print Final Configuration
@@ -1692,6 +1776,8 @@ if(FIRST_RUN)
 	message(STATUS "C++ Compiler: \"${CMAKE_CXX_COMPILER_ID}\"")
 
 	info_cfg_text("Build Options:")
+	info_cfg_option(WITH_GAMEENGINE)
+	info_cfg_option(WITH_PLAYER)
 	info_cfg_option(WITH_BULLET)
 	info_cfg_option(WITH_IK_SOLVER)
 	info_cfg_option(WITH_IK_ITASC)
@@ -1760,7 +1846,10 @@ if(FIRST_RUN)
 
 	info_cfg_text("OpenGL:")
 	info_cfg_option(WITH_GLEW_ES)
+	info_cfg_option(WITH_GLU)
 	info_cfg_option(WITH_GL_EGL)
+	info_cfg_option(WITH_GL_PROFILE_COMPAT)
+	info_cfg_option(WITH_GL_PROFILE_CORE)
 	info_cfg_option(WITH_GL_PROFILE_ES20)
 	if(WIN32)
 		info_cfg_option(WITH_GL_ANGLE)

GNUmakefile

@@ -236,8 +236,9 @@ help: .FORCE
 	@echo "  * check_descriptions   - check for duplicate/invalid descriptions"
 	@echo ""
 	@echo "Utilities (not associated with building blender)"
-	@echo "  * icons      - updates PNG icons from SVG files."
-	@echo "  * icons_geom - updates Geometry icons from BLEND file."
+	@echo "  * icons    - Updates PNG icons from SVG files."
+	@echo "               Set environment variables 'BLENDER_BIN' and 'INKSCAPE_BIN'"
+	@echo "               to define your own commands."
 	@echo "  * tgz      - create a compressed archive of the source code."
 	@echo "  * update   - updates git and all submodules"
 	@echo ""
@@ -424,10 +425,6 @@ icons: .FORCE
 	"$(BLENDER_DIR)/release/datafiles/blender_icons_update.py"
 	"$(BLENDER_DIR)/release/datafiles/prvicons_update.py"
 
-icons_geom: .FORCE
-	BLENDER_BIN="$(BUILD_DIR)/bin/blender" \
-	    "$(BLENDER_DIR)/release/datafiles/blender_icons_geom_update.py"
-
 update: .FORCE
 	if [ "$(OS_NCASE)" = "darwin" ] && [ ! -d "../lib/$(OS_NCASE)" ]; then \
 		svn checkout https://svn.blender.org/svnroot/bf-blender/trunk/lib/$(OS_NCASE) ../lib/$(OS_NCASE) ; \

build_files/build_environment/cmake/ffmpeg.cmake

@@ -103,7 +103,6 @@ ExternalProject_Add(external_ffmpeg
 		--disable-indev=jack
 		--disable-indev=alsa
 		--disable-outdev=alsa
-		--disable-crystalhd
 	PATCH_COMMAND ${PATCH_CMD} --verbose -p 0 -N -d ${BUILD_DIR}/ffmpeg/src/external_ffmpeg < ${PATCH_DIR}/ffmpeg.diff
 	BUILD_COMMAND ${CONFIGURE_ENV_NO_PERL} && cd ${BUILD_DIR}/ffmpeg/src/external_ffmpeg/ && make -j${MAKE_THREADS}
 	INSTALL_COMMAND ${CONFIGURE_ENV_NO_PERL} && cd ${BUILD_DIR}/ffmpeg/src/external_ffmpeg/ && make install

build_files/build_environment/cmake/llvm.cmake

@@ -58,4 +58,3 @@ if(MSVC)
 		DEPENDEES mkdir update patch download configure build install
 	)
 endif()
-

build_files/build_environment/cmake/setup_mingw32.cmake

@@ -216,4 +216,3 @@ if(NOT EXISTS "${DOWNLOAD_DIR}/mingw/mingw32/bin/i686-w64-mingw32-ranlib.exe")
 		COMMAND ${CMAKE_COMMAND} -E copy "${DOWNLOAD_DIR}/mingw/mingw32/bin/ranlib.exe" "${DOWNLOAD_DIR}/mingw/mingw32/bin/i686-w64-mingw32-ranlib.exe"
 	)
 endif()
-

build_files/build_environment/cmake/setup_mingw64.cmake

@@ -216,4 +216,3 @@ if(NOT EXISTS "${DOWNLOAD_DIR}/mingw/mingw64/bin/x86_64-w64-mingw32-ranlib.exe")
 		COMMAND ${CMAKE_COMMAND} -E copy "${DOWNLOAD_DIR}/mingw/mingw64/bin/ranlib.exe" "${DOWNLOAD_DIR}/mingw/mingw64/bin/x86_64-w64-mingw32-ranlib.exe"
 	)
 endif()
-

build_files/build_environment/cmake/zlib_mingw.cmake

@@ -37,4 +37,3 @@ endif()
 if(MSVC)
 	set_target_properties(external_zlib_mingw PROPERTIES FOLDER Mingw)
 endif()
-

build_files/build_environment/install_deps.sh

@@ -25,7 +25,7 @@
 ARGS=$( \
 getopt \
 -o s:i:t:h \
---long source:,install:,tmp:,info:,threads:,help,show-deps,no-sudo,no-build,no-confirm,\
+--long source:,install:,tmp:,info:,threads:,help,show-deps,no-sudo,no-build,no-confirm,use-cxx11,\
 with-all,with-opencollada,with-jack,\
 ver-ocio:,ver-oiio:,ver-llvm:,ver-osl:,ver-osd:,ver-openvdb:,\
 force-all,force-python,force-numpy,force-boost,\
@@ -104,6 +104,11 @@ ARGUMENTS_INFO="\"COMMAND LINE ARGUMENTS:
     --no-confirm
         Disable any interaction with user (suitable for automated run).
 
+    --use-cxx11
+        Build all libraries in cpp11 'mode' (will be mandatory soon in blender2.8 branch).
+        NOTE: If your compiler is gcc-6.0 or above, you probably *want* to enable this option (since it's default
+              standard starting from this version).
+
     --with-all
         By default, a number of optional and not-so-often needed libraries are not installed.
         This option will try to install them, at the cost of potential conflicts (depending on
@@ -285,7 +290,7 @@ SUDO="sudo"
 
 NO_BUILD=false
 NO_CONFIRM=false
-USE_CXX11=true  # Mandatory in blender2.8
+USE_CXX11=false
 
 PYTHON_VERSION="3.6.2"
 PYTHON_VERSION_MIN="3.6"
@@ -496,6 +501,9 @@ while true; do
     --no-confirm)
       NO_CONFIRM=true; shift; continue
     ;;
+    --use-cxx11)
+      USE_CXX11=true; shift; continue
+    ;;
     --with-all)
       WITH_ALL=true; shift; continue
     ;;
@@ -796,7 +804,7 @@ FFMPEG_SOURCE=( "http://ffmpeg.org/releases/ffmpeg-$FFMPEG_VERSION.tar.bz2" )
 
 CXXFLAGS_BACK=$CXXFLAGS
 if [ "$USE_CXX11" = true ]; then
-  WARNING "C++11 is now mandatory for blender2.8, this *should* go smoothly with any very recent distribution.
+  WARNING "You are trying to use c++11, this *should* go smoothely with any very recent distribution
 However, if you are experiencing linking errors (also when building Blender itself), please try the following:
     * Re-run this script with '--build-all --force-all' options.
     * Ensure your gcc version is at the very least 4.8, if possible you should really rather use gcc-5.1 or above.
@@ -2677,10 +2685,10 @@ install_DEB() {
   install_packages_DEB $_packages
 
   PRINT""
-  LIBSNDFILE_DEV="libsndfile1-dev"
-  check_package_DEB $LIBSNDFILE_DEV
+  SNDFILE_DEV="libsndfile1-dev"
+  check_package_DEB $SNDFILE_DEV
   if [ $? -eq 0 ]; then
-    install_packages_DEB $LIBSNDFILE_DEV
+    install_packages_DEB $SNDFILE_DEV
   fi
 
   PRINT ""
@@ -3275,10 +3283,10 @@ install_RPM() {
   fi
 
   PRINT""
-  LIBSNDFILE_DEV="libsndfile-devel"
-  check_package_RPM $LIBSNDFILE_DEV
+  SNDFILE_DEV="libsndfile-devel"
+  check_package_RPM $SNDFILE_DEV
   if [ $? -eq 0 ]; then
-    install_packages_RPM $LIBSNDFILE_DEV
+    install_packages_RPM $SNDFILE_DEV
   fi
 
   if [ "$WITH_ALL" = true ]; then
@@ -3682,10 +3690,10 @@ install_ARCH() {
   install_packages_ARCH $_packages
 
   PRINT""
-  LIBSNDFILE_DEV="libsndfile"
-  check_package_ARCH $LIBSNDFILE_DEV
+  SNDFILE_DEV="libsndfile"
+  check_package_ARCH $SNDFILE_DEV
   if [ $? -eq 0 ]; then
-    install_packages_ARCH $LIBSNDFILE_DEV
+    install_packages_ARCH $SNDFILE_DEV
   fi
 
   PRINT ""

build_files/build_environment/patches/cmake/modules/SelectLibraryConfigurations.cmake

@@ -79,4 +79,3 @@ macro( select_library_configurations basename )
         ${basename}_LIBRARY_DEBUG
     )
 endmacro( select_library_configurations )
-

build_files/buildbot/config/blender_linux.cmake

@@ -21,8 +21,9 @@ else()
 	message(FATAL_ERROR "Unknown build environment")
 endif()
 
-# Default to only build Blender
+# Default to only build Blender, not the player
 set(WITH_BLENDER             ON  CACHE BOOL "" FORCE)
+set(WITH_PLAYER              OFF CACHE BOOL "" FORCE)
 
 # ######## Linux-specific build options ########
 # Options which are specific to Linux-only platforms
@@ -73,7 +74,7 @@ set(SNDFILE_LIBRARY          "/usr/lib${MULTILIB}/libsndfile.a;/usr/lib${MULTILI
 
 # OpenAL libraries
 set(OPENAL_ROOT_DIR           "/opt/lib/openal" CACHE STRING "" FORCE)
-set(OPENAL_INCLUDE_DIR        "${OPENAL_ROOT_DIR}/include/AL" CACHE STRING "" FORCE)
+set(OPENAL_INCLUDE_DIR        "${OPENAL_ROOT_DIR}/include" CACHE STRING "" FORCE)
 set(OPENAL_LIBRARY
 	${OPENAL_ROOT_DIR}/lib/libopenal.a
 	${OPENAL_ROOT_DIR}/lib/libcommon.a

build_files/buildbot/config/blender_linux_player.cmake

@@ -0,0 +1,12 @@
+# This is applied as an override on top of blender_linux.config
+# Disables all the areas which are not needed for the player.
+set(WITH_COMPOSITOR          OFF CACHE BOOL "" FORCE)
+set(WITH_CYCLES              OFF CACHE BOOL "" FORCE)
+set(WITH_FREESTYLE           OFF CACHE BOOL "" FORCE)
+set(WITH_GHOST_XDND          OFF CACHE BOOL "" FORCE)
+set(WITH_OPENCOLLADA         OFF CACHE BOOL "" FORCE)
+set(WITH_OPENSUBDIV          OFF CACHE BOOL "" FORCE)
+set(WITH_LIBMV               OFF CACHE BOOL "" FORCE)
+
+set(WITH_BLENDER             OFF CACHE BOOL "" FORCE)
+set(WITH_PLAYER              ON  CACHE BOOL "" FORCE)

build_files/buildbot/slave_compile.py

@@ -60,6 +60,7 @@ if 'cmake' in builder:
 
     # Config file to be used (relative to blender's sources root)
     cmake_config_file = "build_files/cmake/config/blender_full.cmake"
+    cmake_player_config_file = None
     cmake_cuda_config_file = None
 
     # Set build options.
@@ -77,7 +78,13 @@ if 'cmake' in builder:
         # cmake_extra_options.append('-DCUDA_NVCC_EXECUTABLE=/usr/local/cuda-hack/nvcc')
 
     elif builder.startswith('win'):
-        if builder.endswith('_vc2015'):
+        if builder.endswith('_vs2017'):
+            if builder.startswith('win64'):
+                cmake_options.extend(['-G', 'Visual Studio 15 2017 Win64'])
+            elif builder.startswith('win32'):
+                bits = 32
+                cmake_options.extend(['-G', 'Visual Studio 15 2017'])
+        elif builder.endswith('_vc2015'):
             if builder.startswith('win64'):
                 cmake_options.extend(['-G', 'Visual Studio 14 2015 Win64'])
             elif builder.startswith('win32'):
@@ -100,13 +107,14 @@ if 'cmake' in builder:
         elif glibc == 'glibc211':
             deb_name = "squeeze"
         cmake_config_file = "build_files/buildbot/config/blender_linux.cmake"
+        cmake_player_config_file = "build_files/buildbot/config/blender_linux_player.cmake"
         if builder.endswith('x86_64_cmake'):
             chroot_name = 'buildbot_' + deb_name + '_x86_64'
-            targets = ['blender']
+            targets = ['player', 'blender']
         elif builder.endswith('i686_cmake'):
             bits = 32
             chroot_name = 'buildbot_' + deb_name + '_i686'
-            targets = ['blender']
+            targets = ['player', 'blender']
         cmake_extra_options.extend(["-DCMAKE_C_COMPILER=/usr/bin/gcc-7",
                                     "-DCMAKE_CXX_COMPILER=/usr/bin/g++-7"])
 
@@ -157,7 +165,9 @@ if 'cmake' in builder:
         os.chdir(target_build_dir)
         # Tweaking CMake options to respect the target
         target_cmake_options = cmake_options[:]
-        if target == 'cuda':
+        if target == 'player':
+            target_cmake_options.append("-C" + os.path.join(blender_dir, cmake_player_config_file))
+        elif target == 'cuda':
             target_cmake_options += cuda_cmake_options
             target_chroot_prefix = cuda_chroot_prefix[:]
             target_name = 'cycles_kernel_cuda'

build_files/buildbot/slave_pack.py

@@ -126,6 +126,7 @@ if builder.find('cmake') != -1:
 
     elif builder.startswith('linux_'):
         blender = os.path.join(install_dir, 'blender')
+        blenderplayer = os.path.join(install_dir, 'blenderplayer')
 
         buildinfo_h = os.path.join(build_dir, "source", "creator", "buildinfo.h")
         blender_h = os.path.join(blender_dir, "source", "blender", "blenkernel", "BKE_blender_version.h")
@@ -148,7 +149,7 @@ if builder.find('cmake') != -1:
         # Strip all unused symbols from the binaries
         print("Stripping binaries...")
         chroot_prefix = ['schroot', '-c', chroot_name, '--']
-        subprocess.call(chroot_prefix + ['strip', '--strip-all', blender])
+        subprocess.call(chroot_prefix + ['strip', '--strip-all', blender, blenderplayer])
 
         print("Stripping python...")
         py_target = os.path.join(install_dir, blender_version)

build_files/cmake/Modules/FindGLEW.cmake

@@ -9,6 +9,7 @@
 #
 # also defined,
 #  GLEW_LIBRARY, where to find the Glew library.
+#  GLEW_MX_LIBRARY, where to find the GlewMX library.
 
 #=============================================================================
 # Copyright 2014 Blender Foundation.
@@ -49,6 +50,16 @@ FIND_LIBRARY(GLEW_LIBRARY
     lib64 lib
   )
 
+
+FIND_LIBRARY(GLEW_MX_LIBRARY
+  NAMES
+    GLEWmx
+  HINTS
+    ${_glew_SEARCH_DIRS}
+  PATH_SUFFIXES
+    lib64 lib
+  )
+
 # handle the QUIETLY and REQUIRED arguments and set GLEW_FOUND to TRUE if
 # all listed variables are TRUE
 INCLUDE(FindPackageHandleStandardArgs)
@@ -62,6 +73,7 @@ ENDIF(GLEW_FOUND)
 MARK_AS_ADVANCED(
   GLEW_INCLUDE_DIR
   GLEW_LIBRARY
+  GLEW_MX_LIBRARY
 )
 
 UNSET(_glew_SEARCH_DIRS)

build_files/cmake/Modules/FindLLVM.cmake

@@ -93,4 +93,3 @@ FIND_PACKAGE_HANDLE_STANDARD_ARGS(LLVM DEFAULT_MSG
 MARK_AS_ADVANCED(
   LLVM_LIBRARY
 )
-

build_files/cmake/Modules/FindSndFile.cmake

@@ -1,15 +1,15 @@
 # - Find SndFile library
 # Find the native SndFile includes and library
 # This module defines
-#  LIBSNDFILE_INCLUDE_DIRS, where to find sndfile.h, Set when
-#                        LIBSNDFILE_INCLUDE_DIR is found.
-#  LIBSNDFILE_LIBRARIES, libraries to link against to use SndFile.
-#  LIBSNDFILE_ROOT_DIR, The base directory to search for SndFile.
+#  SNDFILE_INCLUDE_DIRS, where to find sndfile.h, Set when
+#                        SNDFILE_INCLUDE_DIR is found.
+#  SNDFILE_LIBRARIES, libraries to link against to use SndFile.
+#  SNDFILE_ROOT_DIR, The base directory to search for SndFile.
 #                    This can also be an environment variable.
-#  LIBSNDFILE_FOUND, If false, do not try to use SndFile.
+#  SNDFILE_FOUND, If false, do not try to use SndFile.
 #
 # also defined, but not for general use are
-#  LIBSNDFILE_LIBRARY, where to find the SndFile library.
+#  SNDFILE_LIBRARY, where to find the SndFile library.
 
 #=============================================================================
 # Copyright 2011 Blender Foundation.
@@ -22,26 +22,26 @@
 # See the License for more information.
 #=============================================================================
 
-# If LIBSNDFILE_ROOT_DIR was defined in the environment, use it.
-IF(NOT LIBSNDFILE_ROOT_DIR AND NOT $ENV{LIBSNDFILE_ROOT_DIR} STREQUAL "")
-	SET(LIBSNDFILE_ROOT_DIR $ENV{LIBSNDFILE_ROOT_DIR})
+# If SNDFILE_ROOT_DIR was defined in the environment, use it.
+IF(NOT SNDFILE_ROOT_DIR AND NOT $ENV{SNDFILE_ROOT_DIR} STREQUAL "")
+  SET(SNDFILE_ROOT_DIR $ENV{SNDFILE_ROOT_DIR})
 ENDIF()
 
 SET(_sndfile_SEARCH_DIRS
-	${LIBSNDFILE_ROOT_DIR}
+  ${SNDFILE_ROOT_DIR}
   /usr/local
   /sw # Fink
   /opt/local # DarwinPorts
 )
 
-FIND_PATH(LIBSNDFILE_INCLUDE_DIR sndfile.h
+FIND_PATH(SNDFILE_INCLUDE_DIR sndfile.h
   HINTS
     ${_sndfile_SEARCH_DIRS}
   PATH_SUFFIXES
     include
 )
 
-FIND_LIBRARY(LIBSNDFILE_LIBRARY
+FIND_LIBRARY(SNDFILE_LIBRARY
   NAMES
     sndfile
   HINTS
@@ -50,18 +50,18 @@ FIND_LIBRARY(LIBSNDFILE_LIBRARY
     lib64 lib
   )
 
-# handle the QUIETLY and REQUIRED arguments and set LIBSNDFILE_FOUND to TRUE if 
+# handle the QUIETLY and REQUIRED arguments and set SNDFILE_FOUND to TRUE if
 # all listed variables are TRUE
 INCLUDE(FindPackageHandleStandardArgs)
 FIND_PACKAGE_HANDLE_STANDARD_ARGS(SndFile DEFAULT_MSG
-	LIBSNDFILE_LIBRARY LIBSNDFILE_INCLUDE_DIR)
+    SNDFILE_LIBRARY SNDFILE_INCLUDE_DIR)
 
-IF(LIBSNDFILE_FOUND)
-	SET(LIBSNDFILE_LIBRARIES ${LIBSNDFILE_LIBRARY})
-	SET(LIBSNDFILE_INCLUDE_DIRS ${LIBSNDFILE_INCLUDE_DIR})
-ENDIF(LIBSNDFILE_FOUND)
+IF(SNDFILE_FOUND)
+  SET(SNDFILE_LIBRARIES ${SNDFILE_LIBRARY})
+  SET(SNDFILE_INCLUDE_DIRS ${SNDFILE_INCLUDE_DIR})
+ENDIF(SNDFILE_FOUND)
 
 MARK_AS_ADVANCED(
-	LIBSNDFILE_INCLUDE_DIR
-	LIBSNDFILE_LIBRARY
+  SNDFILE_INCLUDE_DIR
+  SNDFILE_LIBRARY
 )

build_files/cmake/Modules/GTestTesting.cmake

@@ -32,7 +32,6 @@ macro(BLENDER_SRC_GTEST_EX NAME SRC EXTRA_LIBS DO_ADD_TEST)
 		                      ${EXTRA_LIBS}
 		                      ${PLATFORM_LINKLIBS}
 		                      bf_testing_main
-		                      bf_intern_eigen
 		                      bf_intern_guardedalloc
 		                      extern_gtest
 		                      extern_gmock

build_files/cmake/config/blender_full.cmake

@@ -16,6 +16,7 @@ set(WITH_CYCLES_OPENSUBDIV   ON  CACHE BOOL "" FORCE)
 set(WITH_FFTW3               ON  CACHE BOOL "" FORCE)
 set(WITH_LIBMV               ON  CACHE BOOL "" FORCE)
 set(WITH_LIBMV_SCHUR_SPECIALIZATIONS ON CACHE BOOL "" FORCE)
+set(WITH_GAMEENGINE          ON  CACHE BOOL "" FORCE)
 set(WITH_COMPOSITOR          ON  CACHE BOOL "" FORCE)
 set(WITH_FREESTYLE           ON  CACHE BOOL "" FORCE)
 set(WITH_GHOST_XDND          ON  CACHE BOOL "" FORCE)
@@ -23,6 +24,7 @@ set(WITH_IK_SOLVER           ON  CACHE BOOL "" FORCE)
 set(WITH_IK_ITASC            ON  CACHE BOOL "" FORCE)
 set(WITH_IMAGE_CINEON        ON  CACHE BOOL "" FORCE)
 set(WITH_IMAGE_DDS           ON  CACHE BOOL "" FORCE)
+set(WITH_IMAGE_FRAMESERVER   ON  CACHE BOOL "" FORCE)
 set(WITH_IMAGE_HDR           ON  CACHE BOOL "" FORCE)
 set(WITH_IMAGE_OPENEXR       ON  CACHE BOOL "" FORCE)
 set(WITH_IMAGE_OPENJPEG      ON  CACHE BOOL "" FORCE)
@@ -49,6 +51,7 @@ set(WITH_SDL                 ON  CACHE BOOL "" FORCE)
 set(WITH_X11_XINPUT          ON  CACHE BOOL "" FORCE)
 set(WITH_X11_XF86VMODE       ON  CACHE BOOL "" FORCE)
 
+set(WITH_PLAYER              ON  CACHE BOOL "" FORCE)
 set(WITH_MEM_JEMALLOC        ON  CACHE BOOL "" FORCE)
 
 

build_files/cmake/config/blender_headless.cmake

@@ -6,6 +6,7 @@
 #
 
 set(WITH_HEADLESS            ON  CACHE BOOL "" FORCE)
+set(WITH_GAMEENGINE          OFF CACHE BOOL "" FORCE)
 
 # disable audio, its possible some devs may want this but for now disable
 # so the python module doesnt hold the audio device and loads quickly.

build_files/cmake/config/blender_lite.cmake

@@ -21,6 +21,7 @@ set(WITH_CYCLES_OPENSUBDIV   OFF CACHE BOOL "" FORCE)
 set(WITH_FFTW3               OFF CACHE BOOL "" FORCE)
 set(WITH_LIBMV               OFF CACHE BOOL "" FORCE)
 set(WITH_LLVM                OFF CACHE BOOL "" FORCE)
+set(WITH_GAMEENGINE          OFF CACHE BOOL "" FORCE)
 set(WITH_COMPOSITOR          OFF CACHE BOOL "" FORCE)
 set(WITH_FREESTYLE           OFF CACHE BOOL "" FORCE)
 set(WITH_GHOST_XDND          OFF CACHE BOOL "" FORCE)
@@ -28,6 +29,7 @@ set(WITH_IK_SOLVER           OFF CACHE BOOL "" FORCE)
 set(WITH_IK_ITASC            OFF CACHE BOOL "" FORCE)
 set(WITH_IMAGE_CINEON        OFF CACHE BOOL "" FORCE)
 set(WITH_IMAGE_DDS           OFF CACHE BOOL "" FORCE)
+set(WITH_IMAGE_FRAMESERVER   OFF CACHE BOOL "" FORCE)
 set(WITH_IMAGE_HDR           OFF CACHE BOOL "" FORCE)
 set(WITH_IMAGE_OPENEXR       OFF CACHE BOOL "" FORCE)
 set(WITH_IMAGE_OPENJPEG      OFF CACHE BOOL "" FORCE)

build_files/cmake/config/blender_release.cmake

@@ -16,6 +16,7 @@ set(WITH_CYCLES_OPENSUBDIV   ON  CACHE BOOL "" FORCE)
 set(WITH_FFTW3               ON  CACHE BOOL "" FORCE)
 set(WITH_LIBMV               ON  CACHE BOOL "" FORCE)
 set(WITH_LIBMV_SCHUR_SPECIALIZATIONS ON CACHE BOOL "" FORCE)
+set(WITH_GAMEENGINE          ON  CACHE BOOL "" FORCE)
 set(WITH_COMPOSITOR          ON  CACHE BOOL "" FORCE)
 set(WITH_FREESTYLE           ON  CACHE BOOL "" FORCE)
 set(WITH_GHOST_XDND          ON  CACHE BOOL "" FORCE)
@@ -23,6 +24,7 @@ set(WITH_IK_SOLVER           ON  CACHE BOOL "" FORCE)
 set(WITH_IK_ITASC            ON  CACHE BOOL "" FORCE)
 set(WITH_IMAGE_CINEON        ON  CACHE BOOL "" FORCE)
 set(WITH_IMAGE_DDS           ON  CACHE BOOL "" FORCE)
+set(WITH_IMAGE_FRAMESERVER   ON  CACHE BOOL "" FORCE)
 set(WITH_IMAGE_HDR           ON  CACHE BOOL "" FORCE)
 set(WITH_IMAGE_OPENEXR       ON  CACHE BOOL "" FORCE)
 set(WITH_IMAGE_OPENJPEG      ON  CACHE BOOL "" FORCE)
@@ -49,6 +51,7 @@ set(WITH_SDL                 ON  CACHE BOOL "" FORCE)
 set(WITH_X11_XINPUT          ON  CACHE BOOL "" FORCE)
 set(WITH_X11_XF86VMODE       ON  CACHE BOOL "" FORCE)
 
+set(WITH_PLAYER              ON  CACHE BOOL "" FORCE)
 set(WITH_MEM_JEMALLOC        ON  CACHE BOOL "" FORCE)
 set(WITH_CYCLES_CUDA_BINARIES ON  CACHE BOOL "" FORCE)
 set(CYCLES_CUDA_BINARIES_ARCH sm_30;sm_35;sm_37;sm_50;sm_52;sm_60;sm_61 CACHE STRING "" FORCE)

build_files/cmake/config/bpy_module.cmake

@@ -12,6 +12,9 @@ set(WITH_INSTALL_PORTABLE    OFF CACHE BOOL "" FORCE)
 # no point int copying python into python
 set(WITH_PYTHON_INSTALL      OFF CACHE BOOL "" FORCE)
 
+# dont build the game engine
+set(WITH_GAMEENGINE          OFF CACHE BOOL "" FORCE)
+
 # disable audio, its possible some devs may want this but for now disable
 # so the python module doesnt hold the audio device and loads quickly.
 set(WITH_AUDASPACE           OFF CACHE BOOL "" FORCE)

build_files/cmake/config/cycles_standalone.cmake

@@ -6,6 +6,7 @@
 
 # disable Blender
 set(WITH_BLENDER             OFF  CACHE BOOL "" FORCE)
+set(WITH_PLAYER              OFF  CACHE BOOL "" FORCE)
 set(WITH_CYCLES_BLENDER      OFF  CACHE BOOL "" FORCE)
 
 # build Cycles

build_files/cmake/macros.cmake

@@ -326,7 +326,7 @@ function(SETUP_LIBDIRS)
 			link_directories(${JACK_LIBPATH})
 		endif()
 		if(WITH_CODEC_SNDFILE)
-			link_directories(${LIBSNDFILE_LIBPATH})
+			link_directories(${SNDFILE_LIBPATH})
 		endif()
 		if(WITH_FFTW3)
 			link_directories(${FFTW3_LIBPATH})
@@ -412,7 +412,7 @@ function(setup_liblinks
 		target_link_libraries(${target} ${JACK_LIBRARIES})
 	endif()
 	if(WITH_CODEC_SNDFILE)
-		target_link_libraries(${target} ${LIBSNDFILE_LIBRARIES})
+		target_link_libraries(${target} ${SNDFILE_LIBRARIES})
 	endif()
 	if(WITH_SDL AND NOT WITH_SDL_DYNLOAD)
 		target_link_libraries(${target} ${SDL_LIBRARY})
@@ -560,12 +560,6 @@ function(SETUP_BLENDER_SORTED_LIBS)
 		endif()
 	endif()
 
-	if(WITH_AUDASPACE AND NOT WITH_SYSTEM_AUDASPACE)
-		list(APPEND BLENDER_LINK_LIBS
-			audaspace
-			audaspace-py)
-	endif()
-
 	# Sort libraries
 	set(BLENDER_SORTED_LIBS
 		bf_windowmanager
@@ -586,10 +580,8 @@ function(SETUP_BLENDER_SORTED_LIBS)
 		bf_editor_space_outliner
 		bf_editor_space_script
 		bf_editor_space_sequencer
-		bf_editor_space_statusbar
 		bf_editor_space_text
 		bf_editor_space_time
-		bf_editor_space_topbar
 		bf_editor_space_userpref
 		bf_editor_space_view3d
 		bf_editor_space_clip
@@ -600,7 +592,6 @@ function(SETUP_BLENDER_SORTED_LIBS)
 		bf_editor_curve
 		bf_editor_gpencil
 		bf_editor_interface
-		bf_editor_manipulator_library
 		bf_editor_mesh
 		bf_editor_metaball
 		bf_editor_object
@@ -608,7 +599,6 @@ function(SETUP_BLENDER_SORTED_LIBS)
 		bf_editor_armature
 		bf_editor_physics
 		bf_editor_render
-		bf_editor_scene
 		bf_editor_screen
 		bf_editor_sculpt_paint
 		bf_editor_sound
@@ -621,7 +611,6 @@ function(SETUP_BLENDER_SORTED_LIBS)
 		bf_python
 		bf_python_ext
 		bf_python_mathutils
-		bf_python_gawain
 		bf_python_bmesh
 		bf_freestyle
 		bf_ikplugin
@@ -629,14 +618,11 @@ function(SETUP_BLENDER_SORTED_LIBS)
 		bf_alembic
 		bf_bmesh
 		bf_gpu
-		bf_draw
 		bf_blenloader
 		bf_blenkernel
 		bf_physics
 		bf_nodes
 		bf_rna
-		bf_editor_manipulator_library  # rna -> manipulator bad-level calls
-		bf_python
 		bf_imbuf
 		bf_blenlib
 		bf_depsgraph
@@ -677,8 +663,6 @@ function(SETUP_BLENDER_SORTED_LIBS)
 		bf_blenfont
 		bf_blentranslation
 		bf_intern_audaspace
-		audaspace
-		audaspace-py
 		bf_intern_mikktspace
 		bf_intern_dualcon
 		bf_intern_cycles
@@ -690,7 +674,6 @@ function(SETUP_BLENDER_SORTED_LIBS)
 		cycles_util
 		cycles_subd
 		bf_intern_opencolorio
-		bf_intern_gawain
 		bf_intern_eigen
 		extern_rangetree
 		extern_wcwidth
@@ -767,6 +750,10 @@ function(SETUP_BLENDER_SORTED_LIBS)
 		list_insert_after(BLENDER_SORTED_LIBS "ge_logic_ngnetwork" "extern_bullet")
 	endif()
 
+	if(WITH_GAMEENGINE_DECKLINK)
+		list(APPEND BLENDER_SORTED_LIBS bf_intern_decklink)
+	endif()
+
 	if(WIN32)
 		list(APPEND BLENDER_SORTED_LIBS bf_intern_gpudirect)
 	endif()
@@ -1054,13 +1041,19 @@ macro(remove_cc_flag
 
 endmacro()
 
-macro(add_cc_flag
+macro(add_c_flag
 	flag)
 
 	set(CMAKE_C_FLAGS "${CMAKE_C_FLAGS} ${flag}")
 	set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} ${flag}")
 endmacro()
 
+macro(add_cxx_flag
+	flag)
+
+	set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} ${flag}")
+endmacro()
+
 macro(remove_strict_flags)
 
 	if(CMAKE_COMPILER_IS_GNUCC)
@@ -1083,7 +1076,8 @@ macro(remove_strict_flags)
 		)
 
 		# negate flags implied by '-Wall'
-		add_cc_flag("${CC_REMOVE_STRICT_FLAGS}")
+		add_c_flag("${C_REMOVE_STRICT_FLAGS}")
+		add_cxx_flag("${CXX_REMOVE_STRICT_FLAGS}")
 	endif()
 
 	if(CMAKE_C_COMPILER_ID MATCHES "Clang")
@@ -1095,7 +1089,8 @@ macro(remove_strict_flags)
 		)
 
 		# negate flags implied by '-Wall'
-		add_cc_flag("${CC_REMOVE_STRICT_FLAGS}")
+		add_c_flag("${C_REMOVE_STRICT_FLAGS}")
+		add_cxx_flag("${CXX_REMOVE_STRICT_FLAGS}")
 	endif()
 
 	if(MSVC)
@@ -1125,28 +1120,39 @@ endmacro()
 # note, we can only append flags on a single file so we need to negate the options.
 # at the moment we cant shut up ffmpeg deprecations, so use this, but will
 # probably add more removals here.
-macro(remove_strict_flags_file
+macro(remove_strict_c_flags_file
 	filenames)
-
 	foreach(_SOURCE ${ARGV})
-
 		if(CMAKE_COMPILER_IS_GNUCC OR
 		   (CMAKE_C_COMPILER_ID MATCHES "Clang"))
-
 			set_source_files_properties(${_SOURCE}
 				PROPERTIES
-					COMPILE_FLAGS "${CC_REMOVE_STRICT_FLAGS}"
+					COMPILE_FLAGS "${C_REMOVE_STRICT_FLAGS}"
 			)
 		endif()
-
 		if(MSVC)
 			# TODO
 		endif()
-
 	endforeach()
-
 	unset(_SOURCE)
+endmacro()
 
+macro(remove_strict_cxx_flags_file
+	filenames)
+	remove_strict_c_flags_file(${filenames} ${ARHV})
+	foreach(_SOURCE ${ARGV})
+		if(CMAKE_COMPILER_IS_GNUCC OR
+		   (CMAKE_CXX_COMPILER_ID MATCHES "Clang"))
+			set_source_files_properties(${_SOURCE}
+				PROPERTIES
+					COMPILE_FLAGS "${CXX_REMOVE_STRICT_FLAGS}"
+			)
+		endif()
+		if(MSVC)
+			# TODO
+		endif()
+	endforeach()
+	unset(_SOURCE)
 endmacro()
 
 # External libs may need 'signed char' to be default.
@@ -1528,7 +1534,6 @@ function(find_python_package
 		  NAMES
 		    ${package}
 		  HINTS
-		    "${PYTHON_LIBPATH}/"
 		    "${PYTHON_LIBPATH}/python${PYTHON_VERSION}/"
 		    "${PYTHON_LIBPATH}/python${_PY_VER_MAJOR}/"
 		  PATH_SUFFIXES

build_files/cmake/platform/platform_apple.cmake

@@ -23,8 +23,6 @@
 
 # Libraries configuration for Apple.
 
-set(MACOSX_DEPLOYMENT_TARGET "10.9")
-
 macro(find_package_wrapper)
 # do nothing, just satisfy the macro
 endmacro()
@@ -45,7 +43,7 @@ if(WITH_OPENAL)
 	find_package(OpenAL)
 	if(OPENAL_FOUND)
 		set(WITH_OPENAL ON)
-		set(OPENAL_INCLUDE_DIR "${LIBDIR}/openal/include/AL")
+		set(OPENAL_INCLUDE_DIR "${LIBDIR}/openal/include")
 	else()
 		set(WITH_OPENAL OFF)
 	endif()
@@ -81,10 +79,10 @@ if(WITH_JACK)
 endif()
 
 if(WITH_CODEC_SNDFILE)
-	set(LIBSNDFILE ${LIBDIR}/sndfile)
-	set(LIBSNDFILE_INCLUDE_DIRS ${LIBSNDFILE}/include)
-	set(LIBSNDFILE_LIBRARIES sndfile FLAC ogg vorbis vorbisenc)
-	set(LIBSNDFILE_LIBPATH ${LIBSNDFILE}/lib ${LIBDIR}/ffmpeg/lib)  # TODO, deprecate
+	set(SNDFILE ${LIBDIR}/sndfile)
+	set(SNDFILE_INCLUDE_DIRS ${SNDFILE}/include)
+	set(SNDFILE_LIBRARIES sndfile FLAC ogg vorbis vorbisenc)
+	set(SNDFILE_LIBPATH ${SNDFILE}/lib ${LIBDIR}/ffmpeg/lib)  # TODO, deprecate
 endif()
 
 if(WITH_PYTHON)

build_files/cmake/platform/platform_unix.cmake

@@ -148,7 +148,7 @@ endif()
 # Codecs
 if(WITH_CODEC_SNDFILE)
 	find_package_wrapper(SndFile)
-	if(NOT LIBSNDFILE_FOUND)
+	if(NOT SNDFILE_FOUND)
 		set(WITH_CODEC_SNDFILE OFF)
 	endif()
 endif()

build_files/cmake/platform/platform_win32.cmake

@@ -551,7 +551,7 @@ set(WINTAB_INC ${LIBDIR}/wintab/include)
 if(WITH_OPENAL)
 	set(OPENAL ${LIBDIR}/openal)
 	set(OPENALDIR ${LIBDIR}/openal)
-	set(OPENAL_INCLUDE_DIR ${OPENAL}/include/AL)
+	set(OPENAL_INCLUDE_DIR ${OPENAL}/include)
 	set(OPENAL_LIBPATH ${OPENAL}/lib)
 	if(MSVC)
 		set(OPENAL_LIBRARY ${OPENAL_LIBPATH}/openal32.lib)
@@ -562,10 +562,11 @@ if(WITH_OPENAL)
 endif()
 
 if(WITH_CODEC_SNDFILE)
-	set(LIBSNDFILE ${LIBDIR}/sndfile)
-	set(LIBSNDFILE_INCLUDE_DIRS ${LIBSNDFILE}/include)
-	set(LIBSNDFILE_LIBPATH ${LIBSNDFILE}/lib) # TODO, deprecate
-	set(LIBSNDFILE_LIBRARIES ${LIBSNDFILE_LIBPATH}/libsndfile-1.lib)
+	set(SNDFILE ${LIBDIR}/sndfile)
+	set(SNDFILE_INCLUDE_DIRS ${SNDFILE}/include)
+	set(SNDFILE_LIBPATH ${SNDFILE}/lib) # TODO, deprecate
+	set(SNDFILE_LIBRARIES ${SNDFILE_LIBPATH}/libsndfile-1.lib)
+
 endif()
 
 if(WITH_RAYOPTIMIZATION AND SUPPORT_SSE_BUILD)

build_files/windows/autodetect_msvc.cmd

@@ -1,14 +1,11 @@
 echo No explicit msvc version requested, autodetecting version.
 
-call "%~dp0\detect_msvc2013.cmd"
+call "%~dp0\detect_msvc2017.cmd"
 if %ERRORLEVEL% EQU 0 goto DetectionComplete
 
 call "%~dp0\detect_msvc2015.cmd"
 if %ERRORLEVEL% EQU 0 goto DetectionComplete
 
-call "%~dp0\detect_msvc2017.cmd"
-if %ERRORLEVEL% EQU 0 goto DetectionComplete
-
 echo Compiler Detection failed. Use verbose switch for more information. 
 exit /b 1
 

build_files/windows/check_libraries.cmd

@@ -1,4 +1,3 @@
-if "%BUILD_VS_YEAR%"=="2013" set BUILD_VS_LIBDIRPOST=vc12
 if "%BUILD_VS_YEAR%"=="2015" set BUILD_VS_LIBDIRPOST=vc14
 if "%BUILD_VS_YEAR%"=="2017" set BUILD_VS_LIBDIRPOST=vc14
 

build_files/windows/detect_msvc2013.cmd

@@ -1,3 +0,0 @@
-set BUILD_VS_VER=12
-set BUILD_VS_YEAR=2013
-call "%~dp0\detect_msvc_classic.cmd"

build_files/windows/detect_msvc2017.cmd

@@ -2,6 +2,7 @@ if NOT "%verbose%" == "" (
 	echo Detecting msvc 2017
 )
 set BUILD_VS_VER=15
+set BUILD_VS_YEAR=2017
 set ProgramFilesX86=%ProgramFiles(x86)%
 if not exist "%ProgramFilesX86%" set ProgramFilesX86=%ProgramFiles%
 

build_files/windows/parse_arguments.cmd

@@ -59,8 +59,6 @@ if NOT "%1" == "" (
 		set VSWHERE_ARGS=-products Microsoft.VisualStudio.Product.BuildTools
 	) else if "%1" == "2015" (
 		set BUILD_VS_YEAR=2015
-	) else if "%1" == "2013" (
-		set BUILD_VS_YEAR=2013
 	) else if "%1" == "packagename" (
 		set BUILD_CMAKE_ARGS=%BUILD_CMAKE_ARGS% -DCPACK_OVERRIDE_PACKAGENAME="%2"
 		shift /1

build_files/windows/show_hashes.cmd

@@ -3,10 +3,10 @@ if "%GIT%" == "" (
 	goto EOF
 )
 cd "%BLENDER_DIR%"
-for /f "delims=" %%i in ('%GIT% rev-parse HEAD') do echo Branch_hash=%%i
+for /f "delims=" %%i in ('"%GIT%" rev-parse HEAD') do echo Branch_hash=%%i
 cd "%BLENDER_DIR%/release/datafiles/locale"
-for /f "delims=" %%i in ('%GIT% rev-parse HEAD') do echo Locale_hash=%%i
+for /f "delims=" %%i in ('"%GIT%" rev-parse HEAD') do echo Locale_hash=%%i
 cd "%BLENDER_DIR%/release/scripts/addons"
-for /f "delims=" %%i in ('%GIT% rev-parse HEAD') do echo Addons_Hash=%%i
+for /f "delims=" %%i in ('"%GIT%" rev-parse HEAD') do echo Addons_Hash=%%i
 cd "%BLENDER_DIR%"
 :EOF

build_files/windows/show_help.cmd

@@ -22,13 +22,13 @@ echo - packagename [newname] ^(override default cpack package name^)
 echo - buildir [newdir] ^(override default build folder^)
 echo - x86 ^(override host auto-detect and build 32 bit code^)
 echo - x64 ^(override host auto-detect and build 64 bit code^)
-echo - 2013 ^(build with visual studio 2013^)
-echo.
-echo Experimental options
-echo - 2015 ^(build with visual studio 2015^)
 echo - 2017 ^(build with visual studio 2017^)
 echo - 2017pre ^(build with visual studio 2017 pre-release^)
 echo - 2017b ^(build with visual studio 2017 Build Tools^)
+
+echo.
+echo Experimental options
+echo - 2015 ^(build with visual studio 2015^)
 echo - clang ^(enable building with clang^)
 echo - asan ^(enable asan when building with clang^)
 echo - ninja ^(enable building with ninja instead of msbuild^)

doc/blender_file_format/BlendFileReader.py

@@ -34,6 +34,7 @@ log = logging.getLogger("BlendFileReader")
 # module global routines
 ######################################################
 
+
 def ReadString(handle, length):
     '''
     ReadString reads a String of given length or a zero terminating String
@@ -338,7 +339,7 @@ class DNAName:
         return result
 
     def ShortName(self):
-        result = self.Name;
+        result = self.Name
         result = result.replace("*", "")
         result = result.replace("(", "")
         result = result.replace(")", "")
@@ -398,7 +399,7 @@ class DNAStructure:
         splitted = path.partition(".")
         name = splitted[0]
         rest = splitted[2]
-        offset = 0;
+        offset = 0
         for field in self.Fields:
             if field.Name.ShortName() == name:
                 log.debug("found " + name + "@" + str(offset))
@@ -443,4 +444,3 @@ class DNAField:
                 return ReadString(handle, self.Name.ArraySize())
         else:
             return self.Type.Structure.GetField(header, handle, path)
-

doc/doxygen/doxygen.source.h

@@ -36,6 +36,62 @@
 
 /* ================================ */
 
+/** \defgroup bge Game Engine */
+/** \defgroup gamelogic Game Logic
+ *  \ingroup bge
+ */
+/** \defgroup bgeconv Converter
+ *  \ingroup bge
+ */
+/** \defgroup blroutines Blender Routines
+ *  \ingroup bge
+ */
+/** \defgroup expressions Expressions
+ *  \ingroup bge
+ */
+/** \defgroup player Game Player
+ *  \ingroup bge
+ */
+/** \defgroup ketsji Ketsji
+ *  \ingroup bge
+ *  \todo check all headers and code files for proper licenses
+ */
+/** \defgroup ketsjinet Ketsji Network
+ *  \ingroup ketsji
+ */
+/** \defgroup bgenet Network
+ *  \ingroup bge
+ */
+/** \defgroup bgenetlb Loopback Network
+ *  \ingroup bgenet
+ */
+/** \defgroup phys Physics
+ *  \ingroup bge
+ */
+/** \defgroup physbullet Bullet Physics
+ *  \ingroup phys
+ */
+/** \defgroup physdummy Dummy Physics (none)
+ *  \ingroup phys
+ */
+/** \defgroup bgerast Rasterizer
+ *  \ingroup bge
+ */
+/** \defgroup bgerastoglfilters OpenGL Filters
+ *  \ingroup bgerast
+ */
+/** \defgroup bgerastogl OpenGL Rasterizer
+ *  \ingroup bgerast
+ */
+/** \defgroup bgesg BGE SceneGraph
+ *  \ingroup bge
+ */
+/** \defgroup bgevideotex BGE Video Texture
+ *  \ingroup bge
+ */
+
+/* ================================ */
+
 /** \defgroup blender Blender */
 
 /** \defgroup blt BlenTranslation
@@ -168,10 +224,6 @@
  *  \ingroup editors
  */
 
-/** \defgroup edscene scene
- *  \ingroup editors
- */
-
 /** \defgroup edsculpt sculpt and paint
  *  \ingroup editors
  */
@@ -212,6 +264,10 @@
  *  \ingroup editors
  */
 
+/** \defgroup splogic game logic editor
+ *  \ingroup editors
+ */
+
 /** \defgroup spnla NLA editor
  *  \ingroup editors
  */

doc/manpage/blender.1.py

@@ -42,6 +42,7 @@ def man_format(data):
     data = data.replace("\t", "  ")
     return data
 
+
 if len(sys.argv) != 3:
     import getopt
     raise getopt.GetoptError("Usage: %s <path-to-blender> <output-filename>" % sys.argv[0])

doc/python_api/examples/bge.constraints.py

@@ -0,0 +1,37 @@
+"""
+Basic Physics Constraint
+++++++++++++++++++++++++
+Example of how to create a hinge Physics Constraint between two objects.
+"""
+from bge import logic
+from bge import constraints
+
+# get object list
+objects = logic.getCurrentScene().objects
+
+# get object named Object1 and Object 2
+object_1 = objects["Object1"]
+object_2 = objects["Object2"]
+
+# want to use Edge constraint type
+constraint_type = 2
+
+# get Object1 and Object2 physics IDs
+physics_id_1 = object_1.getPhysicsId()
+physics_id_2 = object_2.getPhysicsId()
+
+# use bottom right edge of Object1 for hinge position
+edge_position_x = 1.0
+edge_position_y = 0.0
+edge_position_z = -1.0
+
+# rotate the pivot z axis about 90 degrees
+edge_angle_x = 0.0
+edge_angle_y = 0.0
+edge_angle_z = 90.0
+
+# create an edge constraint
+constraints.createConstraint(physics_id_1, physics_id_2,
+                             constraint_type,
+                             edge_position_x, edge_position_y, edge_position_z,
+                             edge_angle_x, edge_angle_y, edge_angle_z)

doc/python_api/examples/bge.texture.1.py

@@ -0,0 +1,40 @@
+"""
+Texture Replacement
++++++++++++++++++++
+
+Example of how to replace a texture in game with an external image.
+``createTexture()`` and ``removeTexture()`` are to be called from a
+module Python Controller.
+"""
+from bge import logic
+from bge import texture
+
+
+def createTexture(cont):
+    """Create a new Dynamic Texture"""
+    obj = cont.owner
+
+    # get the reference pointer (ID) of the internal texture
+    ID = texture.materialID(obj, 'IMoriginal.png')
+
+    # create a texture object
+    object_texture = texture.Texture(obj, ID)
+
+    # create a new source with an external image
+    url = logic.expandPath("//newtexture.jpg")
+    new_source = texture.ImageFFmpeg(url)
+
+    # the texture has to be stored in a permanent Python object
+    logic.texture = object_texture
+
+    # update/replace the texture
+    logic.texture.source = new_source
+    logic.texture.refresh(False)
+
+
+def removeTexture(cont):
+    """Delete the Dynamic Texture, reversing back the final to its original state."""
+    try:
+        del logic.texture
+    except:
+        pass

doc/python_api/examples/bge.texture.2.py

@@ -0,0 +1,239 @@
+"""
+Video Capture with DeckLink
++++++++++++++++++++++++++++
+Video frames captured with DeckLink cards have pixel formats that are generally not directly
+usable by OpenGL, they must be processed by a shader. The three shaders presented here should
+cover all common video capture cases.
+
+This file reflects the current video transfer method implemented in the Decklink module:
+whenever possible the video images are transferred as float texture because this is more
+compatible with GPUs. Of course, only the pixel formats that have a correspondant GL format
+can be transferred as float. Look for fg_shaders in this file for an exhaustive list.
+
+Other pixel formats will be transferred as 32 bits integer red-channel texture but this
+won't work with certain GPU (Intel GMA); the corresponding shaders are not shown here.
+However, it should not be necessary to use any of them as the list below covers all practical
+cases of video capture with all types of Decklink product.
+
+In other words, only use one of the pixel format below and you will be fine. Note that depending
+on the video stream, only certain pixel formats will be allowed (others will throw an exception).
+For example, to capture a PAL video stream, you must use one of the YUV formats.
+
+To find which pixel format is suitable for a particular video stream, use the 'Media Express'
+utility that comes with the Decklink software : if you see the video in the 'Log and Capture'
+Window, you have selected the right pixel format and you can use the same in Blender.
+
+Notes: * these shaders only decode the RGB channel and set the alpha channel to a fixed
+value (look for color.a = ). It's up to you to add postprocessing to the color.
+       * these shaders are compatible with 2D and 3D video stream
+"""
+import bge
+from bge import logic
+from bge import texture as vt
+
+# The default vertex shader, because we need one
+#
+VertexShader = """
+#version 130
+   void main()
+   {
+      gl_Position = gl_ModelViewProjectionMatrix * gl_Vertex;
+      gl_TexCoord[0] = gl_MultiTexCoord0;
+   }
+
+"""
+
+# For use with RGB video stream: the pixel is directly usable
+#
+FragmentShader_R10l = """
+    #version 130
+    uniform sampler2D tex;
+    // stereo = 1.0 if 2D image, =0.5 if 3D (left eye below, right eye above)
+    uniform float stereo;
+    // eye = 0.0 for the left eye, 0.5 for the right eye
+    uniform float eye;
+
+    void main(void)
+    {
+        vec4 color;
+        float tx, ty;
+        tx = gl_TexCoord[0].x;
+        ty = eye+gl_TexCoord[0].y*stereo;
+        color = texture(tex, vec2(tx,ty));
+        color.a = 0.7;
+        gl_FragColor = color;
+    }
+"""
+
+# For use with YUV video stream
+#
+FragmentShader_2vuy = """
+    #version 130
+    uniform sampler2D tex;
+    // stereo = 1.0 if 2D image, =0.5 if 3D (left eye below, right eye above)
+    uniform float stereo;
+    // eye = 0.0 for the left eye, 0.5 for the right eye
+    uniform float eye;
+
+    void main(void)
+    {
+        vec4 color;
+        float tx, ty, width, Y, Cb, Cr;
+        int px;
+        tx = gl_TexCoord[0].x;
+        ty = eye+gl_TexCoord[0].y*stereo;
+        width = float(textureSize(tex, 0).x);
+        color = texture(tex, vec2(tx, ty));
+        px = int(floor(fract(tx*width)*2.0));
+        switch (px) {
+        case 0:
+            Y = color.g;
+            break;
+        case 1:
+            Y = color.a;
+            break;
+        }
+        Y = (Y - 0.0625) * 1.168949772;
+        Cb = (color.b - 0.0625) * 1.142857143 - 0.5;
+        Cr = (color.r - 0.0625) * 1.142857143 - 0.5;
+        color.r = Y + 1.5748 * Cr;
+        color.g = Y - 0.1873 * Cb - 0.4681 * Cr;
+        color.b = Y + 1.8556 * Cb;
+        color.a = 0.7;
+        gl_FragColor = color;
+    }
+"""
+
+# For use with high resolution YUV
+#
+FragmentShader_v210 = """
+    #version 130
+    uniform sampler2D tex;
+    // stereo = 1.0 if 2D image, =0.5 if 3D (left eye below, right eye above)
+    uniform float stereo;
+    // eye = 0.0 for the left eye, 0.5 for the right eye
+    uniform float eye;
+
+    void main(void)
+    {
+        vec4 color, color1, color2, color3;
+        int px;
+        float tx, ty, width, sx, dx, bx, Y, Cb, Cr;
+        tx = gl_TexCoord[0].x;
+        ty = eye+gl_TexCoord[0].y*stereo;
+        width = float(textureSize(tex, 0).x);
+        // to sample macro pixels (6 pixels in 4 words)
+        sx = tx*width*0.25+0.01;
+        // index of display pixel in the macro pixel 0..5
+        px = int(floor(fract(sx)*6.0));
+        // increment as we sample the macro pixel
+        dx = 1.0/width;
+        // base x coord of macro pixel
+        bx = (floor(sx)+0.01)*dx*4.0;
+        color = texture(tex, vec2(bx, ty));
+        color1 = texture(tex, vec2(bx+dx, ty));
+        color2 = texture(tex, vec2(bx+dx*2.0, ty));
+        color3 = texture(tex, vec2(bx+dx*3.0, ty));
+        switch (px) {
+        case 0:
+        case 1:
+            Cb = color.b;
+            Cr = color.r;
+            break;
+        case 2:
+        case 3:
+            Cb = color1.g;
+            Cr = color2.b;
+            break;
+        default:
+            Cb = color2.r;
+            Cr = color3.g;
+            break;
+        }
+        switch (px) {
+        case 0:
+            Y = color.g;
+            break;
+        case 1:
+            Y = color1.b;
+            break;
+        case 2:
+            Y = color1.r;
+            break;
+        case 3:
+            Y = color2.g;
+            break;
+        case 4:
+            Y = color3.b;
+            break;
+        default:
+            Y = color3.r;
+            break;
+        }
+        Y = (Y - 0.0625) * 1.168949772;
+        Cb = (Cb - 0.0625) * 1.142857143 - 0.5;
+        Cr = (Cr - 0.0625) * 1.142857143 - 0.5;
+        color.r = Y + 1.5748 * Cr;
+        color.g = Y - 0.1873 * Cb - 0.4681 * Cr;
+        color.b = Y + 1.8556 * Cb;
+        color.a = 0.7;
+        gl_FragColor = color;
+    }
+"""
+
+# The exhausitve list of pixel formats that are transferred as float texture
+# Only use those for greater efficiency and compatiblity.
+#
+fg_shaders = {
+    '2vuy': FragmentShader_2vuy,
+    '8BitYUV': FragmentShader_2vuy,
+    'v210': FragmentShader_v210,
+    '10BitYUV': FragmentShader_v210,
+    '8BitBGRA': FragmentShader_R10l,
+    'BGRA': FragmentShader_R10l,
+    '8BitARGB': FragmentShader_R10l,
+    '10BitRGBXLE': FragmentShader_R10l,
+    'R10l': FragmentShader_R10l
+}
+
+
+#
+# Helper function to attach a pixel shader to the material that receives the video frame.
+#
+
+def config_video(obj, format, pixel, is3D=False, mat=0, card=0):
+    if pixel not in fg_shaders:
+        raise('Unsuported shader')
+    shader = obj.meshes[0].materials[mat].getShader()
+    if shader is not None and not shader.isValid():
+        shader.setSource(VertexShader, fg_shaders[pixel], True)
+        shader.setSampler('tex', 0)
+        shader.setUniformEyef("eye")
+        shader.setUniform1f("stereo", 0.5 if is3D else 1.0)
+    tex = vt.Texture(obj, mat)
+    tex.source = vt.VideoDeckLink(format + "/" + pixel + ("/3D" if is3D else ""), card)
+    print("frame rate: ", tex.source.framerate)
+    tex.source.play()
+    obj["video"] = tex
+
+#
+# Attach this function to an object that has a material with texture
+# and call it once to initialize the object
+#
+
+
+def init(cont):
+    # config_video(cont.owner, 'HD720p5994', '8BitBGRA')
+    # config_video(cont.owner, 'HD720p5994', '8BitYUV')
+    # config_video(cont.owner, 'pal ', '10BitYUV')
+    config_video(cont.owner, 'pal ', '8BitYUV')
+
+
+#
+# To be called on every frame
+#
+def play(cont):
+    obj = cont.owner
+    video = obj.get("video")
+    if video is not None:
+        video.refresh(True)

doc/python_api/examples/bge.texture.py

@@ -0,0 +1,46 @@
+"""
+Basic Video Playback
+++++++++++++++++++++
+Example of how to replace a texture in game with a video.
+It needs to run everyframe.
+To avoid any confusion with the location of the file,
+we will use ``GameLogic.expandPath()`` to build an absolute file name,
+assuming the video file is in the same directory as the blend-file.
+"""
+import bge
+from bge import texture
+from bge import logic
+
+cont = logic.getCurrentController()
+obj = cont.owner
+
+# the creation of the texture must be done once: save the
+# texture object in an attribute of bge.logic module makes it persistent
+if not hasattr(logic, 'video'):
+
+    # identify a static texture by name
+    matID = texture.materialID(obj, 'IMvideo.png')
+
+    # create a dynamic texture that will replace the static texture
+    logic.video = texture.Texture(obj, matID)
+
+    # define a source of image for the texture, here a movie
+    movie = logic.expandPath('//trailer_400p.ogg')
+    logic.video.source = texture.VideoFFmpeg(movie)
+    logic.video.source.scale = True
+
+    # Note that we can change the ``Texture`` source at any time.
+    # Suppose we want to switch between two movies during the game:
+    logic.mySources[0] = texture.VideoFFmpeg('movie1.avi')
+    logic.mySources[1] = texture.VideoFFmpeg('movie2.avi')
+
+    # And then assign (and reassign) the source during the game
+    logic.video.source = logic.mySources[movieSel]
+
+    # quick off the movie, but it wont play in the background
+    logic.video.source.play()
+
+
+# Video playback is not a background process: it happens only when we refresh the texture.
+# So you need to call this function every frame to ensure update of the texture.
+logic.video.refresh(True)

doc/python_api/examples/blf.py

@@ -15,6 +15,7 @@ font_info = {
     "handler": None,
 }
 
+
 def init():
     """init function - runs once"""
     import os

doc/python_api/examples/bpy.app.handlers.1.py

@@ -17,4 +17,5 @@ from bpy.app.handlers import persistent
 def load_handler(dummy):
     print("Load Handler:", bpy.data.filepath)
 
+
 bpy.app.handlers.load_post.append(load_handler)

doc/python_api/examples/bpy.app.handlers.py

@@ -11,4 +11,5 @@ import bpy
 def my_handler(scene):
     print("Frame Change", scene.frame_current)
 
+
 bpy.app.handlers.frame_change_pre.append(my_handler)

doc/python_api/examples/bpy.app.translations.py

@@ -81,6 +81,7 @@ for msg in translations_tuple:
 
 # Define remaining addon (operators, UI...) here.
 
+
 def register():
    # Usual operator/UI/etc. registration...
 

doc/python_api/examples/bpy.ops.2.py

@@ -20,6 +20,6 @@ The execution context is one of:
 'EXEC_SCREEN')
 """
 
-# collection add popup
+# group add popup
 import bpy
-bpy.ops.object.collection_instance_add('INVOKE_DEFAULT')
+bpy.ops.object.group_instance_add('INVOKE_DEFAULT')

doc/python_api/examples/bpy.props.2.py

@@ -14,6 +14,7 @@ class MaterialSettings(bpy.types.PropertyGroup):
     my_float = bpy.props.FloatProperty()
     my_string = bpy.props.StringProperty()
 
+
 bpy.utils.register_class(MaterialSettings)
 
 bpy.types.Material.my_settings = \

doc/python_api/examples/bpy.props.3.py

@@ -14,6 +14,7 @@ class SceneSettingItem(bpy.types.PropertyGroup):
     name = bpy.props.StringProperty(name="Test Prop", default="Unknown")
     value = bpy.props.IntProperty(name="Test Prop", default=22)
 
+
 bpy.utils.register_class(SceneSettingItem)
 
 bpy.types.Scene.my_settings = \

doc/python_api/examples/bpy.props.4.py

@@ -14,6 +14,7 @@ import bpy
 def update_func(self, context):
     print("my test function", self)
 
+
 bpy.types.Scene.testprop = bpy.props.FloatProperty(update=update_func)
 
 bpy.context.scene.testprop = 11.0

doc/python_api/examples/bpy.props.5.py

@@ -19,6 +19,7 @@ def get_float(self):
 def set_float(self, value):
     self["testprop"] = value
 
+
 bpy.types.Scene.test_float = bpy.props.FloatProperty(get=get_float, set=set_float)
 
 
@@ -27,6 +28,7 @@ def get_date(self):
     import datetime
     return str(datetime.datetime.now())
 
+
 bpy.types.Scene.test_date = bpy.props.StringProperty(get=get_date)
 
 
@@ -40,6 +42,7 @@ def get_array(self):
 def set_array(self, values):
     self["somebool"] = values[0] and values[1]
 
+
 bpy.types.Scene.test_array = bpy.props.BoolVectorProperty(size=2, get=get_array, set=set_array)
 
 
@@ -61,6 +64,7 @@ def get_enum(self):
 def set_enum(self, value):
     print("setting value", value)
 
+
 bpy.types.Scene.test_enum = bpy.props.EnumProperty(items=test_items, get=get_enum, set=set_enum)
 
 

doc/python_api/examples/bpy.types.Menu.2.py

@@ -14,4 +14,5 @@ import bpy
 def menu_draw(self, context):
     self.layout.operator("wm.save_homefile")
 
+
 bpy.types.INFO_MT_file.append(menu_draw)

doc/python_api/examples/bpy.types.Menu.4.py

@@ -60,6 +60,7 @@ def menu_func(self, context):
     layout.separator()
     layout.operator(WM_OT_button_context_test.bl_idname)
 
+
 classes = (
     WM_OT_button_context_test,
     WM_MT_button_context,
@@ -77,5 +78,6 @@ def unregister():
         bpy.utils.unregister_class(cls)
     bpy.types.WM_MT_button_context.remove(menu_func)
 
+
 if __name__ == "__main__":
     register()

doc/python_api/examples/bpy.types.NodeTree.py

@@ -21,4 +21,5 @@ class CyclesNodeTree(bpy.types.NodeTree):
     def poll(cls, context):
         return context.scene.render.engine == 'CYCLES'
 
+
 bpy.utils.register_class(CyclesNodeTree)

doc/python_api/examples/bpy.types.Operator.1.py

@@ -42,6 +42,7 @@ class SimpleMouseOperator(bpy.types.Operator):
         self.y = event.mouse_y
         return self.execute(context)
 
+
 bpy.utils.register_class(SimpleMouseOperator)
 
 # Test call to the newly defined operator.

doc/python_api/examples/bpy.types.Operator.2.py

@@ -42,6 +42,7 @@ def menu_func(self, context):
     self.layout.operator_context = 'INVOKE_DEFAULT'
     self.layout.operator(ExportSomeData.bl_idname, text="Text Export Operator")
 
+
 # Register and add to the file selector
 bpy.utils.register_class(ExportSomeData)
 bpy.types.INFO_MT_file_export.append(menu_func)

doc/python_api/examples/bpy.types.Operator.4.py

@@ -41,6 +41,7 @@ class CustomDrawOperator(bpy.types.Operator):
 
         col.prop(self, "my_string")
 
+
 bpy.utils.register_class(CustomDrawOperator)
 
 # test call

doc/python_api/examples/bpy.types.Operator.py

@@ -22,6 +22,7 @@ class HelloWorldOperator(bpy.types.Operator):
         print("Hello World")
         return {'FINISHED'}
 
+
 bpy.utils.register_class(HelloWorldOperator)
 
 # test call to the newly defined operator

doc/python_api/examples/bpy.types.PropertyGroup.py

@@ -31,6 +31,7 @@ class MyPropertyGroup(bpy.types.PropertyGroup):
     custom_1 = bpy.props.FloatProperty(name="My Float")
     custom_2 = bpy.props.IntProperty(name="My Int")
 
+
 bpy.utils.register_class(MyPropertyGroup)
 
 bpy.types.Object.my_prop_grp = bpy.props.PointerProperty(type=MyPropertyGroup)

doc/python_api/examples/bpy.types.WindowManager.popup_menu.py

@@ -10,4 +10,5 @@ import bpy
 def draw(self, context):
     self.layout.label("Hello World")
 
+
 bpy.context.window_manager.popup_menu(draw, title="Greeting", icon='INFO')

doc/python_api/examples/bpy.types.bpy_struct.keyframe_insert.1.py

@@ -12,6 +12,7 @@ from bpy.props import PointerProperty
 class MyPropGroup(bpy.types.PropertyGroup):
     nested = bpy.props.FloatProperty(name="Nested", default=0.0)
 
+
 # register it so its available for all bones
 bpy.utils.register_class(MyPropGroup)
 bpy.types.Bone.my_prop = PointerProperty(type=MyPropGroup,

doc/python_api/examples/gpu.offscreen.1.py

@@ -52,7 +52,6 @@ class OffScreenDraw(bpy.types.Operator):
     @staticmethod
     def _update_offscreen(context, offscreen):
         scene = context.scene
-        render_layer = context.render_layer
         render = scene.render
         camera = scene.camera
 
@@ -66,7 +65,6 @@ class OffScreenDraw(bpy.types.Operator):
 
         offscreen.draw_view3d(
             scene,
-                render_layer,
             context.space_data,
             context.region,
             projection_matrix,

doc/python_api/rst/bge.app.rst

@@ -0,0 +1,49 @@
+
+Application Data (bge.app)
+==========================
+
+Module to access application values that remain unchanged during runtime.
+
+.. module:: bge.app
+
+.. data:: version
+
+   The Blender/BGE version as a tuple of 3 ints, eg. (2, 75, 1).
+
+   .. note::
+
+      Version tuples can be compared simply with (in)equality symbols;
+      for example, ``(2, 74, 5) <= (2, 75, 0)`` returns True (lexical order).
+
+   :type: tuple of three ints
+
+.. data:: version_string
+
+   The Blender/BGE version formatted as a string, eg. "2.75 (sub 1)".
+
+   :type: str
+
+.. data:: version_char
+
+   The Blender/BGE version character (for minor releases).
+
+   :type: str
+
+.. data:: has_texture_ffmpeg
+
+   True if the BGE has been built with FFmpeg support,
+   enabling use of :class:`~bge.texture.ImageFFmpeg` and :class:`~bge.texture.VideoFFmpeg`.
+
+   :type: bool
+
+.. data:: has_joystick
+
+   True if the BGE has been built with joystick support.
+
+   :type: bool
+
+.. data:: has_physics
+
+   True if the BGE has been built with physics support.
+
+   :type: bool

doc/python_api/rst/bge.constraints.rst

@@ -0,0 +1,356 @@
+
+Physics Constraints (bge.constraints)
+=====================================
+
+Bullet Physics provides collision detection
+and rigid body dynamics for the Blender Game Engine.
+
+Features:
+
+- Vehicle simulation.
+- Rigid body constraints: hinge and point to point (ball socket).
+- Access to internal physics settings,
+  like deactivation time, and debugging features
+
+.. module:: bge.constraints
+
+.. note:: Note about parameter settings
+
+   Since this API is not well documented, it can be unclear what kind of values to use for setting parameters.
+   In general, damping settings should be in the range of 0 to 1 and
+   stiffness settings should not be much higher than about 10.
+
+
+Examples
+--------
+
+.. seealso::
+
+   For more examples of Bullet physics and how to use them
+   see the `pybullet forum <https://pybullet.org/Bullet/phpBB3/viewforum.php?f=17>`__.
+
+.. include:: __/examples/bge.constraints.py
+   :start-line: 1
+   :end-line: 4
+
+.. literalinclude:: __/examples/bge.constraints.py
+   :lines: 6-
+
+
+Functions
+---------
+
+.. function:: createConstraint( \
+      physicsid_1, physicsid_2, constraint_type, \
+      pivot_x=0.0, pivot_y=0.0, pivot_z=0.0, \
+      axis_x=0.0, axis_y=0.0, axis_z=0.0, flag=0)
+
+   Creates a constraint.
+
+   :arg physicsid_1: The physics id of the first object in constraint.
+   :type physicsid_1: int
+
+   :arg physicsid_2: The physics id of the second object in constraint.
+   :type physicsid_2: int
+
+   :arg constraint_type: The type of the constraint, see `Create Constraint Constants`_.
+
+   :type constraint_type: int
+
+   :arg pivot_x: Pivot X position. (optional)
+   :type pivot_x: float
+
+   :arg pivot_y: Pivot Y position. (optional)
+   :type pivot_y: float
+
+   :arg pivot_z: Pivot Z position. (optional)
+   :type pivot_z: float
+
+   :arg axis_x: X axis angle in degrees. (optional)
+   :type axis_x: float
+
+   :arg axis_y: Y axis angle in degrees. (optional)
+   :type axis_y: float
+
+   :arg axis_z: Z axis angle in degrees. (optional)
+   :type axis_z: float
+
+   :arg flag: 128 to disable collision between linked bodies. (optional)
+   :type flag: int
+
+   :return: A constraint wrapper.
+   :rtype: :class:`~bge.types.KX_ConstraintWrapper`
+
+.. function:: exportBulletFile(filename)
+
+   Exports a file representing the dynamics world (usually using ``.bullet`` extension).
+
+   See `Bullet binary serialization <http://bulletphysics.org/mediawiki-1.5.8/index.php/Bullet_binary_serialization>`__.
+
+   :arg filename: File path.
+   :type filename: str
+
+.. function:: getAppliedImpulse(constraintId)
+
+   :arg constraintId: The id of the constraint.
+   :type constraintId: int
+
+   :return: The most recent applied impulse.
+   :rtype: float
+
+.. function:: getVehicleConstraint(constraintId)
+
+   :arg constraintId: The id of the vehicle constraint.
+   :type constraintId: int
+
+   :return: A vehicle constraint object.
+   :rtype: :class:`~bge.types.KX_VehicleWrapper`
+
+.. function:: getCharacter(gameobj)
+
+   :arg gameobj: The game object with the character physics.
+   :type gameobj: :class:`~bge.types.KX_GameObject`
+
+   :return: Character wrapper.
+   :rtype: :class:`~bge.types.KX_CharacterWrapper`
+
+.. function:: removeConstraint(constraintId)
+
+   Removes a constraint.
+
+   :arg constraintId: The id of the constraint to be removed.
+   :type constraintId: int
+
+.. function:: setCcdMode(ccdMode)
+
+   .. note::
+      Very experimental, not recommended
+
+   Sets the CCD (Continous Colision Detection) mode in the Physics Environment.
+
+   :arg ccdMode: The new CCD mode.
+   :type ccdMode: int
+
+.. function:: setContactBreakingTreshold(breakingTreshold)
+
+   .. note::
+      Reasonable default is 0.02 (if units are meters)
+
+   Sets tresholds to do with contact point management.
+
+   :arg breakingTreshold: The new contact breaking treshold.
+   :type breakingTreshold: float
+
+.. function:: setDeactivationAngularTreshold(angularTreshold)
+
+   Sets the angular velocity treshold.
+
+   :arg angularTreshold: New deactivation angular treshold.
+   :type angularTreshold: float
+
+.. function:: setDeactivationLinearTreshold(linearTreshold)
+
+   Sets the linear velocity treshold.
+
+   :arg linearTreshold: New deactivation linear treshold.
+   :type linearTreshold: float
+
+.. function:: setDeactivationTime(time)
+
+   Sets the time after which a resting rigidbody gets deactived.
+
+   :arg time: The deactivation time.
+   :type time: float
+
+.. function:: setDebugMode(mode)
+
+   Sets the debug mode.
+
+   :arg mode: The new debug mode, see `Debug Mode Constants`_.
+
+   :type mode: int
+
+.. function:: setGravity(x, y, z)
+
+   Sets the gravity force.
+
+   :arg x: Gravity X force.
+   :type x: float
+
+   :arg y: Gravity Y force.
+   :type y: float
+
+   :arg z: Gravity Z force.
+   :type z: float
+
+.. function:: setLinearAirDamping(damping)
+
+   .. note::
+
+      Not implemented
+
+   Sets the linear air damping for rigidbodies.
+
+.. function:: setNumIterations(numiter)
+
+   Sets the number of iterations for an iterative constraint solver.
+
+   :arg numiter: New number of iterations.
+   :type numiter: int
+
+.. function:: setNumTimeSubSteps(numsubstep)
+
+   Sets the number of substeps for each physics proceed. Tradeoff quality for performance.
+
+   :arg numsubstep: New number of substeps.
+   :type numsubstep: int
+
+.. function:: setSolverDamping(damping)
+
+   .. note::
+      Very experimental, not recommended
+
+   Sets the damper constant of a penalty based solver.
+
+   :arg damping: New damping for the solver.
+   :type damping: float
+
+.. function:: setSolverTau(tau)
+
+   .. note::
+      Very experimental, not recommended
+
+   Sets the spring constant of a penalty based solver.
+
+   :arg tau: New tau for the solver.
+   :type tau: float
+
+.. function:: setSolverType(solverType)
+
+   .. note::
+      Very experimental, not recommended
+
+   Sets the solver type.
+
+   :arg solverType: The new type of the solver.
+   :type solverType: int
+
+.. function:: setSorConstant(sor)
+
+   .. note::
+      Very experimental, not recommended
+
+   Sets the successive overrelaxation constant.
+
+   :arg sor: New sor value.
+   :type sor: float
+
+.. function:: setUseEpa(epa)
+
+   .. note::
+
+      Not implemented
+
+
+Constants
++++++++++
+
+.. attribute:: error
+
+   Symbolic constant string that indicates error.
+
+   :type: str
+
+
+Debug Mode Constants
+^^^^^^^^^^^^^^^^^^^^
+
+Debug mode to be used with :func:`setDebugMode`.
+
+
+.. data:: DBG_NODEBUG
+
+   No debug.
+
+.. data:: DBG_DRAWWIREFRAME
+
+   Draw wireframe in debug.
+
+.. data:: DBG_DRAWAABB
+
+   Draw Axis Aligned Bounding Box in debug.
+
+.. data:: DBG_DRAWFREATURESTEXT
+
+   Draw features text in debug.
+
+.. data:: DBG_DRAWCONTACTPOINTS
+
+   Draw contact points in debug.
+
+.. data:: DBG_NOHELPTEXT
+
+   Debug without help text.
+
+.. data:: DBG_DRAWTEXT
+
+   Draw text in debug.
+
+.. data:: DBG_PROFILETIMINGS
+
+   Draw profile timings in debug.
+
+.. data:: DBG_ENABLESATCOMPARISION
+
+   Enable sat comparision in debug.
+
+.. data:: DBG_DISABLEBULLETLCP
+
+   Disable Bullet LCP.
+
+.. data:: DBG_ENABLECCD
+
+   Enable Continous Collision Detection in debug.
+
+.. data:: DBG_DRAWCONSTRAINTS
+
+   Draw constraints in debug.
+
+.. data:: DBG_DRAWCONSTRAINTLIMITS
+
+   Draw constraint limits in debug.
+
+.. data:: DBG_FASTWIREFRAME
+
+   Draw a fast wireframe in debug.
+
+
+Create Constraint Constants
+^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Constraint type to be used with :func:`createConstraint`.
+
+
+.. data:: POINTTOPOINT_CONSTRAINT
+
+   .. to do
+
+.. data:: LINEHINGE_CONSTRAINT
+
+   .. to do
+
+.. data:: ANGULAR_CONSTRAINT
+
+   .. to do
+
+.. data:: CONETWIST_CONSTRAINT
+
+   .. to do
+
+.. data:: VEHICLE_CONSTRAINT
+
+   .. to do
+
+.. data:: GENERIC_6DOF_CONSTRAINT
+
+   .. to do

doc/python_api/rst/bge.events.rst

@@ -0,0 +1,250 @@
+
+Game Keys (bge.events)
+======================
+
+*****
+Intro
+*****
+
+This module holds key constants for the SCA_KeyboardSensor.
+
+.. module:: bge.events
+
+.. 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!")
+
+
+*********
+Functions
+*********
+
+.. function:: EventToString(event)
+
+   Return the string name of a key event. Will raise a ValueError error if its invalid.
+
+   :arg event: key event constant from :mod:`bge.events` or the keyboard sensor.
+   :type event: int
+   :rtype: string
+
+.. function:: EventToCharacter(event, shift)
+
+   Return the string name of a key event. Returns an empty string if the event cant be represented as a character.
+
+   :type event: int
+   :arg event: key event constant from :mod:`bge.events` or the keyboard sensor.
+   :type shift: bool
+   :arg shift: set to true if shift is held.
+   :rtype: string
+
+****************
+Keys (Constants)
+****************
+
+.. _mouse-keys:
+
+==========
+Mouse Keys
+==========
+
+.. data:: LEFTMOUSE
+.. data:: MIDDLEMOUSE
+.. data:: RIGHTMOUSE
+.. data:: WHEELUPMOUSE
+.. data:: WHEELDOWNMOUSE
+.. data:: MOUSEX
+.. data:: MOUSEY
+
+.. _keyboard-keys:
+
+=============
+Keyboard Keys
+=============
+
+-------------
+Alphabet keys
+-------------
+
+.. data:: AKEY
+.. data:: BKEY
+.. data:: CKEY
+.. data:: DKEY
+.. data:: EKEY
+.. data:: FKEY
+.. data:: GKEY
+.. data:: HKEY
+.. data:: IKEY
+.. data:: JKEY
+.. data:: KKEY
+.. data:: LKEY
+.. data:: MKEY
+.. data:: NKEY
+.. data:: OKEY
+.. data:: PKEY
+.. data:: QKEY
+.. data:: RKEY
+.. data:: SKEY
+.. data:: TKEY
+.. data:: UKEY
+.. data:: VKEY
+.. data:: WKEY
+.. data:: XKEY
+.. data:: YKEY
+.. data:: ZKEY
+
+-----------
+Number keys
+-----------
+
+.. data:: ZEROKEY
+.. data:: ONEKEY
+.. data:: TWOKEY
+.. data:: THREEKEY
+.. data:: FOURKEY
+.. data:: FIVEKEY
+.. data:: SIXKEY
+.. data:: SEVENKEY
+.. data:: EIGHTKEY
+.. data:: NINEKEY
+
+--------------
+Modifiers Keys
+--------------
+
+.. data:: CAPSLOCKKEY
+.. data:: LEFTCTRLKEY
+.. data:: LEFTALTKEY
+.. data:: RIGHTALTKEY
+.. data:: RIGHTCTRLKEY
+.. data:: RIGHTSHIFTKEY
+.. data:: LEFTSHIFTKEY
+
+----------
+Arrow Keys
+----------
+
+.. data:: LEFTARROWKEY
+.. data:: DOWNARROWKEY
+.. data:: RIGHTARROWKEY
+.. data:: UPARROWKEY
+
+--------------
+Numberpad Keys
+--------------
+
+.. data:: PAD0
+.. data:: PAD1
+.. data:: PAD2
+.. data:: PAD3
+.. data:: PAD4
+.. data:: PAD5
+.. data:: PAD6
+.. data:: PAD7
+.. data:: PAD8
+.. data:: PAD9
+.. data:: PADPERIOD
+.. data:: PADSLASHKEY
+.. data:: PADASTERKEY
+.. data:: PADMINUS
+.. data:: PADENTER
+.. data:: PADPLUSKEY
+
+-------------
+Function Keys
+-------------
+
+.. data:: F1KEY
+.. data:: F2KEY
+.. data:: F3KEY
+.. data:: F4KEY
+.. data:: F5KEY
+.. data:: F6KEY
+.. data:: F7KEY
+.. data:: F8KEY
+.. data:: F9KEY
+.. data:: F10KEY
+.. data:: F11KEY
+.. data:: F12KEY
+.. data:: F13KEY
+.. data:: F14KEY
+.. data:: F15KEY
+.. data:: F16KEY
+.. data:: F17KEY
+.. data:: F18KEY
+.. data:: F19KEY
+
+----------
+Other Keys
+----------
+
+.. data:: ACCENTGRAVEKEY
+.. data:: BACKSLASHKEY
+.. data:: BACKSPACEKEY
+.. data:: COMMAKEY
+.. data:: DELKEY
+.. data:: ENDKEY
+.. data:: EQUALKEY
+.. data:: ESCKEY
+.. data:: HOMEKEY
+.. data:: INSERTKEY
+.. data:: LEFTBRACKETKEY
+.. data:: LINEFEEDKEY
+.. data:: MINUSKEY
+.. data:: PAGEDOWNKEY
+.. data:: PAGEUPKEY
+.. data:: PAUSEKEY
+.. data:: PERIODKEY
+.. data:: QUOTEKEY
+.. data:: RIGHTBRACKETKEY
+.. data:: RETKEY (Deprecated: use bge.events.ENTERKEY)
+.. data:: ENTERKEY
+.. data:: SEMICOLONKEY
+.. data:: SLASHKEY
+.. data:: SPACEKEY
+.. data:: TABKEY

doc/python_api/rst/bge.render.rst

@@ -0,0 +1,425 @@
+
+Rasterizer (bge.render)
+=======================
+
+*****
+Intro
+*****
+
+.. module:: bge.render
+
+Example of using a :class:`bge.types.SCA_MouseSensor`,
+and two :class:`bge.types.KX_ObjectActuator` to implement MouseLook:
+
+.. note::
+   This can also be achieved with the :class:`bge.types.KX_MouseActuator`.
+
+.. code-block:: python
+
+   # To use a mouse movement sensor "Mouse" and a
+   # motion actuator to mouse look:
+   import bge
+
+   # scale sets the speed of motion
+   scale = 1.0, 0.5
+
+   co = bge.logic.getCurrentController()
+   obj = co.owner
+   mouse = co.sensors["Mouse"]
+   lmotion = co.actuators["LMove"]
+   wmotion = co.actuators["WMove"]
+
+   # Transform the mouse coordinates to see how far the mouse has moved.
+   def mousePos():
+      x = (bge.render.getWindowWidth() / 2 - mouse.position[0]) * scale[0]
+      y = (bge.render.getWindowHeight() / 2 - mouse.position[1]) * scale[1]
+      return (x, y)
+
+   pos = mousePos()
+
+   # Set the amount of motion: X is applied in world coordinates...
+   wmotion.useLocalTorque = False
+   wmotion.torque = ((0.0, 0.0, pos[0]))
+
+   # ...Y is applied in local coordinates
+   lmotion.useLocalTorque = True
+   lmotion.torque = ((-pos[1], 0.0, 0.0))
+
+   # Activate both actuators
+   co.activate(lmotion)
+   co.activate(wmotion)
+
+   # Centre the mouse
+   bge.render.setMousePosition(int(bge.render.getWindowWidth() / 2), int(bge.render.getWindowHeight() / 2))
+
+*********
+Constants
+*********
+
+.. data:: KX_TEXFACE_MATERIAL
+
+   Materials as defined by the texture face settings.
+
+.. data:: KX_BLENDER_MULTITEX_MATERIAL
+
+   Materials approximating blender materials with multitexturing.
+
+.. data:: KX_BLENDER_GLSL_MATERIAL
+
+   Materials approximating blender materials with GLSL.
+
+.. DATA:: VSYNC_OFF
+
+   Disables vsync
+
+.. DATA:: VSYNC_ON
+
+   Enables vsync
+
+.. DATA:: VSYNC_ADAPTIVE
+
+   Enables adaptive vsync if supported.
+   Adaptive vsync enables vsync if the framerate is above the monitors refresh rate.
+   Otherwise, vsync is diabled if the framerate is too low.
+
+.. data:: LEFT_EYE
+
+   Left eye being used during stereoscopic rendering.
+
+.. data:: RIGHT_EYE
+
+   Right eye being used during stereoscopic rendering.
+
+.. data:: RAS_OFS_RENDER_BUFFER
+
+   The pixel buffer for offscreen render is a RenderBuffer. Argument to :func:`offScreenCreate`
+
+.. data:: RAS_OFS_RENDER_TEXTURE
+
+   The pixel buffer for offscreen render is a Texture. Argument to :func:`offScreenCreate`
+
+
+*****
+Types
+*****
+
+.. class:: RASOffScreen
+
+   An off-screen render buffer object. 
+
+   Use :func:`offScreenCreate` to create it.
+   Currently it can only be used in the :class:`bge.texture.ImageRender`
+   constructor to render on a FBO rather than the default viewport.
+
+  .. attribute:: width
+
+     The width in pixel of the FBO
+
+     :type: integer
+
+  .. attribute:: height
+
+     The height in pixel of the FBO
+
+     :type: integer
+
+  .. attribute:: color
+
+     The underlying OpenGL bind code of the texture object that holds
+     the rendered image, 0 if the FBO is using RenderBuffer.
+     The choice between RenderBuffer and Texture is determined
+     by the target argument of :func:`offScreenCreate`.
+
+     :type: integer
+
+
+*********
+Functions
+*********
+
+.. function:: getWindowWidth()
+
+   Gets the width of the window (in pixels)
+
+   :rtype: integer
+
+.. function:: getWindowHeight()
+
+   Gets the height of the window (in pixels)
+
+   :rtype: integer
+
+.. function:: setWindowSize(width, height)
+
+   Set the width and height of the window (in pixels). This also works for fullscreen applications.
+
+   .. note:: Only works in the standalone player, not the Blender-embedded player.
+
+   :arg width: width in pixels
+   :type width: integer
+   :arg height: height in pixels
+   :type height: integer
+
+.. function:: setFullScreen(enable)
+
+   Set whether or not the window should be fullscreen.
+
+   .. note:: Only works in the standalone player, not the Blender-embedded player.
+
+   :arg enable: ``True`` to set full screen, ``False`` to set windowed.
+   :type enable: bool
+
+.. function:: getFullScreen()
+
+   Returns whether or not the window is fullscreen.
+
+   .. note:: Only works in the standalone player, not the Blender-embedded player; there it always returns False.
+
+   :rtype: bool
+
+.. function:: getDisplayDimensions()
+
+   Get the display dimensions, in pixels, of the display (e.g., the
+   monitor). Can return the size of the entire view, so the
+   combination of all monitors; for example, ``(3840, 1080)`` for two
+   side-by-side 1080p monitors.
+   
+   :rtype: tuple (width, height)
+
+.. function:: makeScreenshot(filename)
+
+   Writes an image file with the current displayed frame.
+
+   The image is written to *'filename'*.
+   The path may be absolute (eg. ``/home/foo/image``) or relative when started with
+   ``//`` (eg. ``//image``). Note that absolute paths are not portable between platforms.
+   If the filename contains a ``#``,
+   it will be replaced by an incremental index so that screenshots can be taken multiple
+   times without overwriting the previous ones (eg. ``image-#``).
+
+   Settings for the image are taken from the render settings (file format and respective settings,
+   gamma and colospace conversion, etc).
+   The image resolution matches the framebuffer, meaning, the window size and aspect ratio.
+   When running from the standalone player, instead of the embedded player, only PNG files are supported.
+   Additional color conversions are also not supported.
+
+   :arg filename: path and name of the file to write
+   :type filename: string
+
+
+.. function:: enableVisibility(visible)
+
+   Deprecated; doesn't do anything.
+
+
+.. function:: showMouse(visible)
+
+   Enables or disables the operating system mouse cursor.
+
+   :arg visible:
+   :type visible: boolean
+
+
+.. function:: setMousePosition(x, y)
+
+   Sets the mouse cursor position.
+
+   :arg x: X-coordinate in screen pixel coordinates.
+   :type x: integer
+   :arg y: Y-coordinate in screen pixel coordinates.
+   :type y: integer
+
+
+.. function:: setBackgroundColor(rgba)
+
+   Deprecated and no longer functional. Use :py:meth:`bge.types.KX_WorldInfo.backgroundColor` instead.
+
+
+.. function:: setEyeSeparation(eyesep)
+
+   Sets the eye separation for stereo mode. Usually Focal Length/30 provides a confortable value.
+
+   :arg eyesep: The distance between the left and right eye.
+   :type eyesep: float
+
+
+.. function:: getEyeSeparation()
+
+   Gets the current eye separation for stereo mode.
+
+   :rtype: float
+
+
+.. function:: setFocalLength(focallength)
+
+   Sets the focal length for stereo mode. It uses the current camera focal length as initial value.
+
+   :arg focallength: The focal length.
+   :type focallength: float
+
+.. function:: getFocalLength()
+
+   Gets the current focal length for stereo mode.
+
+   :rtype: float
+
+.. function:: getStereoEye()
+
+   Gets the current stereoscopy eye being rendered.
+   This function is mainly used in a :class:`bge.types.KX_Scene.pre_draw` callback
+   function to customize the camera projection matrices for each
+   stereoscopic eye.
+
+   :rtype: LEFT_EYE, RIGHT_EYE
+
+.. function:: setMaterialMode(mode)
+
+   Set the material mode to use for OpenGL rendering.
+
+   :arg mode: material mode
+   :type mode: KX_TEXFACE_MATERIAL, KX_BLENDER_MULTITEX_MATERIAL, KX_BLENDER_GLSL_MATERIAL
+
+   .. note:: Changes will only affect newly created scenes.
+
+
+.. function:: getMaterialMode(mode)
+
+   Get the material mode to use for OpenGL rendering.
+
+   :rtype: KX_TEXFACE_MATERIAL, KX_BLENDER_MULTITEX_MATERIAL, KX_BLENDER_GLSL_MATERIAL
+
+
+.. function:: setGLSLMaterialSetting(setting, enable)
+
+   Enables or disables a GLSL material setting.
+
+   :arg setting:
+   :type setting: string (lights, shaders, shadows, ramps, nodes, extra_textures)
+   :arg enable:
+   :type enable: boolean
+
+
+.. function:: getGLSLMaterialSetting(setting)
+
+   Get the state of a GLSL material setting.
+
+   :arg setting:
+   :type setting: string (lights, shaders, shadows, ramps, nodes, extra_textures)
+   :rtype: boolean
+
+.. function:: setAnisotropicFiltering(level)
+
+   Set the anisotropic filtering level for textures.
+
+   :arg level: The new anisotropic filtering level to use
+   :type level: integer (must be one of 1, 2, 4, 8, 16)
+
+   .. note:: Changing this value can cause all textures to be recreated, which can be slow.
+
+.. function:: getAnisotropicFiltering()
+
+   Get the anisotropic filtering level used for textures.
+
+   :rtype: integer (one of 1, 2, 4, 8, 16)
+
+.. function:: setMipmapping(value)
+
+   Change how to use mipmapping.
+
+   :type value: RAS_MIPMAP_NONE, RAS_MIPMAP_NEAREST, RAS_MIPMAP_LINEAR
+
+   .. note:: Changing this value can cause all textures to be recreated, which can be slow.
+
+.. function:: getMipmapping()
+
+   Get the current mipmapping setting.
+
+   :rtype: RAS_MIPMAP_NONE, RAS_MIPMAP_NEAREST, RAS_MIPMAP_LINEAR
+
+.. function:: drawLine(fromVec,toVec,color)
+
+   Draw a line in the 3D scene.
+
+   :arg fromVec: the origin of the line
+   :type fromVec: list [x, y, z]
+   :arg toVec: the end of the line
+   :type toVec: list [x, y, z]
+   :arg color: the color of the line
+   :type color: list [r, g, b]
+
+
+.. function:: enableMotionBlur(factor)
+
+   Enable the motion blur effect.
+
+   :arg factor: the ammount of motion blur to display.
+   :type factor: float [0.0 - 1.0]
+
+
+.. function:: disableMotionBlur()
+
+   Disable the motion blur effect.
+
+.. function:: showFramerate(enable)
+
+   Show or hide the framerate.
+
+   :arg enable:
+   :type enable: boolean
+
+.. function:: showProfile(enable)
+
+   Show or hide the profile.
+
+   :arg enable:
+   :type enable: boolean
+
+.. function:: showProperties(enable)
+
+   Show or hide the debug properties.
+
+   :arg enable:
+   :type enable: boolean
+
+.. function:: autoDebugList(enable)
+
+   Enable or disable auto adding debug properties to the debug list.
+
+   :arg enable:
+   :type enable: boolean
+
+.. function:: clearDebugList()
+
+   Clears the debug property list.
+
+.. function:: setVsync(value)
+
+   Set the vsync value
+
+   :arg value: One of VSYNC_OFF, VSYNC_ON, VSYNC_ADAPTIVE
+   :type value: integer
+
+.. function:: getVsync()
+
+   Get the current vsync value
+
+   :rtype: One of VSYNC_OFF, VSYNC_ON, VSYNC_ADAPTIVE
+
+.. function:: offScreenCreate(width,height[,samples=0][,target=bge.render.RAS_OFS_RENDER_BUFFER])
+
+   Create a Off-screen render buffer object.
+
+   :arg width: the width of the buffer in pixels
+   :type width: integer
+   :arg height: the height of the buffer in pixels
+   :type height: integer
+   :arg samples: the number of multisample for anti-aliasing (MSAA), 0 to disable MSAA
+   :type samples: integer
+   :arg target: the pixel storage: :data:`RAS_OFS_RENDER_BUFFER` to render on RenderBuffers (the default),
+      :data:`RAS_OFS_RENDER_TEXTURE` to render on texture. 
+      The later is interesting if you want to access the texture directly (see :attr:`RASOffScreen.color`).
+      Otherwise the default is preferable as it's more widely supported by GPUs and more efficient.
+      If the GPU does not support MSAA+Texture (e.g. Intel HD GPU), MSAA will be disabled.
+   :type target: integer
+   :rtype: :class:`RASOffScreen`
+

doc/python_api/rst/bge.types.rst

@@ -0,0 +1,37 @@
+
+Game Types (bge.types)
+======================
+
+.. module:: bge.types
+
+************
+Introduction
+************
+
+This module contains the classes that appear as instances in the Game Engine. A
+script must interact with these classes if it is to affect the behaviour of
+objects in a game.
+
+The following example would move an object (i.e. an instance of
+:class:`KX_GameObject`) one unit up.
+
+.. code-block:: python
+
+   # bge.types.SCA_PythonController
+   cont = bge.logic.getCurrentController()
+
+   # bge.types.KX_GameObject
+   obj = cont.owner
+   obj.worldPosition.z += 1
+
+To run the code, it could be placed in a Blender text block and executed with
+a :class:`SCA_PythonController` logic brick.
+
+*****
+Types
+*****
+
+.. toctree::
+   :glob:
+
+   bge.types.*

doc/python_api/rst/bge_types/bge.types.BL_ActionActuator.rst

@@ -0,0 +1,75 @@
+BL_ActionActuator(SCA_IActuator)
+================================
+
+base class --- :class:`SCA_IActuator`
+
+.. class:: BL_ActionActuator(SCA_IActuator)
+
+   Action Actuators apply an action to an actor.
+
+   .. attribute:: action
+
+      The name of the action to set as the current action.
+
+      :type: string
+
+   .. attribute:: frameStart
+
+      Specifies the starting frame of the animation.
+
+      :type: float
+
+   .. attribute:: frameEnd
+
+      Specifies the ending frame of the animation.
+
+      :type: float
+
+   .. attribute:: blendIn
+
+      Specifies the number of frames of animation to generate when making transitions between actions.
+
+      :type: float
+
+   .. attribute:: priority
+
+      Sets the priority of this actuator. Actuators will lower priority numbers will override actuators with higher numbers.
+
+      :type: integer
+
+   .. attribute:: frame
+
+      Sets the current frame for the animation.
+
+      :type: float
+
+   .. attribute:: propName
+
+      Sets the property to be used in FromProp playback mode.
+
+      :type: string
+
+   .. attribute:: blendTime
+
+      Sets the internal frame timer. This property must be in the range from 0.0 to blendIn.
+
+      :type: float
+
+   .. attribute:: mode
+
+      The operation mode of the actuator. Can be one of :ref:`these constants<action-actuator>`.
+
+      :type: integer
+
+   .. attribute:: useContinue
+
+      The actions continue option, True or False. When True, the action will always play from where last left off,
+      otherwise negative events to this actuator will reset it to its start frame.
+
+      :type: boolean
+
+   .. attribute:: framePropName
+
+      The name of the property that is set to the current frame number.
+
+      :type: string

doc/python_api/rst/bge_types/bge.types.BL_ArmatureActuator.rst

@@ -0,0 +1,58 @@
+BL_ArmatureActuator(SCA_IActuator)
+==================================
+
+base class --- :class:`SCA_IActuator`
+
+.. class:: BL_ArmatureActuator(SCA_IActuator)
+
+   Armature Actuators change constraint condition on armatures.
+
+   .. attribute:: type
+
+      The type of action that the actuator executes when it is active.
+
+      Can be one of :ref:`these constants <armatureactuator-constants-type>`
+
+      :type: integer
+
+   .. attribute:: constraint
+
+      The constraint object this actuator is controlling.
+
+      :type: :class:`BL_ArmatureConstraint`
+
+   .. attribute:: target
+
+      The object that this actuator will set as primary target to the constraint it controls.
+
+      :type: :class:`KX_GameObject`
+
+   .. attribute:: subtarget
+
+      The object that this actuator will set as secondary target to the constraint it controls.
+
+      :type: :class:`KX_GameObject`.
+      
+      .. note::
+      
+         Currently, the only secondary target is the pole target for IK constraint.
+
+   .. attribute:: weight
+
+      The weight this actuator will set on the constraint it controls.
+
+      :type: float.
+
+      .. note::
+      
+         Currently only the IK constraint has a weight. It must be a value between 0 and 1.
+
+      .. note::
+      
+         A weight of 0 disables a constraint while still updating constraint runtime values (see :class:`BL_ArmatureConstraint`)
+
+   .. attribute:: influence
+
+      The influence this actuator will set on the constraint it controls.
+
+      :type: float.

doc/python_api/rst/bge_types/bge.types.BL_ArmatureBone.rst

@@ -0,0 +1,103 @@
+BL_ArmatureBone(PyObjectPlus)
+=============================
+
+base class --- :class:`PyObjectPlus`
+
+.. class:: BL_ArmatureBone(PyObjectPlus)
+
+   Proxy to Blender bone structure. All fields are read-only and comply to RNA names.
+   All space attribute correspond to the rest pose.
+
+   .. attribute:: name
+
+      bone name.
+
+      :type: string
+
+   .. attribute:: connected
+
+      true when the bone head is struck to the parent's tail.
+
+      :type: boolean
+
+   .. attribute:: hinge
+
+      true when bone doesn't inherit rotation or scale from parent bone.
+
+      :type: boolean
+
+   .. attribute:: inherit_scale
+
+      true when bone inherits scaling from parent bone.
+
+      :type: boolean
+
+   .. attribute:: bbone_segments
+
+      number of B-bone segments.
+
+      :type: integer
+
+   .. attribute:: roll
+
+      bone rotation around head-tail axis.
+
+      :type: float
+
+   .. attribute:: head
+
+      location of head end of the bone in parent bone space.
+
+      :type: vector [x, y, z]
+
+   .. attribute:: tail
+
+      location of head end of the bone in parent bone space.
+
+      :type: vector [x, y, z]
+
+   .. attribute:: length
+
+      bone length.
+
+      :type: float
+
+   .. attribute:: arm_head
+
+      location of head end of the bone in armature space.
+
+      :type: vector [x, y, z]
+
+   .. attribute:: arm_tail
+
+      location of tail end of the bone in armature space.
+
+      :type: vector [x, y, z]
+
+   .. attribute:: arm_mat
+
+      matrix of the bone head in armature space.
+
+      :type: matrix [4][4]
+
+      .. note::
+      
+         This matrix has no scale part. 
+
+   .. attribute:: bone_mat
+
+      rotation matrix of the bone in parent bone space.
+
+      :type: matrix [3][3]
+
+   .. attribute:: parent
+
+      parent bone, or None for root bone.
+
+      :type: :class:`BL_ArmatureBone`
+
+   .. attribute:: children
+
+      list of bone's children.
+
+      :type: list of :class:`BL_ArmatureBone`

doc/python_api/rst/bge_types/bge.types.BL_ArmatureChannel.rst

@@ -0,0 +1,275 @@
+BL_ArmatureChannel(PyObjectPlus)
+================================
+
+base class --- :class:`PyObjectPlus`
+
+.. class:: BL_ArmatureChannel(PyObjectPlus)
+
+   Proxy to armature pose channel. Allows to read and set armature pose.
+   The attributes are identical to RNA attributes, but mostly in read-only mode.
+
+   .. attribute:: name
+
+      channel name (=bone name), read-only.
+
+      :type: string
+
+   .. attribute:: bone
+
+      return the bone object corresponding to this pose channel, read-only.
+
+      :type: :class:`BL_ArmatureBone`
+
+   .. attribute:: parent
+
+      return the parent channel object, None if root channel, read-only.
+
+      :type: :class:`BL_ArmatureChannel`
+
+   .. attribute:: has_ik
+
+      true if the bone is part of an active IK chain, read-only.
+      This flag is not set when an IK constraint is defined but not enabled (miss target information for example).
+
+      :type: boolean
+
+   .. attribute:: ik_dof_x
+
+      true if the bone is free to rotation in the X axis, read-only.
+
+      :type: boolean
+
+   .. attribute:: ik_dof_y
+
+      true if the bone is free to rotation in the Y axis, read-only.
+
+      :type: boolean
+
+   .. attribute:: ik_dof_z
+
+      true if the bone is free to rotation in the Z axis, read-only.
+
+      :type: boolean
+
+   .. attribute:: ik_limit_x
+
+      true if a limit is imposed on X rotation, read-only.
+
+      :type: boolean
+
+   .. attribute:: ik_limit_y
+
+      true if a limit is imposed on Y rotation, read-only.
+
+      :type: boolean
+
+   .. attribute:: ik_limit_z
+
+      true if a limit is imposed on Z rotation, read-only.
+
+      :type: boolean
+
+   .. attribute:: ik_rot_control
+
+      true if channel rotation should applied as IK constraint, read-only.
+
+      :type: boolean
+
+   .. attribute:: ik_lin_control
+
+      true if channel size should applied as IK constraint, read-only.
+
+      :type: boolean
+
+   .. attribute:: location
+
+      displacement of the bone head in armature local space, read-write.
+
+      :type: vector [X, Y, Z].
+
+      .. note::
+      
+         You can only move a bone if it is unconnected to its parent. An action playing on the armature may change the value. An IK chain does not update this value, see joint_rotation.
+
+      .. note::
+      
+         Changing this field has no immediate effect, the pose is updated when the armature is updated during the graphic render (see :data:`BL_ArmatureObject.update`).
+
+   .. attribute:: scale
+
+      scale of the bone relative to its parent, read-write.
+
+      :type: vector [sizeX, sizeY, sizeZ].
+
+      .. note::
+      
+         An action playing on the armature may change the value.  An IK chain does not update this value, see joint_rotation.
+
+      .. note::
+      
+         Changing this field has no immediate effect, the pose is updated when the armature is updated during the graphic render (see :data:`BL_ArmatureObject.update`)
+
+   .. attribute:: rotation_quaternion
+
+      rotation of the bone relative to its parent expressed as a quaternion, read-write.
+
+      :type: vector [qr, qi, qj, qk].
+
+      .. note::
+      
+         This field is only used if rotation_mode is 0. An action playing on the armature may change the value.  An IK chain does not update this value, see joint_rotation.
+
+      .. note::
+      
+         Changing this field has no immediate effect, the pose is updated when the armature is updated during the graphic render (see :data:`BL_ArmatureObject.update`)
+
+   .. attribute:: rotation_euler
+
+      rotation of the bone relative to its parent expressed as a set of euler angles, read-write.
+
+      :type: vector [X, Y, Z].
+
+      .. note::
+      
+         This field is only used if rotation_mode is > 0. You must always pass the angles in [X, Y, Z] order; the order of applying the angles to the bone depends on rotation_mode. An action playing on the armature may change this field.  An IK chain does not update this value, see joint_rotation.
+
+      .. note::
+      
+         Changing this field has no immediate effect, the pose is updated when the armature is updated during the graphic render (see :data:`BL_ArmatureObject.update`)
+
+   .. attribute:: rotation_mode
+
+      Method of updating the bone rotation, read-write.
+
+      :type: integer (one of :ref:`these constants <armaturechannel-constants-rotation-mode>`)
+
+   .. attribute:: channel_matrix
+
+      pose matrix in bone space (deformation of the bone due to action, constraint, etc), Read-only.
+      This field is updated after the graphic render, it represents the current pose.
+
+      :type: matrix [4][4]
+
+   .. attribute:: pose_matrix
+
+      pose matrix in armature space, read-only, 
+      This field is updated after the graphic render, it represents the current pose.
+
+      :type: matrix [4][4]
+
+   .. attribute:: pose_head
+
+      position of bone head in armature space, read-only.
+
+      :type: vector [x, y, z]
+
+   .. attribute:: pose_tail
+
+      position of bone tail in armature space, read-only.
+
+      :type: vector [x, y, z]
+
+   .. attribute:: ik_min_x
+
+      minimum value of X rotation in degree (<= 0) when X rotation is limited (see ik_limit_x), read-only.
+
+      :type: float
+
+   .. attribute:: ik_max_x
+
+      maximum value of X rotation in degree (>= 0) when X rotation is limited (see ik_limit_x), read-only.
+
+      :type: float
+
+   .. attribute:: ik_min_y
+
+      minimum value of Y rotation in degree (<= 0) when Y rotation is limited (see ik_limit_y), read-only.
+
+      :type: float
+
+   .. attribute:: ik_max_y
+
+      maximum value of Y rotation in degree (>= 0) when Y rotation is limited (see ik_limit_y), read-only.
+
+      :type: float
+
+   .. attribute:: ik_min_z
+
+      minimum value of Z rotation in degree (<= 0) when Z rotation is limited (see ik_limit_z), read-only.
+
+      :type: float
+
+   .. attribute:: ik_max_z
+
+      maximum value of Z rotation in degree (>= 0) when Z rotation is limited (see ik_limit_z), read-only.
+
+      :type: float
+
+   .. attribute:: ik_stiffness_x
+
+      bone rotation stiffness in X axis, read-only.
+
+      :type: float between 0 and 1
+
+   .. attribute:: ik_stiffness_y
+
+      bone rotation stiffness in Y axis, read-only.
+
+      :type: float between 0 and 1
+
+   .. attribute:: ik_stiffness_z
+
+      bone rotation stiffness in Z axis, read-only.
+
+      :type: float between 0 and 1
+
+   .. attribute:: ik_stretch
+
+      ratio of scale change that is allowed, 0=bone can't change size, read-only.
+
+      :type: float
+
+   .. attribute:: ik_rot_weight
+
+      weight of rotation constraint when ik_rot_control is set, read-write.
+
+      :type: float between 0 and 1
+
+   .. attribute:: ik_lin_weight
+
+      weight of size constraint when ik_lin_control is set, read-write.
+
+      :type: float between 0 and 1
+
+   .. attribute:: joint_rotation
+
+      Control bone rotation in term of joint angle (for robotic applications), read-write.
+
+      When writing to this attribute, you pass a [x, y, z] vector and an appropriate set of euler angles or quaternion is calculated according to the rotation_mode.
+
+      When you read this attribute, the current pose matrix is converted into a [x, y, z] vector representing the joint angles.
+
+      The value and the meaning of the x, y, z depends on the ik_dof_x/ik_dof_y/ik_dof_z attributes:
+
+      * 1DoF joint X, Y or Z: the corresponding x, y, or z value is used an a joint angle in radiant
+      * 2DoF joint X+Y or Z+Y: treated as 2 successive 1DoF joints: first X or Z, then Y. The x or z value is used as a joint angle in radiant along the X or Z axis, followed by a rotation along the new Y axis of y radiants.
+      * 2DoF joint X+Z: treated as a 2DoF joint with rotation axis on the X/Z plane. The x and z values are used as the coordinates of the rotation vector in the X/Z plane.
+      * 3DoF joint X+Y+Z: treated as a revolute joint. The [x, y, z] vector represents the equivalent rotation vector to bring the joint from the rest pose to the new pose.
+
+      :type: vector [x, y, z]
+      
+      .. note::
+      
+         The bone must be part of an IK chain if you want to set the ik_dof_x/ik_dof_y/ik_dof_z attributes via the UI, but this will interfere with this attribute since the IK solver will overwrite the pose. You can stay in control of the armature if you create an IK constraint but do not finalize it (e.g. don't set a target) the IK solver will not run but the IK panel will show up on the UI for each bone in the chain.
+
+      .. note::
+      
+         [0, 0, 0] always corresponds to the rest pose.
+
+      .. note::
+      
+         You must request the armature pose to update and wait for the next graphic frame to see the effect of setting this attribute (see :data:`BL_ArmatureObject.update`).
+
+      .. note::
+      
+         You can read the result of the calculation in rotation or euler_rotation attributes after setting this attribute.

doc/python_api/rst/bge_types/bge.types.BL_ArmatureConstraint.rst

@@ -0,0 +1,126 @@
+BL_ArmatureConstraint(PyObjectPlus)
+===================================
+
+base class --- :class:`PyObjectPlus`
+
+.. class:: BL_ArmatureConstraint(PyObjectPlus)
+
+   Proxy to Armature Constraint. Allows to change constraint on the fly.
+   Obtained through :class:`BL_ArmatureObject`.constraints.
+
+   .. note::
+   
+      Not all armature constraints are supported in the GE.
+
+      
+   .. attribute:: type
+
+      Type of constraint, (read-only).
+
+      Use one of :ref:`these constants<armatureconstraint-constants-type>`.
+      
+      :type: integer, one of CONSTRAINT_TYPE_* constants
+
+   .. attribute:: name
+
+      Name of constraint constructed as <bone_name>:<constraint_name>. constraints list.
+
+      :type: string
+
+      This name is also the key subscript on :class:`BL_ArmatureObject`.
+
+   .. attribute:: enforce
+
+      fraction of constraint effect that is enforced. Between 0 and 1.
+
+      :type: float
+
+   .. attribute:: headtail
+
+      Position of target between head and tail of the target bone: 0=head, 1=tail.
+
+      :type: float.
+
+      .. note::
+      
+         Only used if the target is a bone (i.e target object is an armature.
+
+   .. attribute:: lin_error
+
+      runtime linear error (in Blender units) on constraint at the current frame.
+
+      This is a runtime value updated on each frame by the IK solver. Only available on IK constraint and iTaSC solver.
+
+      :type: float
+
+   .. attribute:: rot_error
+
+      Runtime rotation error (in radiant) on constraint at the current frame.
+
+      :type: float.
+
+      This is a runtime value updated on each frame by the IK solver. Only available on IK constraint and iTaSC solver.
+
+      It is only set if the constraint has a rotation part, for example, a CopyPose+Rotation IK constraint.
+
+   .. attribute:: target
+
+      Primary target object for the constraint. The position of this object in the GE will be used as target for the constraint.
+
+      :type: :class:`KX_GameObject`.
+
+   .. attribute:: subtarget
+
+      Secondary target object for the constraint. The position of this object in the GE will be used as secondary target for the constraint.
+
+      :type: :class:`KX_GameObject`.
+
+      Currently this is only used for pole target on IK constraint.
+
+   .. attribute:: active
+
+      True if the constraint is active.
+
+      :type: boolean
+      
+      .. note::
+      
+         An inactive constraint does not update lin_error and rot_error.
+
+   .. attribute:: ik_weight
+
+      Weight of the IK constraint between 0 and 1.
+
+      Only defined for IK constraint.
+
+      :type: float
+
+   .. attribute:: ik_type
+
+      Type of IK constraint, (read-only).
+
+      Use one of :ref:`these constants<armatureconstraint-constants-ik-type>`.
+      
+      :type: integer.
+
+   .. attribute:: ik_flag
+
+      Combination of IK constraint option flags, read-only.
+      
+      Use one of :ref:`these constants<armatureconstraint-constants-ik-flag>`.
+
+      :type: integer
+
+   .. attribute:: ik_dist
+
+      Distance the constraint is trying to maintain with target, only used when ik_type=CONSTRAINT_IK_DISTANCE.
+
+      :type: float
+
+   .. attribute:: ik_mode
+
+      Use one of :ref:`these constants<armatureconstraint-constants-ik-mode>`.
+      
+      Additional mode for IK constraint. Currently only used for Distance constraint:
+
+      :type: integer

doc/python_api/rst/bge_types/bge.types.BL_ArmatureObject.rst

@@ -0,0 +1,31 @@
+BL_ArmatureObject(KX_GameObject)
+================================
+
+base class --- :class:`KX_GameObject`
+
+.. class:: BL_ArmatureObject(KX_GameObject)
+
+   An armature object.
+
+   .. attribute:: constraints
+
+      The list of armature constraint defined on this armature.
+      Elements of the list can be accessed by index or string.
+      The key format for string access is '<bone_name>:<constraint_name>'.
+
+      :type: list of :class:`BL_ArmatureConstraint`
+
+   .. attribute:: channels
+
+      The list of armature channels.
+      Elements of the list can be accessed by index or name the bone.
+
+      :type: list of :class:`BL_ArmatureChannel`
+
+   .. method:: update()
+
+      Ensures that the armature will be updated on next graphic frame.
+
+      This action is unecessary if a KX_ArmatureActuator with mode run is active
+      or if an action is playing. Use this function in other cases. It must be called
+      on each frame to ensure that the armature is updated continously.

doc/python_api/rst/bge_types/bge.types.BL_Shader.rst

@@ -0,0 +1,227 @@
+BL_Shader(PyObjectPlus)
+=======================
+
+base class --- :class:`PyObjectPlus`
+
+.. class:: BL_Shader(PyObjectPlus)
+
+   BL_Shader GLSL shaders.
+
+   TODO - Description
+
+   .. method:: setUniformfv(name, fList)
+
+      Set a uniform with a list of float values
+
+      :arg name: the uniform name
+      :type name: string
+      :arg fList: a list (2, 3 or 4 elements) of float values
+      :type fList: list[float]
+
+   .. method:: delSource()
+
+      Clear the shader. Use this method before the source is changed with :data:`setSource`.
+
+   .. method:: getFragmentProg()
+
+      Returns the fragment program.
+
+      :return: The fragment program.
+      :rtype: string
+
+   .. method:: getVertexProg()
+
+      Get the vertex program.
+
+      :return: The vertex program.
+      :rtype: string
+
+   .. method:: isValid()
+
+      Check if the shader is valid.
+
+      :return: True if the shader is valid
+      :rtype: boolean
+
+   .. method:: setAttrib(enum)
+
+      Set attribute location. (The parameter is ignored a.t.m. and the value of "tangent" is always used.)
+
+      :arg enum: attribute location value
+      :type enum: integer
+
+   .. method:: setNumberOfPasses( max_pass )
+
+      Set the maximum number of passes. Not used a.t.m.
+
+      :arg max_pass: the maximum number of passes
+      :type max_pass: integer
+
+   .. method:: setSampler(name, index)
+
+      Set uniform texture sample index.
+
+      :arg name: Uniform name
+      :type name: string
+      :arg index: Texture sample index.
+      :type index: integer
+
+   .. method:: setSource(vertexProgram, fragmentProgram)
+
+      Set the vertex and fragment programs
+
+      :arg vertexProgram: Vertex program
+      :type vertexProgram: string
+      :arg fragmentProgram: Fragment program
+      :type fragmentProgram: string
+
+   .. method:: setUniform1f(name, fx)
+
+      Set a uniform with 1 float value.
+
+      :arg name: the uniform name
+      :type name: string
+      :arg fx: Uniform value
+      :type fx: float
+
+   .. method:: setUniform1i(name, ix)
+
+      Set a uniform with an integer value.
+
+      :arg name: the uniform name
+      :type name: string
+      :arg ix: the uniform value
+      :type ix: integer
+
+   .. method:: setUniform2f(name, fx, fy)
+
+      Set a uniform with 2 float values
+
+      :arg name: the uniform name
+      :type name: string
+      :arg fx: first float value
+      :type fx: float
+
+      :arg fy: second float value
+      :type fy: float
+
+   .. method:: setUniform2i(name, ix, iy)
+
+      Set a uniform with 2 integer values
+
+      :arg name: the uniform name
+      :type name: string
+      :arg ix: first integer value
+      :type ix: integer
+      :arg iy: second integer value
+      :type iy: integer
+
+   .. method:: setUniform3f(name, fx, fy, fz)
+
+      Set a uniform with 3 float values.
+
+      :arg name: the uniform name
+      :type name: string
+      :arg fx: first float value
+      :type fx: float
+      :arg fy: second float value
+      :type fy: float
+      :arg fz: third float value
+      :type fz: float
+
+   .. method:: setUniform3i(name, ix, iy, iz)
+
+      Set a uniform with 3 integer values
+
+      :arg name: the uniform name
+      :type name: string
+      :arg ix: first integer value
+      :type ix: integer
+      :arg iy: second integer value
+      :type iy: integer
+      :arg iz: third integer value
+      :type iz: integer
+
+   .. method:: setUniform4f(name, fx, fy, fz, fw)
+
+      Set a uniform with 4 float values.
+
+      :arg name: the uniform name
+      :type name: string
+      :arg fx: first float value
+      :type fx: float
+      :arg fy: second float value
+      :type fy: float
+      :arg fz: third float value
+      :type fz: float
+      :arg fw: fourth float value
+      :type fw: float
+
+   .. method:: setUniform4i(name, ix, iy, iz, iw)
+
+      Set a uniform with 4 integer values
+
+      :arg name: the uniform name
+      :type name: string
+      :arg ix: first integer value
+      :type ix: integer
+      :arg iy: second integer value
+      :type iy: integer
+      :arg iz: third integer value
+      :type iz: integer
+      :arg iw: fourth integer value
+      :type iw: integer
+
+   .. method:: setUniformDef(name, type)
+
+      Define a new uniform
+
+      :arg name: the uniform name
+      :type name: string
+      :arg type: uniform type
+      :type type: UNI_NONE, UNI_INT, UNI_FLOAT, UNI_INT2, UNI_FLOAT2, UNI_INT3, UNI_FLOAT3, UNI_INT4, UNI_FLOAT4, UNI_MAT3, UNI_MAT4, UNI_MAX
+
+   .. method:: setUniformMatrix3(name, mat, transpose)
+
+      Set a uniform with a 3x3 matrix value
+
+      :arg name: the uniform name
+      :type name: string
+      :arg mat: A 3x3 matrix [[f, f, f], [f, f, f], [f, f, f]]
+      :type mat: 3x3 matrix
+      :arg transpose: set to True to transpose the matrix
+      :type transpose: boolean
+
+   .. method:: setUniformMatrix4(name, mat, transpose)
+
+      Set a uniform with a 4x4 matrix value
+
+      :arg name: the uniform name
+      :type name: string
+      :arg mat: A 4x4 matrix [[f, f, f, f], [f, f, f, f], [f, f, f, f], [f, f, f, f]]
+      :type mat: 4x4 matrix
+      :arg transpose: set to True to transpose the matrix
+      :type transpose: boolean
+
+   .. method:: setUniformiv(name, iList)
+
+      Set a uniform with a list of integer values
+
+      :arg name: the uniform name
+      :type name: string
+      :arg iList: a list (2, 3 or 4 elements) of integer values
+      :type iList: list[integer]
+
+   .. method:: setUniformEyef(name)
+
+      Set a uniform with a float value that reflects the eye being render in stereo mode: 
+      0.0 for the left eye, 0.5 for the right eye. In non stereo mode, the value of the uniform
+      is fixed to 0.0. The typical use of this uniform is in stereo mode to sample stereo textures
+      containing the left and right eye images in a top-bottom order. 
+
+      :arg name: the uniform name
+      :type name: string
+
+   .. method:: validate()
+
+      Validate the shader object.

doc/python_api/rst/bge_types/bge.types.BL_ShapeActionActuator.rst

@@ -0,0 +1,68 @@
+BL_ShapeActionActuator(SCA_IActuator)
+=====================================
+
+base class --- :class:`SCA_IActuator`
+
+.. class:: BL_ShapeActionActuator(SCA_IActuator)
+
+   ShapeAction Actuators apply an shape action to an mesh object.
+
+   .. attribute:: action
+
+      The name of the action to set as the current shape action.
+
+      :type: string
+
+   .. attribute:: frameStart
+
+      Specifies the starting frame of the shape animation.
+
+      :type: float
+
+   .. attribute:: frameEnd
+
+      Specifies the ending frame of the shape animation.
+
+      :type: float
+
+   .. attribute:: blendIn
+
+      Specifies the number of frames of animation to generate when making transitions between actions.
+
+      :type: float
+
+   .. attribute:: priority
+
+      Sets the priority of this actuator. Actuators will lower priority numbers will override actuators with higher numbers.
+
+      :type: integer
+
+   .. attribute:: frame
+
+      Sets the current frame for the animation.
+
+      :type: float
+
+   .. attribute:: propName
+
+      Sets the property to be used in FromProp playback mode.
+
+      :type: string
+
+   .. attribute:: blendTime
+
+      Sets the internal frame timer. This property must be in the range from 0.0 to blendin.
+
+      :type: float
+
+   .. attribute:: mode
+
+      The operation mode of the actuator. Can be one of :ref:`these constants<action-actuator>`.
+
+      :type: integer
+
+   .. attribute:: framePropName
+
+      The name of the property that is set to the current frame number.
+
+      :type: string

doc/python_api/rst/bge_types/bge.types.CListValue.rst

@@ -0,0 +1,69 @@
+CListValue(CPropValue)
+======================
+
+base class --- :class:`CPropValue`
+
+.. class:: CListValue(CPropValue)
+
+   This is a list like object used in the game engine internally that behaves similar to a python list in most ways.
+
+   As well as the normal index lookup (``val= clist[i]``), CListValue supports string lookups (``val= scene.objects["Cube"]``)
+
+   Other operations such as ``len(clist)``, ``list(clist)``, ``clist[0:10]`` are also supported.
+
+   .. method:: append(val)
+
+      Add an item to the list (like pythons append)
+
+      .. warning::
+      
+         Appending values to the list can cause crashes when the list is used internally by the game engine.
+
+   .. method:: count(val)
+
+      Count the number of instances of a value in the list.
+
+      :return: number of instances
+      :rtype: integer
+
+   .. method:: index(val)
+
+      Return the index of a value in the list.
+
+      :return: The index of the value in the list.
+      :rtype: integer
+
+   .. method:: reverse()
+
+      Reverse the order of the list.
+
+   .. method:: get(key, default=None)
+
+      Return the value matching key, or the default value if its not found.
+
+      :return: The key value or a default.
+
+   .. method:: from_id(id)
+
+      This is a funtion especially for the game engine to return a value with a spesific id.
+
+      Since object names are not always unique, the id of an object can be used to get an object from the CValueList.
+
+      Example:
+
+      .. code-block:: python
+        
+         myObID=id(gameObject)
+         ob= scene.objects.from_id(myObID)
+
+      Where ``myObID`` is an int or long from the id function.
+
+      This has the advantage that you can store the id in places you could not store a gameObject.
+
+      .. warning::
+
+         The id is derived from a memory location and will be different each time the game engine starts.
+
+      .. warning::
+
+         The id can't be stored as an integer in game object properties, as those only have a limited range that the id may not be contained in. Instead an id can be stored as a string game property and converted back to an integer for use in from_id lookups.

doc/python_api/rst/bge_types/bge.types.CPropValue.rst

@@ -0,0 +1,8 @@
+CPropValue(CValue)
+==================
+
+base class --- :class:`CValue`
+
+.. class:: CPropValue(CValue)
+
+   This class has no python functions

doc/python_api/rst/bge_types/bge.types.CValue.rst

@@ -0,0 +1,15 @@
+CValue(PyObjectPlus)
+====================
+
+base class --- :class:`PyObjectPlus`
+
+.. class:: CValue(PyObjectPlus)
+
+   This class is a basis for other classes.
+
+   .. attribute:: name
+
+      The name of this CValue derived object (read-only).
+
+      :type: string
+      

doc/python_api/rst/bge_types/bge.types.KX_ArmatureSensor.rst

@@ -0,0 +1,34 @@
+KX_ArmatureSensor(SCA_ISensor)
+==============================
+
+base class --- :class:`SCA_ISensor`
+
+.. class:: KX_ArmatureSensor(SCA_ISensor)
+
+   Armature sensor detect conditions on armatures.
+
+   .. attribute:: type
+
+      The type of measurement that the sensor make when it is active.
+      
+      Can be one of :ref:`these constants <armaturesensor-type>`
+
+      :type: integer.
+
+   .. attribute:: constraint
+
+      The constraint object this sensor is watching.
+
+      :type: :class:`BL_ArmatureConstraint`
+
+   .. attribute:: value
+   
+      The threshold used in the comparison with the constraint error
+      The linear error is only updated on CopyPose/Distance IK constraint with iTaSC solver
+      The rotation error is only updated on CopyPose+rotation IK constraint with iTaSC solver
+      The linear error on CopyPose is always >= 0: it is the norm of the distance between the target and the bone
+      The rotation error on CopyPose is always >= 0: it is the norm of the equivalent rotation vector between the bone and the target orientations
+      The linear error on Distance can be positive if the distance between the bone and the target is greater than the desired distance, and negative if the distance is smaller.
+
+      :type: float
+      

doc/python_api/rst/bge_types/bge.types.KX_BlenderMaterial.rst

@@ -0,0 +1,182 @@
+KX_BlenderMaterial(PyObjectPlus)
+================================
+
+base class --- :class:`PyObjectPlus`
+
+.. class:: KX_BlenderMaterial(PyObjectPlus)
+
+   This is the interface to materials in the game engine.
+
+   Materials define the render state to be applied to mesh objects.
+   
+   The example below shows a simple GLSL shader setup allowing to dynamically mix two texture channels
+   in a material. All materials of the object executing this script should have two textures using
+   separate UV maps in the two first texture channels.
+   
+   The code works for both Multitexture and GLSL rendering modes.
+
+   .. code-block:: python
+
+      from bge import logic
+      
+      vertex_shader = """
+      
+      void main(void)
+      {
+         // simple projection of the vertex position to view space
+         gl_Position = gl_ModelViewProjectionMatrix * gl_Vertex;
+         // coordinate of the 1st texture channel
+         gl_TexCoord[0] = gl_MultiTexCoord0;
+         // coordinate of the 2nd texture channel
+         gl_TexCoord[1] = gl_MultiTexCoord1;
+      }
+      """
+      
+      fragment_shader ="""
+
+      uniform sampler2D texture_0;
+      uniform sampler2D texture_1;
+      uniform float factor;
+
+      void main(void)
+      {
+         vec4 color_0 = texture2D(texture_0, gl_TexCoord[0].st);
+         vec4 color_1 = texture2D(texture_1, gl_TexCoord[1].st);
+         gl_FragColor = mix(color_0, color_1, factor);
+      }
+      """
+
+      object = logic.getCurrentController().owner
+      
+      for mesh in object.meshes:
+          for material in mesh.materials:
+              shader = material.getShader()
+              if shader is not None:
+                  if not shader.isValid():
+                      shader.setSource(vertex_shader, fragment_shader, True)
+
+                  # get the first texture channel of the material
+                  shader.setSampler('texture_0', 0)
+                  # get the second texture channel of the material
+                  shader.setSampler('texture_1', 1)
+                  # pass another uniform to the shader
+                  shader.setUniform1f('factor', 0.3)
+
+   .. attribute:: shader
+
+      The material's shader.
+
+      :type: :class:`BL_Shader`
+
+   .. attribute:: blending
+
+      Ints used for pixel blending, (src, dst), matching the setBlending method.
+
+      :type: (integer, integer)
+
+   .. attribute:: material_index
+
+      The material's index.
+
+      :type: integer
+
+   .. method:: getShader()
+
+      Returns the material's shader.
+
+      :return: the material's shader
+      :rtype: :class:`BL_Shader`
+
+   .. method:: getTextureBindcode(textureslot)
+
+      Returns the material's texture OpenGL bind code/id/number/name.
+
+      :arg textureslot: Specifies the texture slot number
+      :type textureslot: integer
+      :return: the material's texture OpenGL bind code/id/number/name
+      :rtype: integer
+
+   .. attribute:: alpha
+
+      The material's alpha transparency.
+
+      :type: float between 0.0 and 1.0 inclusive
+
+   .. attribute:: hardness
+
+      How hard (sharp) the material's specular reflection is.
+
+      :type: integer between 1 and 511 inclusive
+
+   .. attribute:: emit
+
+      Amount of light to emit.
+
+      :type: float between 0.0 and 2.0 inclusive
+
+   .. attribute:: specularIntensity
+
+      How intense (bright) the material's specular reflection is.
+
+      :type: float between 0.0 and 1.0 inclusive
+
+   .. attribute:: diffuseIntensity
+
+      The material's amount of diffuse reflection.
+
+      :type: float between 0.0 and 1.0 inclusive
+
+   .. attribute:: specularColor
+
+      The material's specular color.
+
+      :type: :class:`mathutils.Color`
+
+   .. attribute:: diffuseColor
+
+      The material's diffuse color.
+
+      :type: :class:`mathutils.Color`
+
+   .. method:: setBlending(src, dest)
+
+      Set the pixel color arithmetic functions.
+
+      :arg src: Specifies how the red, green, blue, and alpha source blending factors are computed, one of...
+      
+         * :data:`~bgl.GL_ZERO`
+         * :data:`~bgl.GL_ONE`
+         * :data:`~bgl.GL_SRC_COLOR`
+         * :data:`~bgl.GL_ONE_MINUS_SRC_COLOR`
+         * :data:`~bgl.GL_DST_COLOR`
+         * :data:`~bgl.GL_ONE_MINUS_DST_COLOR`
+         * :data:`~bgl.GL_SRC_ALPHA`
+         * :data:`~bgl.GL_ONE_MINUS_SRC_ALPHA`
+         * :data:`~bgl.GL_DST_ALPHA`
+         * :data:`~bgl.GL_ONE_MINUS_DST_ALPHA`
+         * :data:`~bgl.GL_SRC_ALPHA_SATURATE`
+      
+      :type src: int
+
+      :arg dest: Specifies how the red, green, blue, and alpha destination blending factors are computed, one of...
+      
+         * :data:`~bgl.GL_ZERO`
+         * :data:`~bgl.GL_ONE`
+         * :data:`~bgl.GL_SRC_COLOR`
+         * :data:`~bgl.GL_ONE_MINUS_SRC_COLOR`
+         * :data:`~bgl.GL_DST_COLOR`
+         * :data:`~bgl.GL_ONE_MINUS_DST_COLOR`
+         * :data:`~bgl.GL_SRC_ALPHA`
+         * :data:`~bgl.GL_ONE_MINUS_SRC_ALPHA`
+         * :data:`~bgl.GL_DST_ALPHA`
+         * :data:`~bgl.GL_ONE_MINUS_DST_ALPHA`
+         * :data:`~bgl.GL_SRC_ALPHA_SATURATE`
+      
+      :type dest: int
+
+   .. method:: getMaterialIndex()
+
+      Returns the material's index.
+
+      :return: the material's index
+      :rtype: integer

doc/python_api/rst/bge_types/bge.types.KX_Camera.rst

@@ -0,0 +1,300 @@
+KX_Camera(KX_GameObject)
+========================
+
+base class --- :class:`KX_GameObject`
+
+.. class:: KX_Camera(KX_GameObject)
+
+   A Camera object.
+
+   .. data:: INSIDE
+
+      See :data:`sphereInsideFrustum` and :data:`boxInsideFrustum`
+
+   .. data:: INTERSECT
+
+      See :data:`sphereInsideFrustum` and :data:`boxInsideFrustum`
+
+   .. data:: OUTSIDE
+
+      See :data:`sphereInsideFrustum` and :data:`boxInsideFrustum`
+
+   .. attribute:: lens
+
+      The camera's lens value.
+
+      :type: float
+
+   .. attribute:: fov
+
+      The camera's field of view value.
+
+      :type: float
+
+   .. attribute:: ortho_scale
+
+      The camera's view scale when in orthographic mode.
+
+      :type: float
+
+   .. attribute:: near
+
+      The camera's near clip distance.
+
+      :type: float
+
+   .. attribute:: far
+
+      The camera's far clip distance.
+
+      :type: float
+
+   .. attribute:: shift_x
+
+      The camera's horizontal shift.
+
+      :type: float
+
+   .. attribute:: shift_y
+
+      The camera's vertical shift.
+
+      :type: float
+
+   .. attribute:: perspective
+
+      True if this camera has a perspective transform, False for an orthographic projection.
+
+      :type: boolean
+
+   .. attribute:: frustum_culling
+
+      True if this camera is frustum culling.
+
+      :type: boolean
+
+   .. attribute:: projection_matrix
+
+      This camera's 4x4 projection matrix.
+
+      .. note::
+      
+         This is the identity matrix prior to rendering the first frame (any Python done on frame 1). 
+
+      :type: 4x4 Matrix [[float]]
+
+   .. attribute:: modelview_matrix
+
+      This camera's 4x4 model view matrix. (read-only).
+
+      :type: 4x4 Matrix [[float]]
+
+      .. note::
+      
+         This matrix is regenerated every frame from the camera's position and orientation. Also, this is the identity matrix prior to rendering the first frame (any Python done on frame 1).
+
+   .. attribute:: camera_to_world
+
+      This camera's camera to world transform. (read-only).
+
+      :type: 4x4 Matrix [[float]]
+
+      .. note::
+      
+         This matrix is regenerated every frame from the camera's position and orientation.
+
+   .. attribute:: world_to_camera
+
+      This camera's world to camera transform. (read-only).
+
+      :type: 4x4 Matrix [[float]]
+
+      .. note::
+         
+         Regenerated every frame from the camera's position and orientation.
+
+      .. note::
+      
+         This is camera_to_world inverted.
+
+   .. attribute:: useViewport
+
+      True when the camera is used as a viewport, set True to enable a viewport for this camera.
+
+      :type: boolean
+
+   .. method:: sphereInsideFrustum(centre, radius)
+
+      Tests the given sphere against the view frustum.
+
+      :arg centre: The centre of the sphere (in world coordinates.)
+      :type centre: list [x, y, z]
+      :arg radius: the radius of the sphere
+      :type radius: float
+      :return: :data:`~bge.types.KX_Camera.INSIDE`, :data:`~bge.types.KX_Camera.OUTSIDE` or :data:`~bge.types.KX_Camera.INTERSECT`
+      :rtype: integer
+
+      .. note::
+
+         When the camera is first initialized the result will be invalid because the projection matrix has not been set.
+
+      .. code-block:: python
+
+         from bge import logic
+         cont = logic.getCurrentController()
+         cam = cont.owner
+         
+         # A sphere of radius 4.0 located at [x, y, z] = [1.0, 1.0, 1.0]
+         if (cam.sphereInsideFrustum([1.0, 1.0, 1.0], 4) != cam.OUTSIDE):
+             # Sphere is inside frustum !
+             # Do something useful !
+         else:
+             # Sphere is outside frustum
+
+   .. method:: boxInsideFrustum(box)
+
+      Tests the given box against the view frustum.
+
+      :arg box: Eight (8) corner points of the box (in world coordinates.)
+      :type box: list of lists
+      :return: :data:`~bge.types.KX_Camera.INSIDE`, :data:`~bge.types.KX_Camera.OUTSIDE` or :data:`~bge.types.KX_Camera.INTERSECT`
+
+      .. note::
+      
+         When the camera is first initialized the result will be invalid because the projection matrix has not been set.
+
+      .. code-block:: python
+
+         from bge import logic
+         cont = logic.getCurrentController()
+         cam = cont.owner
+
+         # Box to test...
+         box = []
+         box.append([-1.0, -1.0, -1.0])
+         box.append([-1.0, -1.0,  1.0])
+         box.append([-1.0,  1.0, -1.0])
+         box.append([-1.0,  1.0,  1.0])
+         box.append([ 1.0, -1.0, -1.0])
+         box.append([ 1.0, -1.0,  1.0])
+         box.append([ 1.0,  1.0, -1.0])
+         box.append([ 1.0,  1.0,  1.0])
+         
+         if (cam.boxInsideFrustum(box) != cam.OUTSIDE):
+           # Box is inside/intersects frustum !
+           # Do something useful !
+         else:
+           # Box is outside the frustum !
+           
+   .. method:: pointInsideFrustum(point)
+
+      Tests the given point against the view frustum.
+
+      :arg point: The point to test (in world coordinates.)
+      :type point: 3D Vector
+      :return: True if the given point is inside this camera's viewing frustum.
+      :rtype: boolean
+
+      .. note::
+      
+         When the camera is first initialized the result will be invalid because the projection matrix has not been set.
+
+      .. code-block:: python
+
+         from bge import logic
+         cont = logic.getCurrentController()
+         cam = cont.owner
+
+         # Test point [0.0, 0.0, 0.0]
+         if (cam.pointInsideFrustum([0.0, 0.0, 0.0])):
+           # Point is inside frustum !
+           # Do something useful !
+         else:
+           # Box is outside the frustum !
+
+   .. method:: getCameraToWorld()
+
+      Returns the camera-to-world transform.
+
+      :return: the camera-to-world transform matrix.
+      :rtype: matrix (4x4 list)
+
+   .. method:: getWorldToCamera()
+
+      Returns the world-to-camera transform.
+
+      This returns the inverse matrix of getCameraToWorld().
+
+      :return: the world-to-camera transform matrix.
+      :rtype: matrix (4x4 list)
+
+   .. method:: setOnTop()
+
+      Set this cameras viewport ontop of all other viewport.
+
+   .. method:: setViewport(left, bottom, right, top)
+
+      Sets the region of this viewport on the screen in pixels.
+
+      Use :data:`bge.render.getWindowHeight` and :data:`bge.render.getWindowWidth` to calculate values relative to the entire display.
+
+      :arg left: left pixel coordinate of this viewport
+      :type left: integer
+      :arg bottom: bottom pixel coordinate of this viewport
+      :type bottom: integer
+      :arg right: right pixel coordinate of this viewport
+      :type right: integer
+      :arg top: top pixel coordinate of this viewport
+      :type top: integer
+
+   .. method:: getScreenPosition(object)
+
+      Gets the position of an object projected on screen space.
+
+      .. code-block:: python
+
+         # For an object in the middle of the screen, coord = [0.5, 0.5]
+         coord = camera.getScreenPosition(object)
+
+      :arg object: object name or list [x, y, z]
+      :type object: :class:`KX_GameObject` or 3D Vector
+      :return: the object's position in screen coordinates.
+      :rtype: list [x, y]
+
+   .. method:: getScreenVect(x, y)
+
+      Gets the vector from the camera position in the screen coordinate direction.
+
+      :arg x: X Axis
+      :type x: float
+      :arg y: Y Axis
+      :type y: float
+      :rtype: 3D Vector
+      :return: The vector from screen coordinate.
+
+      .. code-block:: python
+
+         # Gets the vector of the camera front direction:
+         m_vect = camera.getScreenVect(0.5, 0.5)
+
+   .. method:: getScreenRay(x, y, dist=inf, property=None)
+
+      Look towards a screen coordinate (x, y) and find first object hit within dist that matches prop.
+      The ray is similar to KX_GameObject->rayCastTo.
+
+      :arg x: X Axis
+      :type x: float
+      :arg y: Y Axis
+      :type y: float
+      :arg dist: max distance to look (can be negative => look behind); 0 or omitted => detect up to other
+      :type dist: float
+      :arg property: property name that object must have; can be omitted => detect any object
+      :type property: string
+      :rtype: :class:`KX_GameObject`
+      :return: the first object hit or None if no object or object does not match prop
+
+      .. code-block:: python
+
+         # Gets an object with a property "wall" in front of the camera within a distance of 100:
+         target = camera.getScreenRay(0.5, 0.5, 100, "wall")
+         

doc/python_api/rst/bge_types/bge.types.KX_CameraActuator.rst

@@ -0,0 +1,44 @@
+KX_CameraActuator(SCA_IActuator)
+================================
+
+base class --- :class:`SCA_IActuator`
+
+.. class:: KX_CameraActuator(SCA_IActuator)
+
+   Applies changes to a camera.
+
+   .. attribute:: damping
+
+      strength of of the camera following movement.
+
+      :type: float
+
+   .. attribute:: axis
+
+      The camera axis (0, 1, 2) for positive ``XYZ``, (3, 4, 5) for negative ``XYZ``.
+
+      :type: int
+
+   .. attribute:: min
+
+      minimum distance to the target object maintained by the actuator.
+
+      :type: float
+
+   .. attribute:: max
+
+      maximum distance to stay from the target object.
+
+      :type: float
+
+   .. attribute:: height
+
+      height to stay above the target object.
+
+      :type: float
+
+   .. attribute:: object
+
+      the object this actuator tracks.
+
+      :type: :class:`KX_GameObject` or None

doc/python_api/rst/bge_types/bge.types.KX_CharacterWrapper.rst

@@ -0,0 +1,42 @@
+KX_CharacterWrapper(PyObjectPlus)
+=================================
+
+base class --- :class:`PyObjectPlus`
+
+.. class:: KX_CharacterWrapper(PyObjectPlus)
+
+   A wrapper to expose character physics options.
+
+   .. attribute:: onGround
+
+      Whether or not the character is on the ground. (read-only)
+
+      :type: boolean
+
+   .. attribute:: gravity
+
+      The gravity value used for the character.
+
+      :type: float
+
+   .. attribute:: maxJumps
+
+      The maximum number of jumps a character can perform before having to touch the ground. By default this is set to 1. 2 allows for a double jump, etc.
+
+      :type: int in [0, 255], default 1
+
+   .. attribute:: jumpCount
+
+      The current jump count. This can be used to have different logic for a single jump versus a double jump. For example, a different animation for the second jump.
+
+      :type: int
+
+   .. attribute:: walkDirection
+
+      The speed and direction the character is traveling in using world coordinates. This should be used instead of applyMovement() to properly move the character.
+
+      :type: Vector((x, y, z))
+
+   .. method:: jump()
+
+      The character jumps based on it's jump speed.

doc/python_api/rst/bge_types/bge.types.KX_ConstraintActuator.rst

@@ -0,0 +1,76 @@
+KX_ConstraintActuator(SCA_IActuator)
+====================================
+
+base class --- :class:`SCA_IActuator`
+
+.. class:: KX_ConstraintActuator(SCA_IActuator)
+
+   A constraint actuator limits the position, rotation, distance or orientation of an object.
+
+   .. attribute:: damp
+
+      Time constant of the constraint expressed in frame (not use by Force field constraint).
+
+      :type: integer
+
+   .. attribute:: rotDamp
+
+      Time constant for the rotation expressed in frame (only for the distance constraint), 0 = use damp for rotation as well.
+
+      :type: integer
+
+   .. attribute:: direction
+
+      The reference direction in world coordinate for the orientation constraint.
+
+      :type: 3-tuple of float: (x, y, z)
+
+   .. attribute:: option
+
+      Binary combination of :ref:`these constants <constraint-actuator-option>`
+
+      :type: integer
+
+   .. attribute:: time
+
+      activation time of the actuator. The actuator disables itself after this many frame. If set to 0, the actuator is not limited in time.
+
+      :type: integer
+
+   .. attribute:: propName
+
+      the name of the property or material for the ray detection of the distance constraint.
+
+      :type: string
+
+   .. attribute:: min
+
+      The lower bound of the constraint. For the rotation and orientation constraint, it represents radiant.
+
+      :type: float
+
+   .. attribute:: distance
+
+      the target distance of the distance constraint.
+
+      :type: float
+
+   .. attribute:: max
+
+      the upper bound of the constraint. For rotation and orientation constraints, it represents radiant.
+
+      :type: float
+
+   .. attribute:: rayLength
+
+      the length of the ray of the distance constraint.
+
+      :type: float
+
+   .. attribute:: limit
+
+      type of constraint. Use one of the :ref:`these constants <constraint-actuator-limit>`
+
+      :type: integer.
+
+      

doc/python_api/rst/bge_types/bge.types.KX_ConstraintWrapper.rst

@@ -0,0 +1,140 @@
+KX_ConstraintWrapper(PyObjectPlus)
+==================================
+
+base class --- :class:`PyObjectPlus`
+
+.. class:: KX_ConstraintWrapper(PyObjectPlus)
+
+   KX_ConstraintWrapper
+
+   .. method:: getConstraintId(val)
+
+      Returns the contraint ID
+
+      :return: the constraint ID
+      :rtype: integer
+
+   .. method:: setParam(axis, value0, value1)
+
+      Set the contraint limits
+
+      :arg axis:
+      :type axis: integer
+
+      .. note::
+         * Lowerlimit == Upperlimit -> axis is locked
+         * Lowerlimit > Upperlimit -> axis is free
+         * Lowerlimit < Upperlimit -> axis it limited in that range
+
+      For PHY_LINEHINGE_CONSTRAINT = 2 or PHY_ANGULAR_CONSTRAINT = 3:
+
+      axis = 3 is a constraint limit, with low/high limit value
+         * 3: X axis angle
+
+      :arg value0 (min): Set the minimum limit of the axis
+      :type value0: float
+      :arg value1 (max): Set the maximum limit of the axis
+      :type value1: float
+
+      For PHY_CONE_TWIST_CONSTRAINT = 4:
+
+      axis = 3..5 are constraint limits, high limit values
+         * 3: X axis angle
+         * 4: Y axis angle
+         * 5: Z axis angle
+
+      :arg value0 (min): Set the minimum limit of the axis
+      :type value0: float
+      :arg value1 (max): Set the maximum limit of the axis
+      :type value1: float
+
+      For PHY_GENERIC_6DOF_CONSTRAINT = 12:
+
+      axis = 0..2 are constraint limits, with low/high limit value
+         * 0: X axis position
+         * 1: Y axis position
+         * 2: Z axis position
+
+      axis = 3..5 are relative constraint (Euler) angles in radians
+         * 3: X axis angle
+         * 4: Y axis angle
+         * 5: Z axis angle
+
+      :arg value0 (min): Set the minimum limit of the axis
+      :type value0: float
+      :arg value1 (max): Set the maximum limit of the axis
+      :type value1: float
+
+      axis = 6..8 are translational motors, with value0=target velocity, value1 = max motor force
+         * 6: X axis position
+         * 7: Y axis position
+         * 8: Z axis position
+
+      axis = 9..11 are rotational motors, with value0=target velocity, value1 = max motor force
+         * 9: X axis angle
+         * 10: Y axis angle
+         * 11: Z axis angle
+
+      :arg value0 (speed): Set the linear velocity of the axis
+      :type value0: float Range: -10,000.00 to 10,000.00
+      :arg value1 (force): Set the maximum force limit of the axis
+      :type value1: float Range: -10,000.00 to 10,000.00
+
+      axis = 12..14 are for linear springs on each of the position of freedom
+         * 12: X axis position
+         * 13: Y axis position
+         * 14: Z axis position
+
+      axis = 15..17 are for angular springs on each of the angle of freedom in radians
+         * 15: X axis angle
+         * 16: Y axis angle
+         * 17: Z axis angle
+
+      :arg value0 (stiffness): Set the stiffness of the spring
+      :type value0: float
+      :arg value1 (damping): Tendency of the spring to return to it's original position
+      :type value1: float
+                    1.0 = springs back to original position (no damping)
+                    0.0 = don't springs back
+
+   .. method:: getParam(axis)
+
+      Get the contraint position or euler angle of a generic 6DOF constraint
+
+      :arg axis:
+      :type axis: integer
+
+      axis = 0..2 are linear constraint values
+         * 0: X axis position
+         * 1: Y axis position
+         * 2: Z axis position
+
+      :return: position
+      :rtype: float
+
+      axis = 3..5 are relative constraint (Euler) angles in radians 
+         * 3: X axis angle
+         * 4: Y axis angle
+         * 5: Z axis angle
+
+      :return: angle
+      :rtype: float
+
+   .. attribute:: constraint_id
+
+      Returns the contraint ID  (read only)
+
+      :type: integer
+
+   .. attribute:: constraint_type
+
+      Returns the contraint type (read only)
+
+      :type: integer
+
+         - :class:`~bge.constraints.POINTTOPOINT_CONSTRAINT`
+         - :class:`~bge.constraints.LINEHINGE_CONSTRAINT`
+         - :class:`~bge.constraints.ANGULAR_CONSTRAINT`
+         - :class:`~bge.constraints.CONETWIST_CONSTRAINT`
+         - :class:`~bge.constraints.VEHICLE_CONSTRAINT`
+         - :class:`~bge.constraints.GENERIC_6DOF_CONSTRAINT`

doc/python_api/rst/bge_types/bge.types.KX_FontObject.rst

@@ -0,0 +1,29 @@
+KX_FontObject(KX_GameObject)
+============================
+
+base class --- :class:`KX_GameObject`
+
+.. class:: KX_FontObject(KX_GameObject)
+
+   A Font object.
+
+   .. code-block:: python
+
+      # Display a message about the exit key using a Font object.
+      import bge
+
+      co = bge.logic.getCurrentController()
+      font = co.owner
+
+      exit_key = bge.events.EventToString(bge.logic.getExitKey())
+
+      if exit_key.endswith("KEY"):
+          exit_key = exit_key[:-3]
+
+      font.text = "Press key '%s' to quit the game." % exit_key
+
+   .. attribute:: text
+
+      The text displayed by this Font object.
+
+      :type: string

doc/python_api/rst/bge_types/bge.types.KX_GameActuator.rst

@@ -0,0 +1,20 @@
+KX_GameActuator(SCA_IActuator)
+==============================
+
+base class --- :class:`SCA_IActuator`
+
+.. class:: KX_GameActuator(SCA_IActuator)
+
+   The game actuator loads a new .blend file, restarts the current .blend file or quits the game.
+
+   .. attribute:: fileName
+
+      the new .blend file to load.
+
+      :type: string
+
+   .. attribute:: mode
+
+      The mode of this actuator. Can be on of :ref:`these constants <game-actuator>`
+
+      :type: Int

doc/python_api/rst/bge_types/bge.types.KX_LibLoadStatus.rst

@@ -0,0 +1,48 @@
+KX_LibLoadStatus(PyObjectPlus)
+==============================
+
+base class --- :class:`PyObjectPlus`
+
+.. class:: KX_LibLoadStatus(PyObjectPlus)
+
+   An object providing information about a LibLoad() operation.
+
+   .. code-block:: python
+
+      # Print a message when an async LibLoad is done
+      import bge
+
+      def finished_cb(status):
+          print("Library (%s) loaded in %.2fms." % (status.libraryName, status.timeTaken))
+
+      bge.logic.LibLoad('myblend.blend', 'Scene', async=True).onFinish = finished_cb
+
+   .. attribute:: onFinish
+
+      A callback that gets called when the lib load is done.
+
+      :type: callable
+
+   .. attribute:: finished
+
+      The current status of the lib load.
+
+      :type: boolean
+
+   .. attribute:: progress
+
+      The current progress of the lib load as a normalized value from 0.0 to 1.0.
+
+      :type: float
+
+   .. attribute:: libraryName
+
+      The name of the library being loaded (the first argument to LibLoad).
+
+      :type: string
+
+   .. attribute:: timeTaken
+
+      The amount of time, in seconds, the lib load took (0 until the operation is complete).
+
+      :type: float

doc/python_api/rst/bge_types/bge.types.KX_LightObject.rst

@@ -0,0 +1,161 @@
+KX_LightObject(KX_GameObject)
+=============================
+
+base class --- :class:`KX_GameObject`
+
+.. class:: KX_LightObject(KX_GameObject)
+
+   A Light object.
+
+   .. code-block:: python
+
+      # Turn on a red alert light.
+      import bge
+
+      co = bge.logic.getCurrentController()
+      light = co.owner
+
+      light.energy = 1.0
+      light.color = [1.0, 0.0, 0.0]
+
+   .. data:: SPOT
+
+      A spot light source. See attribute :data:`type`
+
+   .. data:: SUN
+
+      A point light source with no attenuation. See attribute :data:`type`
+
+   .. data:: NORMAL
+
+      A point light source. See attribute :data:`type`
+
+   .. attribute:: type
+
+      The type of light - must be SPOT, SUN or NORMAL
+
+   .. attribute:: layer
+
+      The layer mask that this light affects object on.
+
+      :type: bitfield
+
+   .. attribute:: energy
+
+      The brightness of this light.
+
+      :type: float
+
+   .. attribute:: shadowClipStart
+
+      The shadowmap clip start, below which objects will not generate shadows.
+
+      :type: float (read only)
+
+   .. attribute:: shadowClipEnd
+
+      The shadowmap clip end, beyond which objects will not generate shadows.
+
+      :type: float (read only)
+
+   .. attribute:: shadowFrustumSize
+
+      Size of the frustum used for creating the shadowmap.
+
+      :type: float (read only)
+
+   .. attribute:: shadowBindId
+
+      The OpenGL shadow texture bind number/id.
+
+      :type: int (read only)
+
+   .. attribute:: shadowMapType
+
+      The shadow shadow map type (0 -> Simple; 1 -> Variance)
+
+      :type: int (read only)
+
+   .. attribute:: shadowBias
+
+      The shadow buffer sampling bias.
+
+      :type: float (read only)
+
+   .. attribute:: shadowBleedBias
+
+      The bias for reducing light-bleed on variance shadow maps.
+
+      :type: float (read only)
+
+   .. attribute:: useShadow
+
+      Returns True if the light has Shadow option activated, else returns False.
+
+      :type: boolean (read only)
+
+   .. attribute:: shadowColor
+
+      The color of this light shadows. Black = (0.0, 0.0, 0.0), White = (1.0, 1.0, 1.0).
+
+      :type: :class:`mathutils.Color` (read only)
+
+   .. attribute:: shadowMatrix
+
+      Matrix that converts a vector in camera space to shadow buffer depth space.
+
+      Computed as:
+          mat4_perspective_to_depth * mat4_lamp_to_perspective * mat4_world_to_lamp * mat4_cam_to_world.
+
+      mat4_perspective_to_depth is a fixed matrix defined as follow:
+
+         0.5 0.0 0.0 0.5
+         0.0 0.5 0.0 0.5
+         0.0 0.0 0.5 0.5
+         0.0 0.0 0.0 1.0
+
+      .. note:
+
+         There is one matrix of that type per lamp casting shadow in the scene.
+
+      :type: Matrix4x4 (read only)
+
+   .. attribute:: distance
+
+      The maximum distance this light can illuminate. (SPOT and NORMAL lights only).
+
+      :type: float
+
+   .. attribute:: color
+
+      The color of this light. Black = [0.0, 0.0, 0.0], White = [1.0, 1.0, 1.0].
+
+      :type: list [r, g, b]
+
+   .. attribute:: lin_attenuation
+
+      The linear component of this light's attenuation. (SPOT and NORMAL lights only).
+
+      :type: float
+
+   .. attribute:: quad_attenuation
+
+      The quadratic component of this light's attenuation (SPOT and NORMAL lights only).
+
+      :type: float
+
+   .. attribute:: spotsize
+
+      The cone angle of the spot light, in degrees (SPOT lights only).
+
+      :type: float in [0 - 180].
+
+   .. attribute:: spotblend
+
+      Specifies the intensity distribution of the spot light (SPOT lights only).
+
+      :type: float in [0 - 1]
+
+      .. note::
+         
+         Higher values result in a more focused light source.

doc/python_api/rst/bge_types/bge.types.KX_MeshProxy.rst

@@ -0,0 +1,131 @@
+KX_MeshProxy(SCA_IObject)
+=========================
+
+base class --- :class:`SCA_IObject`
+
+.. class:: KX_MeshProxy(SCA_IObject)
+
+   A mesh object.
+
+   You can only change the vertex properties of a mesh object, not the mesh topology.
+
+   To use mesh objects effectively, you should know a bit about how the game engine handles them.
+
+   #. Mesh Objects are converted from Blender at scene load.
+   #. The Converter groups polygons by Material.  This means they can be sent to the renderer efficiently.  A material holds:
+
+      #. The texture.
+      #. The Blender material.
+      #. The Tile properties
+      #. The face properties - (From the "Texture Face" panel)
+      #. Transparency & z sorting
+      #. Light layer
+      #. Polygon shape (triangle/quad)
+      #. Game Object
+
+   #. Vertices will be split by face if necessary.  Vertices can only be shared between faces if:
+
+      #. They are at the same position
+      #. UV coordinates are the same
+      #. Their normals are the same (both polygons are "Set Smooth")
+      #. They are the same color, for example: a cube has 24 vertices: 6 faces with 4 vertices per face.
+
+   The correct method of iterating over every :class:`KX_VertexProxy` in a game object
+   
+   .. code-block:: python
+
+      from bge import logic
+
+      cont = logic.getCurrentController()
+      object = cont.owner
+
+      for mesh in object.meshes:
+         for m_index in range(len(mesh.materials)):
+            for v_index in range(mesh.getVertexArrayLength(m_index)):
+               vertex = mesh.getVertex(m_index, v_index)
+               # Do something with vertex here...
+               # ... eg: color the vertex red.
+               vertex.color = [1.0, 0.0, 0.0, 1.0]
+
+   .. attribute:: materials
+
+      :type: list of :class:`KX_BlenderMaterial` type
+
+   .. attribute:: numPolygons
+
+      :type: integer
+
+   .. attribute:: numMaterials
+
+      :type: integer
+
+   .. method:: getMaterialName(matid)
+
+      Gets the name of the specified material.
+
+      :arg matid: the specified material.
+      :type matid: integer
+      :return: the attached material name.
+      :rtype: string
+
+   .. method:: getTextureName(matid)
+
+      Gets the name of the specified material's texture.
+
+      :arg matid: the specified material
+      :type matid: integer
+      :return: the attached material's texture name.
+      :rtype: string
+
+   .. method:: getVertexArrayLength(matid)
+
+      Gets the length of the vertex array associated with the specified material.
+
+      There is one vertex array for each material.
+
+      :arg matid: the specified material
+      :type matid: integer
+      :return: the number of verticies in the vertex array.
+      :rtype: integer
+
+   .. method:: getVertex(matid, index)
+
+      Gets the specified vertex from the mesh object.
+
+      :arg matid: the specified material
+      :type matid: integer
+      :arg index: the index into the vertex array.
+      :type index: integer
+      :return: a vertex object.
+      :rtype: :class:`KX_VertexProxy`
+
+   .. method:: getPolygon(index)
+
+      Gets the specified polygon from the mesh.
+
+      :arg index: polygon number
+      :type index: integer
+      :return: a polygon object.
+      :rtype: :class:`KX_PolyProxy`
+
+   .. method:: transform(matid, matrix)
+
+      Transforms the vertices of a mesh.
+
+      :arg matid: material index, -1 transforms all.
+      :type matid: integer
+      :arg matrix: transformation matrix.
+      :type matrix: 4x4 matrix [[float]]
+
+   .. method:: transformUV(matid, matrix, uv_index=-1, uv_index_from=-1)
+
+      Transforms the vertices UV's of a mesh.
+
+      :arg matid: material index, -1 transforms all.
+      :type matid: integer
+      :arg matrix: transformation matrix.
+      :type matrix: 4x4 matrix [[float]]
+      :arg uv_index: optional uv index, -1 for all, otherwise 0 or 1.
+      :type uv_index: integer
+      :arg uv_index_from: optional uv index to copy from, -1 to transform the current uv.
+      :type uv_index_from: integer

doc/python_api/rst/bge_types/bge.types.KX_MouseActuator.rst

@@ -0,0 +1,100 @@
+KX_MouseActuator(SCA_IActuator)
+====================================
+
+base class --- :class:`SCA_IActuator`
+
+.. class:: KX_MouseActuator(SCA_IActuator)
+
+   The mouse actuator gives control over the visibility of the mouse cursor and rotates the parent object according to mouse movement.
+
+   .. method:: reset()
+
+      Undoes the rotation caused by the mouse actuator.
+
+   .. attribute:: visible
+
+      The visibility of the mouse cursor.
+
+      :type: boolean
+
+   .. attribute:: use_axis_x
+
+      Mouse movement along the x axis effects object rotation.
+
+      :type: boolean
+
+   .. attribute:: use_axis_y
+
+      Mouse movement along the y axis effects object rotation.
+
+      :type: boolean
+
+   .. attribute:: threshold
+
+      Amount of movement from the mouse required before rotation is triggered.
+
+      :type: list (vector of 2 floats)
+
+      The values in the list should be between 0.0 and 0.5.
+
+   .. attribute:: reset_x
+
+      Mouse is locked to the center of the screen on the x axis.
+
+      :type: boolean
+
+   .. attribute:: reset_y
+
+      Mouse is locked to the center of the screen on the y axis.
+
+      :type: boolean
+
+   .. attribute:: object_axis
+
+      The object's 3D axis to rotate with the mouse movement. ([x, y])
+
+      :type: list (vector of 2 integers from 0 to 2)
+
+      * KX_ACT_MOUSE_OBJECT_AXIS_X
+      * KX_ACT_MOUSE_OBJECT_AXIS_Y
+      * KX_ACT_MOUSE_OBJECT_AXIS_Z
+
+   .. attribute:: local_x
+
+      Rotation caused by mouse movement along the x axis is local.
+
+      :type: boolean
+
+   .. attribute:: local_y
+
+      Rotation caused by mouse movement along the y axis is local.
+
+      :type: boolean
+
+   .. attribute:: sensitivity
+
+      The amount of rotation caused by mouse movement along the x and y axis.
+
+      :type: list (vector of 2 floats)
+
+      Negative values invert the rotation.
+
+   .. attribute:: limit_x
+
+      The minimum and maximum angle of rotation caused by mouse movement along the x axis in degrees.
+      limit_x[0] is minimum, limit_x[1] is maximum.
+
+      :type: list (vector of 2 floats)
+
+   .. attribute:: limit_y
+
+      The minimum and maximum angle of rotation caused by mouse movement along the y axis in degrees.
+      limit_y[0] is minimum, limit_y[1] is maximum.
+
+      :type: list (vector of 2 floats)
+
+   .. attribute:: angle
+
+      The current rotational offset caused by the mouse actuator in degrees.
+
+      :type: list (vector of 2 floats)

doc/python_api/rst/bge_types/bge.types.KX_MouseFocusSensor.rst

@@ -0,0 +1,81 @@
+KX_MouseFocusSensor(SCA_MouseSensor)
+====================================
+
+base class --- :class:`SCA_MouseSensor`
+
+.. class:: KX_MouseFocusSensor(SCA_MouseSensor)
+
+   The mouse focus sensor detects when the mouse is over the current game object.
+
+   The mouse focus sensor works by transforming the mouse coordinates from 2d device
+   space to 3d space then raycasting away from the camera.
+
+   .. attribute:: raySource
+
+      The worldspace source of the ray (the view position).
+
+      :type: list (vector of 3 floats)
+
+   .. attribute:: rayTarget
+
+      The worldspace target of the ray.
+
+      :type: list (vector of 3 floats)
+
+   .. attribute:: rayDirection
+
+      The :data:`rayTarget` - :class:`raySource` normalized.
+
+      :type: list (normalized vector of 3 floats)
+
+   .. attribute:: hitObject
+
+      the last object the mouse was over.
+
+      :type: :class:`KX_GameObject` or None
+
+   .. attribute:: hitPosition
+
+      The worldspace position of the ray intersecton.
+
+      :type: list (vector of 3 floats)
+
+   .. attribute:: hitNormal
+
+      the worldspace normal from the face at point of intersection.
+
+      :type: list (normalized vector of 3 floats)
+
+   .. attribute:: hitUV
+
+      the UV coordinates at the point of intersection.
+
+      :type: list (vector of 2 floats)
+
+      If the object has no UV mapping, it returns [0, 0].
+
+      The UV coordinates are not normalized, they can be < 0 or > 1 depending on the UV mapping.
+
+   .. attribute:: usePulseFocus
+
+      When enabled, moving the mouse over a different object generates a pulse. (only used when the 'Mouse Over Any' sensor option is set).
+
+      :type: boolean
+
+   .. attribute:: useXRay
+
+      If enabled it allows the sensor to see through game objects that don't have the selected property or material.
+
+     :type: boolean
+
+   .. attribute:: propName
+
+      The property or material the sensor is looking for.
+
+     :type: string
+
+   .. attribute:: useMaterial
+
+      Determines if the sensor is looking for a property or material. KX_True = Find material; KX_False = Find property.
+
+     :type: boolean

doc/python_api/rst/bge_types/bge.types.KX_NavMeshObject.rst

@@ -0,0 +1,44 @@
+KX_NavMeshObject(KX_GameObject)
+===============================
+
+base class --- :class:`KX_GameObject`
+
+.. class:: KX_NavMeshObject(KX_GameObject)
+
+   Python interface for using and controlling navigation meshes. 
+
+   .. method:: findPath(start, goal)
+
+      Finds the path from start to goal points.
+
+      :arg start: the start point
+      :arg start: 3D Vector
+      :arg goal: the goal point
+      :arg start: 3D Vector
+      :return: a path as a list of points
+      :rtype: list of points
+
+   .. method:: raycast(start, goal)
+
+      Raycast from start to goal points.
+
+      :arg start: the start point
+      :arg start: 3D Vector
+      :arg goal: the goal point
+      :arg start: 3D Vector
+      :return: the hit factor
+      :rtype: float
+
+   .. method:: draw(mode)
+
+      Draws a debug mesh for the navigation mesh.
+
+      :arg mode: the drawing mode (one of :ref:`these constants <navmesh-draw-mode>`)
+      :arg mode: integer
+      :return: None
+
+   .. method:: rebuild()
+
+      Rebuild the navigation mesh.
+
+      :return: None

doc/python_api/rst/bge_types/bge.types.KX_NearSensor.rst

@@ -0,0 +1,20 @@
+KX_NearSensor(KX_TouchSensor)
+=============================
+
+base class --- :class:`KX_TouchSensor`
+
+.. class:: KX_NearSensor(KX_TouchSensor)
+
+   A near sensor is a specialised form of touch sensor.
+
+   .. attribute:: distance
+
+      The near sensor activates when an object is within this distance.
+
+      :type: float
+
+   .. attribute:: resetDistance
+
+      The near sensor deactivates when the object exceeds this distance.
+
+      :type: float

doc/python_api/rst/bge_types/bge.types.KX_NetworkMessageActuator.rst

@@ -0,0 +1,32 @@
+KX_NetworkMessageActuator(SCA_IActuator)
+========================================
+
+base class --- :class:`SCA_IActuator`
+
+.. class:: KX_NetworkMessageActuator(SCA_IActuator)
+
+   Message Actuator
+
+   .. attribute:: propName
+
+      Messages will only be sent to objects with the given property name.
+
+      :type: string
+
+   .. attribute:: subject
+
+      The subject field of the message.
+
+      :type: string
+
+   .. attribute:: body
+
+      The body of the message.
+
+      :type: string
+
+   .. attribute:: usePropBody
+
+      Send a property instead of a regular body message.
+
+      :type: boolean