Skip to content

Commit 41ba3e8

Browse files
committed
Clean up temp notes
1 parent 1662f9f commit 41ba3e8

File tree

2 files changed

+10
-22
lines changed

2 files changed

+10
-22
lines changed

docs/source/effects.rst

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,13 @@
22
Effects
33
=======
44

5-
In order to draw something to the screen using this framework you need to make one or multiple effects.
6-
An effect is an independent python package of a certain format.
5+
In order to draw something to the screen using this framework you need to make one or
6+
multiple effects. what these effects are doing is entirely up to you. Some like to
7+
put everything into one effect and switch what they draw by flipping some internal
8+
states, but this is probably not practical for more complex things.
79

10+
An effect is a class with references to resources and a method for drawing.
11+
An effect is an independent python package of specific format.
812

913
The Effect Package
1014
^^^^^^^^^^^^^^^^^^
@@ -53,6 +57,10 @@ Resources
5357
Resource loading is baked into the effect class it self. Methods are inherited
5458
from the base ``Effect`` class such as ``get_shader`` and ``get_texture``.
5559

60+
Remember that you can also create global resource directories for all
61+
the effects in your projects as well. This can be achieved by configuring
62+
resource finders in :doc:`settings`.
63+
5664
The Effect Module
5765
^^^^^^^^^^^^^^^^^
5866

docs/source/tempnotes.rst

Lines changed: 0 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -4,18 +4,12 @@ Temporary Notes
44

55
This needs to be restructured into actual docs.
66

7-
- Shaders and textures can be easily loaded by using the ``get_texture`` and
8-
``get_shader`` method inherited from ``Effect``.
97
- The ``cube`` objects is a ``VAO`` that you bind supplying the shader and the system
108
will figure out the attribute mapping.
11-
- Please look in the ``demosys.opengl.geometry`` module for the valid attribute names and
12-
look at shaders in the testdemo_.
139
- You currently define vertex,
1410
fragment and geometry shader in one glsl file separated by
1511
preprocessors.
16-
- Effects not defined in the ``settings.py`` module will not run.
1712

18-
That should give you an idea..
1913

2014
Anything we draw to the screen must be implemented as an ``Effect``. If
2115
that effect is one or multiple things is entirely up to you. An effect
@@ -46,20 +40,6 @@ Some babble about the current state of the project:
4640
in a shader that only use position (or any other combination of attributes
4741
in the VAO); the VAO class will on-the-fly generate a version internally
4842
with only positions.
49-
- We only support 2D textures at the moment loaded with PIL/Pillow, but
50-
this is trivial to extend.
51-
- Resource loading is supported in the ``Effect`` class itself. In ``__init__()``
52-
you can fetch resources using for example ``self.get_shader`` or\ ``self.get_texture``.
53-
This will return a lazy object that will be populated after the loading
54-
stage is done.
55-
- Resources shared between effects can be put outside effect packages
56-
inside your project directory. For example in ``testdemo/resources/shaders``
57-
and ``testdemo/resources/textures``. Make sure you add those paths in the
58-
settings file.
59-
- We don't have any scene/mesh loaders. You can hack something in yourself
60-
for now or just stick to or extend the ``geometry`` module. - We try to
61-
do as much validation as possible and give useful feedback when something
62-
goes wrong.
6343
- The ``time`` value passed to the effects ``draw`` method is the current
6444
duration in the playing music. If no music is loaded, a dummy timer is used.
6545

0 commit comments

Comments
 (0)