diff options
author | Aaron Carlisle <carlisle.b3d@gmail.com> | 2020-10-12 01:21:28 +0300 |
---|---|---|
committer | Aaron Carlisle <carlisle.b3d@gmail.com> | 2020-10-12 01:21:28 +0300 |
commit | 72335d5e89d9ecae5f08ab0d4076235a7f6b5f06 (patch) | |
tree | 6782f3ee6685c2ae580078f52ade1a6f98768108 /source | |
parent | 1b575cbb75c3cfd402374a876c2e900f31dda791 (diff) |
Pydoc: Move builtin GPU shader information to code
This fixes a compile warning for sphinx.
This commit includes some reformating of the information.
Diffstat (limited to 'source')
-rw-r--r-- | source/blender/python/gpu/gpu_py_shader.c | 29 |
1 files changed, 28 insertions, 1 deletions
diff --git a/source/blender/python/gpu/gpu_py_shader.c b/source/blender/python/gpu/gpu_py_shader.c index 7734c80abc4..3748691c434 100644 --- a/source/blender/python/gpu/gpu_py_shader.c +++ b/source/blender/python/gpu/gpu_py_shader.c @@ -748,7 +748,34 @@ static struct PyMethodDef bpygpu_shader_module_methods[] = { }; PyDoc_STRVAR(bpygpu_shader_module_doc, - "This module provides access to GPUShader internal functions."); + "This module provides access to GPUShader internal functions.\n" + "\n" + ".. rubric:: Built-in shaders\n" + "\n" + "All built-in shaders have the ``mat4 ModelViewProjectionMatrix`` uniform.\n" + "The value of it can only be modified using the :class:`gpu.matrix` module.\n" + "\n" + "2D_UNIFORM_COLOR\n" + " :Attributes: vec3 pos\n" + " :Uniforms: vec4 color\n" + "2D_FLAT_COLOR\n" + " :Attributes: vec3 pos, vec4 color\n" + " :Uniforms: none\n" + "2D_SMOOTH_COLOR\n" + " :Attributes: vec3 pos, vec4 color\n" + " :Uniforms: none\n" + "2D_IMAGE\n" + " :Attributes: vec3 pos, vec2 texCoord\n" + " :Uniforms: sampler2D image\n" + "3D_UNIFORM_COLOR\n" + " :Attributes: vec3 pos\n" + " :Uniforms: vec4 color\n" + "3D_FLAT_COLOR\n" + " :Attributes: vec3 pos, vec4 color\n" + " :Uniforms: none\n" + "3D_SMOOTH_COLOR\n" + " :Attributes: vec3 pos, vec4 color\n" + " :Uniforms: none\n"); static PyModuleDef BPyGPU_shader_module_def = { PyModuleDef_HEAD_INIT, .m_name = "gpu.shader", |