Skip to content

Effects

keyed.effects

Raster effects.

Note

This module currently only defines the Effect Protocol. You can find some concrete effect implementations in keyed-extras, the sponsorware extension for the keyed library. Some of these effects will eventually be merged into the main package.

Effect

Bases: Protocol

Protocol defining the Effects interface.

In keyed, effects are raster-based, and are applied to keyed.scene.Layers during the compositing process.

Effects modify a layer's rasterized data (represented as a NumPy array).

Implementations must define an apply method that modifies the input array in-place.

Source code in src/keyed/effects.py 
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
class Effect(Protocol):
    """Protocol defining the Effects interface.

    In `keyed`, effects are raster-based, and are applied to `keyed.scene.Layer`s during the
    compositing process.

    Effects modify a layer's rasterized data (represented as a NumPy array).

    Implementations must define an `apply` method that modifies the input array in-place.
    """

    def apply(self, array: np.ndarray) -> None:
        """Apply the effect to an image array.

        Args:
            array: RGBA image data as a NumPy array with shape (height, width, 4).
                  The array should be modified in-place.
        """
        ...

apply 

apply(array)

Apply the effect to an image array.

Parameters:

Name Type Description Default
array ndarray

RGBA image data as a NumPy array with shape (height, width, 4). The array should be modified in-place.

 required
Source code in src/keyed/effects.py 
29
30
31
32
33
34
35
36
def apply(self, array: np.ndarray) -> None:
    """Apply the effect to an image array.

    Args:
        array: RGBA image data as a NumPy array with shape (height, width, 4).
              The array should be modified in-place.
    """
    ...