Tom Rothamel
e1b8de8512
Assimp was contributing a lot of to the size of Ren'Py, so put it on a diet and removed all the formats except for GLTF). This would also let us switch toanother GLTF parser in the future.
621 lines
24 KiB
ReStructuredText
621 lines
24 KiB
ReStructuredText
.. _model:
|
|
|
|
Model-Based Rendering
|
|
=====================
|
|
|
|
While Ren'Py is primarily used with two dimensional rectangular images that
|
|
are common in visual novels, underneath the hood it has a model-based renderer
|
|
intended to to take advantage of features found in modern GPUs. This allows
|
|
for a number of visual effects that would not otherwise be possible.
|
|
|
|
As a warning, this is one of the most advanced features available in Ren'Py.
|
|
In many cases, it's not necessary to understand how model-based rendering
|
|
works behind the scenes - features like :tpref:`matrixcolor` and Live2D support
|
|
can be used without understanding how Model-Based rendering works, and more
|
|
such features will be added to the understanding. This documentation is
|
|
intended for very advanced creators, and for developers looking to add
|
|
to Ren'Py itself.
|
|
|
|
Model-Based Rendering is one of the most advanced features in Ren'Py, and
|
|
this documentation may be hard to understand without first looking at the
|
|
OpenGL, OpenGL ES, GLSL, and GLSL ES manual. What's more, since there are
|
|
portions of the models that are passed directly to your GPU drivers, which
|
|
may accept erroneous inputs, it's important to check on multiple kinds of
|
|
hardware.
|
|
|
|
|
|
Models, Renders, and Drawing Operations
|
|
---------------------------------------
|
|
|
|
The fundamental thing that Ren'Py draws to the screen is a Model. A model
|
|
consists of the following things:
|
|
|
|
* A Mesh of one or more triangles. A triangle consists of
|
|
three vertices (corners), each of which contains a position in two or
|
|
three-dimensional space, and may contain additional information, most
|
|
commonly texture coordinates.
|
|
|
|
* Zero or more textures, with the precise number allowed being limited by the
|
|
GPUs your game can run on. All GPUs should support at least three textures
|
|
per model. A texture is a rectangle containing image data that's been loaded
|
|
on the GPU, either directly or using a render-to-texture operation.
|
|
|
|
* A list of shader part names. Ren'Py uses these shader parts to create shaders,
|
|
which are programs that are run on the GPU to render the model. Shader part
|
|
names can be prefixed with a "-" to prevent that shader part from being used.
|
|
|
|
* Uniform values. A uniform is additional data that is the same throughout the
|
|
model. For example, when a model represents a solid color, the color is a
|
|
uniform.
|
|
|
|
* GL properties. GL properties are flags that further control how things
|
|
are rendered, such as the minification/magnification modes and the
|
|
color mask.
|
|
|
|
As Ren'Py usually draws more than one thing to the screen, it creates a
|
|
tree of :class:`Render` objects. These Render objects may have Models or
|
|
other Renders as children. (A Render object can also be turned into a Model.
|
|
as described below.) A Render contains:
|
|
|
|
* A list of children, including a 2-dimensional offset that is applied to
|
|
each child.
|
|
|
|
* A :class:`Matrix` that describes how the children are transformed in
|
|
three-dimensional space.
|
|
|
|
* Lists of shader part names, uniforms, and GL properties that are applied
|
|
to the Models when being drawn.
|
|
|
|
* Flags that determine if the drawable-space clipping polygon should be
|
|
updated.
|
|
|
|
Ren'Py draws the screen by performing a depth-first walk through the tree of
|
|
Renders, until a Model is encountered. During this walk, Ren'Py updates a
|
|
matrix transforming the location of the Model, a clipping polygon, and
|
|
lists of shader parts, uniforms, and GL properties. When a Model is encountered
|
|
as part of this walk, the appropriate shader program is activated on the GPU,
|
|
all information is transferred, and a drawing operation occurs.
|
|
|
|
|
|
Where Models are Created
|
|
------------------------
|
|
|
|
Ren'Py creates Models automatically as part of its normal operation.
|
|
The main reason to understand where models are created is that models
|
|
correspond to drawing operations, and hence are the units that shaders
|
|
are applied to.
|
|
|
|
Images and Image Manipulators
|
|
These create a model with a mesh containing two triangles that cover
|
|
the rectangle of the image. The mesh contains texture coordinates.
|
|
The model uses the "renpy.texture" shader.
|
|
|
|
:func:`Solid`
|
|
The Solid displayable creates a mesh containing two triangles, and no
|
|
texture coordinates. The model uses the "renpy.solid" shader,
|
|
with the color placed in the ``u_renpy_solid_color`` uniform.
|
|
|
|
:func:`Dissolve`, :func:`ImageDissolve`, :func:`AlphaDissolve`, :func:`Pixellate`, :func:`AlphaMask`, :func:`Flatten`
|
|
Each of these transforms and displayables creates a Model with a mesh,
|
|
shaders, and uniforms as is needed for its purposes.
|
|
|
|
Live2D
|
|
Live2D displayables may created multiple Models when rendered, generally
|
|
one Model for each layer.
|
|
|
|
:func:`Transform` and ATL
|
|
A Transform creates a model if :tpref:`mesh` is True, or if :tpref:`blur`
|
|
is being used. In this case, the children of the Transform are rendered
|
|
to textures, with the mesh of the first texture being used for the mesh
|
|
associated with the model.
|
|
|
|
Not every transform creates a Model. Some transforms will simply add
|
|
shaders and uniforms to a Render (such as transforms that use
|
|
:tpref:`blur` or :tpref:`alpha`). Other transforms simply affect
|
|
geometry.
|
|
|
|
:class:`Render`
|
|
A Transform creates a model if its ``mesh`` attribute is True.
|
|
In this case, the children of the Render are rendered to
|
|
textures, with the mesh of the first texture being used for
|
|
the mesh associated with the model.
|
|
|
|
It's expected that Ren'Py will add more ways of creating models in the
|
|
future.
|
|
|
|
Shader Program Generation
|
|
-------------------------
|
|
|
|
Ren'Py generates a shader program by first assembling a list of shader part
|
|
names. This list consists of "renpy.geometry", the list of shader parts
|
|
taken from Renders, and the list of shader parts found in the Model being
|
|
drawn.
|
|
|
|
The shader parts are then deduplicated. If a shader part begins with "-",
|
|
it is removed from the list, as is the rest of that part without the
|
|
leading "-". (So "-renpy.geometry" will cause itself and "renpy.geometry"
|
|
to be removed.)
|
|
|
|
Ren'Py then takes the list of shader parts, and retrieves lists of variables,
|
|
functions, vertex shader parts, and fragment shader parts. These are, in turn,
|
|
used to generate the source code for shaders, with the parts of the vertex and
|
|
fragment shaders being included in low-number to high-number priority order.
|
|
|
|
This means that any variable created by one of the shaders will be accessible
|
|
by every other fragment from any other shader in the list of shader parts.
|
|
There is no scope like in Python functions to protect interference between
|
|
shaders.
|
|
|
|
Ren'Py keeps a cache of all combinations of shader parts that have ever been
|
|
used in game/cache/shaders.txt, and loads them at startup. If major changes
|
|
in shader use occur, this file should be edited or deleted so it can be
|
|
re-created with valid data.
|
|
|
|
|
|
.. _custom-shaders:
|
|
|
|
Creating a Custom Shader
|
|
-------------------------
|
|
|
|
New shader parts can be created by calling the renpy.register_shader
|
|
function and supplying portions of GLSL shaders.
|
|
|
|
Generally, shader parts should be of the form "namespace.part", such as
|
|
"mygame.recolor" or "mylibrary.warp". Names beginning with "renpy." or
|
|
"live2d." are reserved for Ren'Py, as are names beginning with _.
|
|
|
|
.. include:: inc/register_shader
|
|
|
|
Ren'Py supports only the following variable types:
|
|
|
|
* float (a Python float)
|
|
* vec2 (a tuple of 2 floats)
|
|
* vec3 (a tuple of 3 floats)
|
|
* vec4 (a tuple of 4 floats)
|
|
* mat2 (a :class:`Matrix`)
|
|
* mat3 (a :class:`Matrix`)
|
|
* mat4 (a :class:`Matrix`)
|
|
* sampler2D (supplied by Ren'Py)
|
|
|
|
Uniform variables should begin with u\_, attributes with a\_, and varying
|
|
variables with v\_. Names starting with u_renpy\_, a_renpy, and v_renpy
|
|
are reserved, as are the standard variables given below.
|
|
|
|
As a general sketch for priority levels, priority 100 sets up geometry,
|
|
priority 200 determines the initial fragment color (gl_FragColor), and
|
|
higher-numbered priorities can apply effects to alter that color.
|
|
|
|
Here's an example of a custom shader part that applies a gradient across
|
|
each model it is used to render::
|
|
|
|
init python:
|
|
|
|
renpy.register_shader("example.gradient", variables="""
|
|
uniform vec4 u_gradient_left;
|
|
uniform vec4 u_gradient_right;
|
|
uniform vec2 u_model_size;
|
|
varying float v_gradient_done;
|
|
attribute vec4 a_position;
|
|
""", vertex_300="""
|
|
v_gradient_done = a_position.x / u_model_size.x;
|
|
""", fragment_300="""
|
|
float gradient_done = v_gradient_done;
|
|
gl_FragColor *= mix(u_gradient_left, u_gradient_right, gradient_done);
|
|
""")
|
|
|
|
The custom shader can then be applied using a transform::
|
|
|
|
transform gradient:
|
|
shader "example.gradient"
|
|
u_gradient_left (1.0, 0.0, 0.0, 1.0)
|
|
u_gradient_right (0.0, 0.0, 1.0, 1.0)
|
|
|
|
show eileen happy at gradient
|
|
|
|
As stated before, the ``gradient_done`` variable from the example.gradient shader
|
|
will be accessible by any and all other shaders applied from the same list. This
|
|
can be useful when having optional parts in a given shader system, but it can also
|
|
lead to name collisions when using two independent shaders.
|
|
|
|
There is a variable that can help in debugging custom shaders:
|
|
|
|
.. var:: config.log_gl_shaders = False
|
|
|
|
If true, source code for the GLSL shader programs will be written to
|
|
log.txt on start.
|
|
|
|
|
|
.. _shader-local-variables:
|
|
|
|
Shader Part Local Variables
|
|
---------------------------
|
|
|
|
Variables can be declared shader-local by using one of ``u__``, ``a__``,
|
|
``v__``, or ``l__`` as a prefix. When this is done, the double underscores
|
|
are filled in with the shader name with all dots replaced with underscores.
|
|
For example, if the shader name is ``example.gradient``, the prefix
|
|
``u__`` will be replaced with ``u_example_gradient_``.
|
|
|
|
The main use of this is with :doc:`text shaders <textshaders>`, where most
|
|
uniforms are shader-local. Also, local variables inside the shader should
|
|
be declared with ``l__``.
|
|
|
|
|
|
Transforms and Model-Based Rendering
|
|
------------------------------------
|
|
|
|
Model-Based rendering adds the following properties to ATL and :func:`Transform`:
|
|
|
|
.. transform-property:: mesh
|
|
|
|
:type: None or True or tuple
|
|
:default: None
|
|
|
|
If not None, this Transform will be rendered as a model. This means:
|
|
|
|
* A mesh will be created. If this is a 2-component tuple, it's taken
|
|
as the number of points in the mesh, in the x and y directions. (Each
|
|
dimension must be at least 2.) If True, the mesh is taken from the
|
|
child.
|
|
* The child of this transform will be rendered to a texture.
|
|
* The renpy.texture shader will be added.
|
|
|
|
.. transform-property:: mesh_pad
|
|
|
|
:type: None or tuple
|
|
:default: None
|
|
|
|
If not None, this can either be a 2 or 4-component tuple. If mesh is
|
|
True and this is given, this applies padding to the size of the textures
|
|
applied to the textures used by the mesh. A 2-component tuple applies
|
|
padding to the right and bottom, while a 4-component tuple applies
|
|
padding to the left, top, right, and bottom.
|
|
|
|
This can be used, in conjunction with the ``gl_pixel_perfect`` property,
|
|
to render text into a mesh. In Ren'Py, text is rendered at the screen
|
|
resolution, which might overflow the boundaries of the texture that
|
|
will be applied to the mesh. Adding a few pixels of padding makes the
|
|
texture bigger, which will display all pixels. For example::
|
|
|
|
transform adjust_text:
|
|
mesh True
|
|
mesh_pad (10, 0)
|
|
gl_pixel_perfect True
|
|
shader "shaders.adjust_text"
|
|
|
|
will ensure that the texture passed to the shader contains all of the pixels
|
|
of the text.
|
|
|
|
.. transform-property:: shader
|
|
|
|
:type: None or str or list of str
|
|
:default: None
|
|
|
|
If not None, a shader part name or list of shader part names that will be
|
|
applied to this Render (if a Model is created) or the Models reached
|
|
through this Render.
|
|
|
|
.. transform-property:: blend
|
|
|
|
:type: None or str
|
|
:default: None
|
|
|
|
if not None, this should be a string. This string is looked up in
|
|
:var:`config.gl_blend_func` to get the value for the gl_blend_func
|
|
property. It's used to use alternate blend modes.
|
|
|
|
The default blend modes this supports are "normal", "add", "multiply",
|
|
"min", and "max".
|
|
|
|
|
|
In addition, uniforms that start with u\_ but not with u_renpy are made available
|
|
as Transform properties. GL properties are made available as transform
|
|
properties starting with gl\_. For example, the color_mask property is made
|
|
available as gl_color_mask.
|
|
|
|
Blend Functions
|
|
---------------
|
|
|
|
.. var:: config.gl_blend_func = { ... }
|
|
|
|
A dictionary used to map a blend mode name to a blend function. The
|
|
blend modes are supplied to the :ref:`gl_blend_func <gl-blend-func>` property, given below.
|
|
|
|
The default blend modes are::
|
|
|
|
gl_blend_func["normal"] = (GL_FUNC_ADD, GL_ONE, GL_ONE_MINUS_SRC_ALPHA, GL_FUNC_ADD, GL_ONE, GL_ONE_MINUS_SRC_ALPHA)
|
|
gl_blend_func["add"] = (GL_FUNC_ADD, GL_ONE, GL_ONE, GL_FUNC_ADD, GL_ZERO, GL_ONE)
|
|
gl_blend_func["multiply"] = (GL_FUNC_ADD, GL_DST_COLOR, GL_ONE_MINUS_SRC_ALPHA, GL_FUNC_ADD, GL_ZERO, GL_ONE)
|
|
gl_blend_func["min"] = (GL_MIN, GL_ONE, GL_ONE, GL_MIN, GL_ONE, GL_ONE)
|
|
gl_blend_func["max"] = (GL_MAX, GL_ONE, GL_ONE, GL_MAX, GL_ONE, GL_ONE)
|
|
|
|
As Ren'Py uses premultiplied alpha, the results of some of these may be counterintuitive when a pixel
|
|
is not opaque. In the GPU, the color (r, g, b, a) is represented as (r * a, g * a, b * a, a), and the blend function
|
|
uses these premultiplied colors. This may be a different result that you get for these blend modes in a paint program,
|
|
when what is drawn is not fully opaque.
|
|
|
|
.. _model-uniforms:
|
|
|
|
Float, Sample, and Vector Uniforms
|
|
-----------------------------------
|
|
|
|
The following uniforms are made available to all models.
|
|
|
|
``vec2 u_model_size``
|
|
The width and height of the model, as supplied to Ren'Py. This
|
|
is only available for 2D models that supply a size, and is (0, 0)
|
|
for 3d models.
|
|
|
|
.. _u-lod-bias:
|
|
|
|
``float u_lod_bias``
|
|
The level of detail bias to apply to texture lookups. This may be
|
|
set in a Transform. The default value, taken from :var:`config.gl_lod_bias`
|
|
and defaulting to -0.5, biases Ren'Py to always pick the next bigger
|
|
level and scale it down.
|
|
|
|
``float u_time``
|
|
The time of the frame. The epoch is undefined, so it's best to treat
|
|
this as a number that increases by one second a second. The time is
|
|
modulo 86400, so it will reset to 0.0 once a day.
|
|
|
|
``vec4 u_random``
|
|
Four random numbers between 0.0 and 1.0 that are (with incredibly high
|
|
likelyhood) different from frame to frame.
|
|
|
|
``vec4 u_viewport``
|
|
This gives the current viewport being drawn into. u_viewport.xy is
|
|
are the coordinates of the bottom-left corner of the viewport, relative
|
|
to the bottom-left corner of the window. u_viewport.pq is the width
|
|
and height of the viewport.
|
|
|
|
``vec2 u_virtual_size``
|
|
|
|
This is the virtual size of the game (:var:`config.screen_width`, :var:`config.screen_height`).
|
|
This can be used to convert from gl_Position to virtual coordinates using:
|
|
|
|
.. code-block:: glsl
|
|
|
|
v_position = u_virtual_size * vec2(gl_Position.x * .5 + .5, -gl_Position.y * .5 + .5)
|
|
|
|
``vec2 u_drawable_size``
|
|
The size of the drawable are of the windows, in pixels, at the resolution
|
|
the game is running at. For example, if a 1280x720 game is scaled up to
|
|
1980x1080, this will be (1920, 1080).
|
|
|
|
``sampler2D tex0``, ``sampler2D tex1``, ``sampler2D tex2``
|
|
If textures are available, the corresponding samplers are placed in
|
|
this variable.
|
|
|
|
``vec2 res0``, ``vec2 res1``, ``vec2 res2``
|
|
If textures are available, the size of the textures are placed in these
|
|
variables. When the texture is loaded from disk, this is the size of the
|
|
image file. After a render to texture, it's the number of drawable pixels
|
|
the rendered texture covered.
|
|
|
|
Matrix Uniforms
|
|
----------------
|
|
|
|
The following uniforms are made available to all models. This assumes that only one transform with the
|
|
:tpref:`perspective` property is used to render a model. When multiple transforms with the :tpref:`perspective`
|
|
are used, the innermost transformation with perspective set defines the world and view spaces.
|
|
|
|
``mat4 u_projection``
|
|
This is a matrix that transforms coordinates from view space to the OpenGL viewport.
|
|
This is sent by Ren'Py, and is updated by transforms with the :tpref:`perspective` property
|
|
to encapsulate the effects of that property.
|
|
|
|
``mat4 u_view``
|
|
This is a matrix that transforms vertex coordinates from the world space to the view space. This
|
|
defaults to the identity matrix, but can be set by transforms with the :tpref:`perspective` property,
|
|
in which case the effects of positioning, rotation, and scaling are encapsulated in this matrix.
|
|
|
|
``mat4 u_model``
|
|
This is a matrix that transforms vertex coordinates from the model space to the world space.
|
|
|
|
``mat4 u_projectionview``
|
|
This matrix contains ``u_projection * u_view``. It exists to minimize the number of uniforms that need
|
|
to be sent to the GPU, and the amount of work that needs to be done in the shader.
|
|
|
|
``mat4 u_transform``
|
|
This is the same as ``u_projectionview * u_model``. It's the matrix that transforms vertex coordinates
|
|
directly to the OpenGL viewport. It exists to minimize the number of uniforms that need to be sent to the GPU,
|
|
the amount of work that needs to be done in the shader, and for compatibility with older versions of Ren'Py.
|
|
|
|
In addition to these methods, Ren'Py can sythesize matrices with certain functions applied when suffixes are
|
|
appended to the matrix
|
|
|
|
``_inverse``
|
|
When appended to a matrix, this returns the inverse of the matrix. For example, ``u_projection_inverse``
|
|
is the inverse of the projection matrix.
|
|
|
|
``_transpose``
|
|
When appended to a matrix, this returns the transpose of the matrix. For example, ``u_view_transpose``
|
|
is the transpose of the projection matrix.
|
|
|
|
``_inversetranspose``
|
|
When appended to a matrix, this returns the inverse of the transpose of the matrix. For example,
|
|
``u_model_inversetranspose`` is the inverse of the transpose of the model matrix. This is useful for
|
|
transforming normals.
|
|
|
|
Attributes
|
|
----------
|
|
|
|
The following attribute is available to all models:
|
|
|
|
``vec4 a_position``
|
|
The position of the vertex being rendered. This is in virtual pixels, relative to the upper
|
|
left corner of the texture.
|
|
|
|
If textures are available, so is the following attribute:
|
|
|
|
``vec2 a_tex_coord``
|
|
The coordinate that this vertex projects to inside the textures.
|
|
|
|
If normals are available, so is the following attribute:
|
|
|
|
``vec3 a_normal``
|
|
The normal of the vertex being rendered.
|
|
|
|
If tangents are available, so are the following attributes:
|
|
|
|
``vec3 a_tangent``
|
|
The tangent of the vertex being rendered.
|
|
|
|
``vec3 a_bitangent``
|
|
The bitangent of the vertex being rendered.
|
|
|
|
.. _gl-properties:
|
|
|
|
GL Properties
|
|
-------------
|
|
|
|
GL properties change the global state of OpenGL, or the Model-Based renderer.
|
|
These properties can be used with a Transform, or with the :func:`Render.add_property`
|
|
function.
|
|
|
|
.. _gl-blend-func:
|
|
|
|
``gl_blend_func``
|
|
If present, this is expected to be a six-component tuple, which is
|
|
used to set the equation used to blend the pixel being drawn with the
|
|
pixel it is being drawn to, and the parameters to that equation.
|
|
|
|
Specifically, this should be (`rgb_equation`, `src_rgb`, `dst_rgb`,
|
|
`alpha_equation`, `src_alpha`, `dst_alpha`). These will be used to
|
|
call::
|
|
|
|
glBlendEquationSeparate(rgb_equation, alpha_equation)
|
|
glBlendFuncSeparate(src_rgb, dst_rgb, src_alpha, dst_alpha)
|
|
|
|
Please see the OpenGL documentation for what these functions do.
|
|
OpenGL constants can be imported from renpy.uguu::
|
|
|
|
init python:
|
|
from renpy.uguu import GL_ONE, GL_ONE_MINUS_SRC_ALPHA
|
|
|
|
The :tpref:`blend` transform property is generally an easy way to
|
|
use this.
|
|
|
|
``gl_color_mask``
|
|
This is expecting to be a 4-tuple of booleans, corresponding to the four
|
|
channels of a pixel (red, green, blue, and alpha). If a given channel is
|
|
True, the draw operation will write to that pixel. Otherwise, it will
|
|
not.
|
|
|
|
``gl_depth``
|
|
If True, this will clear the depth buffer, and then enable depth
|
|
rendering for this displayable and the children of this displayable.
|
|
|
|
Note that drawing any pixel, even transparent pixels, will update
|
|
the depth buffer. As a result, using this with images that have
|
|
transparency may lead to unexpected problems. (As an alternative,
|
|
consider the ``zorder`` and ``behind`` clauses of the ``show`` statement.)
|
|
|
|
``gl_pixel_perfect``
|
|
When True, Ren'Py will move the mesh such that the first vertex is aligned with
|
|
a pixel on the screen. This is mostly used in conjunction with text,
|
|
to ensure that the text remains sharp.
|
|
|
|
The following properties only take effect when a texture is being created,
|
|
by a Transform with :tpref:`mesh` set, or by :func:`Model`, where these
|
|
can be supplied the property method.
|
|
|
|
``gl_drawable_resolution``
|
|
If True or not set, the texture is rendered at the same resolution
|
|
as the window displaying the game. If False, it's rendered at the
|
|
virtual resolution of the displayable.
|
|
|
|
``gl_anisotropic``
|
|
If supplied, this determines if the textures applied to a mesh are
|
|
created with anisotropy. Anisotropy is a feature that causes multiple
|
|
texels (texture pixels) to be sampled when a texture is zoomed by a
|
|
different amount in X and Y.
|
|
|
|
This defaults to True. Ren'Py sets this to False for certain effects,
|
|
like the Pixellate transition.
|
|
|
|
``gl_mipmap``
|
|
If supplied, this determines if the textures supplied to a mesh are
|
|
created with mipmaps. This defaults to True.
|
|
|
|
``gl_texture_wrap``
|
|
When supplied, this determines how the textures applied to a mesh
|
|
are wrapped. This expects a 2-component tuple, where the first
|
|
component is used to set GL_TEXTURE_WRAP_S and the second component
|
|
is used to set GL_TEXTURE_WRAP_T, which conventionally are the X and Y
|
|
axes of the created texture.
|
|
|
|
The values should be OpenGL constants imported from renpy.uguu::
|
|
|
|
init python:
|
|
from renpy.uguu import GL_CLAMP_TO_EDGE, GL_MIRRORED_REPEAT, GL_REPEAT
|
|
|
|
This can also be customized for specific textures. `gl_texture_wrap_tex0` controls
|
|
the first texture, `gl_texture_wrap_tex1` the second, `gl_texture_wrap_tex2`, the third,
|
|
and `gl_texture_wrap_tex3` the fourth. While only these four are avalable through Transforms,
|
|
it's possibe to supply "texture_wrap_tex4" or "texture_wrap_myuniform" to Render.add_property.
|
|
|
|
GLTFModel Displayable
|
|
-----------------------
|
|
|
|
The GLTFModel displayble allow you to load 3D models in the GLTF file format. This is what you should use
|
|
if you have a 3D model you created in another program and want to display in Ren'Py.
|
|
|
|
.. include:: inc/assimp
|
|
|
|
Model Displayable
|
|
-----------------
|
|
|
|
The Model displayable acts as a factory to created models for use with the
|
|
model-based renderer. This is an older API you may wish to use when you want to create
|
|
models in Python.
|
|
|
|
.. include:: inc/model_displayable
|
|
|
|
Model Displayable Examples
|
|
^^^^^^^^^^^^^^^^^^^^^^^^^^
|
|
|
|
The Model displayable can be used in conjunction with an ATL transform and
|
|
a built-in shader to create the Dissolve transform::
|
|
|
|
transform dt(delay=1.0, new_widget=None, old_widget=None):
|
|
delay delay
|
|
Model().texture(old_widget).child(new_widget)
|
|
shader [ 'renpy.dissolve' ]
|
|
|
|
u_renpy_dissolve 0.0
|
|
linear delay u_renpy_dissolve 1.0
|
|
|
|
Using the Model displayable as the child of a displayable is incompatible
|
|
with :tpref:`mesh`, as the two both create models inside Ren'Py.
|
|
|
|
Animated Shaders
|
|
----------------
|
|
|
|
When using shaders that depend on ``u_time`` to animate, one must be aware,
|
|
that even though every shader on screen will run on every frame displayed,
|
|
Ren'Py does not run on constant FPS, and will fall back to the minimum frame
|
|
rate of 5 FPS if no displayables require to be redrawn.
|
|
|
|
When using an animating shader in an ATL transform, this can cause that shader
|
|
to "stutter" and only animate properly while some other object on screen
|
|
animates as well, in case the transform you're using it in does not cause
|
|
redraws otherwise. In this case, an empty ATL loop can be introduced to force
|
|
redraws to happen::
|
|
|
|
transform fancy_shader:
|
|
shader 'my_fancy_shader'
|
|
pause 0
|
|
repeat
|
|
|
|
``pause 0`` will cycle the frames as fast as possible. You can also set
|
|
different values for ``pause`` to specify a minimum frame rate, like
|
|
``pause 1.0/30``.
|
|
|
|
|
|
Shader Parts
|
|
------------
|
|
|
|
For a list of shader parts that Ren'Py uses, see the :doc:`shader_parts`.
|